platform-transfers

GET /v1/platform-transfers/platforms

Platforms we can move a store from, and the ones we can move it to.

All platform-transfers endpoints

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 GET https://api.zinndigital.com/v1/platform-transfers/platforms \
  -H "Authorization: Bearer zdk_live_…"

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

Everything the transfer selector is built from, in one response: the source platforms grouped for display, the target platforms, and the three priced tiers. Requires `billing.view`. **`targets` is a strict subset of `sources`, and deliberately so.** A platform can be a target only when we can host it, so self-hosted PHP/Node stacks (WooCommerce, Magento, PrestaShop, …) appear in both lists while hosted SaaS platforms (Shopify, Wix, Squarespace, …) appear only as sources. Nobody but their owner can run those, so we cannot promise a result on them. Tier prices are in the caller's currency, converted from the cached FX rates by the same function the charge captures — so the price on the selector is the price at the till. Send `X-Zinn-Currency` to choose.

Response

NameTypeRequiredWhat it is
sourcesTransferPlatformGroup[]Yes
targetsTransferPlatformGroup[]Yes
tiersTransferTier[]Yes

Errors this endpoint can return

401 · 403 · 429