platform-transfers

POST `/v1/platform-transfers/quote`

Price a transfer without buying it.

Authentication

Send an API key as a bearer token. The key must carry the billing.view permission; 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/platform-transfers/quote \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "source_platform": <string>, "target_platform": <string>, "entity_count": <integer> }'

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

The tier a given move would be sold at, chosen as the cheapest whose entity bound covers the store. Creates nothing and charges nothing. Requires `billing.view`.

Request body

Name	Type	Required	What it is
`source_platform`	`string`	Yes	—
`target_platform`	`string`	Yes	—
`entity_count`	`integer`	Yes	Products + customers + orders + posts, as the customer estimates them.

Response

Name	Type	Required	What it is
`tier_code`	`string`	Yes	—
`tier_name`	`string`	Yes	—
`price_amount_minor`	`integer`	Yes	—
`currency`	`string`	Yes	—
`sla_business_days`	`integer`	Yes	—
`max_entities`	`object`	No	—

Errors this endpoint can return

401 · 403 · 422 · 429

POST /v1/platform-transfers/quote