GET
List translations

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

resource_type
enum<string>
required

Required. Together with resource_id it bounds the read to one entity, which is why this list carries no cursor: a single resource's translated fields are a small, complete set. A value outside the enum is a 400, not an empty page, because "no translations" and "no such resource type" are different facts and a client told the former stops looking.

Available options:
product,
collection,
page,
category
resource_id
string
required

Required. The id of the product, collection, page or category whose translations to read.

limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object