Overview

TryYourSize API 0.1.0

Server API conventions: authenticate with Authorization: Bearer sk_… (or a restricted rk_… key holding the operation’s key scopes). Pin the version with the TYS-Version header (a date, e.g. 2026-10-25; without it the latest version answers and the response’s TYS-Version says which). Errors are {error, status, code, doc_url, request_id}. POSTs accept an Idempotency-Key (responses stored 24 h). Lists are cursor-paginated (limit, cursor → data, has_more, next_cursor). Rate limits answer 429 with Retry-After; every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset.

TryYourSize developers

• https://docs.tryyoursize.com/

Information

• OpenAPI version: 3.0.3

Operations

POST

/v1/embed/init

POST

/v1/funnel_events

GET

/v1/products/{product}/tryon

POST

/v1/tryon

GET

/v1/tryon/{tryon_id}

GET

/v1/products/{product}/appearance

GET

/v1/audit_events

POST

/v1/orders

POST

/v1/returns

POST

/v1/recommendation_handles

POST

/v1/recommendations

GET

/v1/products

POST

/v1/products

GET

/v1/products/{product}

PATCH

/v1/products/{product}

GET

/v1/products/{product}/size_map

PUT

/v1/products/{product}/size_map

GET

/v1/products/{product}/garments

POST

/v1/products/{product}/garments

GET

/v1/garments/{garment_id}

PUT

/v1/garments/{garment_id}

POST

/v1/garments/{garment_id}/publish

GET

/v1/fit_groups

POST

/v1/fit_groups

GET

/v1/fit_groups/{fit_group_id}

POST

/v1/fit_groups/{fit_group_id}/products

Authentication

PublishableKey

The store’s publishable key (pk_test_… / pk_live_…). Safe in browsers; works only from the origins registered for the key.

Security scheme type: apiKey

Header parameter name: TYS-Publishable-Key

SecretKey

A secret key (sk_test_… / sk_live_…) or a restricted key (rk_test_… / rk_live_…) from your server: Authorization: Bearer sk_…. A secret key has every scope; a restricted key only the scopes it was created with. Each operation lists its key scopes.

Security scheme type: http