Page translations

Read and write localized page fields through the Store API.

Get page translation

GET read_pages + read_translations

Fetch one page translation.

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

Path parameters

Name Type Description
id required uuid

Page id.

Example: 5ff7d4ea-3250-4a4d-9d26-07f64d917d31
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 Pages.

  • 404 TRANSLATION_RESOURCE_NOT_FOUND

    Page does not exist in this store.

Set page translation

PUT write_pages + write_translations

Set one page translation.

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

Path parameters

Name Type Description
id required uuid

Page id.

Example: 5ff7d4ea-3250-4a4d-9d26-07f64d917d31
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: {"title": "About us", "slug": "about-us"}

Errors

  • 400 TRANSLATION_INVALID_LOCALE

    Locale is not enabled or is the default locale.

  • 400 TRANSLATION_INVALID_FIELD

    Field is not translatable for Pages.

  • 404 TRANSLATION_RESOURCE_NOT_FOUND

    Page does not exist in this store.

Batch get page translations

GET read_pages + read_translations

Fetch page translations in batch.

Returns translated Page fields for multiple page 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 Page ids.

Example: 5ff7d4ea-3250-4a4d-9d26-07f64d917d31,3a588f80-fd8c-4d46-af1b-00a1c4a7f85a

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 Pages.

  • 404 TRANSLATION_RESOURCE_NOT_FOUND

    Page does not exist in this store.

Batch set page translations

PUT write_pages + write_translations

Set page translations in batch.

Writes translated Page fields for multiple page 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": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31", "fields": {"title": "About us"}}]

Errors

  • 400 TRANSLATION_INVALID_LOCALE

    Locale is not enabled or is the default locale.

  • 400 TRANSLATION_INVALID_FIELD

    Field is not translatable for Pages.

  • 404 TRANSLATION_RESOURCE_NOT_FOUND

    Page does not exist in this store.