API reference
The complete REST contract, generated from the implementation.
Read the contract
The operation list, request schemas and response schemas below are generated from the API’s route registry and Go wire types. Download the OpenAPI 3.1 document to import it into your client generator or API tool. Replace the local server URL with your own deployed API.
Common conventions
- Bearer authentication uses operator or merchant/store keys as indicated per operation.
- All bodies are JSON objects; unknown and duplicate fields are rejected.
- Lists use limit (1–100) and cursor, returning data and optional next_cursor.
- IDs are opaque. Never derive tenant identity from a request body.
- PUT replaces the documented input fields; it is not a partial PATCH.
- The request body maximum is 256 KiB. API version: /v1.
Operations
Expand an endpoint for its scope, parameters, request and response contracts.
GET/healthzProcess health
Required scope: public. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Responses
200- Success ·
Status 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/readyzDatabase readiness
Required scope: public. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Responses
200- Success ·
Status 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/api-keysList API key metadata, never secrets
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
KeyList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/api-keysIssue a scoped API key (secret returned once)
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Request body
{
"name": "Store server",
"scopes": [
"catalog",
"fit",
"events",
"analytics"
],
"store_id": "sto_example"
}Responses
201- Success ·
IssuedKey 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
DELETE/v1/api-keys/{key_id}Revoke an API key
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
key_id | path · required |
Responses
200- Success ·
Status 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/api-keysList seller API key metadata
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
KeyList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/api-keysIssue a store-scoped integration key
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
Request body
{
"name": "Store server",
"scopes": [
"catalog",
"fit",
"events",
"analytics"
],
"store_id": "sto_example"
}Responses
201- Success ·
IssuedKey 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
DELETE/v1/console/api-keys/{key_id}Revoke a seller API key
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
key_id | path · required |
Responses
200- Success ·
Status 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/loginSign in (website gateway only)
Website backend only. Returns a session token to be placed in an HttpOnly cookie; never forward it to browser JavaScript.
Request body
Responses
200- Success ·
ConsoleAuthenticated 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/logoutRevoke the current console session
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
Responses
200- Success ·
Status 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/meGet seller account and integration configuration
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
Responses
200- Success ·
ConsoleOverview 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/product-typesGet supported console product types
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
Responses
200- Success ·
ProductTypeList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/shopify/callbackValidate Shopify authorization callback
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
shop | query · required | |
code | query · required | |
state | query · required | |
timestamp | query · required | |
hmac | query · required |
Responses
200- Success ·
ConsoleShopifyConnection 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/shopify/launchVerify a signed Shopify app launch (not authorization)
Website backend only. Verifies a fresh Shopify-signed app-launch query. Does not authorize a shop, create OAuth state or save a connection.
Request body
Responses
200- Success ·
ConsoleShopifyLaunch 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/signupCreate a seller account (website gateway only)
Website backend only. Returns a session token to be placed in an HttpOnly cookie; never forward it to browser JavaScript.
Request body
Responses
201- Success ·
ConsoleAuthenticated 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/storesList seller stores
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
StoreList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/storesCreate a seller store
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
Responses
201- Success ·
Store 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/stores/{store_id}/milo/insightsMilo test-group exposure and order attribution from cart attributes (descriptive)
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Responses
200- Success ·
MiloInsights 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/stores/{store_id}/productsList seller products
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
ProductList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/stores/{store_id}/products/{product_id}Get a seller product
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
product_id | path · required |
Responses
200- Success ·
Product 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/stores/{store_id}/products/{product_id}/variantsList seller product variants
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
product_id | path · required | |
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
VariantList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
DELETE/v1/console/stores/{store_id}/shopifyRemove stored Shopify credentials
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Responses
200- Success ·
Status 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/stores/{store_id}/shopifyGet Shopify authorization status
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Responses
200- Success ·
ConsoleShopifyConnection 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/stores/{store_id}/shopify/startStart Shopify authorization
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
Responses
200- Success ·
ConsoleShopifyStart 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/stores/{store_id}/shopify/syncImport or update products, variants and inventory from Shopify
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Responses
200- Success ·
ShopifySyncResult 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/stores/{store_id}/size-chartsList seller size charts
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
ChartList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/stores/{store_id}/size-chartsCreate a seller size chart
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
{
"basis": "garment",
"category": "tops",
"measurements": [
{
"method": "flat_width",
"name": "chest"
},
{
"method": "linear",
"name": "shoulders"
},
{
"method": "linear",
"name": "length"
}
],
"name": "Linen camp-collar shirt approved chart",
"rows": [
{
"measurements": {
"chest": {
"max": 50,
"min": 50
},
"length": {
"max": 68,
"min": 68
},
"shoulders": {
"max": 44,
"min": 44
}
},
"size": "S"
},
{
"measurements": {
"chest": {
"max": 52,
"min": 52
},
"length": {
"max": 70,
"min": 70
},
"shoulders": {
"max": 46,
"min": 46
}
},
"size": "M"
},
{
"measurements": {
"chest": {
"max": 54,
"min": 54
},
"length": {
"max": 72,
"min": 72
},
"shoulders": {
"max": 48,
"min": 48
}
},
"size": "L"
}
],
"unit": "cm",
"verified": true
}Responses
201- Success ·
Chart 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/stores/{store_id}/size-charts/extractTranscribe a size chart image into draft table rows (never saved or verified)
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
Responses
200- Success ·
ChartExtractResult 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/console/stores/{store_id}/size-charts/{chart_id}Get a seller size chart
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
chart_id | path · required |
Responses
200- Success ·
Chart 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
PUT/v1/console/stores/{store_id}/size-charts/{chart_id}Replace a seller size chart and increment its revision
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
chart_id | path · required |
Request body
{
"basis": "garment",
"category": "tops",
"measurements": [
{
"method": "flat_width",
"name": "chest"
},
{
"method": "linear",
"name": "shoulders"
},
{
"method": "linear",
"name": "length"
}
],
"name": "Linen camp-collar shirt approved chart",
"rows": [
{
"measurements": {
"chest": {
"max": 50,
"min": 50
},
"length": {
"max": 68,
"min": 68
},
"shoulders": {
"max": 44,
"min": 44
}
},
"size": "S"
},
{
"measurements": {
"chest": {
"max": 52,
"min": 52
},
"length": {
"max": 70,
"min": 70
},
"shoulders": {
"max": 46,
"min": 46
}
},
"size": "M"
},
{
"measurements": {
"chest": {
"max": 54,
"min": 54
},
"length": {
"max": 72,
"min": 72
},
"shoulders": {
"max": 48,
"min": 48
}
},
"size": "L"
}
],
"unit": "cm",
"verified": true
}Responses
200- Success ·
Chart 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/console/stores/{store_id}/size-charts/{chart_id}/productsAssign a chart to 1–100 products atomically
Website backend only. Requires the console gateway secret and a seller session, not an integration API key.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
chart_id | path · required |
Request body
Responses
200- Success ·
ConsoleChartProductsResult 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/merchantGet the authenticated merchant
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Responses
200- Success ·
Merchant 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
PUT/v1/merchantUpdate the authenticated merchant name
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Responses
200- Success ·
Merchant 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/merchantsCreate a merchant and initial admin key (operator only)
Required scope: bootstrap. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Responses
201- Success ·
MerchantCreated 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/openapi.jsonOpenAPI document
Required scope: public. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Responses
200- Success ·
object 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/product-typesList supported product types and categories
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Responses
200- Success ·
ProductTypeList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/statusAPI status
Required scope: public. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Responses
200- Success ·
Status 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/storefront/shopify/fitRun a Shopify storefront sizing quiz (signed app proxy and quiz capability)
Shopify app proxy only. Requires a fresh HMAC-SHA256 signature over all query parameters except signature, using Shopify's proxy canonicalization (not OAuth canonicalization). Required query fields: shop, timestamp, path_prefix, logged_in_customer_id (may be empty), signature. POST JSON action=start requires Shopify product_id and variant_id and returns 201 with a 30-minute quiz capability. Actions next, recommend and complete require that token in the JSON body. Tokens bind shop, merchant, store, customer context and session. No merchant API keys or cookies. Maximum body 16 KiB. Start returns questions; next returns next; recommend returns size, explanation, warnings and Shopify variant IDs; complete accepts variant_id and returns completed. No customer answer retrieval endpoint.
| Parameter | Location | Details |
|---|---|---|
shop | query · required | |
timestamp | query · required | |
path_prefix | query · required | |
logged_in_customer_id | query · required | |
signature | query · required |
Request body
Responses
200- Success ·
StorefrontFitResult 201- Quiz started; returns token and questions ·
StorefrontFitResult 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/storefront/shopify/miloFind products, build an outfit or swap a slot through the signed Shopify proxy
Shopify signed app proxy only, using the same fresh query signature as /fit. Store and merchant derive exclusively from the signed shop connection. Maximum body 16 KiB; message 1–1000 UTF-8 bytes; history at most 8 user/assistant turns of 1000 bytes; cumulative brief.query at most 2000 bytes. action=find returns one product; outfit defaults to top, bottom and shoes, with transparent partial results for absent catalog categories; swap requires swap_slot and preserves other selected variants. anchor {product_id, optional variant_id and slot} with action=outfit builds the outfit around that product, which is retained first in products and brief.selected. Identical first-turn requests may be served from a ten-minute per-instance cache. brief.intent remains find or outfit during swaps. Return the full brief on follow-ups. Switching find/outfit resets inherited slots. Budget is an integer in explicit supported currency minor units, 0–9000000000000; prices are parsed exactly without floating point. Natural-language budget phrases require agreement with the explicit budget field. Selected product_id and variant_id are Shopify numeric strings and are revalidated in this store. products[].price_minor and total_minor use brief.selected variants; alternative variants can cost more. URLs are safe store-relative /products/handle paths. Availability and prices are a synced snapshot, never live stock. The server never writes carts or infers size. Optional AI selection makes at most two bounded Choice calls and can abstain; errors return mode=fallback with plain warnings. Query/history are transient but sent to the AI model when configured. No generative provider is used. Full semantics and limits: docs/milo.md.
| Parameter | Location | Details |
|---|---|---|
shop | query · required | |
timestamp | query · required | |
path_prefix | query · required | |
logged_in_customer_id | query · required | |
signature | query · required |
Request body
{
"message": "A casual cotton outfit",
"brief": {
"currency": "PKR",
"budget_minor": 2000000,
"selected": null
},
"action": "outfit"
}Responses
200- Success ·
MiloResult 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/storefront/shopify/milo/eventsCount an aggregate Milo exposure, open or engagement for a test group (signed proxy)
Shopify signed app proxy only. Counts one aggregate daily event for the signed shop's store: kind exposure, open or engaged; group milo or holdout (holdout only exposure). Stores per-day counters only, no visitor, customer, cart or message data. Maximum body 1 KiB; ten times the storefront per-minute limit. The widget sends each kind once per browser session when Shopify analytics consent allows.
| Parameter | Location | Details |
|---|---|---|
shop | query · required | |
timestamp | query · required | |
path_prefix | query · required | |
logged_in_customer_id | query · required | |
signature | query · required |
Request body
Responses
200- Success ·
Status 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/storesList merchant stores
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
StoreList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/storesCreate a store
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Responses
201- Success ·
Store 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}Get a store
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Responses
200- Success ·
Store 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
PUT/v1/stores/{store_id}Update a store
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Responses
200- Success ·
Store 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/catalog/itemsList ingested catalog items
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
CatalogItemRecordList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/catalog/itemsUpsert up to 100 catalog items for pre-sales (idempotent by item id)
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
Responses
200- Success ·
CatalogUpserted 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
DELETE/v1/stores/{store_id}/catalog/items/{item_id}Remove a catalog item
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
item_id | path · required |
Responses
200- Success ·
Status 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/eventsList events including system-generated quiz events
Required scope: events. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
EventList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/eventsIngest an idempotent customer or order outcome
Required scope: events. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
{
"external_id": "order-123-line-1-purchase",
"line_item_id": "line-1",
"occurred_at": "2026-09-20T12:00:00Z",
"order_id": "order-123",
"product_id": "prd_example",
"quantity": 1,
"session_id": "fit_example",
"source": "custom-store",
"type": "purchase",
"variant_id": "var_example"
}Responses
200- Identical event replay; original event returned ·
Event 201- Success ·
Event 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/events/{event_id}Get an event
Required scope: events. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
event_id | path · required |
Responses
200- Success ·
Event 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/fit-sessionsStart a session and freeze its chart/questionnaire
Required scope: fit. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
{
"color": "black",
"customer_reference": "opaque-customer-reference",
"product_id": "prd_example"
}Responses
201- Success ·
Session 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/fit-sessions/{session_id}Get a session, answers and recommendation
Required scope: fit. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
session_id | path · required |
Responses
200- Success ·
Session 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/fit-sessions/{session_id}/completeRecord acceptance, size override or decline
Required scope: fit. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
session_id | path · required |
Responses
200- Success ·
Session 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/fit-sessions/{session_id}/next-questionAdaptive quiz: get the most informative next question, or done
Required scope: fit. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
session_id | path · required |
Request body
Responses
200- Success ·
NextQuestion 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/fit-sessions/{session_id}/recommendationsSubmit answers and generate an immutable recommendation
Required scope: fit. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
session_id | path · required |
Request body
{
"answers": {
"measurements": {
"chest": 98
},
"preferred_fit": "regular",
"size_consistency": "consistent",
"usual_size": "M"
}
}Responses
200- Success ·
Recommendation 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
{
"algorithm_version": "metr-fit-2.0.0",
"chart_id": "cht_example",
"chart_revision": 1,
"confidence": 0.9,
"confidence_meaning": "uncalibrated_evidence_score",
"created_at": "2026-10-01T12:00:00Z",
"evidence": {
"chest": {
"body_cm": 98,
"chart_max_cm": 98,
"chart_min_cm": 98,
"source": "measurement"
},
"shoulders": {
"body_cm": 45,
"chart_max_cm": 45,
"chart_min_cm": 45,
"source": "measurement"
}
},
"explanation": "M best matches measurement, usual size against this chart.",
"fit": {
"chest": "within_range",
"shoulders": "within_range"
},
"id": "rec_example",
"method": "rules",
"probabilities": {
"L": 0.048,
"M": 0.904,
"S": 0.048
},
"recommended_size": "M",
"session_id": "fit_example",
"variant_ids": [
"var_medium"
],
"warnings": [
"Confidence is an uncalibrated evidence score, not a probability of fit."
]
}GET/v1/stores/{store_id}/metricsDescriptive session-cohort metrics (not causal uplift)
Required scope: analytics. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
from | query · optional | Session creation cohort, maximum 366 days. Defaults to the last 30 days. |
to | query · optional | Session creation cohort, maximum 366 days. Defaults to the last 30 days. |
Responses
200- Success ·
Metrics 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/milo/catalogFind, kit, compare or swap products from a server-supplied outdoor snapshot
Server-to-server catalog-scoped key with existing merchant/store ownership checks. A trusted integration injects an immutable USD snapshot for vertical outdoor; never forward a browser-supplied catalog or expose the key. Stateless, no catalog persistence. Maximum 256 KiB JSON, 128 products, 1000 UTF-8 message bytes, six history turns of 1000 bytes, twelve selected IDs and 2000 cumulative query bytes. Actions: auto, find (one product), bundle (a vertical kit or two or more named categories), compare (2–12 selected IDs, listed facts only), swap (selected swap_id, other products retained). Return brief on follow-ups; top-level fields override it and budget_minor 0 clears the budget. USD=2 decimal places; integer prices/budgets 0–9000000000000. Any amount in the message must equal the budget; otherwise intent=confirm_budget with suggested_budget_minor when one amount was read. Product URLs must be HTTPS on the vertical's source store; images additionally allow cdn.shopify.com; no fetching. Outdoor never recommends sizes. One optional AI Choice call among at most six prevalidated options plus none, under five seconds; errors use labeled fallback. Replies are templates. Thirty requests per store per minute, in addition to normal key limits. See docs/milo-catalog.md.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
Responses
200- Success ·
CatalogResult 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/milo/catalog/imageIdentify and locate one broad outdoor gear category for customer confirmation
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
Responses
200- Success ·
CatalogImageResult 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/milo/turnRun one action-driven sales turn from a server-supplied Retailer Sales Profile and catalog
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
Responses
200- Success ·
SalesTurnResult 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/presales/profilesList Retailer Sales Profile versions with their reports
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
ProfileVersionList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/presales/profiles/rebuildRe-run the sales strategy with current decisions as a new draft
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Responses
201- Success ·
ProfileVersion 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/presales/profiles/{version}Get one profile version with every pre-sales artifact
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
version | path · required |
Responses
200- Success ·
ProfileVersion 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/presales/profiles/{version}/publishPublish a version (publishing an older one rolls back)
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
version | path · required |
Responses
200- Success ·
ProfileVersion 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/presales/settingsGet pre-sales settings and merchant decisions
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Responses
200- Success ·
PresalesSettings 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
PUT/v1/stores/{store_id}/presales/settingsSet industry, site, overrides, rule decisions and demand signals
Required scope: admin. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
Responses
200- Success ·
PresalesSettings 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/productsList products
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
ProductList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/productsCreate a product
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
{
"external_id": "linen-shirt",
"garment_fit": "regular",
"gender": "unisex",
"product_type": "shirt",
"stretch": "none",
"title": "Linen shirt"
}Responses
201- Success ·
Product 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/products/{product_id}Get a product
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
product_id | path · required |
Responses
200- Success ·
Product 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
PUT/v1/stores/{store_id}/products/{product_id}Replace product fields
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
product_id | path · required |
Request body
{
"external_id": "linen-shirt",
"garment_fit": "regular",
"gender": "unisex",
"product_type": "shirt",
"stretch": "none",
"title": "Linen shirt"
}Responses
200- Success ·
Product 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/products/{product_id}/fit-questionnaireGet a product-specific questionnaire
Required scope: fit. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
product_id | path · required | |
color | query · optional | Optional exact variant color to restrict availability. |
Responses
200- Success ·
Questionnaire 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/products/{product_id}/variantsList product variants
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
product_id | path · required | |
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
VariantList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/products/{product_id}/variantsCreate a variant
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
product_id | path · required |
Request body
{
"available": true,
"color": "black",
"external_id": "linen-shirt-m",
"size": "M"
}Responses
201- Success ·
Variant 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/products/{product_id}/variants/{variant_id}Get a variant
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
product_id | path · required | |
variant_id | path · required |
Responses
200- Success ·
Variant 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
PUT/v1/stores/{store_id}/products/{product_id}/variants/{variant_id}Update variant external ID and availability
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
product_id | path · required | |
variant_id | path · required |
Request body
{
"available": true,
"color": "black",
"external_id": "linen-shirt-m",
"size": "M"
}Responses
200- Success ·
Variant 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/size-chartsList size charts
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
limit | query · optional | Minimum: 1. Maximum: 100. |
cursor | query · optional |
Responses
200- Success ·
ChartList 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/stores/{store_id}/size-chartsCreate a size chart
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required |
Request body
{
"basis": "garment",
"category": "tops",
"measurements": [
{
"method": "flat_width",
"name": "chest"
},
{
"method": "linear",
"name": "shoulders"
},
{
"method": "linear",
"name": "length"
}
],
"name": "Linen camp-collar shirt approved chart",
"rows": [
{
"measurements": {
"chest": {
"max": 50,
"min": 50
},
"length": {
"max": 68,
"min": 68
},
"shoulders": {
"max": 44,
"min": 44
}
},
"size": "S"
},
{
"measurements": {
"chest": {
"max": 52,
"min": 52
},
"length": {
"max": 70,
"min": 70
},
"shoulders": {
"max": 46,
"min": 46
}
},
"size": "M"
},
{
"measurements": {
"chest": {
"max": 54,
"min": 54
},
"length": {
"max": 72,
"min": 72
},
"shoulders": {
"max": 48,
"min": 48
}
},
"size": "L"
}
],
"unit": "cm",
"verified": true
}Responses
201- Success ·
Chart 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
GET/v1/stores/{store_id}/size-charts/{chart_id}Get a size chart
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
chart_id | path · required |
Responses
200- Success ·
Chart 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
PUT/v1/stores/{store_id}/size-charts/{chart_id}Replace chart fields and increment its revision
Required scope: catalog. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
| Parameter | Location | Details |
|---|---|---|
store_id | path · required | |
chart_id | path · required |
Request body
{
"basis": "garment",
"category": "tops",
"measurements": [
{
"method": "flat_width",
"name": "chest"
},
{
"method": "linear",
"name": "shoulders"
},
{
"method": "linear",
"name": "length"
}
],
"name": "Linen camp-collar shirt approved chart",
"rows": [
{
"measurements": {
"chest": {
"max": 50,
"min": 50
},
"length": {
"max": 68,
"min": 68
},
"shoulders": {
"max": 44,
"min": 44
}
},
"size": "S"
},
{
"measurements": {
"chest": {
"max": 52,
"min": 52
},
"length": {
"max": 70,
"min": 70
},
"shoulders": {
"max": 46,
"min": 46
}
},
"size": "M"
},
{
"measurements": {
"chest": {
"max": 54,
"min": 54
},
"length": {
"max": 72,
"min": 72
},
"shoulders": {
"max": 48,
"min": 48
}
},
"size": "L"
}
],
"unit": "cm",
"verified": true
}Responses
200- Success ·
Chart 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
POST/v1/webhooks/shopifyReceive verified Shopify inventory and product webhooks
Required scope: public. Admin keys may call all tenant routes. All store resources are scoped to the authenticated merchant and the store in the path.
Request body
object
Responses
200- Success ·
Status 400- Invalid JSON or query ·
ErrorEnvelope 401- Invalid or expired API key ·
ErrorEnvelope 403- Missing scope or wrong store restriction ·
ErrorEnvelope 404- Resource not found within tenant ·
ErrorEnvelope 405- Method not allowed ·
ErrorEnvelope 409- Conflict or non-identical replay ·
ErrorEnvelope 410- Fit session expired ·
ErrorEnvelope 413- Request body too large ·
ErrorEnvelope 415- Expected application/json ·
ErrorEnvelope 422- Validation failed or sizing abstained ·
ErrorEnvelope 429- Rate limited; Retry-After header gives seconds ·
ErrorEnvelope 500- Internal error ·
ErrorEnvelope 502- Upstream service unavailable ·
ErrorEnvelope 503- Dependency unavailable ·
ErrorEnvelope
Request and response schemas
Fields marked required appear in the contract. Optional body measurements remain optional even when the chart itself requires those areas.
| Field | Type | Description |
|---|---|---|
descriptionrequired | string | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
labelrequired | string | See the integration guide for usage. |
Answers
| Field | Type | Description |
|---|---|---|
ageoptional | number | null | See the integration guide for usage. |
body_trackoptional | string | See the integration guide for usage. |
body_typeoptional | string | Optional visual proportions v1: 1 straight, 2 broader upper body, 3 fuller hips, 4 defined waist, 5 fuller middle, 6 fuller balanced proportions. Context only; not scored or converted to measurements. Allowed: 1, 2, 3, 4, 5, 6. |
chest_profileoptional | string | Allowed: narrow, average, broad. |
height_cmoptional | number | null | Optional height in cm for length-bearing charts. Does not infer body lengths. Minimum: 120. Maximum: 230. |
hip_profileoptional | string | Allowed: narrow, average, broad. |
lower_body_profileoptional | string | Allowed: balanced, fuller_hips, fuller_waist. |
measurementsoptional | object | Optional body measurements in cm, restricted to fields advertised by the questionnaire. Never send garment dimensions. |
preferred_fitoptional | string | Allowed: close, regular, loose. |
reference_sizeoptional | string | See the integration guide for usage. |
shoulder_profileoptional | string | Allowed: narrow, average, broad. |
silhouette_hipsoptional | string | Fashion sizing assets v1: asset stem and option number. Optional context only; no measurement or confidence derived from starter priors. Allowed: female_bottoms_hips_seat:1, female_bottoms_hips_seat:2, female_bottoms_hips_seat:3, female_bottoms_hips_seat:4, female_bottoms_hips_seat:5, female_bottoms_hips_seat:6, male_bottoms_hips_seat:1, male_bottoms_hips_seat:2, male_bottoms_hips_seat:3, male_bottoms_hips_seat:4, male_bottoms_hips_seat:5, male_bottoms_hips_seat:6. |
silhouette_shouldersoptional | string | Fashion sizing assets v1: asset stem and option number. Optional context only; no measurement or confidence derived from starter priors. Allowed: female_tops_shoulders:1, female_tops_shoulders:2, female_tops_shoulders:3, female_tops_shoulders:4, female_tops_shoulders:5, female_tops_shoulders:6, male_tops_shoulders:1, male_tops_shoulders:2, male_tops_shoulders:3, male_tops_shoulders:4, male_tops_shoulders:5, male_tops_shoulders:6. |
silhouette_thighoptional | string | Fashion sizing assets v1: asset stem and option number. Optional context only; no measurement or confidence derived from starter priors. Allowed: female_bottoms_thigh_legs:1, female_bottoms_thigh_legs:2, female_bottoms_thigh_legs:3, female_bottoms_thigh_legs:4, female_bottoms_thigh_legs:5, female_bottoms_thigh_legs:6, male_bottoms_thigh_legs:1, male_bottoms_thigh_legs:2, male_bottoms_thigh_legs:3, male_bottoms_thigh_legs:4, male_bottoms_thigh_legs:5, male_bottoms_thigh_legs:6. |
silhouette_waistoptional | string | Fashion sizing assets v1: asset stem and option number. Optional context only; no measurement or confidence derived from starter priors. Allowed: female_tops_waist_stomach:1, female_tops_waist_stomach:2, female_tops_waist_stomach:3, female_tops_waist_stomach:4, female_tops_waist_stomach:5, female_tops_waist_stomach:6, male_tops_waist_stomach:1, male_tops_waist_stomach:2, male_tops_waist_stomach:3, male_tops_waist_stomach:4, male_tops_waist_stomach:5, male_tops_waist_stomach:6. |
size_consistencyoptional | string | Allowed: sometimes_smaller, consistent, sometimes_larger. |
upper_body_profileoptional | string | Allowed: balanced, fuller_chest, fuller_waist. |
usual_sizeoptional | string | See the integration guide for usage. |
waist_profileoptional | string | Allowed: narrow, average, broad. |
weight_kgoptional | number | null | Optional adult weight in kg for apparel. Context only: not used in size scoring or confidence. Minimum: 30. Maximum: 300. |
CatalogAlternative
| Field | Type | Description |
|---|---|---|
kindrequired | string | See the integration guide for usage. |
labelrequired | string | See the integration guide for usage. |
product_idrequired | string | See the integration guide for usage. |
CatalogBrief
| Field | Type | Description |
|---|---|---|
budget_minoroptional | integer | null | See the integration guide for usage. |
categoryoptional | string | Allowed: tops, bottoms, one_piece, footwear. |
intentoptional | string | See the integration guide for usage. |
kitoptional | string | See the integration guide for usage. |
queryrequired | string | See the integration guide for usage. |
selected_idsrequired | string[] | See the integration guide for usage. |
CatalogImageInput
| Field | Type | Description |
|---|---|---|
data_base64required | string | See the integration guide for usage. |
formatrequired | string | See the integration guide for usage. |
CatalogImageResult
| Field | Type | Description |
|---|---|---|
boxrequired | ImageBox | See the integration guide for usage. |
categoryoptional | string | Allowed: tops, bottoms, one_piece, footwear. |
confidencerequired | number | Uncalibrated evidence score, never a probability or accuracy claim. Minimum: 0. Maximum: 1. |
messagerequired | string | See the integration guide for usage. |
needs_confirmationrequired | boolean | See the integration guide for usage. |
presencerequired | number | See the integration guide for usage. |
CatalogInput
| Field | Type | Description |
|---|---|---|
actionrequired | string | See the integration guide for usage. |
briefoptional | CatalogBrief | See the integration guide for usage. |
budget_minoroptional | integer | null | See the integration guide for usage. |
catalogrequired | CatalogProduct[] | See the integration guide for usage. |
categoryoptional | string | Allowed: tops, bottoms, one_piece, footwear. |
historyoptional | MiloTurn[] | See the integration guide for usage. |
kitoptional | string | See the integration guide for usage. |
messagerequired | string | See the integration guide for usage. |
owned_categoriesoptional | string[] | See the integration guide for usage. |
selected_idsoptional | string[] | See the integration guide for usage. |
swap_idoptional | string | See the integration guide for usage. |
verticalrequired | string | See the integration guide for usage. |
CatalogItem
| Field | Type | Description |
|---|---|---|
availablerequired | boolean | See the integration guide for usage. |
brandoptional | string | See the integration guide for usage. |
categoryoptional | string | Allowed: tops, bottoms, one_piece, footwear. |
descriptionoptional | string | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
image_urloptional | string | See the integration guide for usage. |
price_minorrequired | integer | See the integration guide for usage. |
product_typeoptional | string | See the integration guide for usage. |
specsoptional | object | See the integration guide for usage. |
tagsoptional | string[] | See the integration guide for usage. |
titlerequired | string | See the integration guide for usage. |
urlrequired | string | See the integration guide for usage. |
variant_countoptional | integer | See the integration guide for usage. |
CatalogItemRecord
| Field | Type | Description |
|---|---|---|
idrequired | string | See the integration guide for usage. |
itemrequired | CatalogItem | See the integration guide for usage. |
store_idrequired | string | See the integration guide for usage. |
updated_atrequired | date-time | See the integration guide for usage. |
CatalogItemRecordList
| Field | Type | Description |
|---|---|---|
datarequired | CatalogItemRecord[] | See the integration guide for usage. |
next_cursoroptional | string | See the integration guide for usage. |
CatalogItemsInput
| Field | Type | Description |
|---|---|---|
itemsrequired | CatalogItem[] | See the integration guide for usage. |
CatalogKit
| Field | Type | Description |
|---|---|---|
idrequired | string | See the integration guide for usage. |
labelrequired | string | See the integration guide for usage. |
missingrequired | string[] | See the integration guide for usage. |
ownedoptional | string[] | See the integration guide for usage. |
slotsrequired | string[] | See the integration guide for usage. |
CatalogProduct
| Field | Type | Description |
|---|---|---|
availablerequired | boolean | See the integration guide for usage. |
brandrequired | string | See the integration guide for usage. |
categoryrequired | string | Allowed: tops, bottoms, one_piece, footwear. |
currencyrequired | string | See the integration guide for usage. |
descriptionrequired | string | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
image_urloptional | string | See the integration guide for usage. |
price_minorrequired | integer | See the integration guide for usage. |
source_fetched_atrequired | string | See the integration guide for usage. |
specsrequired | object | See the integration guide for usage. |
titlerequired | string | See the integration guide for usage. |
urlrequired | string | See the integration guide for usage. |
variant_countoptional | integer | See the integration guide for usage. |
CatalogResult
| Field | Type | Description |
|---|---|---|
alternativesrequired | CatalogAlternative[] | See the integration guide for usage. |
briefrequired | CatalogBrief | See the integration guide for usage. |
comparisonoptional | CatalogRow[] | See the integration guide for usage. |
currencyrequired | string | See the integration guide for usage. |
extra_productsrequired | CatalogProduct[] | See the integration guide for usage. |
follow_upsrequired | string[] | See the integration guide for usage. |
intentrequired | string | See the integration guide for usage. |
kitoptional | CatalogKit | null | See the integration guide for usage. |
messagerequired | string | See the integration guide for usage. |
moderequired | string | See the integration guide for usage. |
productsrequired | CatalogProduct[] | See the integration guide for usage. |
remaining_minoroptional | integer | null | See the integration guide for usage. |
suggested_budget_minoroptional | integer | null | See the integration guide for usage. |
total_minorrequired | integer | See the integration guide for usage. |
warningsrequired | string[] | See the integration guide for usage. |
CatalogRow
| Field | Type | Description |
|---|---|---|
labelrequired | string | See the integration guide for usage. |
valuesrequired | string[] | See the integration guide for usage. |
CatalogUpserted
| Field | Type | Description |
|---|---|---|
upsertedrequired | integer | See the integration guide for usage. |
Chart
| Field | Type | Description |
|---|---|---|
basisrequired | string | Allowed: body, garment. |
brandoptional | string | See the integration guide for usage. |
categoryrequired | string | Allowed: tops, bottoms, one_piece, footwear. |
created_atrequired | date-time | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
measurementsrequired | Measurement[] | Minimum items: 1. Maximum items: 8. |
merchant_idrequired | string | See the integration guide for usage. |
namerequired | string | See the integration guide for usage. |
revisionrequired | integer | See the integration guide for usage. |
rowsrequired | SizeRow[] | Ordered smallest to largest. Every row must contain every declared measurement. Labels map exactly to variant sizes. Minimum items: 1. Maximum items: 30. |
share_as_referenceoptional | boolean | See the integration guide for usage. |
store_idrequired | string | See the integration guide for usage. |
unitrequired | string | Allowed: cm, in. |
updated_atrequired | date-time | See the integration guide for usage. |
verifiedrequired | boolean | Merchant confirmation that measurements, units, basis and methods were reviewed. Required true for recommendations. |
ChartExtractInput
| Field | Type | Description |
|---|---|---|
datarequired | string | See the integration guide for usage. |
mime_typerequired | string | See the integration guide for usage. |
ChartExtractResult
| Field | Type | Description |
|---|---|---|
notesoptional | string | See the integration guide for usage. |
rowsrequired | string[][] | Ordered smallest to largest. Every row must contain every declared measurement. Labels map exactly to variant sizes. Minimum items: 1. Maximum items: 30. |
ChartInput
| Field | Type | Description |
|---|---|---|
basisrequired | string | Allowed: body, garment. |
brandoptional | string | See the integration guide for usage. |
categoryrequired | string | Allowed: tops, bottoms, one_piece, footwear. |
measurementsrequired | Measurement[] | Minimum items: 1. Maximum items: 8. |
namerequired | string | See the integration guide for usage. |
rowsrequired | SizeRow[] | Ordered smallest to largest. Every row must contain every declared measurement. Labels map exactly to variant sizes. Minimum items: 1. Maximum items: 30. |
share_as_referenceoptional | boolean | See the integration guide for usage. |
unitrequired | string | Allowed: cm, in. |
verifiedrequired | boolean | Merchant confirmation that measurements, units, basis and methods were reviewed. Required true for recommendations. |
ChartList
| Field | Type | Description |
|---|---|---|
datarequired | Chart[] | See the integration guide for usage. |
next_cursoroptional | string | See the integration guide for usage. |
CompletionInput
| Field | Type | Description |
|---|---|---|
chosen_variant_idoptional | string | See the integration guide for usage. |
decisionrequired | string | Allowed: accepted, overridden, declined. |
ConsoleAccount
| Field | Type | Description |
|---|---|---|
created_atrequired | date-time | See the integration guide for usage. |
emailrequired | email | Maximum length: 254. |
idrequired | string | See the integration guide for usage. |
merchant_idrequired | string | See the integration guide for usage. |
ConsoleAuthenticated
| Field | Type | Description |
|---|---|---|
accountrequired | ConsoleAccount | See the integration guide for usage. |
expires_atrequired | date-time | See the integration guide for usage. |
session_tokenrequired | string | Website-server-only session token. Store in an HttpOnly cookie, never browser JSON. |
ConsoleChartProductsInput
| Field | Type | Description |
|---|---|---|
product_idsrequired | string[] | Products in the same store and category as the chart. All selected links update atomically; other product fields and unselected links are preserved. Minimum items: 1. Maximum items: 100. |
ConsoleChartProductsResult
| Field | Type | Description |
|---|---|---|
chart_idrequired | string | See the integration guide for usage. |
products_updatedrequired | integer | See the integration guide for usage. |
ConsoleLogin
| Field | Type | Description |
|---|---|---|
emailrequired | email | Maximum length: 254. |
passwordrequired | string | At least 12 characters and at most 72 UTF-8 bytes. |
ConsoleOverview
| Field | Type | Description |
|---|---|---|
accountrequired | ConsoleAccount | See the integration guide for usage. |
merchantrequired | Merchant | See the integration guide for usage. |
shopify_enabledrequired | boolean | See the integration guide for usage. |
ConsoleShopifyConnection
| Field | Type | Description |
|---|---|---|
connected_atrequired | date-time | See the integration guide for usage. |
expires_atoptional | date-time | null | See the integration guide for usage. |
last_sync_atoptional | date-time | null | See the integration guide for usage. |
scopesrequired | string | See the integration guide for usage. |
shoprequired | string | See the integration guide for usage. |
statusrequired | string | See the integration guide for usage. |
store_idrequired | string | See the integration guide for usage. |
ConsoleShopifyLaunch
| Field | Type | Description |
|---|---|---|
shoprequired | string | See the integration guide for usage. |
ConsoleShopifyLaunchInput
| Field | Type | Description |
|---|---|---|
queryrequired | string | Original Shopify-signed app-launch query without a leading question mark. Never log it or accept an unsigned shop override. Maximum length: 2000. |
ConsoleShopifyStart
| Field | Type | Description |
|---|---|---|
authorization_urlrequired | string | See the integration guide for usage. |
ConsoleShopifyStartInput
| Field | Type | Description |
|---|---|---|
launch_queryoptional | string | Original Shopify-signed app-launch query without a leading question mark. Never log it or accept an unsigned shop override. Maximum length: 2000. |
ConsoleSignup
| Field | Type | Description |
|---|---|---|
companyrequired | string | Maximum length: 120. |
emailrequired | email | Maximum length: 254. |
passwordrequired | string | At least 12 characters and at most 72 UTF-8 bytes. |
DemandSignal
| Field | Type | Description |
|---|---|---|
countoptional | integer | See the integration guide for usage. |
kindrequired | string | See the integration guide for usage. |
textrequired | string | See the integration guide for usage. |
ErrorEnvelope
| Field | Type | Description |
|---|---|---|
errorrequired | Problem | See the integration guide for usage. |
Estimate
| Field | Type | Description |
|---|---|---|
probabilitiesrequired | object | See the integration guide for usage. |
sizerequired | string | Maximum length: 32. |
Event
| Field | Type | Description |
|---|---|---|
customer_referenceoptional | string | Maximum length: 128. |
external_idrequired | string | Maximum length: 128. |
idrequired | string | See the integration guide for usage. |
line_item_idoptional | string | Maximum length: 128. |
merchant_idrequired | string | See the integration guide for usage. |
occurred_atrequired | date-time | See the integration guide for usage. |
order_idoptional | string | Maximum length: 128. |
product_idrequired | string | See the integration guide for usage. |
quantityrequired | integer | Minimum: 1. Maximum: 100. |
reasonoptional | string | See the integration guide for usage. |
received_atrequired | date-time | See the integration guide for usage. |
session_idoptional | string | See the integration guide for usage. |
sourcerequired | string | See the integration guide for usage. |
store_idrequired | string | See the integration guide for usage. |
typerequired | string | See the integration guide for usage. |
variant_idoptional | string | See the integration guide for usage. |
EventInput
| Field | Type | Description |
|---|---|---|
customer_referenceoptional | string | Maximum length: 128. |
external_idrequired | string | Maximum length: 128. |
line_item_idoptional | string | Maximum length: 128. |
occurred_atrequired | date-time | See the integration guide for usage. |
order_idoptional | string | Maximum length: 128. |
product_idrequired | string | See the integration guide for usage. |
quantityrequired | integer | Minimum: 1. Maximum: 100. |
reasonoptional | string | See the integration guide for usage. |
session_idoptional | string | See the integration guide for usage. |
sourcerequired | string | See the integration guide for usage. |
typerequired | string | Allowed: fit_viewed, add_to_cart, checkout_started, purchase, return_requested, size_exchange, item_kept. |
variant_idoptional | string | See the integration guide for usage. |
EventList
| Field | Type | Description |
|---|---|---|
datarequired | Event[] | See the integration guide for usage. |
next_cursoroptional | string | See the integration guide for usage. |
Evidence
| Field | Type | Description |
|---|---|---|
body_cmoptional | number | null | See the integration guide for usage. |
chart_max_cmrequired | number | See the integration guide for usage. |
chart_min_cmrequired | number | See the integration guide for usage. |
estimate_cmoptional | number | null | See the integration guide for usage. |
sd_cmoptional | number | null | See the integration guide for usage. |
sourcerequired | string | See the integration guide for usage. |
ImageBox
| Field | Type | Description |
|---|---|---|
bottomrequired | number | See the integration guide for usage. |
leftrequired | number | See the integration guide for usage. |
rightrequired | number | See the integration guide for usage. |
toprequired | number | See the integration guide for usage. |
IssuedKey
| Field | Type | Description |
|---|---|---|
keyrequired | Key | See the integration guide for usage. |
secretrequired | string | See the integration guide for usage. |
Key
| Field | Type | Description |
|---|---|---|
created_atrequired | date-time | See the integration guide for usage. |
expires_atoptional | date-time | null | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
merchant_idrequired | string | See the integration guide for usage. |
namerequired | string | See the integration guide for usage. |
prefixrequired | string | See the integration guide for usage. |
revoked_atoptional | date-time | null | See the integration guide for usage. |
scopesrequired | string[] | See the integration guide for usage. |
store_idoptional | string | See the integration guide for usage. |
KeyInput
| Field | Type | Description |
|---|---|---|
expires_atoptional | date-time | null | See the integration guide for usage. |
namerequired | string | See the integration guide for usage. |
scopesrequired | string[] | See the integration guide for usage. |
store_idoptional | string | See the integration guide for usage. |
KeyList
| Field | Type | Description |
|---|---|---|
datarequired | Key[] | See the integration guide for usage. |
next_cursoroptional | string | See the integration guide for usage. |
Measurement
| Field | Type | Description |
|---|---|---|
methodrequired | string | Allowed: circumference, flat_width, linear. |
namerequired | string | See the integration guide for usage. |
Merchant
| Field | Type | Description |
|---|---|---|
created_atrequired | date-time | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
namerequired | string | See the integration guide for usage. |
MerchantCreated
MerchantInput
| Field | Type | Description |
|---|---|---|
namerequired | string | See the integration guide for usage. |
Metrics
| Field | Type | Description |
|---|---|---|
exchange_for_size_raterequired | number | null | See the integration guide for usage. |
fit_assisted_conversion_raterequired | number | null | See the integration guide for usage. |
fromrequired | date-time | See the integration guide for usage. |
interpretationrequired | string | See the integration guide for usage. |
kept_after_recommendation_raterequired | number | null | See the integration guide for usage. |
kept_linesrequired | integer | See the integration guide for usage. |
observed_throughrequired | date-time | See the integration guide for usage. |
purchased_linesrequired | integer | See the integration guide for usage. |
quiz_completion_raterequired | number | null | See the integration guide for usage. |
recommendation_acceptance_raterequired | number | null | See the integration guide for usage. |
recommendation_override_raterequired | number | null | See the integration guide for usage. |
sessions_acceptedrequired | integer | See the integration guide for usage. |
sessions_overriddenrequired | integer | See the integration guide for usage. |
sessions_purchasedrequired | integer | See the integration guide for usage. |
sessions_recommendedrequired | integer | See the integration guide for usage. |
sessions_startedrequired | integer | See the integration guide for usage. |
size_exchange_linesrequired | integer | See the integration guide for usage. |
size_related_return_raterequired | number | null | See the integration guide for usage. |
size_return_linesrequired | integer | See the integration guide for usage. |
torequired | date-time | See the integration guide for usage. |
MiloBrief
| Field | Type | Description |
|---|---|---|
budget_minoroptional | integer | null | Optional integer 0–9000000000000 in currency minor units; null clears the budget. |
currencyoptional | string | See the integration guide for usage. |
intentoptional | string | Allowed: find, outfit. |
queryoptional | string | Cumulative preferences, at most 2000 UTF-8 bytes; swaps preserve the original query. Maximum length: 2000. |
selectedrequired | MiloSelection[] | Maximum items: 6. |
slotsoptional | string[] | Maximum items: 6. |
MiloEventInput
| Field | Type | Description |
|---|---|---|
grouprequired | string | See the integration guide for usage. |
kindrequired | string | See the integration guide for usage. |
MiloGroupInsights
| Field | Type | Description |
|---|---|---|
engagedrequired | integer | See the integration guide for usage. |
engaged_ordersrequired | integer | See the integration guide for usage. |
engaged_revenue_minorrequired | integer | See the integration guide for usage. |
opensrequired | integer | See the integration guide for usage. |
ordersrequired | integer | See the integration guide for usage. |
revenue_minorrequired | integer | See the integration guide for usage. |
visitorsrequired | integer | See the integration guide for usage. |
MiloInput
| Field | Type | Description |
|---|---|---|
actionoptional | string | Allowed: find, outfit, swap. |
anchoroptional | MiloSelection | null | See the integration guide for usage. |
briefrequired | MiloBrief | See the integration guide for usage. |
historyoptional | MiloTurn[] | Maximum items: 8. |
messagerequired | string | At most 1000 UTF-8 bytes (not characters). Maximum length: 1000. |
swap_slotoptional | string | Allowed: top, bottom, one_piece, shoes, outerwear, accessory. |
MiloInsights
| Field | Type | Description |
|---|---|---|
currencyrequired | string | See the integration guide for usage. |
daysrequired | integer | See the integration guide for usage. |
holdoutrequired | MiloGroupInsights | See the integration guide for usage. |
milorequired | MiloGroupInsights | See the integration guide for usage. |
orders_scannedrequired | integer | See the integration guide for usage. |
orders_statusrequired | string | See the integration guide for usage. |
sincerequired | string | See the integration guide for usage. |
truncatedrequired | boolean | See the integration guide for usage. |
MiloProduct
| Field | Type | Description |
|---|---|---|
currencyrequired | string | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
image_urlrequired | string | See the integration guide for usage. |
price_minorrequired | integer | See the integration guide for usage. |
slotrequired | string | Allowed: top, bottom, one_piece, shoes, outerwear, accessory. |
titlerequired | string | See the integration guide for usage. |
urlrequired | string | See the integration guide for usage. |
variantsrequired | MiloVariant[] | See the integration guide for usage. |
MiloResult
| Field | Type | Description |
|---|---|---|
briefrequired | MiloBrief | See the integration guide for usage. |
currencyrequired | string | See the integration guide for usage. |
messagerequired | string | At most 1000 UTF-8 bytes (not characters). Maximum length: 1000. |
moderequired | string | Allowed: ai, fallback. |
productsrequired | MiloProduct[] | See the integration guide for usage. |
total_minorrequired | integer | See the integration guide for usage. |
warningsrequired | string[] | See the integration guide for usage. |
MiloSelection
| Field | Type | Description |
|---|---|---|
product_idrequired | string | See the integration guide for usage. |
slotrequired | string | Allowed: top, bottom, one_piece, shoes, outerwear, accessory. |
variant_idrequired | string | See the integration guide for usage. |
MiloTurn
| Field | Type | Description |
|---|---|---|
contentrequired | string | At most 1000 UTF-8 bytes (not characters). Maximum length: 1000. |
rolerequired | string | Allowed: user, assistant. |
MiloVariant
| Field | Type | Description |
|---|---|---|
availablerequired | boolean | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
optionsrequired | object | See the integration guide for usage. |
price_minorrequired | integer | See the integration guide for usage. |
titlerequired | string | See the integration guide for usage. |
NextQuestion
| Field | Type | Description |
|---|---|---|
askedrequired | integer | See the integration guide for usage. |
donerequired | boolean | See the integration guide for usage. |
estimateoptional | Estimate | null | See the integration guide for usage. |
questionoptional | Question | null | See the integration guide for usage. |
NextQuestionInput
| Field | Type | Description |
|---|---|---|
answersrequired | Answers | See the integration guide for usage. |
skippedoptional | string[] | See the integration guide for usage. |
PresalesSettings
| Field | Type | Description |
|---|---|---|
currencyrequired | string | See the integration guide for usage. |
demand_signalsoptional | DemandSignal[] | See the integration guide for usage. |
industryrequired | string | See the integration guide for usage. |
overridesrequired | ProfileOverrides | See the integration guide for usage. |
regionrequired | string | See the integration guide for usage. |
rulesoptional | object | See the integration guide for usage. |
siteoptional | string | See the integration guide for usage. |
store_namerequired | string | See the integration guide for usage. |
Problem
| Field | Type | Description |
|---|---|---|
coderequired | string | See the integration guide for usage. |
messagerequired | string | See the integration guide for usage. |
request_idrequired | string | See the integration guide for usage. |
Product
| Field | Type | Description |
|---|---|---|
created_atrequired | date-time | See the integration guide for usage. |
external_idrequired | string | Maximum length: 128. |
garment_fitrequired | string | Allowed: fitted, regular, relaxed, oversized. |
genderrequired | string | Allowed: women, men, unisex. |
idrequired | string | See the integration guide for usage. |
merchant_idrequired | string | See the integration guide for usage. |
product_typerequired | string | See the integration guide for usage. |
shopifyoptional | ShopifyProduct | null | See the integration guide for usage. |
size_chart_idoptional | string | See the integration guide for usage. |
store_idrequired | string | See the integration guide for usage. |
stretchrequired | string | Allowed: none, moderate, high. |
titlerequired | string | See the integration guide for usage. |
updated_atrequired | date-time | See the integration guide for usage. |
ProductInput
| Field | Type | Description |
|---|---|---|
external_idrequired | string | Maximum length: 128. |
garment_fitrequired | string | Allowed: fitted, regular, relaxed, oversized. |
genderrequired | string | Allowed: women, men, unisex. |
product_typerequired | string | See the integration guide for usage. |
size_chart_idoptional | string | See the integration guide for usage. |
stretchrequired | string | Allowed: none, moderate, high. |
titlerequired | string | See the integration guide for usage. |
ProductList
| Field | Type | Description |
|---|---|---|
datarequired | Product[] | See the integration guide for usage. |
next_cursoroptional | string | See the integration guide for usage. |
ProductType
| Field | Type | Description |
|---|---|---|
categoryrequired | string | Allowed: tops, bottoms, one_piece, footwear, unsupported. |
idrequired | string | See the integration guide for usage. |
labelrequired | string | See the integration guide for usage. |
ProductTypeList
| Field | Type | Description |
|---|---|---|
datarequired | ProductType[] | See the integration guide for usage. |
next_cursoroptional | string | See the integration guide for usage. |
ProfileOverrides
| Field | Type | Description |
|---|---|---|
assistantoptional | SalesAssistant | null | See the integration guide for usage. |
exclude_actionsoptional | string[] | See the integration guide for usage. |
exclude_categoriesoptional | string[] | See the integration guide for usage. |
policiesoptional | SalesPolicy[] | See the integration guide for usage. |
ProfileVersion
| Field | Type | Description |
|---|---|---|
created_atrequired | date-time | See the integration guide for usage. |
demandoptional | object | A pre-sales artifact as metr_ai returned it; see schemas/*.schema.json. |
enrichedoptional | object[] | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
notesoptional | string[] | See the integration guide for usage. |
packoptional | object | A pre-sales artifact as metr_ai returned it; see schemas/*.schema.json. |
profilerequired | object | A pre-sales artifact as metr_ai returned it; see schemas/*.schema.json. |
published_atoptional | date-time | null | See the integration guide for usage. |
reportrequired | object | A pre-sales artifact as metr_ai returned it; see schemas/*.schema.json. |
retaileroptional | object | A pre-sales artifact as metr_ai returned it; see schemas/*.schema.json. |
statusrequired | string | See the integration guide for usage. |
store_idrequired | string | See the integration guide for usage. |
versionrequired | integer | See the integration guide for usage. |
ProfileVersionList
| Field | Type | Description |
|---|---|---|
datarequired | ProfileVersion[] | See the integration guide for usage. |
next_cursoroptional | string | See the integration guide for usage. |
Question
| Field | Type | Description |
|---|---|---|
helpoptional | string | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
labelrequired | string | See the integration guide for usage. |
maxoptional | number | null | See the integration guide for usage. |
minoptional | number | null | See the integration guide for usage. |
option_labelsoptional | object | See the integration guide for usage. |
optionsoptional | string[] | See the integration guide for usage. |
requiredrequired | boolean | See the integration guide for usage. |
sectionoptional | string | Allowed: usual_size, body_profile, height_weight, fit_preference, measurements. |
typerequired | string | See the integration guide for usage. |
unitoptional | string | Allowed: cm, in, kg. |
Questionnaire
| Field | Type | Description |
|---|---|---|
available_sizesrequired | string[] | See the integration guide for usage. |
categoryrequired | string | Allowed: tops, bottoms, one_piece, footwear. |
chart_idrequired | string | See the integration guide for usage. |
chart_revisionrequired | integer | See the integration guide for usage. |
product_idrequired | string | See the integration guide for usage. |
questionsrequired | Question[] | See the integration guide for usage. |
versionrequired | string | See the integration guide for usage. |
Range
| Field | Type | Description |
|---|---|---|
maxrequired | number | See the integration guide for usage. |
minrequired | number | See the integration guide for usage. |
Recommendation
| Field | Type | Description |
|---|---|---|
algorithm_versionrequired | string | See the integration guide for usage. |
chart_idrequired | string | See the integration guide for usage. |
chart_revisionrequired | integer | See the integration guide for usage. |
confidencerequired | number | Uncalibrated evidence score, never a probability or accuracy claim. Minimum: 0. Maximum: 1. |
confidence_meaningrequired | string | See the integration guide for usage. |
created_atrequired | date-time | See the integration guide for usage. |
evidencerequired | object | See the integration guide for usage. |
explanationrequired | string | See the integration guide for usage. |
fitrequired | object | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
methodrequired | string | Allowed: circumference, flat_width, linear. |
probabilitiesrequired | object | See the integration guide for usage. |
recommended_sizerequired | string | See the integration guide for usage. |
session_idrequired | string | See the integration guide for usage. |
variant_idsrequired | string[] | See the integration guide for usage. |
warningsrequired | string[] | See the integration guide for usage. |
RecommendationInput
| Field | Type | Description |
|---|---|---|
answersrequired | Answers | See the integration guide for usage. |
RetailerSalesProfile
| Field | Type | Description |
|---|---|---|
assistantrequired | SalesAssistant | See the integration guide for usage. |
categoriesrequired | SalesCategory[] | See the integration guide for usage. |
currencyrequired | string | See the integration guide for usage. |
currency_exponentrequired | integer | See the integration guide for usage. |
enabled_actionsrequired | string[] | See the integration guide for usage. |
kitsoptional | SalesKit[] | See the integration guide for usage. |
needsoptional | SalesNeed[] | See the integration guide for usage. |
policiesoptional | SalesPolicy[] | See the integration guide for usage. |
primary_sales_strategyrequired | string | See the integration guide for usage. |
retailer_typerequired | string | See the integration guide for usage. |
store_namerequired | string | See the integration guide for usage. |
versionrequired | integer | See the integration guide for usage. |
SalesAction
| Field | Type | Description |
|---|---|---|
idrequired | string | See the integration guide for usage. |
labelrequired | string | See the integration guide for usage. |
product_idsrequired | string[] | See the integration guide for usage. |
valuerequired | string | null | See the integration guide for usage. |
SalesAssistant
| Field | Type | Description |
|---|---|---|
greetingrequired | string | See the integration guide for usage. |
namerequired | string | See the integration guide for usage. |
SalesCategory
| Field | Type | Description |
|---|---|---|
cautionoptional | string | null | See the integration guide for usage. |
compare_specsoptional | string[] | See the integration guide for usage. |
descriptionrequired | string | See the integration guide for usage. |
fit_rulesoptional | SalesFitRule[] | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
labelrequired | string | See the integration guide for usage. |
qualifyoptional | string[] | See the integration guide for usage. |
SalesComparisonRow
| Field | Type | Description |
|---|---|---|
labelrequired | string | See the integration guide for usage. |
valuesrequired | object | See the integration guide for usage. |
SalesEvent
| Field | Type | Description |
|---|---|---|
actionoptional | string | See the integration guide for usage. |
product_idsoptional | string[] | See the integration guide for usage. |
textoptional | string | See the integration guide for usage. |
typerequired | string | See the integration guide for usage. |
valueoptional | string | null | See the integration guide for usage. |
SalesFitRule
| Field | Type | Description |
|---|---|---|
attributerequired | string | See the integration guide for usage. |
dimensionoptional | string | null | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
labeloptional | string | null | See the integration guide for usage. |
numberoptional | number | null | See the integration guide for usage. |
oprequired | string | See the integration guide for usage. |
statusoptional | string | See the integration guide for usage. |
strengthrequired | string | See the integration guide for usage. |
valuesoptional | string[] | See the integration guide for usage. |
whenrequired | object | See the integration guide for usage. |
SalesKit
| Field | Type | Description |
|---|---|---|
answersoptional | object | See the integration guide for usage. |
categoriesrequired | string[] | See the integration guide for usage. |
descriptionrequired | string | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
labelrequired | string | See the integration guide for usage. |
optionaloptional | string[] | See the integration guide for usage. |
SalesNeed
| Field | Type | Description |
|---|---|---|
aboutrequired | string | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
labelrequired | string | See the integration guide for usage. |
optionsrequired | object[] | See the integration guide for usage. |
questionrequired | string | See the integration guide for usage. |
SalesNeeds
| Field | Type | Description |
|---|---|---|
answersoptional | object | See the integration guide for usage. |
budget_minoroptional | integer | null | See the integration guide for usage. |
skippedoptional | string[] | See the integration guide for usage. |
SalesPage
| Field | Type | Description |
|---|---|---|
product_idoptional | string | null | See the integration guide for usage. |
typeoptional | string | See the integration guide for usage. |
SalesPick
| Field | Type | Description |
|---|---|---|
cautionrequired | string | null | See the integration guide for usage. |
product_idrequired | string | See the integration guide for usage. |
reasonsrequired | string[] | See the integration guide for usage. |
reasons_sourcerequired | string | See the integration guide for usage. |
SalesPolicy
| Field | Type | Description |
|---|---|---|
sourcerequired | string | See the integration guide for usage. |
textrequired | string | See the integration guide for usage. |
topicrequired | string | See the integration guide for usage. |
urloptional | string | null | See the integration guide for usage. |
SalesProduct
| Field | Type | Description |
|---|---|---|
availablerequired | boolean | See the integration guide for usage. |
brandoptional | string | null | See the integration guide for usage. |
categoryrequired | string | Allowed: tops, bottoms, one_piece, footwear. |
descriptionoptional | string | See the integration guide for usage. |
factsoptional | object | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
image_urloptional | string | null | See the integration guide for usage. |
price_minorrequired | integer | See the integration guide for usage. |
specsoptional | object | See the integration guide for usage. |
titlerequired | string | See the integration guide for usage. |
urlrequired | string | See the integration guide for usage. |
variant_countrequired | integer | See the integration guide for usage. |
SalesState
| Field | Type | Description |
|---|---|---|
categoryoptional | string | null | Allowed: tops, bottoms, one_piece, footwear. |
kitoptional | string | null | See the integration guide for usage. |
needsrequired | SalesNeeds | See the integration guide for usage. |
pending_budget_minoroptional | integer | null | See the integration guide for usage. |
seenoptional | string[] | See the integration guide for usage. |
shortlistoptional | string[] | See the integration guide for usage. |
stageoptional | string | See the integration guide for usage. |
SalesTurnInput
| Field | Type | Description |
|---|---|---|
catalogoptional | SalesProduct[] | See the integration guide for usage. |
eventoptional | SalesEvent | null | See the integration guide for usage. |
pageoptional | SalesPage | null | See the integration guide for usage. |
profileoptional | RetailerSalesProfile | null | See the integration guide for usage. |
stateoptional | SalesState | null | See the integration guide for usage. |
SalesTurnResult
| Field | Type | Description |
|---|---|---|
actionsrequired | SalesAction[] | See the integration guide for usage. |
comparisonrequired | SalesComparisonRow[] | See the integration guide for usage. |
messagerequired | string | See the integration guide for usage. |
moderequired | string | See the integration guide for usage. |
picksrequired | SalesPick[] | See the integration guide for usage. |
powered_byrequired | string | See the integration guide for usage. |
stagerequired | string | See the integration guide for usage. |
staterequired | SalesState | See the integration guide for usage. |
Session
| Field | Type | Description |
|---|---|---|
answersoptional | Answers | null | See the integration guide for usage. |
chosen_variant_idoptional | string | See the integration guide for usage. |
coloroptional | string | Maximum length: 80. |
completed_atoptional | date-time | null | See the integration guide for usage. |
created_atrequired | date-time | See the integration guide for usage. |
customer_referenceoptional | string | Maximum length: 128. |
decisionoptional | string | Allowed: accepted, overridden, declined. |
expires_atrequired | date-time | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
merchant_idrequired | string | See the integration guide for usage. |
product_idrequired | string | See the integration guide for usage. |
questionnairerequired | Questionnaire | See the integration guide for usage. |
recommendationoptional | Recommendation | null | See the integration guide for usage. |
statusrequired | string | See the integration guide for usage. |
store_idrequired | string | See the integration guide for usage. |
SessionInput
| Field | Type | Description |
|---|---|---|
coloroptional | string | Maximum length: 80. |
customer_referenceoptional | string | Maximum length: 128. |
product_idrequired | string | See the integration guide for usage. |
ShopifyProduct
| Field | Type | Description |
|---|---|---|
currencyrequired | string | See the integration guide for usage. |
descriptionrequired | string | See the integration guide for usage. |
image_urlrequired | string | See the integration guide for usage. |
urlrequired | string | See the integration guide for usage. |
ShopifySyncInput
| Field | Type | Description |
|---|---|---|
forceoptional | boolean | See the integration guide for usage. |
ShopifySyncResult
| Field | Type | Description |
|---|---|---|
products_importedrequired | integer | See the integration guide for usage. |
products_updatedrequired | integer | See the integration guide for usage. |
shoprequired | string | See the integration guide for usage. |
total_productsrequired | integer | See the integration guide for usage. |
total_variantsrequired | integer | See the integration guide for usage. |
variants_importedrequired | integer | See the integration guide for usage. |
variants_updatedrequired | integer | See the integration guide for usage. |
ShopifyVariant
| Field | Type | Description |
|---|---|---|
optionsrequired | object | See the integration guide for usage. |
price_minorrequired | integer | null | See the integration guide for usage. |
titlerequired | string | See the integration guide for usage. |
SizeRow
| Field | Type | Description |
|---|---|---|
measurementsrequired | object | See the integration guide for usage. |
sizerequired | string | Maximum length: 32. |
Status
| Field | Type | Description |
|---|---|---|
statusrequired | string | See the integration guide for usage. |
Store
| Field | Type | Description |
|---|---|---|
created_atrequired | date-time | See the integration guide for usage. |
domainrequired | string | See the integration guide for usage. |
idrequired | string | See the integration guide for usage. |
merchant_idrequired | string | See the integration guide for usage. |
namerequired | string | See the integration guide for usage. |
StorefrontFitInput
| Field | Type | Description |
|---|---|---|
actionrequired | string | See the integration guide for usage. |
answersoptional | Answers | See the integration guide for usage. |
product_idoptional | string | See the integration guide for usage. |
skippedoptional | string[] | See the integration guide for usage. |
tokenoptional | string | See the integration guide for usage. |
variant_idoptional | string | See the integration guide for usage. |
StorefrontFitResult
| Field | Type | Description |
|---|---|---|
completedoptional | boolean | See the integration guide for usage. |
explanationoptional | string | See the integration guide for usage. |
nextoptional | NextQuestion | null | See the integration guide for usage. |
questionsoptional | Question[] | See the integration guide for usage. |
sizeoptional | string | Maximum length: 32. |
tokenoptional | string | See the integration guide for usage. |
variantsoptional | StorefrontVariant[] | See the integration guide for usage. |
warningsoptional | string[] | See the integration guide for usage. |
StorefrontVariant
| Field | Type | Description |
|---|---|---|
colorrequired | string | Maximum length: 80. |
idrequired | string | See the integration guide for usage. |
sizerequired | string | Maximum length: 32. |
StoreInput
| Field | Type | Description |
|---|---|---|
domainrequired | string | See the integration guide for usage. |
namerequired | string | See the integration guide for usage. |
StoreList
| Field | Type | Description |
|---|---|---|
datarequired | Store[] | See the integration guide for usage. |
next_cursoroptional | string | See the integration guide for usage. |
Variant
| Field | Type | Description |
|---|---|---|
availablerequired | boolean | See the integration guide for usage. |
coloroptional | string | Maximum length: 80. |
created_atrequired | date-time | See the integration guide for usage. |
external_idrequired | string | Maximum length: 128. |
idrequired | string | See the integration guide for usage. |
merchant_idrequired | string | See the integration guide for usage. |
product_idrequired | string | See the integration guide for usage. |
shopifyoptional | ShopifyVariant | null | See the integration guide for usage. |
sizerequired | string | Maximum length: 32. |
store_idrequired | string | See the integration guide for usage. |
VariantInput
| Field | Type | Description |
|---|---|---|
availablerequired | boolean | See the integration guide for usage. |
coloroptional | string | Maximum length: 80. |
external_idrequired | string | Maximum length: 128. |
sizerequired | string | Maximum length: 32. |
VariantList
| Field | Type | Description |
|---|---|---|
datarequired | Variant[] | See the integration guide for usage. |
next_cursoroptional | string | See the integration guide for usage. |