seo-connect
POST /v1/seo-connection/offers/orders
Open the basket an offer's order needs. Charges nothing.
Authentication
Send an API key as a bearer token. The endpoint checks sites.create; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/seo-connection/offers/orders \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "offer": <SeoOfferKey>, "product": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Needs the seo.run scope. Puts the product in a NEW basket for the site's organization, priced by the basket from the live row (the request carries no amount), and answers the dashboard address where the person pays it, signed in, in a new tab. Nothing is charged, captured or authorised here. A marketplace product takes the chosen package_id (one of listSeoOfferListings); a domain takes the full domain; context carries the finding, the page, the anchor, a brief and the A/B variant the site showed. A service a person delivers (the done-for-you SEO-plugin migration) carries the site and its context to the staff task, and is refused with refusal.seoOffers.notInGoodStanding when the account is suspended or closed (§2.46).
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
offer | SeoOfferKey | Yes | — |
product | string | Yes | — |
package_id | string | No | — |
domain | string | No | — |
context | object | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
offer | SeoOfferKey | Yes | — |
ledger | string | Yes | — |
product | string | Yes | — |
kind | string | Yes | — |
label | string | Yes | — |
context | object | Yes | — |
url | string | Yes | Where the order continues — opened in a new tab. |
status | string<opened, basket, awaiting_payment, payment_failed, paid, brief_needed, in_progress, delivered, done, disputed, cancelled, refunded, expired> | Yes | — |
total_minor | object | No | — |
tax_minor | object | No | — |
currency | string | No | — |
order_id | string | No | — |
sale_id | string | No | — |
placement_url | string | No | — |
watched | boolean | Yes | — |
created_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429