Translations
Requires scope merchant-locales-read.
Lists the store’s enabled locales with catalogue names, publish state and the primary and default flags, default first.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/locales" \ -H "X-Client-Key: {{merchantKey}}"{ "status": "success", "message": "Locales retrieved", "data": [ { "locale": "en", "name": "English", "native_name": "English", "html_lang": "en", "dir": "ltr", "published": true, "is_primary": true, "is_default": true }, { "locale": "fr", "name": "French", "native_name": "Français", "html_lang": "fr", "dir": "ltr", "published": true, "is_primary": false, "is_default": false }, { "locale": "de", "name": "German", "native_name": "Deutsch", "html_lang": "de", "dir": "ltr", "published": false, "is_primary": false, "is_default": false } ]}Requires scope merchant-locales-write.
Enables a catalogue locale on the store; answers the added locale, unpublished until published.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
POST locales {locale} — enable a catalogue locale on the store. The code must be a supported catalogue code; anything else is a 422, never a guess.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/locales" \ -H "X-Client-Key: {{merchantKey}}" \ -H "Content-Type: application/json" \ -d '{ "locale": "fr" }'{ "status": "success", "message": "Locale added", "data": { "locale": "fr", "name": "French", "native_name": "Français", "html_lang": "fr", "dir": "ltr", "published": false, "is_primary": false, "is_default": false }}Requires scope merchant-locales-write.
Publishes or unpublishes an enabled locale. {locale} is a catalogue code of this store.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Path Parameters
Identifier of the locale, as returned by the Merchant API.
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
PATCH locales/{locale} — publish or unpublish an enabled locale by sending
published. An unknown code, or a code the store never added, answers 404.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/locales/fr" \ -H "X-Client-Key: {{merchantKey}}" \ -H "Content-Type: application/json" \ -d '{ "published": true }'{ "status": "success", "message": "Locale updated", "data": { "locale": "fr", "name": "French", "native_name": "Français", "html_lang": "fr", "dir": "ltr", "published": true, "is_primary": false, "is_default": false }}Requires scope merchant-locales-write.
Removes a locale with all of its translations. {locale} is a catalogue code of this store.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Path Parameters
Identifier of the locale, as returned by the Merchant API.
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/locales/de" \ -H "X-Client-Key: {{merchantKey}}"{ "status": "success", "message": "Locale removed", "data": { "locale": "de", "deleted": true }}Requires scope merchant-locales-write.
Makes a published locale the language the store root address serves; the primary clears the choice. Answers the full locales list with the change.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Path Parameters
Identifier of the locale, as returned by the Merchant API.
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/locales/fr/default" \ -H "X-Client-Key: {{merchantKey}}"{ "status": "success", "message": "Default language updated", "data": [ { "locale": "fr", "name": "French", "native_name": "Français", "html_lang": "fr", "dir": "ltr", "published": true, "is_primary": false, "is_default": true }, { "locale": "en", "name": "English", "native_name": "English", "html_lang": "en", "dir": "ltr", "published": true, "is_primary": true, "is_default": false } ], "meta": { "previous_default": "en", "new_default": "fr" }}Requires scope merchant-translations-read.
Lists one resource type’s translatable content — the current source value, digest and kind per key — with cursor pagination (limit + starting_after, has_more/next_cursor). Each item’s id is the resource’s integer p_id, the value {id} takes on the retrieve and write routes. theme_string is the store’s own singleton: the page carries every theme key of the active theme with has_more false — English comes from the theme registry sync (themes.en_default), with the deprecated owner-asserted theme_strings_en config row as fallback.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Query Parameters
Maximum number of items to return in one page.
1 <= value <= 100Cursor for the next page: pass next_cursor from the previous response unchanged. Keep walking while has_more is true.
One of product, product_variation, product_variation_item, collection, category, page, post, menu, theme_string.
Value in
- "product"
- "product_variation"
- "product_variation_item"
- "collection"
- "category"
- "page"
- "post"
- "menu"
- "theme_string"
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/translatable-resources?limit=2&type=product" \ -H "X-Client-Key: {{merchantKey}}"{ "data": [ { "type": "product", "id": 20417, "content": [ { "key": "title", "value": "Smokehouse Party Pack", "digest": "a5d8229874cabac20c9577aeb246701e6aba6785f98ad997b9131b316b063040", "type": "text" }, { "key": "description", "value": "Hickory-smoked chicken cooked to order, served with cornbread and a tub of slaw. Feeds 10.", "digest": "171974414a853ea9cd646e1e59ea40d46756281b9ad9e57665312a0fc92e3e17", "type": "html" }, { "key": "excerpt", "value": "Hickory-smoked chicken for 10, with cornbread and slaw.", "digest": "35a48d1a4b03bae3424ab50a7df9cc99b7d77c31e6729cb4a0722a5f01fc7e38", "type": "text" } ], "machine_translation_allowed": true }, { "type": "product", "id": 20418, "content": [ { "key": "title", "value": "Fresh Lemonade", "digest": "01b3630e5014c252f00f66eee6328a92268bbdcf634c8cf899db5e2b444951ef", "type": "text" }, { "key": "description", "value": "Our house lemonade, mixed fresh every morning. Served chilled.", "digest": "2c9d4da39dac74152ba277b0c1b67e004778f6d0378c1dff26a078082bb785e6", "type": "html" }, { "key": "excerpt", "value": "Fresh lemonade with mint and lemon slices.", "digest": "90f434859937adad372514016a9670f19eb2060e430b746d84f7b7b9006b2836", "type": "text" } ], "machine_translation_allowed": true } ], "has_more": true, "next_cursor": "eyJpZCI6MjA0MTgsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"}Requires scope merchant-translations-read.
Retrieves one resource’s translatable content with its stored translations, each flagged outdated when the source changed since. {id} is a p_id or UUID of this store. For theme_string, {id} is the store’s own p_id, slug or UUID and keys are <theme-slug>.<dotted-key> against the store’s English defaults (e.g. roast.cart.title) — served from the active theme’s registry-synced en_default, with the deprecated owner-asserted theme_strings_en config row as fallback.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Path Parameters
The kind of resource, one of the type values GET /translatable-resources accepts (for example product, collection or page).
The resource's integer id, as GET /translatable-resources returns it for this type. An id that belongs to another store answers 404.
Query Parameters
One of en, fr, es, pt, pt-BR, de, it, nl, pl, ru, uk, tr, ar, ur, fa, he, hi, ja, ko, zh-CN, zh-TW, id, ms, vi, th, tl, sw, ha, yo, ig, pcm.
length <= 12Value in
- "en"
- "fr"
- "es"
- "pt"
- "pt-BR"
- "de"
- "it"
- "nl"
- "pl"
- "ru"
- "uk"
- "tr"
- "ar"
- "ur"
- "fa"
- "he"
- "hi"
- "ja"
- "ko"
- "zh-CN"
- "zh-TW"
- "id"
- "ms"
- "vi"
- "th"
- "tl"
- "sw"
- "ha"
- "yo"
- "ig"
- "pcm"
- null
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/translatable-resources/product/20417?locale=fr" \ -H "X-Client-Key: {{merchantKey}}"{ "status": "success", "message": "Translatable resource retrieved", "data": { "type": "product", "id": 20417, "content": [ { "key": "title", "value": "Smokehouse Party Pack", "digest": "a5d8229874cabac20c9577aeb246701e6aba6785f98ad997b9131b316b063040", "type": "text" }, { "key": "description", "value": "Hickory-smoked chicken cooked to order, served with cornbread and a tub of slaw. Feeds 10.", "digest": "171974414a853ea9cd646e1e59ea40d46756281b9ad9e57665312a0fc92e3e17", "type": "html" }, { "key": "excerpt", "value": "Hickory-smoked chicken for 10, with cornbread and slaw.", "digest": "35a48d1a4b03bae3424ab50a7df9cc99b7d77c31e6729cb4a0722a5f01fc7e38", "type": "text" } ], "machine_translation_allowed": true, "translations": [ { "key": "title", "locale": "fr", "value": "Pack Fête Fumoir", "outdated": false, "origin": "human", "updated_at": "2026-09-30T12:00:00+01:00" } ] }}Requires scope merchant-translations-write.
Removes one resource’s translations, optionally narrowed to locales and/or keys. {id} is a p_id or UUID of this store. For theme_string, narrowing to keys prunes a retired theme slug’s dormant overrides.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Path Parameters
The kind of resource, one of the type values GET /translatable-resources accepts (for example product, collection or page).
The resource's integer id, as GET /translatable-resources returns it for this type. An id that belongs to another store answers 404.
Query Parameters
One of en, fr, es, pt, pt-BR, de, it, nl, pl, ru, uk, tr, ar, ur, fa, he, hi, ja, ko, zh-CN, zh-TW, id, ms, vi, th, tl, sw, ha, yo, ig, pcm.
Value in
- "en"
- "fr"
- "es"
- "pt"
- "pt-BR"
- "de"
- "it"
- "nl"
- "pl"
- "ru"
- "uk"
- "tr"
- "ar"
- "ur"
- "fa"
- "he"
- "hi"
- "ja"
- "ko"
- "zh-CN"
- "zh-TW"
- "id"
- "ms"
- "vi"
- "th"
- "tl"
- "sw"
- "ha"
- "yo"
- "ig"
- "pcm"
Only remove these translation keys (the key values the translations carry, at most 64 characters each). Omit it to remove every key.
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/translations/product/20417" \ -H "X-Client-Key: {{merchantKey}}"{ "status": "success", "message": "Translations removed", "data": { "type": "product", "id": 20417, "deleted": 2 }}Requires scope merchant-translations-write.
Registers up to 100 translations on one resource against the current source digests — all or nothing. A stale digest, unknown locale or unknown key answers a per-item translation_* code and writes nothing. {id} is a p_id or UUID of this store. Translator flow for theme_string: English defaults arrive via the theme registry sync (no English write path here — the owner-asserted theme_strings_en config row is a deprecated fallback only), echo each key’s current digest, then write at most 100 keys per call — N sequential calls carry a full dictionary.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Path Parameters
The kind of resource, one of the type values GET /translatable-resources accepts (for example product, collection or page).
The resource's integer id, as GET /translatable-resources returns it for this type. An id that belongs to another store answers 404.
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
PUT translations/{type}/{id} — register a batch of translations against the current source digests. The body shape is validated first (at most 100 items); then each item's locale, key and digest is checked against the live source text. Failures answer per-item codes (translation_unknown_locale, translation_unknown_key, translation_digest_stale) and nothing is written unless every item passes.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/translations/product/20417" \ -H "X-Client-Key: {{merchantKey}}" \ -H "Content-Type: application/json" \ -d '{ "translations": [ { "locale": "fr", "key": "title", "value": "Pack Fête Fumoir", "digest": "a5d8229874cabac20c9577aeb246701e6aba6785f98ad997b9131b316b063040" } ] }'{ "status": "success", "message": "Translations registered", "data": { "type": "product", "id": 20417, "translations": [ { "key": "title", "locale": "fr", "value": "Pack Fête Fumoir", "outdated": false, "origin": "human", "updated_at": "2026-09-30T12:00:00+01:00" } ] }}Requires scope merchant-translations-machine.
Prices a machine translation job before anything runs. The body is a REFERENCE, never text: the target locale (a language the store has enabled), a mode (missing, outdated or missing_and_outdated; the outdated modes refresh machine translations only) and resources (type, id, optional keys) naming the store's own content, which is read from the store in its primary language. Answers a quote_id good for ten minutes, the texts and source characters it covers, the estimated_credits (an upper bound: the run never charges more) and the held keys that will not be translated (a store policy page is translated by hand). Charges nothing. The store must have the credits and the merchant must have left the app's machine translation switch on; a job is limited to 200,000 characters, 20 resources and 20 keys per resource, and a store to 1,000,000 characters a day. A job runs inside a time budget: once it is spent the remaining texts are held as time_budget and the app runs the rest again.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
POST translations/machine/quote: what a job would translate and cost, before anything runs.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/translations/machine/quote" \ -H "X-Client-Key: {{merchantKey}}" \ -H "Content-Type: application/json" \ -d '{ "locale": "fr", "mode": "missing", "resources": [ { "type": "product", "id": 20417, "keys": [ "title", "excerpt", "description" ] } ] }'{ "status": "success", "message": "Machine translation quoted", "data": { "quote_id": "qt_01k8m3q7x2n5v9w4b6d8f0g2h4", "locale": "fr", "mode": "missing", "texts": 3, "characters": 412, "estimated_credits": 4, "expires_at": "2026-09-30T12:10:00+01:00", "held": [] }}Requires scope merchant-translations-machine.
Runs a quoted machine translation job: send the quote_id with the same locale, mode and resources it priced. Only clean results are written, each as a translation of origin machine; any text that fails a check is held with a reason (tags_changed, placeholders_changed, numbers_changed, keep_term_changed, empty_output, too_long, source_changed, not_allowed, human_written (an out-of-date translation a person wrote: machine translation only ever refreshes its own, never a person's), edited (a person typed a translation meanwhile and it is never overwritten), write_failed, time_budget or service_unavailable) and nothing is written for it. Answers every key as written or held and the credits_charged to the store, never above the quote. Idempotency-Key is required: the same key replays the first answer without a second charge. A quote is single-use; an unknown or expired one answers 410, one made for another job 409, too few credits 402 before any work starts. Fires translations/update per resource written.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
POST translations/machine: runs a quoted job. Idempotency-Key is required (a retried run would
otherwise spend the store's credits twice) and is checked, like the gates before it, before validation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/translations/machine" \ -H "X-Client-Key: {{merchantKey}}" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "quote_id": "qt_01k8m3q7x2n5v9w4b6d8f0g2h4", "locale": "fr", "mode": "missing", "resources": [ { "type": "product", "id": 20417, "keys": [ "title", "excerpt", "description" ] } ] }'{ "status": "success", "message": "Machine translation finished", "data": { "locale": "fr", "mode": "missing", "texts_written": 2, "texts_held": 1, "credits_charged": 3, "items": [ { "type": "product", "id": 20417, "key": "title", "status": "written", "reason": null }, { "type": "product", "id": 20417, "key": "excerpt", "status": "written", "reason": null }, { "type": "product", "id": 20417, "key": "description", "status": "held", "reason": "tags_changed" } ] }}