localization
GET /v1/session/offering
The currencies and languages this viewer may be shown.
Authentication
This endpoint takes no API key. Anything else it needs, such as a signed request, is described above.
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/session/offering \
-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
What a storefront, checkout or panel shell may offer the person looking at it, already resolved through their provider's policy. The viewer is identified two ways, in this order: who they are, when they are signed in; otherwise where they are standing, from the reseller panel hostname in the browser's Origin. So an anonymous visitor on a reseller's branded panel gets that reseller's offering, and everybody else — an anonymous visitor to Zinn®, an unrecognised origin, a hostname we no longer serve — gets the platform answer: every currency we can charge and every language we ship. Signing in always wins over the origin, because pricing follows the organisation the rest of the API scopes your reads by. restricted says a reseller stands between this viewer and Zinn®; read it rather than inferring one from list lengths, because a reseller who has narrowed nothing returns exactly the same lists as no reseller at all. currency_switcher: false means render no control, not a disabled one. Never cached.
Response
| Name | Type | Required | What it is |
|---|---|---|---|
currencies | string[] | Yes | The currencies this viewer may be quoted in. Never empty. |
default_currency | string | Yes | Always a member of currencies. |
currency_switcher | boolean | Yes | false means render no currency control at all — not a disabled one. |
locales | string[] | Yes | The languages this viewer may read the panel in. Never empty. |
default_locale | string | Yes | Always a member of locales. |
language_switcher | boolean | Yes | false means render no language control at all. |
restricted | boolean | Yes | A reseller stands between this viewer and Zinn®. Explicit rather than inferred: a reseller who has narrowed nothing returns identical lists to no reseller at all. |
Errors this endpoint can return
429