Skip to main content
POST
For an existing protected thread, send its x-widget-thread-token capability in addition to widget identity. Widget identity is verified when signing is configured; tokenless compatibility does not establish tenant ownership. See the authentication and recovery guide for credential and retry rules.

Request body

CartAddRequest
string
required
Shopify variant id (numeric or GID).
integer
Default: 1. Minimum: 1.
string
Widget session id used to reuse the visitor’s cart.
string
Applied only when the server issued it for threadId (see route description).
string
string

Response

CartAddResponse
boolean
required
Fixed value: true.
boolean
required
Fixed value: true.
string
required
integer
required
string
required
integer
required
string,number,null
string,number,null
string (uri)
required
boolean
required
string
boolean
Fixed value: true.

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on November 13, 2026