Order translations

Read and write localized order fields through the Store API.

Batch get order status translations

GET read_orders + read_translations

Fetch order status translations in batch.

An order status translation is the name of one of the store's own (custom) statuses in another store language, addressed by the id that List order statuses returns. Customers see it on the order confirmation, order status and account pages in that language, and staff who use Tringify in that language see it in the order list and order details; without one, everyone sees the status's own name. System statuses (Pending payment, Processing, Completed, Cancelled) are worded by Tringify in every language and refuse translations with ORDER_STATUS_TRANSLATION_SYSTEM. Only name is translatable; it follows the rules of a status name (not blank, at most the order statuses limit's name_max_length characters, no control characters). A translation written against an earlier name is reported outdated. Store Admin, the Tringify mobile app, standard AI Translator jobs, translation CSV (resource order_status) and MCP translate the same names. Each change sends order_statuses/translations/update, or order_statuses/translations/delete when a translation is cleared. Returns a resources entry keyed by order_status:{id} for each requested status (at most 100 per call); a status without a translation has an empty object. Fields without a translation in this locale are omitted from the response. An omitted field is not empty: shoppers see the store's base-language value, which the resource's own GET endpoint returns.

Path parameters

Name Type Description
locale required string

Enabled non-default store locale.

Example: fr

Query parameters

Name Type Description
ids required string

Comma-separated order status IDs.

Example: 2c4e8f1a-7b3d-4e9a-8c6f-1d2e3f4a5b6c,6d2f8a1c-3b4e-4f5a-9c7d-1e2b3a4c5d6e

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Errors

  • 400 TRANSLATION_LOCALE_NOT_ENABLED

    Locale is not enabled for this store.

  • 400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN

    Translations cannot target the store's default locale, the language of the statuses' own names.

  • 400 TRANSLATION_RESOURCE_ID_REQUIRED

    At least one status ID is required.

  • 400 TRANSLATION_INVALID_RESOURCE_ID

    A status ID is not a UUID.

  • 400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE

    A status does not exist in this store.

  • 400 ORDER_STATUS_TRANSLATION_SYSTEM

    A status is a system status: Tringify words it in every language.

  • 400 TRANSLATION_TOO_MANY_RESOURCES

    The request exceeds the translation batch resource limit.

Batch set order status translations

PUT write_orders + write_translations

Set order status translations for any languages in one call.

An order status translation is the name of one of the store's own (custom) statuses in another store language, addressed by the id that List order statuses returns. Customers see it on the order confirmation, order status and account pages in that language, and staff who use Tringify in that language see it in the order list and order details; without one, everyone sees the status's own name. System statuses (Pending payment, Processing, Completed, Cancelled) are worded by Tringify in every language and refuse translations with ORDER_STATUS_TRANSLATION_SYSTEM. Only name is translatable; it follows the rules of a status name (not blank, at most the order statuses limit's name_max_length characters, no control characters). A translation written against an earlier name is reported outdated. Store Admin, the Tringify mobile app, standard AI Translator jobs, translation CSV (resource order_status) and MCP translate the same names. Each change sends order_statuses/translations/update, or order_statuses/translations/delete when a translation is cleared. Each row is one order status in one language: id, locale (any enabled non-default store locale) and fields. Rows for several languages can be mixed in one call; send at most 100 rows (one row = one order status in one locale) and at most one row per order status and locale. Each row is saved on its own: a failing row never stops the others. Empty values clear the matching field translation; omitted fields keep their translation. Every row is validated exactly like the single translation endpoint. The response has totals (rows, saved, failed) and one results entry per row in request order: {id, locale, status} with status saved or failed. A failed row carries the full error (code, message, details); its codes are the single endpoint's codes plus TRANSLATION_ROW_DUPLICATE. A saved rich-text row whose unsafe markup was removed lists warnings. A top-level code and message give the outcome: TRANSLATIONS_SAVED (200, every row saved), TRANSLATIONS_PARTIALLY_SAVED (200, success: true; the message counts saved and failed rows and names the failure reasons, e.g. "2 saved, 1 failed. No source text found for the requested fields (description).") TRANSLATIONS_NOT_SAVED_RETRY (503 with a Retry-After header, success: false; no row saved because every row failed only with TRANSLATION_WRITE_BUSY, so the same call can be sent again after error.details.retry_after_seconds) or TRANSLATIONS_NOT_SAVED (422, success: false; no row saved and at least one row failed for another reason). Both carry the same totals and results in error.details. With an Idempotency-Key, repeating the same request re-applies nothing that already saved and retries the failed rows. A write waits at most 2 seconds for other translation writes of the same item or of a clashing name or slug (for example a translation CSV import writing the same language); writes of other items, types and languages never wait. A row or call that fails with TRANSLATION_WRITE_BUSY (HTTP 503) saved nothing: send it again after error.details.retry_after_seconds (the call's Retry-After header says the same). Every row or call either saved or reports an error; none is left in an unknown state.

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Idempotency-Key string

Optional key for this translation write. Reuse it only with the same payload when repeating the request.

Body parameters

Name Type Description
translations required array<object>

Up to 100 rows shaped as {id, locale, fields}. The only allowed field key is name.

Example: [{"fields":{"name":"In Produktion"},"id":"2c4e8f1a-7b3d-4e9a-8c6f-1d2e3f4a5b6c","locale":"fr"},{"fields":{"name":"In Produktion"},"id":"2c4e8f1a-7b3d-4e9a-8c6f-1d2e3f4a5b6c","locale":"de"},{"fields":{"name":"In Produktion"},"id":"2c4e8f1a-7b3d-4e9a-8c6f-1d2e3f4a5b6c","locale":"pt-BR"}]

Errors

  • 401 UNAUTHORIZED

    Authorization header missing, malformed, or token invalid/expired.

  • 402 SUBSCRIPTION_REQUIRED

    The store does not have an active or trialing subscription.

  • 403 STORE_API_SCOPE_REQUIRED

    Token is valid but lacks the required scope for this call.

  • 429 RATE_LIMITED

    The token's request allowance is exhausted. Retry after the Retry-After header.

  • 400 STORE_API_INVALID_REQUEST_BODY

    The body is not valid JSON or a row has an unknown key or a wrongly typed value.

  • 400 TRANSLATION_NO_WRITES_PROVIDED

    translations is empty.

  • 400 TRANSLATION_TOO_MANY_ROWS

    More than 100 rows; nothing is written.

  • 503 TRANSLATIONS_NOT_SAVED_RETRY

    No row saved and every row failed only with TRANSLATION_WRITE_BUSY: send the same request again after error.details.retry_after_seconds (also the Retry-After header). error.details also has totals and one results entry per row with its error.

  • 422 TRANSLATIONS_NOT_SAVED

    No row saved and at least one row failed with an error that sending again will not fix; error.details has totals and one results entry per row with its error.

  • 400 STORE_API_BODY_PROPERTY_UNKNOWN

    The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).

  • 400 STORE_API_BODY_PROPERTY_INVALID

    A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

Get an order status translation

GET read_orders + read_translations

Fetch one order status name in another store language.

An order status translation is the name of one of the store's own (custom) statuses in another store language, addressed by the id that List order statuses returns. Customers see it on the order confirmation, order status and account pages in that language, and staff who use Tringify in that language see it in the order list and order details; without one, everyone sees the status's own name. System statuses (Pending payment, Processing, Completed, Cancelled) are worded by Tringify in every language and refuse translations with ORDER_STATUS_TRANSLATION_SYSTEM. Only name is translatable; it follows the rules of a status name (not blank, at most the order statuses limit's name_max_length characters, no control characters). A translation written against an earlier name is reported outdated. Store Admin, the Tringify mobile app, standard AI Translator jobs, translation CSV (resource order_status) and MCP translate the same names. Each change sends order_statuses/translations/update, or order_statuses/translations/delete when a translation is cleared. Returns the stored name translation in the selected locale with is_outdated; a status without a translation in this locale returns an empty fields object. Fields without a translation in this locale are omitted from the response. An omitted field is not empty: shoppers see the store's base-language value, which the resource's own GET endpoint returns.

Path parameters

Name Type Description
id required uuid

Order status ID.

Example: 2c4e8f1a-7b3d-4e9a-8c6f-1d2e3f4a5b6c
locale required string

Enabled non-default store locale.

Example: fr

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Errors

  • 400 TRANSLATION_LOCALE_NOT_ENABLED

    Locale is not enabled for this store.

  • 400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN

    Translations cannot target the store's default locale, the language of the statuses' own names.

  • 400 TRANSLATION_INVALID_RESOURCE_ID

    The status ID is not a UUID.

  • 400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE

    The status does not exist in this store.

  • 400 ORDER_STATUS_TRANSLATION_SYSTEM

    The status is a system status: Tringify words it in every language.

Set an order status translation

PUT write_orders + write_translations

Set or clear one order status name in another store language.

An order status translation is the name of one of the store's own (custom) statuses in another store language, addressed by the id that List order statuses returns. Customers see it on the order confirmation, order status and account pages in that language, and staff who use Tringify in that language see it in the order list and order details; without one, everyone sees the status's own name. System statuses (Pending payment, Processing, Completed, Cancelled) are worded by Tringify in every language and refuse translations with ORDER_STATUS_TRANSLATION_SYSTEM. Only name is translatable; it follows the rules of a status name (not blank, at most the order statuses limit's name_max_length characters, no control characters). A translation written against an earlier name is reported outdated. Store Admin, the Tringify mobile app, standard AI Translator jobs, translation CSV (resource order_status) and MCP translate the same names. Each change sends order_statuses/translations/update, or order_statuses/translations/delete when a translation is cleared. Send an empty string to clear the translation; readers in that language then see the status's own name. A write waits at most 2 seconds for other translation writes of the same item or of a clashing name or slug (for example a translation CSV import writing the same language); writes of other items, types and languages never wait. A row or call that fails with TRANSLATION_WRITE_BUSY (HTTP 503) saved nothing: send it again after error.details.retry_after_seconds (the call's Retry-After header says the same). Every row or call either saved or reports an error; none is left in an unknown state.

Path parameters

Name Type Description
id required uuid

Order status ID.

Example: 2c4e8f1a-7b3d-4e9a-8c6f-1d2e3f4a5b6c
locale required string

Enabled non-default store locale.

Example: fr

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Idempotency-Key string

Optional key for this translation write. Reuse it only with the same payload when repeating the request.

Body parameters

Name Type Description
translations required object

Field-keyed translation values. The only allowed field is name.

Example: {"name": "Versandt"}

Errors

  • 400 TRANSLATION_LOCALE_NOT_ENABLED

    Locale is not enabled for this store.

  • 400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN

    Translations cannot target the store's default locale, the language of the statuses' own names.

  • 400 TRANSLATION_INVALID_RESOURCE_ID

    The status ID is not a UUID.

  • 400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE

    The status does not exist in this store.

  • 400 ORDER_STATUS_TRANSLATION_SYSTEM

    The status is a system status: Tringify words it in every language.

  • 400 STORE_API_INVALID_REQUEST_BODY

    Request body must be a JSON object containing only documented fields; error.details.field identifies an unknown field.

  • 400 TRANSLATION_FIELDS_REQUIRED

    translations must contain name.

  • 400 TRANSLATION_FIELD_NOT_TRANSLATABLE

    A field other than name was sent.

  • 400 INVALID_INPUT

    The translation breaks a status name rule (blank after trimming, longer than name_max_length, or control characters); the message says which.

  • 400 ORDER_STATUS_NAME_NO_ALNUM

    The translation has no letter or digit.

  • 503 TRANSLATION_WRITE_BUSY

    Another write of the same status translation was saving; nothing was saved. Send it again after error.details.retry_after_seconds.

  • 503 TRANSLATION_WRITE_BUSY

    Other translation writes held the item or a clashing name or slug for more than 2 seconds; nothing was saved. Send the request again after error.details.retry_after_seconds (also the Retry-After header).

  • 400 STORE_API_BODY_PROPERTY_UNKNOWN

    The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).

  • 400 STORE_API_BODY_PROPERTY_INVALID

    A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.