Skip to main content
PUT
Save a record's metafield translations

Authorizations

Authorization
string
header
required

Bearer token authentication. Accepts company-admin tokens with storefront.view for read operations and storefront.update for writes and scan triggers (legacy per-resource grants like categories.update / products.view / etc. are still accepted during the migration), required on every company operation. Storefront public operations under /api/v202604/{resource} and /api/v202604/{resource}/{slug} are unauthenticated (security: []).

Body

application/json

One record's translations in one language.

owner_type
enum<string>
required

The kind of record whose metafields are translated. Only definitions of this owner type apply, and the original of each field is the value stored on the record.

Available options:
Product,
Variant,
EnrollmentPack
owner_id
integer
required

The record's id. A record of another company, or a variant whose product is another company's, is a 404.

lang
string
required

The language ISO to write (e.g. es, zh-TW). It must be a language the store sells in and not the store's default language, whose values are the originals.

translations
object[]
required

The values to save. Each one's definition must be translatable and of type single_line_text_field, multi_line_text_field, rich_text_field, list.single_line_text_field or url, and the value must be valid for that type. Nothing is saved when any item is refused.

Required array length: 1 - 100 elements

Response

The translations as saved.

metafield_translations
object
required
status
integer
required
meta
object
required

Response metadata of the metafield translation operations. request_uuid and timestamp are always present.