Metr Fit / API V1

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.

ParameterLocationDetails
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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

KeyInput

{
  "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.

ParameterLocationDetails
key_idpath · 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.

ParameterLocationDetails
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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

KeyInput

{
  "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.

ParameterLocationDetails
key_idpath · 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

ConsoleLogin

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.

ParameterLocationDetails
shopquery · required
codequery · required
statequery · required
timestampquery · required
hmacquery · required

Responses

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.

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

ConsoleSignup

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.

ParameterLocationDetails
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

Request body

StoreInput

{
  "domain": "https://shop.example.com",
  "name": "Example Store"
}

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.

ParameterLocationDetails
store_idpath · 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.

ParameterLocationDetails
store_idpath · required
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

ParameterLocationDetails
store_idpath · required
product_idpath · 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.

ParameterLocationDetails
store_idpath · required
product_idpath · required
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

ParameterLocationDetails
store_idpath · 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.

ParameterLocationDetails
store_idpath · required

Responses

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.

ParameterLocationDetails
store_idpath · required

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.

ParameterLocationDetails
store_idpath · required

Request body

ShopifySyncInput

{
  "force": false
}

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.

ParameterLocationDetails
store_idpath · required
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

ParameterLocationDetails
store_idpath · required

Request body

ChartInput

{
  "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.

ParameterLocationDetails
store_idpath · required

Request body

ChartExtractInput

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.

ParameterLocationDetails
store_idpath · required
chart_idpath · 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.

ParameterLocationDetails
store_idpath · required
chart_idpath · required

Request body

ChartInput

{
  "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.

ParameterLocationDetails
store_idpath · required
chart_idpath · required

Responses

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.

Request body

MerchantInput

{
  "name": "Example Fashion"
}

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.

Request body

MerchantInput

{
  "name": "Example Fashion"
}

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.

ParameterLocationDetails
shopquery · required
timestampquery · required
path_prefixquery · required
logged_in_customer_idquery · required
signaturequery · required

Request body

StorefrontFitInput

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.

ParameterLocationDetails
shopquery · required
timestampquery · required
path_prefixquery · required
logged_in_customer_idquery · required
signaturequery · required

Request body

MiloInput

{
  "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.

ParameterLocationDetails
shopquery · required
timestampquery · required
path_prefixquery · required
logged_in_customer_idquery · required
signaturequery · required

Request body

MiloEventInput

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.

ParameterLocationDetails
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

Request body

StoreInput

{
  "domain": "https://shop.example.com",
  "name": "Example Store"
}

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.

ParameterLocationDetails
store_idpath · 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.

ParameterLocationDetails
store_idpath · required

Request body

StoreInput

{
  "domain": "https://shop.example.com",
  "name": "Example Store"
}

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.

ParameterLocationDetails
store_idpath · required
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

ParameterLocationDetails
store_idpath · required

Request body

CatalogItemsInput

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.

ParameterLocationDetails
store_idpath · required
item_idpath · 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.

ParameterLocationDetails
store_idpath · required
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

ParameterLocationDetails
store_idpath · required

Request body

EventInput

{
  "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.

ParameterLocationDetails
store_idpath · required
event_idpath · 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.

ParameterLocationDetails
store_idpath · required

Request body

SessionInput

{
  "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.

ParameterLocationDetails
store_idpath · required
session_idpath · 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.

ParameterLocationDetails
store_idpath · required
session_idpath · required

Request body

CompletionInput

{
  "chosen_variant_id": "var_example",
  "decision": "accepted"
}

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.

ParameterLocationDetails
store_idpath · required
session_idpath · required

Request body

NextQuestionInput

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.

ParameterLocationDetails
store_idpath · required
session_idpath · required

Request body

RecommendationInput

{
  "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.

ParameterLocationDetails
store_idpath · required
fromquery · optionalSession creation cohort, maximum 366 days. Defaults to the last 30 days.
toquery · optionalSession 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.

ParameterLocationDetails
store_idpath · required

Request body

CatalogInput

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.

ParameterLocationDetails
store_idpath · required

Request body

CatalogImageInput

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.

ParameterLocationDetails
store_idpath · required

Request body

SalesTurnInput

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.

ParameterLocationDetails
store_idpath · required
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

ParameterLocationDetails
store_idpath · 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.

ParameterLocationDetails
store_idpath · required
versionpath · 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.

ParameterLocationDetails
store_idpath · required
versionpath · 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.

ParameterLocationDetails
store_idpath · 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.

ParameterLocationDetails
store_idpath · required

Request body

PresalesSettings

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.

ParameterLocationDetails
store_idpath · required
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

ParameterLocationDetails
store_idpath · required

Request body

ProductInput

{
  "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.

ParameterLocationDetails
store_idpath · required
product_idpath · 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.

ParameterLocationDetails
store_idpath · required
product_idpath · required

Request body

ProductInput

{
  "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.

ParameterLocationDetails
store_idpath · required
product_idpath · required
colorquery · optionalOptional 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.

ParameterLocationDetails
store_idpath · required
product_idpath · required
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

ParameterLocationDetails
store_idpath · required
product_idpath · required

Request body

VariantInput

{
  "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.

ParameterLocationDetails
store_idpath · required
product_idpath · required
variant_idpath · 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.

ParameterLocationDetails
store_idpath · required
product_idpath · required
variant_idpath · required

Request body

VariantInput

{
  "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.

ParameterLocationDetails
store_idpath · required
limitquery · optional Minimum: 1. Maximum: 100.
cursorquery · 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.

ParameterLocationDetails
store_idpath · required

Request body

ChartInput

{
  "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.

ParameterLocationDetails
store_idpath · required
chart_idpath · 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.

ParameterLocationDetails
store_idpath · required
chart_idpath · required

Request body

ChartInput

{
  "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.

FieldTypeDescription
descriptionrequiredstringSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
labelrequiredstringSee the integration guide for usage.

Answers

FieldTypeDescription
ageoptionalnumber | nullSee the integration guide for usage.
body_trackoptionalstringSee the integration guide for usage.
body_typeoptionalstringOptional 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_profileoptionalstringAllowed: narrow, average, broad.
height_cmoptionalnumber | nullOptional height in cm for length-bearing charts. Does not infer body lengths. Minimum: 120. Maximum: 230.
hip_profileoptionalstringAllowed: narrow, average, broad.
lower_body_profileoptionalstringAllowed: balanced, fuller_hips, fuller_waist.
measurementsoptionalobjectOptional body measurements in cm, restricted to fields advertised by the questionnaire. Never send garment dimensions.
preferred_fitoptionalstringAllowed: close, regular, loose.
reference_sizeoptionalstringSee the integration guide for usage.
shoulder_profileoptionalstringAllowed: narrow, average, broad.
silhouette_hipsoptionalstringFashion 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_shouldersoptionalstringFashion 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_thighoptionalstringFashion 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_waistoptionalstringFashion 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_consistencyoptionalstringAllowed: sometimes_smaller, consistent, sometimes_larger.
upper_body_profileoptionalstringAllowed: balanced, fuller_chest, fuller_waist.
usual_sizeoptionalstringSee the integration guide for usage.
waist_profileoptionalstringAllowed: narrow, average, broad.
weight_kgoptionalnumber | nullOptional adult weight in kg for apparel. Context only: not used in size scoring or confidence. Minimum: 30. Maximum: 300.

CatalogAlternative

FieldTypeDescription
kindrequiredstringSee the integration guide for usage.
labelrequiredstringSee the integration guide for usage.
product_idrequiredstringSee the integration guide for usage.

CatalogBrief

FieldTypeDescription
budget_minoroptionalinteger | nullSee the integration guide for usage.
categoryoptionalstringAllowed: tops, bottoms, one_piece, footwear.
intentoptionalstringSee the integration guide for usage.
kitoptionalstringSee the integration guide for usage.
queryrequiredstringSee the integration guide for usage.
selected_idsrequiredstring[]See the integration guide for usage.

CatalogImageInput

FieldTypeDescription
data_base64requiredstringSee the integration guide for usage.
formatrequiredstringSee the integration guide for usage.

CatalogImageResult

FieldTypeDescription
boxrequiredImageBoxSee the integration guide for usage.
categoryoptionalstringAllowed: tops, bottoms, one_piece, footwear.
confidencerequirednumberUncalibrated evidence score, never a probability or accuracy claim. Minimum: 0. Maximum: 1.
messagerequiredstringSee the integration guide for usage.
needs_confirmationrequiredbooleanSee the integration guide for usage.
presencerequirednumberSee the integration guide for usage.

CatalogInput

FieldTypeDescription
actionrequiredstringSee the integration guide for usage.
briefoptionalCatalogBriefSee the integration guide for usage.
budget_minoroptionalinteger | nullSee the integration guide for usage.
catalogrequiredCatalogProduct[]See the integration guide for usage.
categoryoptionalstringAllowed: tops, bottoms, one_piece, footwear.
historyoptionalMiloTurn[]See the integration guide for usage.
kitoptionalstringSee the integration guide for usage.
messagerequiredstringSee the integration guide for usage.
owned_categoriesoptionalstring[]See the integration guide for usage.
selected_idsoptionalstring[]See the integration guide for usage.
swap_idoptionalstringSee the integration guide for usage.
verticalrequiredstringSee the integration guide for usage.

CatalogItem

FieldTypeDescription
availablerequiredbooleanSee the integration guide for usage.
brandoptionalstringSee the integration guide for usage.
categoryoptionalstringAllowed: tops, bottoms, one_piece, footwear.
descriptionoptionalstringSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
image_urloptionalstringSee the integration guide for usage.
price_minorrequiredintegerSee the integration guide for usage.
product_typeoptionalstringSee the integration guide for usage.
specsoptionalobjectSee the integration guide for usage.
tagsoptionalstring[]See the integration guide for usage.
titlerequiredstringSee the integration guide for usage.
urlrequiredstringSee the integration guide for usage.
variant_countoptionalintegerSee the integration guide for usage.

CatalogItemRecord

FieldTypeDescription
idrequiredstringSee the integration guide for usage.
itemrequiredCatalogItemSee the integration guide for usage.
store_idrequiredstringSee the integration guide for usage.
updated_atrequireddate-timeSee the integration guide for usage.

CatalogItemRecordList

FieldTypeDescription
datarequiredCatalogItemRecord[]See the integration guide for usage.
next_cursoroptionalstringSee the integration guide for usage.

CatalogItemsInput

FieldTypeDescription
itemsrequiredCatalogItem[]See the integration guide for usage.

CatalogKit

FieldTypeDescription
idrequiredstringSee the integration guide for usage.
labelrequiredstringSee the integration guide for usage.
missingrequiredstring[]See the integration guide for usage.
ownedoptionalstring[]See the integration guide for usage.
slotsrequiredstring[]See the integration guide for usage.

CatalogProduct

FieldTypeDescription
availablerequiredbooleanSee the integration guide for usage.
brandrequiredstringSee the integration guide for usage.
categoryrequiredstringAllowed: tops, bottoms, one_piece, footwear.
currencyrequiredstringSee the integration guide for usage.
descriptionrequiredstringSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
image_urloptionalstringSee the integration guide for usage.
price_minorrequiredintegerSee the integration guide for usage.
source_fetched_atrequiredstringSee the integration guide for usage.
specsrequiredobjectSee the integration guide for usage.
titlerequiredstringSee the integration guide for usage.
urlrequiredstringSee the integration guide for usage.
variant_countoptionalintegerSee the integration guide for usage.

CatalogResult

FieldTypeDescription
alternativesrequiredCatalogAlternative[]See the integration guide for usage.
briefrequiredCatalogBriefSee the integration guide for usage.
comparisonoptionalCatalogRow[]See the integration guide for usage.
currencyrequiredstringSee the integration guide for usage.
extra_productsrequiredCatalogProduct[]See the integration guide for usage.
follow_upsrequiredstring[]See the integration guide for usage.
intentrequiredstringSee the integration guide for usage.
kitoptionalCatalogKit | nullSee the integration guide for usage.
messagerequiredstringSee the integration guide for usage.
moderequiredstringSee the integration guide for usage.
productsrequiredCatalogProduct[]See the integration guide for usage.
remaining_minoroptionalinteger | nullSee the integration guide for usage.
suggested_budget_minoroptionalinteger | nullSee the integration guide for usage.
total_minorrequiredintegerSee the integration guide for usage.
warningsrequiredstring[]See the integration guide for usage.

CatalogRow

FieldTypeDescription
labelrequiredstringSee the integration guide for usage.
valuesrequiredstring[]See the integration guide for usage.

CatalogUpserted

FieldTypeDescription
upsertedrequiredintegerSee the integration guide for usage.

Chart

FieldTypeDescription
basisrequiredstringAllowed: body, garment.
brandoptionalstringSee the integration guide for usage.
categoryrequiredstringAllowed: tops, bottoms, one_piece, footwear.
created_atrequireddate-timeSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
measurementsrequiredMeasurement[]Minimum items: 1. Maximum items: 8.
merchant_idrequiredstringSee the integration guide for usage.
namerequiredstringSee the integration guide for usage.
revisionrequiredintegerSee the integration guide for usage.
rowsrequiredSizeRow[]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_referenceoptionalbooleanSee the integration guide for usage.
store_idrequiredstringSee the integration guide for usage.
unitrequiredstringAllowed: cm, in.
updated_atrequireddate-timeSee the integration guide for usage.
verifiedrequiredbooleanMerchant confirmation that measurements, units, basis and methods were reviewed. Required true for recommendations.

ChartExtractInput

FieldTypeDescription
datarequiredstringSee the integration guide for usage.
mime_typerequiredstringSee the integration guide for usage.

ChartExtractResult

FieldTypeDescription
notesoptionalstringSee the integration guide for usage.
rowsrequiredstring[][]Ordered smallest to largest. Every row must contain every declared measurement. Labels map exactly to variant sizes. Minimum items: 1. Maximum items: 30.

ChartInput

FieldTypeDescription
basisrequiredstringAllowed: body, garment.
brandoptionalstringSee the integration guide for usage.
categoryrequiredstringAllowed: tops, bottoms, one_piece, footwear.
measurementsrequiredMeasurement[]Minimum items: 1. Maximum items: 8.
namerequiredstringSee the integration guide for usage.
rowsrequiredSizeRow[]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_referenceoptionalbooleanSee the integration guide for usage.
unitrequiredstringAllowed: cm, in.
verifiedrequiredbooleanMerchant confirmation that measurements, units, basis and methods were reviewed. Required true for recommendations.

ChartList

FieldTypeDescription
datarequiredChart[]See the integration guide for usage.
next_cursoroptionalstringSee the integration guide for usage.

CompletionInput

FieldTypeDescription
chosen_variant_idoptionalstringSee the integration guide for usage.
decisionrequiredstringAllowed: accepted, overridden, declined.

ConsoleAccount

FieldTypeDescription
created_atrequireddate-timeSee the integration guide for usage.
emailrequiredemailMaximum length: 254.
idrequiredstringSee the integration guide for usage.
merchant_idrequiredstringSee the integration guide for usage.

ConsoleAuthenticated

FieldTypeDescription
accountrequiredConsoleAccountSee the integration guide for usage.
expires_atrequireddate-timeSee the integration guide for usage.
session_tokenrequiredstringWebsite-server-only session token. Store in an HttpOnly cookie, never browser JSON.

ConsoleChartProductsInput

FieldTypeDescription
product_idsrequiredstring[]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

FieldTypeDescription
chart_idrequiredstringSee the integration guide for usage.
products_updatedrequiredintegerSee the integration guide for usage.

ConsoleLogin

FieldTypeDescription
emailrequiredemailMaximum length: 254.
passwordrequiredstringAt least 12 characters and at most 72 UTF-8 bytes.

ConsoleOverview

FieldTypeDescription
accountrequiredConsoleAccountSee the integration guide for usage.
merchantrequiredMerchantSee the integration guide for usage.
shopify_enabledrequiredbooleanSee the integration guide for usage.

ConsoleShopifyConnection

FieldTypeDescription
connected_atrequireddate-timeSee the integration guide for usage.
expires_atoptionaldate-time | nullSee the integration guide for usage.
last_sync_atoptionaldate-time | nullSee the integration guide for usage.
scopesrequiredstringSee the integration guide for usage.
shoprequiredstringSee the integration guide for usage.
statusrequiredstringSee the integration guide for usage.
store_idrequiredstringSee the integration guide for usage.

ConsoleShopifyLaunch

FieldTypeDescription
shoprequiredstringSee the integration guide for usage.

ConsoleShopifyLaunchInput

FieldTypeDescription
queryrequiredstringOriginal Shopify-signed app-launch query without a leading question mark. Never log it or accept an unsigned shop override. Maximum length: 2000.

ConsoleShopifyStart

FieldTypeDescription
authorization_urlrequiredstringSee the integration guide for usage.

ConsoleShopifyStartInput

FieldTypeDescription
launch_queryoptionalstringOriginal Shopify-signed app-launch query without a leading question mark. Never log it or accept an unsigned shop override. Maximum length: 2000.

ConsoleSignup

FieldTypeDescription
companyrequiredstringMaximum length: 120.
emailrequiredemailMaximum length: 254.
passwordrequiredstringAt least 12 characters and at most 72 UTF-8 bytes.

DemandSignal

FieldTypeDescription
countoptionalintegerSee the integration guide for usage.
kindrequiredstringSee the integration guide for usage.
textrequiredstringSee the integration guide for usage.

ErrorEnvelope

FieldTypeDescription
errorrequiredProblemSee the integration guide for usage.

Estimate

FieldTypeDescription
probabilitiesrequiredobjectSee the integration guide for usage.
sizerequiredstringMaximum length: 32.

Event

FieldTypeDescription
customer_referenceoptionalstringMaximum length: 128.
external_idrequiredstringMaximum length: 128.
idrequiredstringSee the integration guide for usage.
line_item_idoptionalstringMaximum length: 128.
merchant_idrequiredstringSee the integration guide for usage.
occurred_atrequireddate-timeSee the integration guide for usage.
order_idoptionalstringMaximum length: 128.
product_idrequiredstringSee the integration guide for usage.
quantityrequiredintegerMinimum: 1. Maximum: 100.
reasonoptionalstringSee the integration guide for usage.
received_atrequireddate-timeSee the integration guide for usage.
session_idoptionalstringSee the integration guide for usage.
sourcerequiredstringSee the integration guide for usage.
store_idrequiredstringSee the integration guide for usage.
typerequiredstringSee the integration guide for usage.
variant_idoptionalstringSee the integration guide for usage.

EventInput

FieldTypeDescription
customer_referenceoptionalstringMaximum length: 128.
external_idrequiredstringMaximum length: 128.
line_item_idoptionalstringMaximum length: 128.
occurred_atrequireddate-timeSee the integration guide for usage.
order_idoptionalstringMaximum length: 128.
product_idrequiredstringSee the integration guide for usage.
quantityrequiredintegerMinimum: 1. Maximum: 100.
reasonoptionalstringSee the integration guide for usage.
session_idoptionalstringSee the integration guide for usage.
sourcerequiredstringSee the integration guide for usage.
typerequiredstringAllowed: fit_viewed, add_to_cart, checkout_started, purchase, return_requested, size_exchange, item_kept.
variant_idoptionalstringSee the integration guide for usage.

EventList

FieldTypeDescription
datarequiredEvent[]See the integration guide for usage.
next_cursoroptionalstringSee the integration guide for usage.

Evidence

FieldTypeDescription
body_cmoptionalnumber | nullSee the integration guide for usage.
chart_max_cmrequirednumberSee the integration guide for usage.
chart_min_cmrequirednumberSee the integration guide for usage.
estimate_cmoptionalnumber | nullSee the integration guide for usage.
sd_cmoptionalnumber | nullSee the integration guide for usage.
sourcerequiredstringSee the integration guide for usage.

ImageBox

FieldTypeDescription
bottomrequirednumberSee the integration guide for usage.
leftrequirednumberSee the integration guide for usage.
rightrequirednumberSee the integration guide for usage.
toprequirednumberSee the integration guide for usage.

IssuedKey

FieldTypeDescription
keyrequiredKeySee the integration guide for usage.
secretrequiredstringSee the integration guide for usage.

Key

FieldTypeDescription
created_atrequireddate-timeSee the integration guide for usage.
expires_atoptionaldate-time | nullSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
merchant_idrequiredstringSee the integration guide for usage.
namerequiredstringSee the integration guide for usage.
prefixrequiredstringSee the integration guide for usage.
revoked_atoptionaldate-time | nullSee the integration guide for usage.
scopesrequiredstring[]See the integration guide for usage.
store_idoptionalstringSee the integration guide for usage.

KeyInput

FieldTypeDescription
expires_atoptionaldate-time | nullSee the integration guide for usage.
namerequiredstringSee the integration guide for usage.
scopesrequiredstring[]See the integration guide for usage.
store_idoptionalstringSee the integration guide for usage.

KeyList

FieldTypeDescription
datarequiredKey[]See the integration guide for usage.
next_cursoroptionalstringSee the integration guide for usage.

Measurement

FieldTypeDescription
methodrequiredstringAllowed: circumference, flat_width, linear.
namerequiredstringSee the integration guide for usage.

Merchant

FieldTypeDescription
created_atrequireddate-timeSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
namerequiredstringSee the integration guide for usage.

MerchantCreated

FieldTypeDescription
api_keyrequiredIssuedKeySee the integration guide for usage.
merchantrequiredMerchantSee the integration guide for usage.

MerchantInput

FieldTypeDescription
namerequiredstringSee the integration guide for usage.

Metrics

FieldTypeDescription
exchange_for_size_raterequirednumber | nullSee the integration guide for usage.
fit_assisted_conversion_raterequirednumber | nullSee the integration guide for usage.
fromrequireddate-timeSee the integration guide for usage.
interpretationrequiredstringSee the integration guide for usage.
kept_after_recommendation_raterequirednumber | nullSee the integration guide for usage.
kept_linesrequiredintegerSee the integration guide for usage.
observed_throughrequireddate-timeSee the integration guide for usage.
purchased_linesrequiredintegerSee the integration guide for usage.
quiz_completion_raterequirednumber | nullSee the integration guide for usage.
recommendation_acceptance_raterequirednumber | nullSee the integration guide for usage.
recommendation_override_raterequirednumber | nullSee the integration guide for usage.
sessions_acceptedrequiredintegerSee the integration guide for usage.
sessions_overriddenrequiredintegerSee the integration guide for usage.
sessions_purchasedrequiredintegerSee the integration guide for usage.
sessions_recommendedrequiredintegerSee the integration guide for usage.
sessions_startedrequiredintegerSee the integration guide for usage.
size_exchange_linesrequiredintegerSee the integration guide for usage.
size_related_return_raterequirednumber | nullSee the integration guide for usage.
size_return_linesrequiredintegerSee the integration guide for usage.
torequireddate-timeSee the integration guide for usage.

MiloBrief

FieldTypeDescription
budget_minoroptionalinteger | nullOptional integer 0–9000000000000 in currency minor units; null clears the budget.
currencyoptionalstringSee the integration guide for usage.
intentoptionalstringAllowed: find, outfit.
queryoptionalstringCumulative preferences, at most 2000 UTF-8 bytes; swaps preserve the original query. Maximum length: 2000.
selectedrequiredMiloSelection[]Maximum items: 6.
slotsoptionalstring[]Maximum items: 6.

MiloEventInput

FieldTypeDescription
grouprequiredstringSee the integration guide for usage.
kindrequiredstringSee the integration guide for usage.

MiloGroupInsights

FieldTypeDescription
engagedrequiredintegerSee the integration guide for usage.
engaged_ordersrequiredintegerSee the integration guide for usage.
engaged_revenue_minorrequiredintegerSee the integration guide for usage.
opensrequiredintegerSee the integration guide for usage.
ordersrequiredintegerSee the integration guide for usage.
revenue_minorrequiredintegerSee the integration guide for usage.
visitorsrequiredintegerSee the integration guide for usage.

MiloInput

FieldTypeDescription
actionoptionalstringAllowed: find, outfit, swap.
anchoroptionalMiloSelection | nullSee the integration guide for usage.
briefrequiredMiloBriefSee the integration guide for usage.
historyoptionalMiloTurn[]Maximum items: 8.
messagerequiredstringAt most 1000 UTF-8 bytes (not characters). Maximum length: 1000.
swap_slotoptionalstringAllowed: top, bottom, one_piece, shoes, outerwear, accessory.

MiloInsights

FieldTypeDescription
currencyrequiredstringSee the integration guide for usage.
daysrequiredintegerSee the integration guide for usage.
holdoutrequiredMiloGroupInsightsSee the integration guide for usage.
milorequiredMiloGroupInsightsSee the integration guide for usage.
orders_scannedrequiredintegerSee the integration guide for usage.
orders_statusrequiredstringSee the integration guide for usage.
sincerequiredstringSee the integration guide for usage.
truncatedrequiredbooleanSee the integration guide for usage.

MiloProduct

FieldTypeDescription
currencyrequiredstringSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
image_urlrequiredstringSee the integration guide for usage.
price_minorrequiredintegerSee the integration guide for usage.
slotrequiredstringAllowed: top, bottom, one_piece, shoes, outerwear, accessory.
titlerequiredstringSee the integration guide for usage.
urlrequiredstringSee the integration guide for usage.
variantsrequiredMiloVariant[]See the integration guide for usage.

MiloResult

FieldTypeDescription
briefrequiredMiloBriefSee the integration guide for usage.
currencyrequiredstringSee the integration guide for usage.
messagerequiredstringAt most 1000 UTF-8 bytes (not characters). Maximum length: 1000.
moderequiredstringAllowed: ai, fallback.
productsrequiredMiloProduct[]See the integration guide for usage.
total_minorrequiredintegerSee the integration guide for usage.
warningsrequiredstring[]See the integration guide for usage.

MiloSelection

FieldTypeDescription
product_idrequiredstringSee the integration guide for usage.
slotrequiredstringAllowed: top, bottom, one_piece, shoes, outerwear, accessory.
variant_idrequiredstringSee the integration guide for usage.

MiloTurn

FieldTypeDescription
contentrequiredstringAt most 1000 UTF-8 bytes (not characters). Maximum length: 1000.
rolerequiredstringAllowed: user, assistant.

MiloVariant

FieldTypeDescription
availablerequiredbooleanSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
optionsrequiredobjectSee the integration guide for usage.
price_minorrequiredintegerSee the integration guide for usage.
titlerequiredstringSee the integration guide for usage.

NextQuestion

FieldTypeDescription
askedrequiredintegerSee the integration guide for usage.
donerequiredbooleanSee the integration guide for usage.
estimateoptionalEstimate | nullSee the integration guide for usage.
questionoptionalQuestion | nullSee the integration guide for usage.

NextQuestionInput

FieldTypeDescription
answersrequiredAnswersSee the integration guide for usage.
skippedoptionalstring[]See the integration guide for usage.

PresalesSettings

FieldTypeDescription
currencyrequiredstringSee the integration guide for usage.
demand_signalsoptionalDemandSignal[]See the integration guide for usage.
industryrequiredstringSee the integration guide for usage.
overridesrequiredProfileOverridesSee the integration guide for usage.
regionrequiredstringSee the integration guide for usage.
rulesoptionalobjectSee the integration guide for usage.
siteoptionalstringSee the integration guide for usage.
store_namerequiredstringSee the integration guide for usage.

Problem

FieldTypeDescription
coderequiredstringSee the integration guide for usage.
messagerequiredstringSee the integration guide for usage.
request_idrequiredstringSee the integration guide for usage.

Product

FieldTypeDescription
created_atrequireddate-timeSee the integration guide for usage.
external_idrequiredstringMaximum length: 128.
garment_fitrequiredstringAllowed: fitted, regular, relaxed, oversized.
genderrequiredstringAllowed: women, men, unisex.
idrequiredstringSee the integration guide for usage.
merchant_idrequiredstringSee the integration guide for usage.
product_typerequiredstringSee the integration guide for usage.
shopifyoptionalShopifyProduct | nullSee the integration guide for usage.
size_chart_idoptionalstringSee the integration guide for usage.
store_idrequiredstringSee the integration guide for usage.
stretchrequiredstringAllowed: none, moderate, high.
titlerequiredstringSee the integration guide for usage.
updated_atrequireddate-timeSee the integration guide for usage.

ProductInput

FieldTypeDescription
external_idrequiredstringMaximum length: 128.
garment_fitrequiredstringAllowed: fitted, regular, relaxed, oversized.
genderrequiredstringAllowed: women, men, unisex.
product_typerequiredstringSee the integration guide for usage.
size_chart_idoptionalstringSee the integration guide for usage.
stretchrequiredstringAllowed: none, moderate, high.
titlerequiredstringSee the integration guide for usage.

ProductList

FieldTypeDescription
datarequiredProduct[]See the integration guide for usage.
next_cursoroptionalstringSee the integration guide for usage.

ProductType

FieldTypeDescription
categoryrequiredstringAllowed: tops, bottoms, one_piece, footwear, unsupported.
idrequiredstringSee the integration guide for usage.
labelrequiredstringSee the integration guide for usage.

ProductTypeList

FieldTypeDescription
datarequiredProductType[]See the integration guide for usage.
next_cursoroptionalstringSee the integration guide for usage.

ProfileOverrides

FieldTypeDescription
assistantoptionalSalesAssistant | nullSee the integration guide for usage.
exclude_actionsoptionalstring[]See the integration guide for usage.
exclude_categoriesoptionalstring[]See the integration guide for usage.
policiesoptionalSalesPolicy[]See the integration guide for usage.

ProfileVersion

FieldTypeDescription
created_atrequireddate-timeSee the integration guide for usage.
demandoptionalobjectA pre-sales artifact as metr_ai returned it; see schemas/*.schema.json.
enrichedoptionalobject[]See the integration guide for usage.
idrequiredstringSee the integration guide for usage.
notesoptionalstring[]See the integration guide for usage.
packoptionalobjectA pre-sales artifact as metr_ai returned it; see schemas/*.schema.json.
profilerequiredobjectA pre-sales artifact as metr_ai returned it; see schemas/*.schema.json.
published_atoptionaldate-time | nullSee the integration guide for usage.
reportrequiredobjectA pre-sales artifact as metr_ai returned it; see schemas/*.schema.json.
retaileroptionalobjectA pre-sales artifact as metr_ai returned it; see schemas/*.schema.json.
statusrequiredstringSee the integration guide for usage.
store_idrequiredstringSee the integration guide for usage.
versionrequiredintegerSee the integration guide for usage.

ProfileVersionList

FieldTypeDescription
datarequiredProfileVersion[]See the integration guide for usage.
next_cursoroptionalstringSee the integration guide for usage.

Question

FieldTypeDescription
helpoptionalstringSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
labelrequiredstringSee the integration guide for usage.
maxoptionalnumber | nullSee the integration guide for usage.
minoptionalnumber | nullSee the integration guide for usage.
option_labelsoptionalobjectSee the integration guide for usage.
optionsoptionalstring[]See the integration guide for usage.
requiredrequiredbooleanSee the integration guide for usage.
sectionoptionalstringAllowed: usual_size, body_profile, height_weight, fit_preference, measurements.
typerequiredstringSee the integration guide for usage.
unitoptionalstringAllowed: cm, in, kg.

Questionnaire

FieldTypeDescription
available_sizesrequiredstring[]See the integration guide for usage.
categoryrequiredstringAllowed: tops, bottoms, one_piece, footwear.
chart_idrequiredstringSee the integration guide for usage.
chart_revisionrequiredintegerSee the integration guide for usage.
product_idrequiredstringSee the integration guide for usage.
questionsrequiredQuestion[]See the integration guide for usage.
versionrequiredstringSee the integration guide for usage.

Range

FieldTypeDescription
maxrequirednumberSee the integration guide for usage.
minrequirednumberSee the integration guide for usage.

Recommendation

FieldTypeDescription
algorithm_versionrequiredstringSee the integration guide for usage.
chart_idrequiredstringSee the integration guide for usage.
chart_revisionrequiredintegerSee the integration guide for usage.
confidencerequirednumberUncalibrated evidence score, never a probability or accuracy claim. Minimum: 0. Maximum: 1.
confidence_meaningrequiredstringSee the integration guide for usage.
created_atrequireddate-timeSee the integration guide for usage.
evidencerequiredobjectSee the integration guide for usage.
explanationrequiredstringSee the integration guide for usage.
fitrequiredobjectSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
methodrequiredstringAllowed: circumference, flat_width, linear.
probabilitiesrequiredobjectSee the integration guide for usage.
recommended_sizerequiredstringSee the integration guide for usage.
session_idrequiredstringSee the integration guide for usage.
variant_idsrequiredstring[]See the integration guide for usage.
warningsrequiredstring[]See the integration guide for usage.

RecommendationInput

FieldTypeDescription
answersrequiredAnswersSee the integration guide for usage.

RetailerSalesProfile

FieldTypeDescription
assistantrequiredSalesAssistantSee the integration guide for usage.
categoriesrequiredSalesCategory[]See the integration guide for usage.
currencyrequiredstringSee the integration guide for usage.
currency_exponentrequiredintegerSee the integration guide for usage.
enabled_actionsrequiredstring[]See the integration guide for usage.
kitsoptionalSalesKit[]See the integration guide for usage.
needsoptionalSalesNeed[]See the integration guide for usage.
policiesoptionalSalesPolicy[]See the integration guide for usage.
primary_sales_strategyrequiredstringSee the integration guide for usage.
retailer_typerequiredstringSee the integration guide for usage.
store_namerequiredstringSee the integration guide for usage.
versionrequiredintegerSee the integration guide for usage.

SalesAction

FieldTypeDescription
idrequiredstringSee the integration guide for usage.
labelrequiredstringSee the integration guide for usage.
product_idsrequiredstring[]See the integration guide for usage.
valuerequiredstring | nullSee the integration guide for usage.

SalesAssistant

FieldTypeDescription
greetingrequiredstringSee the integration guide for usage.
namerequiredstringSee the integration guide for usage.

SalesCategory

FieldTypeDescription
cautionoptionalstring | nullSee the integration guide for usage.
compare_specsoptionalstring[]See the integration guide for usage.
descriptionrequiredstringSee the integration guide for usage.
fit_rulesoptionalSalesFitRule[]See the integration guide for usage.
idrequiredstringSee the integration guide for usage.
labelrequiredstringSee the integration guide for usage.
qualifyoptionalstring[]See the integration guide for usage.

SalesComparisonRow

FieldTypeDescription
labelrequiredstringSee the integration guide for usage.
valuesrequiredobjectSee the integration guide for usage.

SalesEvent

FieldTypeDescription
actionoptionalstringSee the integration guide for usage.
product_idsoptionalstring[]See the integration guide for usage.
textoptionalstringSee the integration guide for usage.
typerequiredstringSee the integration guide for usage.
valueoptionalstring | nullSee the integration guide for usage.

SalesFitRule

FieldTypeDescription
attributerequiredstringSee the integration guide for usage.
dimensionoptionalstring | nullSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
labeloptionalstring | nullSee the integration guide for usage.
numberoptionalnumber | nullSee the integration guide for usage.
oprequiredstringSee the integration guide for usage.
statusoptionalstringSee the integration guide for usage.
strengthrequiredstringSee the integration guide for usage.
valuesoptionalstring[]See the integration guide for usage.
whenrequiredobjectSee the integration guide for usage.

SalesKit

FieldTypeDescription
answersoptionalobjectSee the integration guide for usage.
categoriesrequiredstring[]See the integration guide for usage.
descriptionrequiredstringSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
labelrequiredstringSee the integration guide for usage.
optionaloptionalstring[]See the integration guide for usage.

SalesNeed

FieldTypeDescription
aboutrequiredstringSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
labelrequiredstringSee the integration guide for usage.
optionsrequiredobject[]See the integration guide for usage.
questionrequiredstringSee the integration guide for usage.

SalesNeeds

FieldTypeDescription
answersoptionalobjectSee the integration guide for usage.
budget_minoroptionalinteger | nullSee the integration guide for usage.
skippedoptionalstring[]See the integration guide for usage.

SalesPage

FieldTypeDescription
product_idoptionalstring | nullSee the integration guide for usage.
typeoptionalstringSee the integration guide for usage.

SalesPick

FieldTypeDescription
cautionrequiredstring | nullSee the integration guide for usage.
product_idrequiredstringSee the integration guide for usage.
reasonsrequiredstring[]See the integration guide for usage.
reasons_sourcerequiredstringSee the integration guide for usage.

SalesPolicy

FieldTypeDescription
sourcerequiredstringSee the integration guide for usage.
textrequiredstringSee the integration guide for usage.
topicrequiredstringSee the integration guide for usage.
urloptionalstring | nullSee the integration guide for usage.

SalesProduct

FieldTypeDescription
availablerequiredbooleanSee the integration guide for usage.
brandoptionalstring | nullSee the integration guide for usage.
categoryrequiredstringAllowed: tops, bottoms, one_piece, footwear.
descriptionoptionalstringSee the integration guide for usage.
factsoptionalobjectSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
image_urloptionalstring | nullSee the integration guide for usage.
price_minorrequiredintegerSee the integration guide for usage.
specsoptionalobjectSee the integration guide for usage.
titlerequiredstringSee the integration guide for usage.
urlrequiredstringSee the integration guide for usage.
variant_countrequiredintegerSee the integration guide for usage.

SalesState

FieldTypeDescription
categoryoptionalstring | nullAllowed: tops, bottoms, one_piece, footwear.
kitoptionalstring | nullSee the integration guide for usage.
needsrequiredSalesNeedsSee the integration guide for usage.
pending_budget_minoroptionalinteger | nullSee the integration guide for usage.
seenoptionalstring[]See the integration guide for usage.
shortlistoptionalstring[]See the integration guide for usage.
stageoptionalstringSee the integration guide for usage.

SalesTurnInput

FieldTypeDescription
catalogoptionalSalesProduct[]See the integration guide for usage.
eventoptionalSalesEvent | nullSee the integration guide for usage.
pageoptionalSalesPage | nullSee the integration guide for usage.
profileoptionalRetailerSalesProfile | nullSee the integration guide for usage.
stateoptionalSalesState | nullSee the integration guide for usage.

SalesTurnResult

FieldTypeDescription
actionsrequiredSalesAction[]See the integration guide for usage.
comparisonrequiredSalesComparisonRow[]See the integration guide for usage.
messagerequiredstringSee the integration guide for usage.
moderequiredstringSee the integration guide for usage.
picksrequiredSalesPick[]See the integration guide for usage.
powered_byrequiredstringSee the integration guide for usage.
stagerequiredstringSee the integration guide for usage.
staterequiredSalesStateSee the integration guide for usage.

Session

FieldTypeDescription
answersoptionalAnswers | nullSee the integration guide for usage.
chosen_variant_idoptionalstringSee the integration guide for usage.
coloroptionalstringMaximum length: 80.
completed_atoptionaldate-time | nullSee the integration guide for usage.
created_atrequireddate-timeSee the integration guide for usage.
customer_referenceoptionalstringMaximum length: 128.
decisionoptionalstringAllowed: accepted, overridden, declined.
expires_atrequireddate-timeSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
merchant_idrequiredstringSee the integration guide for usage.
product_idrequiredstringSee the integration guide for usage.
questionnairerequiredQuestionnaireSee the integration guide for usage.
recommendationoptionalRecommendation | nullSee the integration guide for usage.
statusrequiredstringSee the integration guide for usage.
store_idrequiredstringSee the integration guide for usage.

SessionInput

FieldTypeDescription
coloroptionalstringMaximum length: 80.
customer_referenceoptionalstringMaximum length: 128.
product_idrequiredstringSee the integration guide for usage.

ShopifyProduct

FieldTypeDescription
currencyrequiredstringSee the integration guide for usage.
descriptionrequiredstringSee the integration guide for usage.
image_urlrequiredstringSee the integration guide for usage.
urlrequiredstringSee the integration guide for usage.

ShopifySyncInput

FieldTypeDescription
forceoptionalbooleanSee the integration guide for usage.

ShopifySyncResult

FieldTypeDescription
products_importedrequiredintegerSee the integration guide for usage.
products_updatedrequiredintegerSee the integration guide for usage.
shoprequiredstringSee the integration guide for usage.
total_productsrequiredintegerSee the integration guide for usage.
total_variantsrequiredintegerSee the integration guide for usage.
variants_importedrequiredintegerSee the integration guide for usage.
variants_updatedrequiredintegerSee the integration guide for usage.

ShopifyVariant

FieldTypeDescription
optionsrequiredobjectSee the integration guide for usage.
price_minorrequiredinteger | nullSee the integration guide for usage.
titlerequiredstringSee the integration guide for usage.

SizeRow

FieldTypeDescription
measurementsrequiredobjectSee the integration guide for usage.
sizerequiredstringMaximum length: 32.

Status

FieldTypeDescription
statusrequiredstringSee the integration guide for usage.

Store

FieldTypeDescription
created_atrequireddate-timeSee the integration guide for usage.
domainrequiredstringSee the integration guide for usage.
idrequiredstringSee the integration guide for usage.
merchant_idrequiredstringSee the integration guide for usage.
namerequiredstringSee the integration guide for usage.

StorefrontFitInput

FieldTypeDescription
actionrequiredstringSee the integration guide for usage.
answersoptionalAnswersSee the integration guide for usage.
product_idoptionalstringSee the integration guide for usage.
skippedoptionalstring[]See the integration guide for usage.
tokenoptionalstringSee the integration guide for usage.
variant_idoptionalstringSee the integration guide for usage.

StorefrontFitResult

FieldTypeDescription
completedoptionalbooleanSee the integration guide for usage.
explanationoptionalstringSee the integration guide for usage.
nextoptionalNextQuestion | nullSee the integration guide for usage.
questionsoptionalQuestion[]See the integration guide for usage.
sizeoptionalstringMaximum length: 32.
tokenoptionalstringSee the integration guide for usage.
variantsoptionalStorefrontVariant[]See the integration guide for usage.
warningsoptionalstring[]See the integration guide for usage.

StorefrontVariant

FieldTypeDescription
colorrequiredstringMaximum length: 80.
idrequiredstringSee the integration guide for usage.
sizerequiredstringMaximum length: 32.

StoreInput

FieldTypeDescription
domainrequiredstringSee the integration guide for usage.
namerequiredstringSee the integration guide for usage.

StoreList

FieldTypeDescription
datarequiredStore[]See the integration guide for usage.
next_cursoroptionalstringSee the integration guide for usage.

Variant

FieldTypeDescription
availablerequiredbooleanSee the integration guide for usage.
coloroptionalstringMaximum length: 80.
created_atrequireddate-timeSee the integration guide for usage.
external_idrequiredstringMaximum length: 128.
idrequiredstringSee the integration guide for usage.
merchant_idrequiredstringSee the integration guide for usage.
product_idrequiredstringSee the integration guide for usage.
shopifyoptionalShopifyVariant | nullSee the integration guide for usage.
sizerequiredstringMaximum length: 32.
store_idrequiredstringSee the integration guide for usage.

VariantInput

FieldTypeDescription
availablerequiredbooleanSee the integration guide for usage.
coloroptionalstringMaximum length: 80.
external_idrequiredstringMaximum length: 128.
sizerequiredstringMaximum length: 32.

VariantList

FieldTypeDescription
datarequiredVariant[]See the integration guide for usage.
next_cursoroptionalstringSee the integration guide for usage.