Vendor translations

Read and write localized vendor fields through the Store API.

Get vendor translation

GET read_products + read_translations

Fetch one vendor translation.

Returns stored translated Vendor fields for one locale, including whether the translation is out of date.

Path parameters

Name Type Description
id required integer

Vendor id.

Example: 7
locale required string

Enabled non-default store locale.

Example: fr

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Errors

  • 400 TRANSLATION_INVALID_LOCALE

    Locale is not enabled or is the default locale.

  • 400 TRANSLATION_INVALID_FIELD

    Field is not translatable for vendors.

  • 404 VENDOR_NOT_FOUND

    Vendor does not exist in this store.

Set vendor translation

PUT write_products + write_translations

Set one vendor translation.

Writes translated Vendor fields for one locale. Empty values clear the matching field translation.

Path parameters

Name Type Description
id required integer

Vendor id.

Example: 7
locale required string

Enabled non-default store locale.

Example: fr

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Body parameters

Name Type Description
translations required object

Field-keyed translation values. Allowed fields come from contract.translation.fields.

Example: {"name": "Acme Supplies FR", "description": "Acme Supplies fournit du matériel outdoor en gros."}

Errors

  • 400 TRANSLATION_INVALID_LOCALE

    Locale is not enabled or is the default locale.

  • 400 TRANSLATION_INVALID_FIELD

    Field is not translatable for vendors.

  • 404 VENDOR_NOT_FOUND

    Vendor does not exist in this store.

Batch get vendor translations

GET read_products + read_translations

Fetch vendor translations in batch.

Returns translated Vendor fields for multiple vendor ids in one locale.

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 vendor ids.

Example: 1,2,3

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Errors

  • 400 TRANSLATION_INVALID_LOCALE

    Locale is not enabled or is the default locale.

  • 400 TRANSLATION_INVALID_FIELD

    Field is not translatable for vendors.

  • 404 VENDOR_NOT_FOUND

    Vendor does not exist in this store.

Batch set vendor translations

PUT write_products + write_translations

Set vendor translations in batch.

Writes translated Vendor fields for multiple vendor ids in one locale. Either every row is written or, if any row is invalid, none are.

Path parameters

Name Type Description
locale required string

Enabled non-default store locale.

Example: fr

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Body parameters

Name Type Description
translations required array<object>

Rows with id and fields. Allowed field keys come from contract.translation.fields.

Example: [{"id": 7, "fields": {"name": "Acme Supplies FR"}}]

Errors

  • 400 TRANSLATION_INVALID_LOCALE

    Locale is not enabled or is the default locale.

  • 400 TRANSLATION_INVALID_FIELD

    Field is not translatable for vendors.

  • 404 VENDOR_NOT_FOUND

    Vendor does not exist in this store.