Metafield definition translations

A definition's name is the label shoppers see next to its value, for example in the platform metafield block. Names translate per definition and locale. The definition must be visible to the token and editable by the merchant (merchant_access read_write, which every merchant-owned definition is); other app-owned definitions return TRANSLATION_FIELD_NOT_TRANSLATABLE. The token also needs the read scope of the definition's owner_type. Translation CSV (resource metafield_definition) and Store Admin translate the same names. Name translations send no webhooks, like choice label translations. Returns a resources entry keyed by metafield_definition:{id} for each requested definition (at most 100 per call); a definition without a translation has an empty object. One definition the token cannot address fails the whole call with its code. 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. Staff-created merchant tokens also require settings.metafield_definitions:read, as in Store Admin.

A definition's name is the label shoppers see next to its value, for example in the platform metafield block. Names translate per definition and locale. The definition must be visible to the token and editable by the merchant (merchant_access read_write, which every merchant-owned definition is); other app-owned definitions return TRANSLATION_FIELD_NOT_TRANSLATABLE. The token also needs the read scope of the definition's owner_type. Translation CSV (resource metafield_definition) and Store Admin translate the same names. Name translations send no webhooks, like choice label translations. A row for a definition the token cannot address fails with that row's code (METAFIELD_DEFINITION_NOT_FOUND, TRANSLATION_FIELD_NOT_TRANSLATABLE, METAFIELD_WRITE_APP_OWN_ONLY, or STORE_API_SCOPE_REQUIRED when the token lacks the definition owner's read scope). Each row is one definition 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 definition in one locale) and at most one row per definition 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. Staff-created merchant tokens also require settings.metafield_definitions:write, as in Store Admin.

A definition's name is the label shoppers see next to its value, for example in the platform metafield block. Names translate per definition and locale. The definition must be visible to the token and editable by the merchant (merchant_access read_write, which every merchant-owned definition is); other app-owned definitions return TRANSLATION_FIELD_NOT_TRANSLATABLE. The token also needs the read scope of the definition's owner_type. Translation CSV (resource metafield_definition) and Store Admin translate the same names. Name translations send no webhooks, like choice label translations. Returns the stored name translation in the selected locale with is_outdated; a definition 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. Staff-created merchant tokens also require settings.metafield_definitions:read, as in Store Admin.

A definition's name is the label shoppers see next to its value, for example in the platform metafield block. Names translate per definition and locale. The definition must be visible to the token and editable by the merchant (merchant_access read_write, which every merchant-owned definition is); other app-owned definitions return TRANSLATION_FIELD_NOT_TRANSLATABLE. The token also needs the read scope of the definition's owner_type. Translation CSV (resource metafield_definition) and Store Admin translate the same names. Name translations send no webhooks, like choice label translations. Only name is translatable. Send an empty string to clear the translation; shoppers then see the source name. When the source name changes later, the translation is marked outdated. App tokens can translate only definitions their app owns. 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. Staff-created merchant tokens also require settings.metafield_definitions:write, as in Store Admin.

Select definitions (single_select, list.single_select) store choice keys as values and show each choice's label to shoppers. Labels translate per choice, not per value, so one translation covers every resource that stores that choice. The definition must be visible to the token and translatable, and the token also needs the read scope of the definition's owner_type. Read choice keys from the definition's validation_rules.choices. 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. Staff-created merchant tokens also require settings.metafield_definitions:read, as in Store Admin.

Sets the choice label shoppers see in an enabled non-default locale. The choice key, which resources store as their value, never changes. Send an empty string to clear the translation; shoppers then see the source label. When the source label changes later, the translation is marked outdated. App tokens can translate only definitions their app owns. 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. Staff-created merchant tokens also require settings.metafield_definitions:write, as in Store Admin.