Ask for a copy of my data, or for my account to be deleted
Make a request on behalf of the signed-in shopper: export for a copy of the personal data the store holds
about them, or erasure for the deletion of their account and that data. An erasure must carry
confirm: true, sent only after the shopper has confirmed in the storefront.
What happens next is the store’s choice:
The store reviews each request (the default). The request is requested until the store approves or
declines it. An approved export can be downloaded for seven days from
GET /v1/customers/{id}/data-requests/{request_id}/export; an approved erasure is carried out by the store.
Shoppers complete their own requests. An export is approved at once and can be downloaded straight
away; an erasure is carried out at once and the request is completed.
An erasure is refused with 409 while the shopper has a Subscribe & Save subscription still running, paid
orders not yet shipped, or a business buyer account; the message says which. After an erasure, records the store
must keep (such as sales) remain with the personal details removed, and the shopper’s sign-in no longer
resolves to a customer.
Each shopper has one open request of each kind: asking again while one is waiting, or while an export is still
downloadable, returns that request with created: false and status 200. A repeated Idempotency-Key
returns the request it first created.
Customer-self access. Works with a publishable key (safe from the
browser). Provide the shopper’s session token in the x-auth-token
header (or the store’s bring-your-own-auth assertion in x-external-auth);
it must resolve to the customer in the {id} path parameter, otherwise the
request returns 403. Limited to 5 requests per shopper per hour.
Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
Full read/write access to all endpoints
⚠️ NEVER expose in client-side code or public repositories
Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
Catalogue reads, plus the actions a shopper takes for themselves
✅ Safe for client-side JavaScript, mobile apps, and public code
Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist,
reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents
Endpoint-Specific Requirements:
Authentication endpoints (/v1/auth/*): state-changing POST calls require a secret key, for store and marketplace keys alike; GET /v1/auth/me accepts either key
AI Recommendations (POST /v1/recommendations): Secret key required
Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
All other write operations: Secret key required
All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Limited publishable keys:
A publishable key can be limited to the products that carry one tag (for example starter:jewellery), created from
the store's Developers page. The limit applies to the key, never to the shopper: shopper sign-up and sign-in stay store-wide.
Reads return only the slice: products (with their facets, filters, search, brands and specifications), categories and
subcategories that hold in-slice products, collections, promotions, posts and lookbooks that carry the tag, reviews of
in-slice products, prices, discovery lists and the store information summary, with every count computed on the slice.
A product outside the slice answers 404, as if it did not exist.
A write that names a product or variant outside the slice (adding to the cart or wishlist, reserving stock, an order line,
a review, a promotion calculation, a storefront event) answers 403 with the error code out_of_scope, and nothing is
written or reserved. An order is refused as a whole.
A route that carries no slice behaviour is not available to the key: it answers 403 with endpoint_not_allowed.
Orders placed through such a key record the tag on the order's attribution as key_scope.
Secret keys and connected-app keys cannot be limited.
Responses are cached per key limit: a limited key never receives a response cached for the whole store, and the reverse.
Headers
x-auth-token
string
required
The signed-in shopper's session token, obtained when the shopper logs in. Must resolve to the customer in the {id} path parameter.
x-external-auth
string
Bring-your-own-auth assertion for stores that manage authentication in an external identity provider (Auth0, Clerk, Cognito, Firebase, NextAuth, SSO). Resolves the shopper whose data requests are managed.
Format: <base64url(JSON)>.<base64url(HMAC-SHA256(JSON))> where the JSON is { "external_id": "...", "iat": <unix>, "exp": <unix> } and the HMAC is keyed on the store's hmac_secret. Claim lifetime capped at 300 seconds. Provide exactly one of x-auth-token, x-external-auth, or x-idp-token.
x-idp-token
string
A raw token from the store's own identity provider (e.g. a Firebase ID token). Galactic Core forwards it to the store's configured Auth verifier, which validates it against the provider and returns the identity; resolves the shopper whose data requests are managed.
Use this when the store wants Galactic Core to verify tokens on its behalf rather than signing an assertion itself. Verification is fail-closed: if the verifier rejects the token or is unreachable, the request is unauthenticated (401). Requires an Auth verifier to be configured for the store. Provide exactly one of x-auth-token, x-external-auth, or x-idp-token.
Idempotency-Key
string
A key of up to 255 characters; a retry with the same key returns the request it created.
Maximum string length: 255
Path Parameters
id
string<uuid>
required
The shopper's customer id.
Body
application/json
kind
enum<string>
required
Available options:
export,
erasure
confirm
boolean
Required, and must be true, when kind is erasure. Not accepted with export.
Response
An open request of this kind already exists (or the Idempotency-Key was used before); it is returned unchanged.
data_request
object
required
A shopper's request for a copy of their data (export) or for the deletion of their account and the personal
data the store holds about them (erasure). The store decides how requests are handled: either each request
waits for the store to approve or decline it, or it completes as soon as it is made.
Show child attributes
created
boolean
required
False when an open request of this kind already existed and was returned instead.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Galactic Core API Documentation","colors":{"primary":"#3b82f6","light":"#60a5fa","dark":"#3b82f6"},"logo":{"light":"https://mintcdn.com/tybritelabs/9cNSmgnBxs-QU_UC/branding/gc-long-blue.png?fit=max\u0026auto=format\u0026n=9cNSmgnBxs-QU_UC\u0026q=85\u0026s=88d64ea989973d874ed73437459487f7","dark":"https://mintcdn.com/tybritelabs/9cNSmgnBxs-QU_UC/branding/gc-long-white.png?fit=max\u0026auto=format\u0026n=9cNSmgnBxs-QU_UC\u0026q=85\u0026s=051cafe35073e2d41a7bfb963b3ad22b"},"favicon":"https://mintcdn.com/tybritelabs/9cNSmgnBxs-QU_UC/favicon.svg?fit=max\u0026auto=format\u0026n=9cNSmgnBxs-QU_UC\u0026q=85\u0026s=83f32264cd55e429e1a14f9d0ee78689","navbar":{"links":[{"href":"https://gc.tybritelabs.com/dashboard","label":"Dashboard"}],"primary":{"type":"button","label":"Get Started","href":"/quickstart"}},"footer":{"socials":{"github":"https://github.com/tybrite","twitter":"https://twitter.com/tybrite","linkedin":"https://linkedin.com/company/tybrite"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://gc.tybritelabs.com/dashboard"},{"anchor":"GitHub","icon":"github","href":"https://github.com/tybrite"},{"anchor":"Support","icon":"envelope","href":"mailto:support@tybrite.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tybritelabs","hasAudioNarration":false,"actualSubdomain":"tybritelabs","customDomains":["docs.tybritelabs.com"],"gitSource":{"type":"github","owner":"tybrite","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6afd85f52bf917781dec4260","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Galactic Core","count":344},{"language":"default","tag":"API Reference","count":288},{"language":"default","tag":"TLDP","count":51},{"language":"default","tag":"Getting Started","count":50},{"language":"default","tag":"TypeScript SDK","count":47},{"language":"default","tag":"Agent","count":43},{"language":"default","tag":"Customers","count":23},{"language":"default","tag":"Returns","count":15},{"language":"default","tag":"B2B","count":14},{"language":"default","tag":"Authentication","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted","slug":"/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted","pageMetadata":{"title":"Ask for a copy of my data, or for my account to be deleted","description":"Make a request on behalf of the signed-in shopper: `export` for a copy of the personal data the store holds\nabout them, or `erasure` for the deletion of their account and that data. An erasure must carry\n`confirm: true`, sent only after the shopper has confirmed in the storefront.\n\nWhat happens next is the store's choice:\n- **The store reviews each request** (the default). The request is `requested` until the store approves or\n declines it. An approved export can be downloaded for seven days from\n `GET /v1/customers/{id}/data-requests/{request_id}/export`; an approved erasure is carried out by the store.\n- **Shoppers complete their own requests.** An export is `approved` at once and can be downloaded straight\n away; an erasure is carried out at once and the request is `completed`.\n\nAn erasure is refused with `409` while the shopper has a Subscribe \u0026 Save subscription still running, paid\norders not yet shipped, or a business buyer account; the message says which. After an erasure, records the store\nmust keep (such as sales) remain with the personal details removed, and the shopper's sign-in no longer\nresolves to a customer.\n\nEach shopper has one open request of each kind: asking again while one is waiting, or while an export is still\ndownloadable, returns that request with `created: false` and status `200`. A repeated `Idempotency-Key`\nreturns the request it first created.\n\n**Customer-self access.** Works with a publishable key (safe from the\nbrowser). Provide the shopper's session token in the `x-auth-token`\nheader (or the store's bring-your-own-auth assertion in `x-external-auth`);\nit must resolve to the customer in the `{id}` path parameter, otherwise the\nrequest returns `403`. Limited to 5 requests per shopper per hour.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers/{id}/data-requests","href":"/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Make a request on behalf of the signed-in shopper: \", _jsx(_components.code, {\n children: \"export\"\n }), \" for a copy of the personal data the store holds\\nabout them, or \", _jsx(_components.code, {\n children: \"erasure\"\n }), \" for the deletion of their account and that data. An erasure must carry\\n\", _jsx(_components.code, {\n children: \"confirm: true\"\n }), \", sent only after the shopper has confirmed in the storefront.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"What happens next is the store’s choice:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"The store reviews each request\"\n }), \" (the default). The request is \", _jsx(_components.code, {\n children: \"requested\"\n }), \" until the store approves or\\ndeclines it. An approved export can be downloaded for seven days from\\n\", _jsx(_components.code, {\n children: \"GET /v1/customers/{id}/data-requests/{request_id}/export\"\n }), \"; an approved erasure is carried out by the store.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Shoppers complete their own requests.\"\n }), \" An export is \", _jsx(_components.code, {\n children: \"approved\"\n }), \" at once and can be downloaded straight\\naway; an erasure is carried out at once and the request is \", _jsx(_components.code, {\n children: \"completed\"\n }), \".\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"An erasure is refused with \", _jsx(_components.code, {\n children: \"409\"\n }), \" while the shopper has a Subscribe \u0026 Save subscription still running, paid\\norders not yet shipped, or a business buyer account; the message says which. After an erasure, records the store\\nmust keep (such as sales) remain with the personal details removed, and the shopper’s sign-in no longer\\nresolves to a customer.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Each shopper has one open request of each kind: asking again while one is waiting, or while an export is still\\ndownloadable, returns that request with \", _jsx(_components.code, {\n children: \"created: false\"\n }), \" and status \", _jsx(_components.code, {\n children: \"200\"\n }), \". A repeated \", _jsx(_components.code, {\n children: \"Idempotency-Key\"\n }), \"\\nreturns the request it first created.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Customer-self access.\"\n }), \" Works with a publishable key (safe from the\\nbrowser). Provide the shopper’s session token in the \", _jsx(_components.code, {\n children: \"x-auth-token\"\n }), \"\\nheader (or the store’s bring-your-own-auth assertion in \", _jsx(_components.code, {\n children: \"x-external-auth\"\n }), \");\\nit must resolve to the customer in the \", _jsx(_components.code, {\n children: \"{id}\"\n }), \" path parameter, otherwise the\\nrequest returns \", _jsx(_components.code, {\n children: \"403\"\n }), \". Limited to 5 requests per shopper per hour.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Ask for a copy of my data, or for my account to be deleted","description":"Make a request on behalf of the signed-in shopper: `export` for a copy of the personal data the store holds\nabout them, or `erasure` for the deletion of their account and that data. An erasure must carry\n`confirm: true`, sent only after the shopper has confirmed in the storefront.\n\nWhat happens next is the store's choice:\n- **The store reviews each request** (the default). The request is `requested` until the store approves or\n declines it. An approved export can be downloaded for seven days from\n `GET /v1/customers/{id}/data-requests/{request_id}/export`; an approved erasure is carried out by the store.\n- **Shoppers complete their own requests.** An export is `approved` at once and can be downloaded straight\n away; an erasure is carried out at once and the request is `completed`.\n\nAn erasure is refused with `409` while the shopper has a Subscribe \u0026 Save subscription still running, paid\norders not yet shipped, or a business buyer account; the message says which. After an erasure, records the store\nmust keep (such as sales) remain with the personal details removed, and the shopper's sign-in no longer\nresolves to a customer.\n\nEach shopper has one open request of each kind: asking again while one is waiting, or while an export is still\ndownloadable, returns that request with `created: false` and status `200`. A repeated `Idempotency-Key`\nreturns the request it first created.\n\n**Customer-self access.** Works with a publishable key (safe from the\nbrowser). Provide the shopper's session token in the `x-auth-token`\nheader (or the store's bring-your-own-auth assertion in `x-external-auth`);\nit must resolve to the customer in the `{id}` path parameter, otherwise the\nrequest returns `403`. Limited to 5 requests per shopper per hour.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers/{id}/data-requests","href":"/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/tybritelabs/af1ac4e439492905/sync.js","/_mintlify/custom/tybritelabs/cffa438ecec94ea5/scripts/check-tldp-isolation.js"],"openApiReferenceData":{"operation":{"operationId":"createCustomerDataRequest","tags":["Customers"],"summary":"Ask for a copy of my data, or for my account to be deleted","description":"Make a request on behalf of the signed-in shopper: `export` for a copy of the personal data the store holds\nabout them, or `erasure` for the deletion of their account and that data. An erasure must carry\n`confirm: true`, sent only after the shopper has confirmed in the storefront.\n\nWhat happens next is the store's choice:\n- **The store reviews each request** (the default). The request is `requested` until the store approves or\n declines it. An approved export can be downloaded for seven days from\n `GET /v1/customers/{id}/data-requests/{request_id}/export`; an approved erasure is carried out by the store.\n- **Shoppers complete their own requests.** An export is `approved` at once and can be downloaded straight\n away; an erasure is carried out at once and the request is `completed`.\n\nAn erasure is refused with `409` while the shopper has a Subscribe \u0026 Save subscription still running, paid\norders not yet shipped, or a business buyer account; the message says which. After an erasure, records the store\nmust keep (such as sales) remain with the personal details removed, and the shopper's sign-in no longer\nresolves to a customer.\n\nEach shopper has one open request of each kind: asking again while one is waiting, or while an export is still\ndownloadable, returns that request with `created: false` and status `200`. A repeated `Idempotency-Key`\nreturns the request it first created.\n\n**Customer-self access.** Works with a publishable key (safe from the\nbrowser). Provide the shopper's session token in the `x-auth-token`\nheader (or the store's bring-your-own-auth assertion in `x-external-auth`);\nit must resolve to the customer in the `{id}` path parameter, otherwise the\nrequest returns `403`. Limited to 5 requests per shopper per hour.\n","security":["6e41e8f3-c158-45fb-afcc-1643aef15f02"],"parameters":["6ff18326-ef00-4290-9226-fed1684297ac","d3728035-799a-47e3-a572-829e2340dd45","4cfe6152-824f-41d1-b29c-c9ec15135f85","1e758d34-d31c-4c57-ac43-d51a74ba80b5","449384e0-db82-4d6f-aa10-9b3973f10a89"],"requestBody":"f4598d9a-d11a-470e-8830-a9e2b8eff311","responses":{"200":"2b95eb72-c950-4e65-a639-d8e42986ecca","201":"318f18da-d853-43b6-81bc-91b5b5956ea9","400":"bc17ed7c-b46e-4aac-87b8-5bedfaf3f1d1","401":"be315f5f-73f2-47c2-b776-5bc019580b95","402":"a6e89b74-1b66-4f10-8002-3a756b2aaa9e","403":"7bb09cd7-9991-4580-8cb9-1f557f63213d","404":"531b0894-8f57-45be-a626-daa7afaf9814","409":"4bda45d7-9a4e-4745-b61a-348f62639753","429":"77e27043-a4b5-4f38-adbb-a300e5f9a41f","500":"38de4c9b-3ecc-43e3-9c98-529a184120ca"},"method":"post","type":"path","servers":["a9261009-7b5a-4dee-9970-34482b20107c"],"path":"/v1/customers/{id}/data-requests","baseUrlOptions":["https://api.tybritelabs.com"],"title":"Ask for a copy of my data, or for my account to be deleted","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6ff18326-ef00-4290-9226-fed1684297ac":{"name":"id","in":"path","required":true,"description":"The shopper's customer id.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The shopper's customer id.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"d3728035-799a-47e3-a572-829e2340dd45":{"name":"x-auth-token","in":"header","required":true,"description":"The signed-in shopper's session token, obtained when the shopper logs in. Must resolve to the customer in the `{id}` path parameter.","schema":{"type":"string","isRequired":true,"description":"The signed-in shopper's session token, obtained when the shopper logs in. Must resolve to the customer in the `{id}` path parameter.","uniqueKey":"","typeLabel":"string"}},"4cfe6152-824f-41d1-b29c-c9ec15135f85":{"name":"x-external-auth","in":"header","required":false,"description":"Bring-your-own-auth assertion for stores that manage authentication in an external identity provider (Auth0, Clerk, Cognito, Firebase, NextAuth, SSO). Resolves the shopper whose data requests are managed.\n\nFormat: `\u003cbase64url(JSON)>.\u003cbase64url(HMAC-SHA256(JSON))>` where the JSON is `{ \"external_id\": \"...\", \"iat\": \u003cunix>, \"exp\": \u003cunix> }` and the HMAC is keyed on the store's `hmac_secret`. Claim lifetime capped at 300 seconds. Provide exactly one of `x-auth-token`, `x-external-auth`, or `x-idp-token`.\n","schema":{"type":"string","isRequired":false,"description":"Bring-your-own-auth assertion for stores that manage authentication in an external identity provider (Auth0, Clerk, Cognito, Firebase, NextAuth, SSO). Resolves the shopper whose data requests are managed.\n\nFormat: `\u003cbase64url(JSON)>.\u003cbase64url(HMAC-SHA256(JSON))>` where the JSON is `{ \"external_id\": \"...\", \"iat\": \u003cunix>, \"exp\": \u003cunix> }` and the HMAC is keyed on the store's `hmac_secret`. Claim lifetime capped at 300 seconds. Provide exactly one of `x-auth-token`, `x-external-auth`, or `x-idp-token`.\n","uniqueKey":"","typeLabel":"string"}},"1e758d34-d31c-4c57-ac43-d51a74ba80b5":{"name":"x-idp-token","in":"header","required":false,"description":"A raw token from the store's own identity provider (e.g. a Firebase ID token). Galactic Core forwards it to the store's configured Auth verifier, which validates it against the provider and returns the identity; resolves the shopper whose data requests are managed.\n\nUse this when the store wants Galactic Core to verify tokens on its behalf rather than signing an assertion itself. Verification is fail-closed: if the verifier rejects the token or is unreachable, the request is unauthenticated (`401`). Requires an Auth verifier to be configured for the store. Provide exactly one of `x-auth-token`, `x-external-auth`, or `x-idp-token`.\n","schema":{"type":"string","isRequired":false,"description":"A raw token from the store's own identity provider (e.g. a Firebase ID token). Galactic Core forwards it to the store's configured Auth verifier, which validates it against the provider and returns the identity; resolves the shopper whose data requests are managed.\n\nUse this when the store wants Galactic Core to verify tokens on its behalf rather than signing an assertion itself. Verification is fail-closed: if the verifier rejects the token or is unreachable, the request is unauthenticated (`401`). Requires an Auth verifier to be configured for the store. Provide exactly one of `x-auth-token`, `x-external-auth`, or `x-idp-token`.\n","uniqueKey":"","typeLabel":"string"}},"449384e0-db82-4d6f-aa10-9b3973f10a89":{"name":"Idempotency-Key","in":"header","required":false,"description":"A key of up to 255 characters; a retry with the same key returns the request it created.","schema":{"type":"string","maxLength":255,"isRequired":false,"description":"A key of up to 255 characters; a retry with the same key returns the request it created.","uniqueKey":"","typeLabel":"string"},"example":"dsr-1771523993-abc123"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["kind"],"properties":{"kind":{"type":"string","enum":["export","erasure"],"isRequired":true,"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"confirm":{"type":"boolean","description":"Required, and must be `true`, when `kind` is `erasure`. Not accepted with `export`.","uniqueKey":"confirm","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"export":{"title":"export","value":{"kind":"export"}},"erasure":{"title":"erasure","value":{"kind":"erasure","confirm":true}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"2b95eb72-c950-4e65-a639-d8e42986ecca":{"description":"An open request of this kind already exists (or the Idempotency-Key was used before); it is returned unchanged.","headers":{"Tybrite-Environment":{"description":"Confirms which environment your API key resolved to. Use this to verify that test keys\nare hitting sandbox data and live keys are hitting production data.\n\n- `production` — requests are scoped to live data; real orders, customers, and payments\n- `sandbox` — requests are scoped to isolated test data; no real money is moved\n\nPresent on every authenticated response, including error responses.\n","schema":{"type":"string","enum":["production","sandbox"]},"example":"sandbox"}},"content":{"application/json":{"schema":{"type":"object","required":["data_request","created"],"properties":{"data_request":{"type":"object","description":"A shopper's request for a copy of their data (`export`) or for the deletion of their account and the personal\ndata the store holds about them (`erasure`). The store decides how requests are handled: either each request\nwaits for the store to approve or decline it, or it completes as soon as it is made.\n","required":["id","kind","status","handling","requested_at","download_available"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data_request.id","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","enum":["export","erasure"],"isRequired":true,"uniqueKey":"data_request.kind","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["requested","approved","declined","completed","failed"],"description":"`requested` waits for the store. `approved` (export) means the copy is ready to download. `completed` means\nthe copy was downloaded at least once, or the erasure has been carried out. `declined` carries the store's\nreason in `decline_reason`.\n","isRequired":true,"uniqueKey":"data_request.status","typeLabel":"enum\u003cstring>"},"handling":{"type":"string","enum":["request","self_service"],"description":"How the store handled requests when this one was made. `self_service` requests complete at once.","isRequired":true,"uniqueKey":"data_request.handling","typeLabel":"enum\u003cstring>"},"requested_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data_request.requested_at","typeLabel":"string\u003cdate-time>"},"download_available":{"type":"boolean","description":"True while an approved export can be downloaded.","isRequired":true,"uniqueKey":"data_request.download_available","typeLabel":"boolean"},"decided_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data_request.decided_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data_request.decided_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_request.decided_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data_request.completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data_request.completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_request.completed_at","typeLabel":"string\u003cdate-time> | null"},"decline_reason":{"oneOf":[{"type":"string","description":"The store's reason, written for the shopper. Present only when the request was declined.","uniqueKey":"data_request.decline_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The store's reason, written for the shopper. Present only when the request was declined.","uniqueKey":"data_request.decline_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_request.decline_reason","typeLabel":"string | null"},"download_expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"For an export, the end of the download window (seven days after approval).","uniqueKey":"data_request.download_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"For an export, the end of the download window (seven days after approval).","uniqueKey":"data_request.download_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_request.download_expires_at","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"data_request","typeLabel":"object"},"created":{"type":"boolean","description":"False when an open request of this kind already existed and was returned instead.","isRequired":true,"uniqueKey":"created","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"data_request":{"id":"7c1e0f52-3a9b-4d8e-9f60-2b1c3d4e5f60","kind":"export","status":"requested","handling":"request","requested_at":"2026-11-07T09:12:00+00:00","decided_at":null,"completed_at":null,"decline_reason":null,"download_expires_at":null,"download_available":false},"created":false},"examples":{"Example":{"title":"Example","value":{"data_request":{"id":"7c1e0f52-3a9b-4d8e-9f60-2b1c3d4e5f60","kind":"export","status":"requested","handling":"request","requested_at":"2026-11-07T09:12:00+00:00","decided_at":null,"completed_at":null,"decline_reason":null,"download_expires_at":null,"download_available":false},"created":false}}},"exampleType":"examples"}},"exampleType":"examples"},"318f18da-d853-43b6-81bc-91b5b5956ea9":{"description":"The request was made.","headers":{"Tybrite-Environment":{"description":"Confirms which environment your API key resolved to. Use this to verify that test keys\nare hitting sandbox data and live keys are hitting production data.\n\n- `production` — requests are scoped to live data; real orders, customers, and payments\n- `sandbox` — requests are scoped to isolated test data; no real money is moved\n\nPresent on every authenticated response, including error responses.\n","schema":{"type":"string","enum":["production","sandbox"]},"example":"sandbox"}},"content":{"application/json":{"schema":{"type":"object","required":["data_request","created"],"properties":{"data_request":{"type":"object","description":"A shopper's request for a copy of their data (`export`) or for the deletion of their account and the personal\ndata the store holds about them (`erasure`). The store decides how requests are handled: either each request\nwaits for the store to approve or decline it, or it completes as soon as it is made.\n","required":["id","kind","status","handling","requested_at","download_available"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data_request.id","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","enum":["export","erasure"],"isRequired":true,"uniqueKey":"data_request.kind","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["requested","approved","declined","completed","failed"],"description":"`requested` waits for the store. `approved` (export) means the copy is ready to download. `completed` means\nthe copy was downloaded at least once, or the erasure has been carried out. `declined` carries the store's\nreason in `decline_reason`.\n","isRequired":true,"uniqueKey":"data_request.status","typeLabel":"enum\u003cstring>"},"handling":{"type":"string","enum":["request","self_service"],"description":"How the store handled requests when this one was made. `self_service` requests complete at once.","isRequired":true,"uniqueKey":"data_request.handling","typeLabel":"enum\u003cstring>"},"requested_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data_request.requested_at","typeLabel":"string\u003cdate-time>"},"download_available":{"type":"boolean","description":"True while an approved export can be downloaded.","isRequired":true,"uniqueKey":"data_request.download_available","typeLabel":"boolean"},"decided_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data_request.decided_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data_request.decided_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_request.decided_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data_request.completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data_request.completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_request.completed_at","typeLabel":"string\u003cdate-time> | null"},"decline_reason":{"oneOf":[{"type":"string","description":"The store's reason, written for the shopper. Present only when the request was declined.","uniqueKey":"data_request.decline_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The store's reason, written for the shopper. Present only when the request was declined.","uniqueKey":"data_request.decline_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_request.decline_reason","typeLabel":"string | null"},"download_expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"For an export, the end of the download window (seven days after approval).","uniqueKey":"data_request.download_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"For an export, the end of the download window (seven days after approval).","uniqueKey":"data_request.download_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_request.download_expires_at","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"data_request","typeLabel":"object"},"created":{"type":"boolean","description":"False when an open request of this kind already existed and was returned instead.","isRequired":true,"uniqueKey":"created","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"data_request":{"id":"7c1e0f52-3a9b-4d8e-9f60-2b1c3d4e5f60","kind":"export","status":"requested","handling":"request","requested_at":"2026-11-07T09:12:00+00:00","decided_at":null,"completed_at":null,"decline_reason":null,"download_expires_at":null,"download_available":false},"created":true},"examples":{"Example":{"title":"Example","value":{"data_request":{"id":"7c1e0f52-3a9b-4d8e-9f60-2b1c3d4e5f60","kind":"export","status":"requested","handling":"request","requested_at":"2026-11-07T09:12:00+00:00","decided_at":null,"completed_at":null,"decline_reason":null,"download_expires_at":null,"download_available":false},"created":true}}},"exampleType":"examples"}},"exampleType":"examples"},"bc17ed7c-b46e-4aac-87b8-5bedfaf3f1d1":{"description":"Invalid request - malformed data or missing required fields","headers":{"Tybrite-Environment":{"description":"Confirms which environment your API key resolved to. Use this to verify that test keys\nare hitting sandbox data and live keys are hitting production data.\n\n- `production` — requests are scoped to live data; real orders, customers, and payments\n- `sandbox` — requests are scoped to isolated test data; no real money is moved\n\nPresent on every authenticated response, including error responses.\n","schema":{"type":"string","enum":["production","sandbox"]},"example":"sandbox"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"invalid_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing required field","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","uniqueKey":"error.details.oneOf.0","typeLabel":"string"},{"type":"object","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"string | object"},"hint":{"type":"string","description":"Additional guidance on how to resolve the error.","uniqueKey":"error.hint","typeLabel":"string"},"available_stock":{"type":"integer","description":"Current stock level (present on insufficient_stock errors).","uniqueKey":"error.available_stock","typeLabel":"integer"},"current_cart_quantity":{"type":"integer","description":"Quantity already in cart (present on insufficient_stock errors).","uniqueKey":"error.current_cart_quantity","typeLabel":"integer"},"limit":{"type":"integer","description":"Rate limit ceiling (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"Requests remaining in the current window (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.remaining","typeLabel":"integer"},"reset":{"type":"integer","description":"Unix timestamp when the rate limit / quota window resets (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.reset","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"invalid_request","message":"Invalid request parameters","details":"The 'email' field is required"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"Invalid request parameters","details":"The 'email' field is required"}}}},"exampleType":"examples"}},"exampleType":"examples"},"be315f5f-73f2-47c2-b776-5bc019580b95":{"description":"Authentication failed. `unauthorized` means the API key is missing or invalid, or the `x-auth-token` header is absent. `invalid_token` means the `x-auth-token` is not a valid sign-in token for this store and environment: expired, revoked, issued by another store, or malformed. A storefront refreshes the session once with `POST /v1/auth/refresh` and treats the shopper as signed out if that fails.","headers":{"Tybrite-Environment":{"description":"Confirms which environment your API key resolved to. Use this to verify that test keys\nare hitting sandbox data and live keys are hitting production data.\n\n- `production` — requests are scoped to live data; real orders, customers, and payments\n- `sandbox` — requests are scoped to isolated test data; no real money is moved\n\nPresent on every authenticated response, including error responses.\n","schema":{"type":"string","enum":["production","sandbox"]},"example":"sandbox"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"invalid_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing required field","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","uniqueKey":"error.details.oneOf.0","typeLabel":"string"},{"type":"object","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"string | object"},"hint":{"type":"string","description":"Additional guidance on how to resolve the error.","uniqueKey":"error.hint","typeLabel":"string"},"available_stock":{"type":"integer","description":"Current stock level (present on insufficient_stock errors).","uniqueKey":"error.available_stock","typeLabel":"integer"},"current_cart_quantity":{"type":"integer","description":"Quantity already in cart (present on insufficient_stock errors).","uniqueKey":"error.current_cart_quantity","typeLabel":"integer"},"limit":{"type":"integer","description":"Rate limit ceiling (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"Requests remaining in the current window (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.remaining","typeLabel":"integer"},"reset":{"type":"integer","description":"Unix timestamp when the rate limit / quota window resets (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.reset","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalid_token":{"title":"invalid_token","summary":"Sign-in token not valid","value":{"error":{"code":"invalid_token","message":"Invalid or expired customer token","hint":"Refresh the token via POST /v1/auth/refresh once; if that fails, treat the shopper as signed out and re-authenticate."}}},"unauthorized":{"title":"unauthorized","summary":"API key missing or invalid","value":{"error":{"code":"unauthorized","message":"Missing or invalid Authorization header"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a6e89b74-1b66-4f10-8002-3a756b2aaa9e":{"description":"The store's subscription is not active, or the store is deactivated. Every API-keyed request for that store answers `402` with `subscription_expired` until the subscription is renewed.","headers":{"Tybrite-Environment":{"description":"Confirms which environment your API key resolved to. Use this to verify that test keys\nare hitting sandbox data and live keys are hitting production data.\n\n- `production` — requests are scoped to live data; real orders, customers, and payments\n- `sandbox` — requests are scoped to isolated test data; no real money is moved\n\nPresent on every authenticated response, including error responses.\n","schema":{"type":"string","enum":["production","sandbox"]},"example":"sandbox"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"invalid_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing required field","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","uniqueKey":"error.details.oneOf.0","typeLabel":"string"},{"type":"object","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"string | object"},"hint":{"type":"string","description":"Additional guidance on how to resolve the error.","uniqueKey":"error.hint","typeLabel":"string"},"available_stock":{"type":"integer","description":"Current stock level (present on insufficient_stock errors).","uniqueKey":"error.available_stock","typeLabel":"integer"},"current_cart_quantity":{"type":"integer","description":"Quantity already in cart (present on insufficient_stock errors).","uniqueKey":"error.current_cart_quantity","typeLabel":"integer"},"limit":{"type":"integer","description":"Rate limit ceiling (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"Requests remaining in the current window (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.remaining","typeLabel":"integer"},"reset":{"type":"integer","description":"Unix timestamp when the rate limit / quota window resets (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.reset","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"subscription_expired","message":"This store's subscription is not active"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"subscription_expired","message":"This store's subscription is not active"}}}},"exampleType":"examples"}},"exampleType":"examples"},"7bb09cd7-9991-4580-8cb9-1f557f63213d":{"description":"Insufficient permissions for this key. A GC Connect key that was not granted the operation's scope (for example `agent:read` or `orders:write`) receives `insufficient_scope`, and the message names the scope. A request that needs a secret key (a publishable key on a write, whatever scopes it holds), or a marketplace operator key calling a single-store operation, receives `forbidden`. A store whose plan does not include the feature the route belongs to receives `feature_not_available`, whatever the key. A publishable key limited to the products that carry one tag receives `out_of_scope` for a product, variant, promotion or review outside its slice, and `endpoint_not_allowed` on a route that has no slice behaviour.","headers":{"Tybrite-Environment":{"description":"Confirms which environment your API key resolved to. Use this to verify that test keys\nare hitting sandbox data and live keys are hitting production data.\n\n- `production` — requests are scoped to live data; real orders, customers, and payments\n- `sandbox` — requests are scoped to isolated test data; no real money is moved\n\nPresent on every authenticated response, including error responses.\n","schema":{"type":"string","enum":["production","sandbox"]},"example":"sandbox"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"invalid_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing required field","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","uniqueKey":"error.details.oneOf.0","typeLabel":"string"},{"type":"object","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"string | object"},"hint":{"type":"string","description":"Additional guidance on how to resolve the error.","uniqueKey":"error.hint","typeLabel":"string"},"available_stock":{"type":"integer","description":"Current stock level (present on insufficient_stock errors).","uniqueKey":"error.available_stock","typeLabel":"integer"},"current_cart_quantity":{"type":"integer","description":"Quantity already in cart (present on insufficient_stock errors).","uniqueKey":"error.current_cart_quantity","typeLabel":"integer"},"limit":{"type":"integer","description":"Rate limit ceiling (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"Requests remaining in the current window (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.remaining","typeLabel":"integer"},"reset":{"type":"integer","description":"Unix timestamp when the rate limit / quota window resets (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.reset","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"insufficient_scope":{"title":"insufficient_scope","summary":"Connect key without the operation's scope","value":{"error":{"code":"insufficient_scope","message":"This connected app was not granted the 'agent:read' scope."}}},"forbidden":{"title":"forbidden","summary":"Secret key required","value":{"error":{"code":"forbidden","message":"This operation requires a secret key. Publishable keys cover catalogue reads and the actions a shopper takes for themselves."}}},"feature_not_available":{"title":"feature_not_available","summary":"The store's plan does not include the feature","value":{"error":{"code":"feature_not_available","message":"Smart Search is not available for this store."}}},"out_of_scope":{"title":"out_of_scope","summary":"A publishable key limited to one tag named a product outside its slice","value":{"error":{"code":"out_of_scope","message":"This key is limited to part of the catalogue and this product is outside it."}}}},"exampleType":"examples"}},"exampleType":"examples"},"531b0894-8f57-45be-a626-daa7afaf9814":{"description":"Resource not found","headers":{"Tybrite-Environment":{"description":"Confirms which environment your API key resolved to. Use this to verify that test keys\nare hitting sandbox data and live keys are hitting production data.\n\n- `production` — requests are scoped to live data; real orders, customers, and payments\n- `sandbox` — requests are scoped to isolated test data; no real money is moved\n\nPresent on every authenticated response, including error responses.\n","schema":{"type":"string","enum":["production","sandbox"]},"example":"sandbox"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"invalid_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing required field","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","uniqueKey":"error.details.oneOf.0","typeLabel":"string"},{"type":"object","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"string | object"},"hint":{"type":"string","description":"Additional guidance on how to resolve the error.","uniqueKey":"error.hint","typeLabel":"string"},"available_stock":{"type":"integer","description":"Current stock level (present on insufficient_stock errors).","uniqueKey":"error.available_stock","typeLabel":"integer"},"current_cart_quantity":{"type":"integer","description":"Quantity already in cart (present on insufficient_stock errors).","uniqueKey":"error.current_cart_quantity","typeLabel":"integer"},"limit":{"type":"integer","description":"Rate limit ceiling (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"Requests remaining in the current window (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.remaining","typeLabel":"integer"},"reset":{"type":"integer","description":"Unix timestamp when the rate limit / quota window resets (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.reset","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"not_found","message":"Resource not found"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"Resource not found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"4bda45d7-9a4e-4745-b61a-348f62639753":{"description":"Conflict — the request could not be completed because it conflicts with the current state of a resource.\nCommon causes:\n- Email already registered to another customer at this store\n- Item already exists in wishlist\n- Idempotency-Key reused with a different request body\n","headers":{"Tybrite-Environment":{"description":"Confirms which environment your API key resolved to. Use this to verify that test keys\nare hitting sandbox data and live keys are hitting production data.\n\n- `production` — requests are scoped to live data; real orders, customers, and payments\n- `sandbox` — requests are scoped to isolated test data; no real money is moved\n\nPresent on every authenticated response, including error responses.\n","schema":{"type":"string","enum":["production","sandbox"]},"example":"sandbox"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"invalid_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing required field","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","uniqueKey":"error.details.oneOf.0","typeLabel":"string"},{"type":"object","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"string | object"},"hint":{"type":"string","description":"Additional guidance on how to resolve the error.","uniqueKey":"error.hint","typeLabel":"string"},"available_stock":{"type":"integer","description":"Current stock level (present on insufficient_stock errors).","uniqueKey":"error.available_stock","typeLabel":"integer"},"current_cart_quantity":{"type":"integer","description":"Quantity already in cart (present on insufficient_stock errors).","uniqueKey":"error.current_cart_quantity","typeLabel":"integer"},"limit":{"type":"integer","description":"Rate limit ceiling (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"Requests remaining in the current window (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.remaining","typeLabel":"integer"},"reset":{"type":"integer","description":"Unix timestamp when the rate limit / quota window resets (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.reset","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"conflict","message":"A customer with this email already exists for this store"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"conflict","message":"A customer with this email already exists for this store"}}}},"exampleType":"examples"}},"exampleType":"examples"},"77e27043-a4b5-4f38-adbb-a300e5f9a41f":{"description":"Too many requests. Three distinct `429` codes: `rate_limited` (an abuse throttle — too many requests too fast; carries an `X-RateLimit-Scope: abuse` header and is NOT counted against your monthly quota), `guest_limit_reached` (the same per-address throttle, answered to a guest, a request with no shopper credential, whose per-address hourly budget at this store is lower than a signed-in shopper's) and `quota_exceeded` (your plan's monthly request allowance is reached).\n`guest_limit_reached` carries `details`: `scope` is `guest`, `bucket` is `browse`, `limit` is the guest budget, `window_seconds` is `3600`, `remaining` is `0`, `reset` and `retry_after` say when the hour ends, `signed_in_limit` is the signed-in shopper's budget and `sign_in_raises_limit` is `true`. A storefront shows its sign-in prompt for this code. A signed-in shopper, and a guest whose budget is not lower than the signed-in one, get `rate_limited`.\nOn a throttle refusal (`rate_limited`, `guest_limit_reached`) `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` describe the window that refused the request (the hour, the day or the per-address hour) and `Retry-After` is the time until it ends. On `quota_exceeded` they describe the monthly allowance.","headers":{"Tybrite-Environment":{"description":"Confirms which environment your API key resolved to. Use this to verify that test keys\nare hitting sandbox data and live keys are hitting production data.\n\n- `production` — requests are scoped to live data; real orders, customers, and payments\n- `sandbox` — requests are scoped to isolated test data; no real money is moved\n\nPresent on every authenticated response, including error responses.\n","schema":{"type":"string","enum":["production","sandbox"]},"example":"sandbox"},"Retry-After":{"description":"Seconds until the limit that refused the request resets. Sent with `rate_limited`, `guest_limit_reached` and `quota_exceeded` (for the latter, the seconds until the monthly reset). Not sent when no reset time is known.","schema":{"type":"integer"},"example":540}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"invalid_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing required field","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","uniqueKey":"error.details.oneOf.0","typeLabel":"string"},{"type":"object","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"string | object"},"hint":{"type":"string","description":"Additional guidance on how to resolve the error.","uniqueKey":"error.hint","typeLabel":"string"},"available_stock":{"type":"integer","description":"Current stock level (present on insufficient_stock errors).","uniqueKey":"error.available_stock","typeLabel":"integer"},"current_cart_quantity":{"type":"integer","description":"Quantity already in cart (present on insufficient_stock errors).","uniqueKey":"error.current_cart_quantity","typeLabel":"integer"},"limit":{"type":"integer","description":"Rate limit ceiling (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"Requests remaining in the current window (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.remaining","typeLabel":"integer"},"reset":{"type":"integer","description":"Unix timestamp when the rate limit / quota window resets (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.reset","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"rate_limited":{"title":"rate_limited","summary":"An abuse throttle","value":{"error":{"code":"rate_limited","message":"Too many requests for this API key. Please slow down and try again shortly.","remaining":0,"reset":1706198400}}},"guest_limit_reached":{"title":"guest_limit_reached","summary":"A guest reached a per-address budget that signing in raises","value":{"error":{"code":"guest_limit_reached","message":"Sign in to keep going — signed-in shoppers get more.","details":{"scope":"guest","bucket":"browse","limit":500,"window_seconds":3600,"remaining":0,"reset":1706198400,"retry_after":540,"signed_in_limit":2000,"sign_in_raises_limit":true}}}}},"exampleType":"examples"}},"exampleType":"examples"},"38de4c9b-3ecc-43e3-9c98-529a184120ca":{"description":"Internal server error. A 5xx response never carries `details`.","headers":{"Tybrite-Environment":{"description":"Confirms which environment your API key resolved to. Use this to verify that test keys\nare hitting sandbox data and live keys are hitting production data.\n\n- `production` — requests are scoped to live data; real orders, customers, and payments\n- `sandbox` — requests are scoped to isolated test data; no real money is moved\n\nPresent on every authenticated response, including error responses.\n","schema":{"type":"string","enum":["production","sandbox"]},"example":"sandbox"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"invalid_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing required field","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","uniqueKey":"error.details.oneOf.0","typeLabel":"string"},{"type":"object","description":"Further detail about the error: a sentence, or for some errors an object (for example the `missing` list of `billing_location_required` or the `item_index` and `field_name` of `line_field_required`).","example":"The 'email' field is required","additionalProperties":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"}],"uniqueKey":"error.details","typeLabel":"string | object"},"hint":{"type":"string","description":"Additional guidance on how to resolve the error.","uniqueKey":"error.hint","typeLabel":"string"},"available_stock":{"type":"integer","description":"Current stock level (present on insufficient_stock errors).","uniqueKey":"error.available_stock","typeLabel":"integer"},"current_cart_quantity":{"type":"integer","description":"Quantity already in cart (present on insufficient_stock errors).","uniqueKey":"error.current_cart_quantity","typeLabel":"integer"},"limit":{"type":"integer","description":"Rate limit ceiling (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"Requests remaining in the current window (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.remaining","typeLabel":"integer"},"reset":{"type":"integer","description":"Unix timestamp when the rate limit / quota window resets (present on rate_limited / quota_exceeded errors).","uniqueKey":"error.reset","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"server_error","message":"An unexpected error occurred"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"server_error","message":"An unexpected error occurred"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6e41e8f3-c158-45fb-afcc-1643aef15f02":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"**API Key Authentication**\n \nUse your API key in the Authorization header:\n```\nAuthorization: Bearer tybrite_sk_live_YOUR_KEY\n```\n \n**Key Types:**\n \n**Secret Keys (Server-Side Only):**\n- Format: `tybrite_sk_live_*` (production) or `tybrite_sk_test_*` (sandbox)\n- Full read/write access to all endpoints\n- ⚠️ NEVER expose in client-side code or public repositories\n- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations\n \n**Publishable Keys (Client-Safe):**\n- Format: `tybrite_pk_live_*` (production) or `tybrite_pk_test_*` (sandbox)\n- Catalogue reads, plus the actions a shopper takes for themselves\n- ✅ Safe for client-side JavaScript, mobile apps, and public code\n- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist,\n reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents\n \n**Endpoint-Specific Requirements:**\n- **Authentication endpoints** (`/v1/auth/*`): state-changing `POST` calls require a secret key, for store and marketplace keys alike; `GET /v1/auth/me` accepts either key\n- **Payment verification** (`POST /v1/payments/verify`): Secret key required\n- **AI Recommendations** (`POST /v1/recommendations`): Secret key required\n- **Semantic Search** (`POST /v1/search`): Both key types allowed (read-only operation)\n- **Shopper actions** (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed\n- **All other write operations**: Secret key required\n- **All read operations**: Both key types allowed\n \nUsing a publishable key for restricted operations returns 403 Forbidden.\n\n**Limited publishable keys:**\nA publishable key can be limited to the products that carry one tag (for example `starter:jewellery`), created from\nthe store's Developers page. The limit applies to the key, never to the shopper: shopper sign-up and sign-in stay store-wide.\n- Reads return only the slice: products (with their facets, filters, search, brands and specifications), categories and\n subcategories that hold in-slice products, collections, promotions, posts and lookbooks that carry the tag, reviews of\n in-slice products, prices, discovery lists and the store information summary, with every count computed on the slice.\n A product outside the slice answers `404`, as if it did not exist.\n- A write that names a product or variant outside the slice (adding to the cart or wishlist, reserving stock, an order line,\n a review, a promotion calculation, a storefront event) answers `403` with the error code `out_of_scope`, and nothing is\n written or reserved. An order is refused as a whole.\n- A route that carries no slice behaviour is not available to the key: it answers `403` with `endpoint_not_allowed`.\n- Orders placed through such a key record the tag on the order's attribution as `key_scope`.\n- Secret keys and connected-app keys cannot be limited.\n- Responses are cached per key limit: a limited key never receives a response cached for the whole store, and the reverse.\n","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"a9261009-7b5a-4dee-9970-34482b20107c":{"url":"https://api.tybritelabs.com","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"**API Key Authentication**\n \nUse your API key in the Authorization header:\n```\nAuthorization: Bearer tybrite_sk_live_YOUR_KEY\n```\n \n**Key Types:**\n \n**Secret Keys (Server-Side Only):**\n- Format: `tybrite_sk_live_*` (production) or `tybrite_sk_test_*` (sandbox)\n- Full read/write access to all endpoints\n- ⚠️ NEVER expose in client-side code or public repositories\n- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations\n \n**Publishable Keys (Client-Safe):**\n- Format: `tybrite_pk_live_*` (production) or `tybrite_pk_test_*` (sandbox)\n- Catalogue reads, plus the actions a shopper takes for themselves\n- ✅ Safe for client-side JavaScript, mobile apps, and public code\n- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist,\n reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents\n \n**Endpoint-Specific Requirements:**\n- **Authentication endpoints** (`/v1/auth/*`): state-changing `POST` calls require a secret key, for store and marketplace keys alike; `GET /v1/auth/me` accepts either key\n- **Payment verification** (`POST /v1/payments/verify`): Secret key required\n- **AI Recommendations** (`POST /v1/recommendations`): Secret key required\n- **Semantic Search** (`POST /v1/search`): Both key types allowed (read-only operation)\n- **Shopper actions** (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed\n- **All other write operations**: Secret key required\n- **All read operations**: Both key types allowed\n \nUsing a publishable key for restricted operations returns 403 Forbidden.\n\n**Limited publishable keys:**\nA publishable key can be limited to the products that carry one tag (for example `starter:jewellery`), created from\nthe store's Developers page. The limit applies to the key, never to the shopper: shopper sign-up and sign-in stay store-wide.\n- Reads return only the slice: products (with their facets, filters, search, brands and specifications), categories and\n subcategories that hold in-slice products, collections, promotions, posts and lookbooks that carry the tag, reviews of\n in-slice products, prices, discovery lists and the store information summary, with every count computed on the slice.\n A product outside the slice answers `404`, as if it did not exist.\n- A write that names a product or variant outside the slice (adding to the cart or wishlist, reserving stock, an order line,\n a review, a promotion calculation, a storefront event) answers `403` with the error code `out_of_scope`, and nothing is\n written or reserved. An order is refused as a whole.\n- A route that carries no slice behaviour is not available to the key: it answers `403` with `endpoint_not_allowed`.\n- Orders placed through such a key record the tag on the order's attribution as `key_scope`.\n- Secret keys and connected-app keys cannot be limited.\n- Responses are cached per key limit: a limited key never receives a response cached for the whole store, and the reverse.\n","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"**API Key Authentication**\n \nUse your API key in the Authorization header:\n```\nAuthorization: Bearer tybrite_sk_live_YOUR_KEY\n```\n \n**Key Types:**\n \n**Secret Keys (Server-Side Only):**\n- Format: `tybrite_sk_live_*` (production) or `tybrite_sk_test_*` (sandbox)\n- Full read/write access to all endpoints\n- ⚠️ NEVER expose in client-side code or public repositories\n- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations\n \n**Publishable Keys (Client-Safe):**\n- Format: `tybrite_pk_live_*` (production) or `tybrite_pk_test_*` (sandbox)\n- Catalogue reads, plus the actions a shopper takes for themselves\n- ✅ Safe for client-side JavaScript, mobile apps, and public code\n- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist,\n reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents\n \n**Endpoint-Specific Requirements:**\n- **Authentication endpoints** (`/v1/auth/*`): state-changing `POST` calls require a secret key, for store and marketplace keys alike; `GET /v1/auth/me` accepts either key\n- **Payment verification** (`POST /v1/payments/verify`): Secret key required\n- **AI Recommendations** (`POST /v1/recommendations`): Secret key required\n- **Semantic Search** (`POST /v1/search`): Both key types allowed (read-only operation)\n- **Shopper actions** (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed\n- **All other write operations**: Secret key required\n- **All read operations**: Both key types allowed\n \nUsing a publishable key for restricted operations returns 403 Forbidden.\n\n**Limited publishable keys:**\nA publishable key can be limited to the products that carry one tag (for example `starter:jewellery`), created from\nthe store's Developers page. The limit applies to the key, never to the shopper: shopper sign-up and sign-in stay store-wide.\n- Reads return only the slice: products (with their facets, filters, search, brands and specifications), categories and\n subcategories that hold in-slice products, collections, promotions, posts and lookbooks that carry the tag, reviews of\n in-slice products, prices, discovery lists and the store information summary, with every count computed on the slice.\n A product outside the slice answers `404`, as if it did not exist.\n- A write that names a product or variant outside the slice (adding to the cart or wishlist, reserving stock, an order line,\n a review, a promotion calculation, a storefront event) answers `403` with the error code `out_of_scope`, and nothing is\n written or reserved. An order is refused as a whole.\n- A route that carries no slice behaviour is not available to the key: it answers `403` with `endpoint_not_allowed`.\n- Orders placed through such a key record the tag on the order's attribution as `key_scope`.\n- Secret keys and connected-app keys cannot be limited.\n- Responses are cached per key limit: a limited key never receives a response cached for the whole store, and the reverse.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"tybritelabs","siteName":"Galactic Core API Documentation","title":"Ask for a copy of my data, or for my account to be deleted - Galactic Core API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T11:03:29.043Z","originalFileLocation":"api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Make a request on behalf of the signed-in shopper: export for a copy of the personal data the store holds about them, or erasure for the deletion of their account and that data. An erasure must carry confirm: true, sent only after the shopper has confirmed in the storefront. What happens next is the store\u0026#x27;s choice: - The store reviews each request (the default). The request is requested until the store approves or declines it. An approved export can be downloaded for seven days from GET /v1/customers/{id}/data-requests/{request_id}/export; an approved erasure is carried out by the store. - Shoppers complete their own requests. An export is approved at once and can be downloaded straight away; an erasure is carried out at once and the request is completed. An erasure is refused with 409 while the shopper has a Subscribe \u0026amp; Save subscription still running, paid orders not yet shipped, or a business buyer account; the message says which. After an erasure, records the store must keep (such as sales) remain with the personal details removed, and the shopper\u0026#x27;s sign-in no longer resolves to a customer. Each shopper has one open request of each kind: asking again while one is waiting, or while an export is still downloadable, returns that request with created: false and status 200. A repeated Idempotency-Key returns the request it first created. Customer-self access. Works with a publishable key (safe from the browser). Provide the shopper\u0026#x27;s session token in the x-auth-token header (or the store\u0026#x27;s bring-your-own-auth assertion in x-external-auth); it must resolve to the customer in the {id} path parameter, otherwise the request returns 403. Limited to 5 requests per shopper per hour.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Galactic Core API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tybritelabs/d0xYWWdjx3Q9ZfW_/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/tybritelabs/d0xYWWdjx3Q9ZfW_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tybritelabs/d0xYWWdjx3Q9ZfW_/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tybritelabs/d0xYWWdjx3Q9ZfW_/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tybritelabs/d0xYWWdjx3Q9ZfW_/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tybritelabs/d0xYWWdjx3Q9ZfW_/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tybritelabs/d0xYWWdjx3Q9ZfW_/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tybritelabs/d0xYWWdjx3Q9ZfW_/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tybritelabs/d0xYWWdjx3Q9ZfW_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Ask for a copy of my data, or for my account to be deleted - Galactic Core API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Make a request on behalf of the signed-in shopper: export for a copy of the personal data the store holds about them, or erasure for the deletion of their account and that data. An erasure must carry confirm: true, sent only after the shopper has confirmed in the storefront. What happens next is the store\u0026#x27;s choice: - The store reviews each request (the default). The request is requested until the store approves or declines it. An approved export can be downloaded for seven days from GET /v1/customers/{id}/data-requests/{request_id}/export; an approved erasure is carried out by the store. - Shoppers complete their own requests. An export is approved at once and can be downloaded straight away; an erasure is carried out at once and the request is completed. An erasure is refused with 409 while the shopper has a Subscribe \u0026amp; Save subscription still running, paid orders not yet shipped, or a business buyer account; the message says which. After an erasure, records the store must keep (such as sales) remain with the personal details removed, and the shopper\u0026#x27;s sign-in no longer resolves to a customer. Each shopper has one open request of each kind: asking again while one is waiting, or while an export is still downloadable, returns that request with created: false and status 200. A repeated Idempotency-Key returns the request it first created. Customer-self access. Works with a publishable key (safe from the browser). Provide the shopper\u0026#x27;s session token in the x-auth-token header (or the store\u0026#x27;s bring-your-own-auth assertion in x-external-auth); it must resolve to the customer in the {id} path parameter, otherwise the request returns 403. Limited to 5 requests per shopper per hour.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Galactic Core API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tybritelabs.com/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tybritelabs.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Ask+for+a+copy+of+my+data%2C+or+for+my+account+to+be+deleted\u0026amp;description=Make+a+request+on+behalf+of+the+signed-in+shopper%3A+%60export%60+for+a+copy+of+the+personal+data+the+store+holds%0Aabout+them%2C+or+%60erasure%60+for+the+deletion+of+their+a\u0026amp;theme=e2a958a3415fbc57a167c80a\u0026amp;signature=22a84da078ac1abd642d37a47ce1d6431525212135f1ffc404732324358acc09\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Ask for a copy of my data, or for my account to be deleted - Galactic Core API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Make a request on behalf of the signed-in shopper: export for a copy of the personal data the store holds about them, or erasure for the deletion of their account and that data. An erasure must carry confirm: true, sent only after the shopper has confirmed in the storefront. What happens next is the store\u0026#x27;s choice: - The store reviews each request (the default). The request is requested until the store approves or declines it. An approved export can be downloaded for seven days from GET /v1/customers/{id}/data-requests/{request_id}/export; an approved erasure is carried out by the store. - Shoppers complete their own requests. An export is approved at once and can be downloaded straight away; an erasure is carried out at once and the request is completed. An erasure is refused with 409 while the shopper has a Subscribe \u0026amp; Save subscription still running, paid orders not yet shipped, or a business buyer account; the message says which. After an erasure, records the store must keep (such as sales) remain with the personal details removed, and the shopper\u0026#x27;s sign-in no longer resolves to a customer. Each shopper has one open request of each kind: asking again while one is waiting, or while an export is still downloadable, returns that request with created: false and status 200. A repeated Idempotency-Key returns the request it first created. Customer-self access. Works with a publishable key (safe from the browser). Provide the shopper\u0026#x27;s session token in the x-auth-token header (or the store\u0026#x27;s bring-your-own-auth assertion in x-external-auth); it must resolve to the customer in the {id} path parameter, otherwise the request returns 403. Limited to 5 requests per shopper per hour.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tybritelabs.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Ask+for+a+copy+of+my+data%2C+or+for+my+account+to+be+deleted\u0026amp;description=Make+a+request+on+behalf+of+the+signed-in+shopper%3A+%60export%60+for+a+copy+of+the+personal+data+the+store+holds%0Aabout+them%2C+or+%60erasure%60+for+the+deletion+of+their+a\u0026amp;theme=e2a958a3415fbc57a167c80a\u0026amp;signature=22a84da078ac1abd642d37a47ce1d6431525212135f1ffc404732324358acc09\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/tybritelabs/d0xYWWdjx3Q9ZfW_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Galactic Core API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3b82f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tybritelabs.com/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tybritelabs.com/#organization\",\"name\":\"Galactic Core API Documentation\",\"url\":\"https://docs.tybritelabs.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tybritelabs/9cNSmgnBxs-QU_UC/branding/gc-long-blue.png?fit=max\u0026auto=format\u0026n=9cNSmgnBxs-QU_UC\u0026q=85\u0026s=88d64ea989973d874ed73437459487f7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tybritelabs.com#website\",\"name\":\"Galactic Core API Documentation\",\"url\":\"https://docs.tybritelabs.com\",\"publisher\":{\"@id\":\"https://docs.tybritelabs.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tybritelabs.com/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted#webpage\",\"url\":\"https://docs.tybritelabs.com/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted\",\"name\":\"Ask for a copy of my data, or for my account to be deleted\",\"description\":\"Make a request on behalf of the signed-in shopper: export for a copy of the personal data the store holds about them, or erasure for the deletion of their account and that data. An erasure must carry confirm: true, sent only after the shopper has confirmed in the storefront. What happens next is the store's choice: - The store reviews each request (the default). The request is requested until the store approves or declines it. An approved export can be downloaded for seven days from GET /v1/customers/{id}/data-requests/{request_id}/export; an approved erasure is carried out by the store. - Shoppers complete their own requests. An export is approved at once and can be downloaded straight away; an erasure is carried out at once and the request is completed. An erasure is refused with 409 while the shopper has a Subscribe \u0026 Save subscription still running, paid orders not yet shipped, or a business buyer account; the message says which. After an erasure, records the store must keep (such as sales) remain with the personal details removed, and the shopper's sign-in no longer resolves to a customer. Each shopper has one open request of each kind: asking again while one is waiting, or while an export is still downloadable, returns that request with created: false and status 200. A repeated Idempotency-Key returns the request it first created. Customer-self access. Works with a publishable key (safe from the browser). Provide the shopper's session token in the x-auth-token header (or the store's bring-your-own-auth assertion in x-external-auth); it must resolve to the customer in the {id} path parameter, otherwise the request returns 403. Limited to 5 requests per shopper per hour.\",\"dateModified\":\"2026-11-18T11:03:29.043Z\",\"isPartOf\":{\"@id\":\"https://docs.tybritelabs.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tybritelabs.com/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tybritelabs.com/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customers\",\"item\":\"https://docs.tybritelabs.com/api-reference/customers/create-customer\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ask for a copy of my data, or for my account to be deleted\",\"item\":\"https://docs.tybritelabs.com/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tybritelabs.com/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted#apireference\",\"headline\":\"Ask for a copy of my data, or for my account to be deleted\",\"name\":\"Ask for a copy of my data, or for my account to be deleted\",\"description\":\"Make a request on behalf of the signed-in shopper: export for a copy of the personal data the store holds about them, or erasure for the deletion of their account and that data. An erasure must carry confirm: true, sent only after the shopper has confirmed in the storefront. What happens next is the store's choice: - The store reviews each request (the default). The request is requested until the store approves or declines it. An approved export can be downloaded for seven days from GET /v1/customers/{id}/data-requests/{request_id}/export; an approved erasure is carried out by the store. - Shoppers complete their own requests. An export is approved at once and can be downloaded straight away; an erasure is carried out at once and the request is completed. An erasure is refused with 409 while the shopper has a Subscribe \u0026 Save subscription still running, paid orders not yet shipped, or a business buyer account; the message says which. After an erasure, records the store must keep (such as sales) remain with the personal details removed, and the shopper's sign-in no longer resolves to a customer. Each shopper has one open request of each kind: asking again while one is waiting, or while an export is still downloadable, returns that request with created: false and status 200. A repeated Idempotency-Key returns the request it first created. Customer-self access. Works with a publishable key (safe from the browser). Provide the shopper's session token in the x-auth-token header (or the store's bring-your-own-auth assertion in x-external-auth); it must resolve to the customer in the {id} path parameter, otherwise the request returns 403. Limited to 5 requests per shopper per hour.\",\"url\":\"https://docs.tybritelabs.com/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tybritelabs.com/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted#webpage\"},\"dateModified\":\"2026-11-18T11:03:29.043Z\",\"publisher\":{\"@id\":\"https://docs.tybritelabs.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tybritelabs.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Galactic Core API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Galactic Core API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted.md","siteName":"Galactic Core API Documentation","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://gc.tybritelabs.com/dashboard"},{"anchor":"GitHub","icon":"github","href":"https://github.com/tybrite"},{"anchor":"Support","icon":"envelope","href":"mailto:support@tybrite.com"}]},"products":[{"product":"Galactic Core","icon":"cart-shopping","description":"Programmable commerce infrastructure","tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":""}]},{"tab":"API Reference","groups":[{"group":"Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"System","pages":[{"title":"API information","deprecated":null,"version":null,"openapi":"/openapi.yaml get /","href":"/api-reference/system/api-information"},{"title":"Health check","deprecated":null,"version":null,"openapi":"/tldp/openapi.yaml get /v1/health","href":"/api-reference/system/health-check"},{"title":"Get comprehensive store information","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/store/info","href":"/api-reference/system/get-comprehensive-store-information"}]},{"group":"Store","pages":[{"title":"Get the store profile","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/store/profile","href":"/api-reference/store/get-the-store-profile"},{"title":"List published policies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/store/policies","href":"/api-reference/store/list-published-policies"},{"title":"Get a published policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/store/policies/{slug}","href":"/api-reference/store/get-a-published-policy"}]},{"group":"Products","pages":[{"title":"List products with filtering and pagination","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products","href":"/api-reference/products/list-products-with-filtering-and-pagination"},{"title":"List brands","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/brands","href":"/api-reference/products/list-brands"},{"title":"List the values a product list can be filtered by","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/facets","href":"/api-reference/products/list-the-values-a-product-list-can-be-filtered-by"},{"title":"Get product by ID or variant ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{id}","href":"/api-reference/products/get-product-by-id-or-variant-id"},{"title":"Get product by SEO-friendly slug","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/by-slug/{slug}","href":"/api-reference/products/get-product-by-seo-friendly-slug"},{"title":"Get a variant's specifications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{id}/specifications","href":"/api-reference/products/get-a-variants-specifications"},{"title":"Get a product's custom fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{id}/custom-fields","href":"/api-reference/products/get-a-products-custom-fields"},{"title":"List product specifications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/product-specifications","href":"/api-reference/products/list-product-specifications"},{"title":"List product collections","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/product-collections","href":"/api-reference/products/list-product-collections"},{"title":"Get product collection by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/product-collections/{id}","href":"/api-reference/products/get-product-collection-by-id"},{"title":"Get items in a product collection","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/product-collections/{id}/items","href":"/api-reference/products/get-items-in-a-product-collection"}]},{"group":"Taxonomy","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/categories","href":"/api-reference/taxonomy/list-categories"},{"title":"Get category","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/categories/{id}","href":"/api-reference/taxonomy/get-category"},{"title":"List subcategories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/subcategories","href":"/api-reference/taxonomy/list-subcategories"},{"title":"Get subcategory by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/subcategories/{id}","href":"/api-reference/taxonomy/get-subcategory-by-id"}]},{"group":"Orders","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/orders","href":"/api-reference/orders/list-orders"},{"title":"Create order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/orders","href":"/api-reference/orders/create-order"},{"title":"Get order details","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/orders/{id}","href":"/api-reference/orders/get-order-details"},{"title":"Update order","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/orders/{id}","href":"/api-reference/orders/update-order"},{"title":"Reserve stock for checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/checkout/reserve","href":"/api-reference/orders/reserve-stock-for-checkout"}]},{"group":"Payments","pages":[{"title":"Get available payment methods","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/payments/methods","href":"/api-reference/payments/get-available-payment-methods"},{"title":"Initialize payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/payments/initialize","href":"/api-reference/payments/initialize-payment"},{"title":"Verify payment status","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/payments/verify","href":"/api-reference/payments/verify-payment-status"}]},{"group":"Cart \u0026 Wishlist","pages":[{"title":"Get cart","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/cart","href":"/api-reference/cart-\u0026-wishlist/get-cart"},{"title":"Clear cart","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/cart","href":"/api-reference/cart-\u0026-wishlist/clear-cart"},{"title":"Add to cart","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/cart/items","href":"/api-reference/cart-\u0026-wishlist/add-to-cart"},{"title":"Remove cart item","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/cart/items/{id}","href":"/api-reference/cart-\u0026-wishlist/remove-cart-item"},{"title":"Update cart item","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/cart/items/{id}","href":"/api-reference/cart-\u0026-wishlist/update-cart-item"},{"title":"Merge carts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/cart/merge","href":"/api-reference/cart-\u0026-wishlist/merge-carts"},{"title":"Get wishlist","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/wishlist","href":"/api-reference/cart-\u0026-wishlist/get-wishlist"},{"title":"Add to wishlist","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/wishlist","href":"/api-reference/cart-\u0026-wishlist/add-to-wishlist"},{"title":"Remove from wishlist","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/wishlist/{id}","href":"/api-reference/cart-\u0026-wishlist/remove-from-wishlist"},{"title":"Move wishlist item to cart","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/wishlist/move-to-cart","href":"/api-reference/cart-\u0026-wishlist/move-wishlist-item-to-cart"},{"title":"Ask to be told when a variant is back in stock","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/variants/{id}/notify-when-available","href":"/api-reference/cart-\u0026-wishlist/ask-to-be-told-when-a-variant-is-back-in-stock"},{"title":"Record a guest's contact details at checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/cart/checkout-contact","href":"/api-reference/cart-\u0026-wishlist/record-a-guests-contact-details-at-checkout"},{"title":"Restore the cart behind a recovery link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/cart/checkout-recover","href":"/api-reference/cart-\u0026-wishlist/restore-the-cart-behind-a-recovery-link"}]},{"group":"Marketplace","pages":[{"title":"Check out a multi-merchant cart","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/cart/checkout","href":"/api-reference/marketplace/check-out-a-multi-merchant-cart"},{"title":"Quote a multi-merchant checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/cart/checkout/quote","href":"/api-reference/marketplace/quote-a-multi-merchant-checkout"},{"title":"Get the signed-in shopper's unified marketplace profile","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/me","href":"/api-reference/marketplace/get-the-signed-in-shoppers-unified-marketplace-profile"},{"title":"Get the signed-in shopper's marketplace wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/me/wallet","href":"/api-reference/marketplace/get-the-signed-in-shoppers-marketplace-wallet"},{"title":"Get marketplace information","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/marketplace/info","href":"/api-reference/marketplace/get-marketplace-information"},{"title":"Get placements for a slot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/marketplace/ad-slots/{slot_key}","href":"/api-reference/marketplace/get-placements-for-a-slot"},{"title":"Log an ad impression or click","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/marketplace/ad-events","href":"/api-reference/marketplace/log-an-ad-impression-or-click"},{"title":"List operator-curated merchandising sections","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/marketplace/collections","href":"/api-reference/marketplace/list-operator-curated-merchandising-sections"},{"title":"Get one curated section with its members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/marketplace/collections/{slug}","href":"/api-reference/marketplace/get-one-curated-section-with-its-members"}]},{"group":"Recommendations","pages":[{"title":"Get product recommendations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/recommendations","href":"/api-reference/recommendations/get-product-recommendations"}]},{"group":"Discovery","pages":[{"title":"Most-viewed products (windowed)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/discovery/most-viewed","href":"/api-reference/discovery/most-viewed-products-windowed"},{"title":"Most-added-to-cart products (windowed)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/discovery/most-added-to-cart","href":"/api-reference/discovery/most-added-to-cart-products-windowed"},{"title":"Best-converting products (windowed)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/discovery/best-converting","href":"/api-reference/discovery/best-converting-products-windowed"}]},{"group":"Events","pages":[{"title":"Record a storefront product event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/events","href":"/api-reference/events/record-a-storefront-product-event"}]},{"group":"Tax","pages":[{"title":"Preview tax for a cart before checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/tax/preview","href":"/api-reference/tax/preview-tax-for-a-cart-before-checkout"}]},{"group":"Analytics","pages":[{"title":"Record a storefront analytics event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/analytics/collect","href":"/api-reference/analytics/record-a-storefront-analytics-event"}]},{"group":"Agent","pages":[{"title":"List the agent tools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/capabilities","href":"/api-reference/agent/list-the-agent-tools"},{"title":"Search by constraints","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/search","href":"/api-reference/agent/search-by-constraints"},{"title":"Read a shopper's message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/interpret","href":"/api-reference/agent/read-a-shoppers-message"},{"title":"Get a product dossier","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/products/{id}/context","href":"/api-reference/agent/get-a-product-dossier"},{"title":"Compare products","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/compare","href":"/api-reference/agent/compare-products"},{"title":"Check a product against constraints","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/fit","href":"/api-reference/agent/check-a-product-against-constraints"},{"title":"Find alternatives to a product","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/alternatives","href":"/api-reference/agent/find-alternatives-to-a-product"},{"title":"Price a basket","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/quote","href":"/api-reference/agent/price-a-basket"},{"title":"Create a cart draft","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/cart-drafts","href":"/api-reference/agent/create-a-cart-draft"},{"title":"Draft a cart from an intent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/cart-drafts/from-intent","href":"/api-reference/agent/draft-a-cart-from-an-intent"},{"title":"Get a cart draft","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/cart-drafts/{id}","href":"/api-reference/agent/get-a-cart-draft"},{"title":"Add a draft to the shopper's cart","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/cart-drafts/{id}/apply","href":"/api-reference/agent/add-a-draft-to-the-shoppers-cart"},{"title":"Get insights on a cart","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/cart-insights","href":"/api-reference/agent/get-insights-on-a-cart"},{"title":"Get the shopper's personalisation consent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/me/consent","href":"/api-reference/agent/get-the-shoppers-personalisation-consent"},{"title":"Grant or revoke personalisation consent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/consent","href":"/api-reference/agent/grant-or-revoke-personalisation-consent"},{"title":"Get the shopper's own context","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/me/context","href":"/api-reference/agent/get-the-shoppers-own-context"},{"title":"Get wishlist insights","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/me/wishlist-insights","href":"/api-reference/agent/get-wishlist-insights"},{"title":"Get reorder suggestions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/me/reorder-suggestions","href":"/api-reference/agent/get-reorder-suggestions"},{"title":"Get an order's status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/orders/{id}/status","href":"/api-reference/agent/get-an-orders-status"},{"title":"Request a return for an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/orders/{id}/returns","href":"/api-reference/agent/request-a-return-for-an-order"},{"title":"List the shopper's standing instructions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/me/mandates","href":"/api-reference/agent/list-the-shoppers-standing-instructions"},{"title":"Create a standing instruction","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/mandates","href":"/api-reference/agent/create-a-standing-instruction"},{"title":"Cancel a standing instruction","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/mandates/{id}/cancel","href":"/api-reference/agent/cancel-a-standing-instruction"},{"title":"Subscribe \u0026 Save offers on a product","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/products/{id}/subscribe-save","href":"/api-reference/agent/subscribe-\u0026-save-offers-on-a-product"},{"title":"List the shopper's assistant conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/me/conversations","href":"/api-reference/agent/list-the-shoppers-assistant-conversations"},{"title":"Start an assistant conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/conversations","href":"/api-reference/agent/start-an-assistant-conversation"},{"title":"Delete all of the shopper's assistant conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/agent/me/conversations","href":"/api-reference/agent/delete-all-of-the-shoppers-assistant-conversations"},{"title":"Move a guest's conversations to the shopper who signed in","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/conversations/adopt","href":"/api-reference/agent/move-a-guests-conversations-to-the-shopper-who-signed-in"},{"title":"Get an assistant conversation with its turns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/me/conversations/{id}","href":"/api-reference/agent/get-an-assistant-conversation-with-its-turns"},{"title":"Delete an assistant conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/agent/me/conversations/{id}","href":"/api-reference/agent/delete-an-assistant-conversation"},{"title":"Add a turn to an assistant conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/conversations/{id}/turns","href":"/api-reference/agent/add-a-turn-to-an-assistant-conversation"},{"title":"List the shopper's Subscribe \u0026 Save subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/me/shopper-subscriptions","href":"/api-reference/agent/list-the-shoppers-subscribe-\u0026-save-subscriptions"},{"title":"Start a Subscribe \u0026 Save subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/shopper-subscriptions","href":"/api-reference/agent/start-a-subscribe-\u0026-save-subscription"},{"title":"Pause a Subscribe \u0026 Save subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/shopper-subscriptions/{id}/pause","href":"/api-reference/agent/pause-a-subscribe-\u0026-save-subscription"},{"title":"Skip the next Subscribe \u0026 Save delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/shopper-subscriptions/{id}/skip","href":"/api-reference/agent/skip-the-next-subscribe-\u0026-save-delivery"},{"title":"Cancel a Subscribe \u0026 Save subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/shopper-subscriptions/{id}/cancel","href":"/api-reference/agent/cancel-a-subscribe-\u0026-save-subscription"},{"title":"Change a Subscribe \u0026 Save subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/me/shopper-subscriptions/{id}/update","href":"/api-reference/agent/change-a-subscribe-\u0026-save-subscription"},{"title":"Create a checkout intent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/checkout-intents","href":"/api-reference/agent/create-a-checkout-intent"},{"title":"Get a checkout intent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/checkout-intents/{id}","href":"/api-reference/agent/get-a-checkout-intent"},{"title":"Confirm a checkout intent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/checkout-intents/{id}/confirm","href":"/api-reference/agent/confirm-a-checkout-intent"},{"title":"Cancel a checkout intent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agent/checkout-intents/{id}/cancel","href":"/api-reference/agent/cancel-a-checkout-intent"},{"title":"Get the store's policies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/store-policies","href":"/api-reference/agent/get-the-stores-policies"},{"title":"Get AI credit usage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agent/usage","href":"/api-reference/agent/get-ai-credit-usage"}]},{"group":"Search","pages":[{"title":"Simple text search","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/search","href":"/api-reference/search/simple-text-search"},{"title":"Semantic search","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/search","href":"/api-reference/search/semantic-search"},{"title":"Type-ahead suggestions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/search/autocomplete","href":"/api-reference/search/type-ahead-suggestions"}]},{"group":"Authentication","pages":[{"title":"Register customer account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/register","href":"/api-reference/authentication/register-customer-account"},{"title":"Confirm a new account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/register/verify","href":"/api-reference/authentication/confirm-a-new-account"},{"title":"Resend the confirmation email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/register/resend","href":"/api-reference/authentication/resend-the-confirmation-email"},{"title":"Create an account from a guest order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/claim-account","href":"/api-reference/authentication/create-an-account-from-a-guest-order"},{"title":"Login with email and password","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/login","href":"/api-reference/authentication/login-with-email-and-password"},{"title":"Logout current session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/logout","href":"/api-reference/authentication/logout-current-session"},{"title":"Send a sign-in code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/magic-link","href":"/api-reference/authentication/send-a-sign-in-code"},{"title":"Verify a sign-in code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/verify-otp","href":"/api-reference/authentication/verify-a-sign-in-code"},{"title":"Request a password reset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/password/forgot","href":"/api-reference/authentication/request-a-password-reset"},{"title":"Reset a password","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/password/reset","href":"/api-reference/authentication/reset-a-password"},{"title":"Change or set a password","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/password/change","href":"/api-reference/authentication/change-or-set-a-password"},{"title":"Refresh access token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/auth/refresh","href":"/api-reference/authentication/refresh-access-token"},{"title":"Get current user","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/auth/me","href":"/api-reference/authentication/get-current-user"}]},{"group":"Customers","pages":[{"title":"Create customer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers","href":"/api-reference/customers/create-customer"},{"title":"Get customer details","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/{id}","href":"/api-reference/customers/get-customer-details"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/customers/{id}","href":"/api-reference/customers/update-customer"},{"title":"List a shopper's saved addresses","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/{id}/addresses","href":"/api-reference/customers/list-a-shoppers-saved-addresses"},{"title":"Save a new address","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers/{id}/addresses","href":"/api-reference/customers/save-a-new-address"},{"title":"Delete a saved address","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/customers/{id}/addresses/{addressId}","href":"/api-reference/customers/delete-a-saved-address"},{"title":"Update a saved address","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/customers/{id}/addresses/{addressId}","href":"/api-reference/customers/update-a-saved-address"},{"title":"List a shopper's Subscribe \u0026 Save subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/{id}/shopper-subscriptions","href":"/api-reference/customers/list-a-shoppers-subscribe-\u0026-save-subscriptions"},{"title":"Get a Subscribe \u0026 Save subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/{id}/shopper-subscriptions/{subscriptionId}","href":"/api-reference/customers/get-a-subscribe-\u0026-save-subscription"},{"title":"Change a Subscribe \u0026 Save subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/customers/{id}/shopper-subscriptions/{subscriptionId}","href":"/api-reference/customers/change-a-subscribe-\u0026-save-subscription"},{"title":"Pause a Subscribe \u0026 Save subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers/{id}/shopper-subscriptions/{subscriptionId}/pause","href":"/api-reference/customers/pause-a-subscribe-\u0026-save-subscription"},{"title":"Resume a paused Subscribe \u0026 Save subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers/{id}/shopper-subscriptions/{subscriptionId}/resume","href":"/api-reference/customers/resume-a-paused-subscribe-\u0026-save-subscription"},{"title":"Skip the next Subscribe \u0026 Save delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers/{id}/shopper-subscriptions/{subscriptionId}/skip-next","href":"/api-reference/customers/skip-the-next-subscribe-\u0026-save-delivery"},{"title":"Cancel a Subscribe \u0026 Save subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers/{id}/shopper-subscriptions/{subscriptionId}/cancel","href":"/api-reference/customers/cancel-a-subscribe-\u0026-save-subscription"},{"title":"Add a card to a Subscribe \u0026 Save subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers/{id}/shopper-subscriptions/{subscriptionId}/payment-method","href":"/api-reference/customers/add-a-card-to-a-subscribe-\u0026-save-subscription"},{"title":"List a shopper's saved cards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/{id}/payment-methods","href":"/api-reference/customers/list-a-shoppers-saved-cards"},{"title":"Remove a saved card","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/customers/{id}/payment-methods/{paymentMethodId}","href":"/api-reference/customers/remove-a-saved-card"},{"title":"List a shopper's data requests","description":"Return the signed-in shopper's requests for a copy of their data and for the deletion of their account, newest\nfirst (at most 50), with where each one stands. A declined request carries the store's reason; an approved export\nshows when its download window ends.\n\n**Customer-self access.** Works with a publishable key (safe from the\nbrowser). Provide the shopper's session token in the `x-auth-token`\nheader (or the store's bring-your-own-auth assertion in `x-external-auth`);\nit must resolve to the customer in the `{id}` path parameter, otherwise the\nrequest returns `403`. A sandbox key sees sandbox requests only.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/{id}/data-requests","href":"/api-reference/customers/list-a-shoppers-data-requests"},{"title":"Ask for a copy of my data, or for my account to be deleted","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers/{id}/data-requests","href":"/api-reference/customers/ask-for-a-copy-of-my-data-or-for-my-account-to-be-deleted"},{"title":"Download a copy of my data","description":"Return the shopper's data as JSON for an export request the store approved (or that completed at once), during\nits seven-day download window. The copy is built when it is downloaded, so it reflects the store's records at\nthat moment. The response is sent as an attachment and is never cached.\n\n`409` when the request is still waiting, was declined, or its download window has ended (make a new request\nfor a fresh copy). Another shopper's request, an erasure request, or an id from the other environment returns\n`404`.\n\n**Customer-self access.** Works with a publishable key (safe from the\nbrowser). Provide the shopper's session token in the `x-auth-token`\nheader (or the store's bring-your-own-auth assertion in `x-external-auth`);\nit must resolve to the customer in the `{id}` path parameter, otherwise the\nrequest returns `403`. Limited to 10 downloads per shopper per hour.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/{id}/data-requests/{request_id}/export","href":"/api-reference/customers/download-a-copy-of-my-data"},{"title":"List a shopper's delivered items","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/{id}/fulfilments","href":"/api-reference/customers/list-a-shoppers-delivered-items"},{"title":"Reveal the codes of a delivered item","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers/{id}/fulfilments/{fulfilment_id}/reveal","href":"/api-reference/customers/reveal-the-codes-of-a-delivered-item"},{"title":"Download a file the shopper bought","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/fulfilment/downloads/{fulfilment_id}/{asset_id}","href":"/api-reference/customers/download-a-file-the-shopper-bought"}]},{"group":"Gift Cards","pages":[{"title":"List gift cards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/gift-cards","href":"/api-reference/gift-cards/list-gift-cards"},{"title":"Check gift card balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/gift-cards/check","href":"/api-reference/gift-cards/check-gift-card-balance"}]},{"group":"Promotions","pages":[{"title":"List promotions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/promotions","href":"/api-reference/promotions/list-promotions"},{"title":"Get promotion details","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/promotions/{id}","href":"/api-reference/promotions/get-promotion-details"},{"title":"Calculate a promotion's discount for a cart","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/promotions/{id}/calculate","href":"/api-reference/promotions/calculate-a-promotions-discount-for-a-cart"},{"title":"Find the best promotion for a cart","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/promotions/calculate-best","href":"/api-reference/promotions/find-the-best-promotion-for-a-cart"},{"title":"List the Subscribe \u0026 Save offers for a product","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/subscribe-save/offers","href":"/api-reference/promotions/list-the-subscribe-\u0026-save-offers-for-a-product"},{"title":"Quote the price of a Subscribe \u0026 Save offer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/subscribe-save/quote","href":"/api-reference/promotions/quote-the-price-of-a-subscribe-\u0026-save-offer"}]},{"group":"Campaigns","pages":[{"title":"List running campaigns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/campaigns","href":"/api-reference/campaigns/list-running-campaigns"},{"title":"Get a running campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/campaigns/{id}","href":"/api-reference/campaigns/get-a-running-campaign"}]},{"group":"CMS","pages":[{"title":"List blog posts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/posts","href":"/api-reference/cms/list-blog-posts"},{"title":"Get blog post by slug","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/posts/{slug}","href":"/api-reference/cms/get-blog-post-by-slug"},{"title":"Most-read blog posts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/posts/trending","href":"/api-reference/cms/most-read-blog-posts"},{"title":"Posts related to this one","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/posts/{slug}/related","href":"/api-reference/cms/posts-related-to-this-one"},{"title":"List lookbooks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/lookbooks","href":"/api-reference/cms/list-lookbooks"},{"title":"Get lookbook details by slug","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/lookbooks/{slug}","href":"/api-reference/cms/get-lookbook-details-by-slug"},{"title":"Subscribe an email to the store's newsletter","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/newsletter/subscribe","href":"/api-reference/cms/subscribe-an-email-to-the-stores-newsletter"},{"title":"Get a lead form","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/lead-forms/{slug}","href":"/api-reference/cms/get-a-lead-form"},{"title":"Get a lead form token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/lead-forms/{slug}/token","href":"/api-reference/cms/get-a-lead-form-token"},{"title":"Submit a lead form","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/lead-forms/{slug}/submit","href":"/api-reference/cms/submit-a-lead-form"}]},{"group":"Pricing","pages":[{"title":"Get prices for multiple products with dynamic pricing and multi-currency support","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/prices/products","href":"/api-reference/pricing/get-prices-for-multiple-products-with-dynamic-pricing-and-multi-currency-support"},{"title":"Get single product pricing with dynamic pricing and multi-currency support","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/prices/products/{id}","href":"/api-reference/pricing/get-single-product-pricing-with-dynamic-pricing-and-multi-currency-support"},{"title":"Get product pricing by SEO-friendly slug with dynamic pricing and multi-currency support","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/prices/products/by-slug/{slug}","href":"/api-reference/pricing/get-product-pricing-by-seo-friendly-slug-with-dynamic-pricing-and-multi-currency-support"}]},{"group":"Messaging","pages":[{"title":"List message threads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/messaging/threads","href":"/api-reference/messaging/list-message-threads"},{"title":"Get thread details","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/messaging/threads/{id}","href":"/api-reference/messaging/get-thread-details"},{"title":"Update thread","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/messaging/threads/{id}","href":"/api-reference/messaging/update-thread"},{"title":"Get messages in a thread","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/messaging/threads/{id}/messages","href":"/api-reference/messaging/get-messages-in-a-thread"},{"title":"Send a message to a thread","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/messaging/threads/{id}/messages","href":"/api-reference/messaging/send-a-message-to-a-thread"},{"title":"Start a new conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/messaging/conversations","href":"/api-reference/messaging/start-a-new-conversation"},{"title":"Mark thread as read","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/messaging/threads/{id}/read","href":"/api-reference/messaging/mark-thread-as-read"},{"title":"Delete message","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/messaging/messages/{id}","href":"/api-reference/messaging/delete-message"},{"title":"Edit message","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/messaging/messages/{id}","href":"/api-reference/messaging/edit-message"},{"title":"Subscribe to a thread's new messages in realtime (WebSocket)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/messaging/threads/{id}/subscribe","href":"/api-reference/messaging/subscribe-to-a-threads-new-messages-in-realtime-websocket"},{"title":"Read a guest conversation from its email link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/messaging/guest-thread/view","href":"/api-reference/messaging/read-a-guest-conversation-from-its-email-link"},{"title":"Reply on a guest conversation from its email link","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/messaging/guest-thread/reply","href":"/api-reference/messaging/reply-on-a-guest-conversation-from-its-email-link"}]},{"group":"Shipping","pages":[{"title":"Get shipping zones and pricing tiers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/shipping/zones","href":"/api-reference/shipping/get-shipping-zones-and-pricing-tiers"},{"title":"Calculate shipping fee","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/shipping/calculate","href":"/api-reference/shipping/calculate-shipping-fee"},{"title":"Track a shipment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/shipping/tracking/{carrier}/{number}","href":"/api-reference/shipping/track-a-shipment"}]},{"group":"GC Connect","pages":[{"title":"Validate an authorization request","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/connect/authorize","href":"/api-reference/gc-connect/validate-an-authorization-request"},{"title":"Approve the authorization (merchant consent)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/connect/authorize","href":"/api-reference/gc-connect/approve-the-authorization-merchant-consent"},{"title":"Exchange authorization code for API keys","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/connect/token","href":"/api-reference/gc-connect/exchange-authorization-code-for-api-keys"},{"title":"Revoke a store connection","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/connect/revoke","href":"/api-reference/gc-connect/revoke-a-store-connection"},{"title":"List active store connections","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/connect/sessions","href":"/api-reference/gc-connect/list-active-store-connections"},{"title":"List the linked store's team","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/connect/team","href":"/api-reference/gc-connect/list-the-linked-stores-team"}]},{"group":"Storefront Studio","pages":[{"title":"Read the reported storefront address and routes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/storefront/site","href":"/api-reference/storefront-studio/read-the-reported-storefront-address-and-routes"},{"title":"Report the storefront's address and routes","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/storefront/site","href":"/api-reference/storefront-studio/report-the-storefronts-address-and-routes"},{"title":"List the app's A/B experiments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/storefront/experiments","href":"/api-reference/storefront-studio/list-the-apps-ab-experiments"},{"title":"Register or update an A/B experiment","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/storefront/experiments/{experiment_id}","href":"/api-reference/storefront-studio/register-or-update-an-ab-experiment"},{"title":"Read the paid orders for each variant of an experiment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/storefront/experiments/{experiment_id}/conversions","href":"/api-reference/storefront-studio/read-the-paid-orders-for-each-variant-of-an-experiment"},{"title":"List the support requests the app opened","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/storefront/tickets","href":"/api-reference/storefront-studio/list-the-support-requests-the-app-opened"},{"title":"Open a support request for the store","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/storefront/tickets","href":"/api-reference/storefront-studio/open-a-support-request-for-the-store"},{"title":"Read one support request the app opened","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/storefront/tickets/{ticket_id}","href":"/api-reference/storefront-studio/read-one-support-request-the-app-opened"},{"title":"List the templates the app offered","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/storefront/templates","href":"/api-reference/storefront-studio/list-the-templates-the-app-offered"},{"title":"Read a template the app offered","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/storefront/templates/{template_id}","href":"/api-reference/storefront-studio/read-a-template-the-app-offered"},{"title":"Offer a template for the store","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/storefront/templates/{template_id}","href":"/api-reference/storefront-studio/offer-a-template-for-the-store"},{"title":"Withdraw a template offer","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/storefront/templates/{template_id}","href":"/api-reference/storefront-studio/withdraw-a-template-offer"}]},{"group":"Reviews","pages":[{"title":"List reviews for a product","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/reviews","href":"/api-reference/reviews/list-reviews-for-a-product"},{"title":"Submit a product review","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/reviews","href":"/api-reference/reviews/submit-a-product-review"},{"title":"Get a single review","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/reviews/{id}","href":"/api-reference/reviews/get-a-single-review"},{"title":"Delete your own review","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/reviews/{id}","href":"/api-reference/reviews/delete-your-own-review"},{"title":"Mark a review as helpful","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/reviews/{id}/helpful","href":"/api-reference/reviews/mark-a-review-as-helpful"}]},{"group":"Returns","pages":[{"title":"List return reason codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/returns/reasons","href":"/api-reference/returns/list-return-reason-codes"},{"title":"Check whether an order can still be returned","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/returns/eligibility","href":"/api-reference/returns/check-whether-an-order-can-still-be-returned"},{"title":"Get the customer's store credit balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/returns/store-credit","href":"/api-reference/returns/get-the-customers-store-credit-balance"},{"title":"List the signed-in customer's returns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/returns","href":"/api-reference/returns/list-the-signed-in-customers-returns"},{"title":"Lodge a return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/returns","href":"/api-reference/returns/lodge-a-return"},{"title":"Get one of the customer's returns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/returns/{id}","href":"/api-reference/returns/get-one-of-the-customers-returns"},{"title":"Accept a store credit offer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/returns/{id}/accept-credit","href":"/api-reference/returns/accept-a-store-credit-offer"},{"title":"Request a refund instead of store credit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/returns/{id}/request-refund","href":"/api-reference/returns/request-a-refund-instead-of-store-credit"}]},{"group":"Disputes","pages":[{"title":"List dispute reason codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/disputes/reasons","href":"/api-reference/disputes/list-dispute-reason-codes"},{"title":"List the shopper's disputes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/disputes","href":"/api-reference/disputes/list-the-shoppers-disputes"},{"title":"Open a dispute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/disputes","href":"/api-reference/disputes/open-a-dispute"},{"title":"Get a dispute","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/disputes/{id}","href":"/api-reference/disputes/get-a-dispute"},{"title":"Cancel a dispute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/disputes/{id}/cancel","href":"/api-reference/disputes/cancel-a-dispute"},{"title":"Add a message to a dispute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/disputes/{id}/messages","href":"/api-reference/disputes/add-a-message-to-a-dispute"}]},{"group":"B2B","pages":[{"title":"List your requests for quote","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/b2b/rfqs","href":"/api-reference/b2b/list-your-requests-for-quote"},{"title":"Request a quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/b2b/rfqs","href":"/api-reference/b2b/request-a-quote"},{"title":"Get one of your RFQs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/b2b/rfqs/{id}","href":"/api-reference/b2b/get-one-of-your-rfqs"},{"title":"Get a quote addressed to you","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/b2b/quotes/{id}","href":"/api-reference/b2b/get-a-quote-addressed-to-you"},{"title":"Accept a quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/b2b/quotes/{id}/accept","href":"/api-reference/b2b/accept-a-quote"},{"title":"Reject a quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/b2b/quotes/{id}/reject","href":"/api-reference/b2b/reject-a-quote"},{"title":"List your purchase orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/b2b/purchase-orders","href":"/api-reference/b2b/list-your-purchase-orders"},{"title":"Get one of your purchase orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/b2b/purchase-orders/{id}","href":"/api-reference/b2b/get-one-of-your-purchase-orders"},{"title":"List your invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/b2b/invoices","href":"/api-reference/b2b/list-your-invoices"},{"title":"Get one of your invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/b2b/invoices/{id}","href":"/api-reference/b2b/get-one-of-your-invoices"},{"title":"Start paying an invoice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/b2b/invoices/{id}/pay","href":"/api-reference/b2b/start-paying-an-invoice"},{"title":"List the approvals the signed-in approver can decide","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/b2b/approvals","href":"/api-reference/b2b/list-the-approvals-the-signed-in-approver-can-decide"},{"title":"Approve or reject a held purchase","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/b2b/approvals/{id}/decision","href":"/api-reference/b2b/approve-or-reject-a-held-purchase"},{"title":"Place a wholesale order directly (self-serve checkout)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/b2b/orders","href":"/api-reference/b2b/place-a-wholesale-order-directly-self-serve-checkout"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/tldp/openapi.yaml get /v1/webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/tldp/openapi.yaml post /v1/webhooks","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/webhook_endpoints/{id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/tldp/openapi.yaml delete /v1/webhooks/{webhookId}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/webhook_endpoints/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/tldp/openapi.yaml post /v1/webhooks/{webhookId}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List webhook events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/webhook_events","href":"/api-reference/webhooks/list-webhook-events"},{"title":"Get a webhook event","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/webhook_events/{id}","href":"/api-reference/webhooks/get-a-webhook-event"},{"title":"Retry a webhook event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/webhook_events/{id}/retry","href":"/api-reference/webhooks/retry-a-webhook-event"}]},{"group":"Ingestion","pages":[{"title":"Ingest a batch of products","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/ingest/products","href":"/api-reference/ingestion/ingest-a-batch-of-products"},{"title":"Get a sample product feed","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/ingest/sample","href":"/api-reference/ingestion/get-a-sample-product-feed"},{"title":"Validate a product feed (no writes)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/ingest/test","href":"/api-reference/ingestion/validate-a-product-feed-no-writes"}]},{"group":"Feeds","pages":[{"title":"Public catalog feed (JSON)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/feeds/{store}/products.json","href":"/api-reference/feeds/public-catalog-feed-json"},{"title":"Public catalog feed (XML)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/feeds/{store}/products.xml","href":"/api-reference/feeds/public-catalog-feed-xml"},{"title":"Store summary for AI assistants (llms.txt)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/feeds/{store}/llms.txt","href":"/api-reference/feeds/store-summary-for-ai-assistants-llmstxt"},{"title":"Full catalog for AI assistants (llms-full.txt)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/feeds/{store}/llms-full.txt","href":"/api-reference/feeds/full-catalog-for-ai-assistants-llms-fulltxt"},{"title":"How an AI assistant connects to a store (agent.json)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/feeds/{store}/agent.json","href":"/api-reference/feeds/how-an-ai-assistant-connects-to-a-store-agentjson"}]},{"group":"Sandbox","pages":[{"title":"Reset your sandbox data","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/sandbox/reset","href":"/api-reference/sandbox/reset-your-sandbox-data"},{"title":"Reset your sandbox data (alias)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/sandbox/data","href":"/api-reference/sandbox/reset-your-sandbox-data-alias"},{"title":"Fast-forward sandbox time","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/sandbox/time","href":"/api-reference/sandbox/fast-forward-sandbox-time"},{"title":"Replay a sandbox webhook event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/sandbox/webhooks/replay","href":"/api-reference/sandbox/replay-a-sandbox-webhook-event"},{"title":"Create a sandbox promotion","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/sandbox/seed/promotion","href":"/api-reference/sandbox/create-a-sandbox-promotion"},{"title":"Create a sandbox gift card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/sandbox/seed/gift-card","href":"/api-reference/sandbox/create-a-sandbox-gift-card"},{"title":"Create a sandbox campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/sandbox/seed/campaign","href":"/api-reference/sandbox/create-a-sandbox-campaign"},{"title":"Create a sandbox B2B buyer account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/sandbox/seed/b2b-buyer-account","href":"/api-reference/sandbox/create-a-sandbox-b2b-buyer-account"},{"title":"Create a sandbox dynamic-pricing rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/sandbox/seed/pricing-rule","href":"/api-reference/sandbox/create-a-sandbox-dynamic-pricing-rule"},{"title":"List sandbox stock levels","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/sandbox/stock","href":"/api-reference/sandbox/list-sandbox-stock-levels"},{"title":"Set sandbox stock levels","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/sandbox/stock","href":"/api-reference/sandbox/set-sandbox-stock-levels"},{"title":"Remove every sandbox stock level","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/sandbox/stock","href":"/api-reference/sandbox/remove-every-sandbox-stock-level"},{"title":"Remove one sandbox stock level","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/sandbox/stock/{variant_id}","href":"/api-reference/sandbox/remove-one-sandbox-stock-level"}]},{"group":"Agency Signup","pages":[{"title":"Get an agency's plans and its active automatic offers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/agency/pricing","href":"/api-reference/agency-signup/get-an-agencys-plans-and-its-active-automatic-offers"},{"title":"Get the platform's active automatic offers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/pricing/offers","href":"/api-reference/agency-signup/get-the-platforms-active-automatic-offers"},{"title":"Sign a merchant up under an agency (send code, verify, create the store)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/agency/merchant-signup","href":"/api-reference/agency-signup/sign-a-merchant-up-under-an-agency-send-code-verify-create-the-store"}]}]},{"tab":"TypeScript SDK","pages":[{"title":"TypeScript SDK","href":"/sdk/introduction"}]},{"tab":"Workflow Examples","pages":[{"title":"Workflow Examples","href":"/workflows/introduction"}]}]},{"product":"TLDP","icon":"truck","description":"One API for logistics: rates, shipments, tracking and returns","pages":[{"title":"TLDP","href":"/tldp"}]}]},"basePath":"","title":"Ask for a copy of my data, or for my account to be deleted - Galactic Core API Documentation","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","Page-Cr9IwkK7.js","CodeSnippet-eoRjC4Le.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","getApiPlaygroundDisplay-CZyAPlR2.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}