List the store's products

GET

/v1/products

curl --request GET \
  --url 'https://api.tryyoursize.com/v1/products?limit=20' \
  --header 'Authorization: Bearer <token>'

• Production (test and live mode are chosen by the key)

Key scopes: products:read. A secret key (sk_) has every scope; a restricted key (rk_) needs the scopes listed.

Newest first, cursor-paginated. sku finds one product by its SKU / style ID.

Authorizations

• SecretKey

Parameters

Query Parameters

sku

string

<= 120 characters

Only the product with this SKU / style ID.

limit

integer

default: 20 >= 1 <= 100

Page size (list convention). Default 20, at most 100.

cursor

string

<= 512 characters

Opaque cursor from the previous page’s next_cursor (list convention). Omit it for the first page.

Responses

200

OK

Media typeapplication/json

One page of a list (convention). Pass next_cursor as cursor for the next page while has_more is true.

object

data

required

Array<object>

object

id

required

string format: uuid

external_id

required

The brand’s SKU or style ID (unique per brand).

string

name

required

string

category

required

The garment type; it sets which POMs are needed.

string

Allowed values: tshirt shirt sweater jacket dress skirt jeans trousers shorts leggings polo hoodie

published_version

Garment version shoppers are fitted against, if any.

integer

draft_version

Garment version being edited, if any.

integer

created_at

required

string format: date-time

updated_at

required

string format: date-time

fit_group_id

The fit group whose garment this product uses (absent until grouped).

string format: uuid

brand_id

The brand the product belongs to; every store of the brand sees it.

string format: uuid

home_store_id

The store the product was created in.

string format: uuid

retired_at

Set when the product is retired; shoppers no longer get a size for it.

string format: date-time

available

Whether the store it was read through offers it (false in the brand list, see stores).

boolean

has_more

required

boolean

next_cursor

string

nullable

Example

{
  "data": [
    {
      "category": "tshirt"
    }
  ]
}

400

Invalid request

Media typeapplication/json

Every error has this shape. error is a human-readable message, status the HTTP status. code is stable and machine-readable; doc_url links its explanation; request_id identifies the request (also in the X-Request-ID response header): quote it to support.

object

error

required

string

status

required

integer

code

Stable error code, e.g. invalid_request, unauthorized, reauth_required, payment_required, forbidden, not_found, conflict, unprocessable, rate_limited, internal_error, not_implemented, unavailable, invalid_api_version, idempotency_key_in_use, idempotency_key_reused, invalid_idempotency_key, handle_expired, handle_invalid.

string

doc_url

string format: uri

request_id

string

Example

{
  "code": "not_found",
  "doc_url": "https://docs.tryyoursize.com/api/errors/#not_found"
}

401

Missing or invalid credentials

Media typeapplication/json

Every error has this shape. error is a human-readable message, status the HTTP status. code is stable and machine-readable; doc_url links its explanation; request_id identifies the request (also in the X-Request-ID response header): quote it to support.

object

error

required

string

status

required

integer

code

Stable error code, e.g. invalid_request, unauthorized, reauth_required, payment_required, forbidden, not_found, conflict, unprocessable, rate_limited, internal_error, not_implemented, unavailable, invalid_api_version, idempotency_key_in_use, idempotency_key_reused, invalid_idempotency_key, handle_expired, handle_invalid.

string

doc_url

string format: uri

request_id

string

Example

{
  "code": "not_found",
  "doc_url": "https://docs.tryyoursize.com/api/errors/#not_found"
}

403

Not allowed

Media typeapplication/json

Every error has this shape. error is a human-readable message, status the HTTP status. code is stable and machine-readable; doc_url links its explanation; request_id identifies the request (also in the X-Request-ID response header): quote it to support.

object

error

required

string

status

required

integer

code

Stable error code, e.g. invalid_request, unauthorized, reauth_required, payment_required, forbidden, not_found, conflict, unprocessable, rate_limited, internal_error, not_implemented, unavailable, invalid_api_version, idempotency_key_in_use, idempotency_key_reused, invalid_idempotency_key, handle_expired, handle_invalid.

string

doc_url

string format: uri

request_id

string

Example

{
  "code": "not_found",
  "doc_url": "https://docs.tryyoursize.com/api/errors/#not_found"
}