Returns the store’s public business profile: support contact details, business and returns
addresses, legal identity, social profiles, the list of published legal documents, and the
store-level custom entries the merchant has made public.
Everything in the response is intended for display on a storefront, so a publishable key may
read it. Draft documents and private custom entries are never included. Contact email and
phone fall back to the store’s own contact details when the merchant has not set dedicated
support ones.
Responses are cached for up to five minutes and carry an ETag; send it back as
If-None-Match to receive 304 Not Modified when nothing has changed. Subscribe to the
store.profile_updated webhook event to learn when the profile changes.
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.
Query Parameters
cache
boolean
default:true
Set to false to bypass the cache and read fresh data.
Response
The store profile
profile
object
required
The store's public business profile: how shoppers reach it, where it trades from, its legal identity, its social profiles, the legal documents it has published, and the custom entries the merchant has made public. Everything here is intended for display on a storefront.
{"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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/store/get-the-store-profile","slug":"/api-reference/store/get-the-store-profile","pageMetadata":{"title":"Get the store profile","description":"Returns the store's public business profile: support contact details, business and returns\naddresses, legal identity, social profiles, the list of published legal documents, and the\nstore-level custom entries the merchant has made public.\n\nEverything in the response is intended for display on a storefront, so a publishable key may\nread it. Draft documents and private custom entries are never included. Contact `email` and\n`phone` fall back to the store's own contact details when the merchant has not set dedicated\nsupport ones.\n\nResponses are cached for up to five minutes and carry an `ETag`; send it back as\n`If-None-Match` to receive `304 Not Modified` when nothing has changed. Subscribe to the\n`store.profile_updated` webhook event to learn when the profile changes.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/store/profile","href":"/api-reference/store/get-the-store-profile","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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns the store’s public business profile: support contact details, business and returns\\naddresses, legal identity, social profiles, the list of published legal documents, and the\\nstore-level custom entries the merchant has made public.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Everything in the response is intended for display on a storefront, so a publishable key may\\nread it. Draft documents and private custom entries are never included. Contact \", _jsx(_components.code, {\n children: \"email\"\n }), \" and\\n\", _jsx(_components.code, {\n children: \"phone\"\n }), \" fall back to the store’s own contact details when the merchant has not set dedicated\\nsupport ones.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Responses are cached for up to five minutes and carry an \", _jsx(_components.code, {\n children: \"ETag\"\n }), \"; send it back as\\n\", _jsx(_components.code, {\n children: \"If-None-Match\"\n }), \" to receive \", _jsx(_components.code, {\n children: \"304 Not Modified\"\n }), \" when nothing has changed. Subscribe to the\\n\", _jsx(_components.code, {\n children: \"store.profile_updated\"\n }), \" webhook event to learn when the profile changes.\"]\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":"Get the store profile","description":"Returns the store's public business profile: support contact details, business and returns\naddresses, legal identity, social profiles, the list of published legal documents, and the\nstore-level custom entries the merchant has made public.\n\nEverything in the response is intended for display on a storefront, so a publishable key may\nread it. Draft documents and private custom entries are never included. Contact `email` and\n`phone` fall back to the store's own contact details when the merchant has not set dedicated\nsupport ones.\n\nResponses are cached for up to five minutes and carry an `ETag`; send it back as\n`If-None-Match` to receive `304 Not Modified` when nothing has changed. Subscribe to the\n`store.profile_updated` webhook event to learn when the profile changes.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/store/profile","href":"/api-reference/store/get-the-store-profile","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":"getStoreProfile","tags":["Store"],"summary":"Get the store profile","description":"Returns the store's public business profile: support contact details, business and returns\naddresses, legal identity, social profiles, the list of published legal documents, and the\nstore-level custom entries the merchant has made public.\n\nEverything in the response is intended for display on a storefront, so a publishable key may\nread it. Draft documents and private custom entries are never included. Contact `email` and\n`phone` fall back to the store's own contact details when the merchant has not set dedicated\nsupport ones.\n\nResponses are cached for up to five minutes and carry an `ETag`; send it back as\n`If-None-Match` to receive `304 Not Modified` when nothing has changed. Subscribe to the\n`store.profile_updated` webhook event to learn when the profile changes.\n","security":["c78359be-8cdd-4747-aa39-7ffc25709771"],"parameters":["85345545-8f53-409d-b0ea-2ba4eba15d35"],"responses":{"200":"49ae50d2-d800-4db9-bb9f-60152f84591c","304":"1d9a4ecb-a40d-49b4-829b-7fc8d8510335","401":"e5f460f6-1850-4f4a-8af0-aa500ed0f2ac","403":"48e43fb7-e8be-4095-9f75-5709d5380693","404":"fcf80a4a-2421-4d13-8a08-c0056481895a","429":"11d1e00c-19e5-4e8c-b3fe-1d1ae0a4be5f","500":"d7bc0ff9-dcbe-4bfb-8d3f-2513cdbbbdd3"},"method":"get","type":"path","servers":["a9261009-7b5a-4dee-9970-34482b20107c"],"path":"/v1/store/profile","baseUrlOptions":["https://api.tybritelabs.com"],"title":"Get the store profile","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"85345545-8f53-409d-b0ea-2ba4eba15d35":{"name":"cache","in":"query","required":false,"schema":{"type":"boolean","default":true,"isRequired":false,"description":"Set to `false` to bypass the cache and read fresh data.","uniqueKey":"","typeLabel":"boolean"},"description":"Set to `false` to bypass the cache and read fresh data."}},"responses":{"49ae50d2-d800-4db9-bb9f-60152f84591c":{"description":"The store profile","headers":{"ETag":{"description":"Entity tag of the response body.","schema":{"type":"string"}},"Cache-Control":{"schema":{"type":"string","example":"public, max-age=300, s-maxage=300"}}},"content":{"application/json":{"schema":{"type":"object","required":["profile"],"properties":{"profile":{"type":"object","description":"The store's public business profile: how shoppers reach it, where it trades from, its legal identity, its social profiles, the legal documents it has published, and the custom entries the merchant has made public. Everything here is intended for display on a storefront.","required":["contact","addresses","business","social","policies","custom_fields","updated_at"],"properties":{"contact":{"oneOf":[{"type":"object","description":"Null when the store has no contact details at all.","properties":{"email":{"oneOf":[{"type":"string","example":"john.doe@example.com","uniqueKey":"profile.contact.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","example":"john.doe@example.com","uniqueKey":"profile.contact.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.contact.oneOf.0.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","example":"+1 415 555 0132","uniqueKey":"profile.contact.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","example":"+1 415 555 0132","uniqueKey":"profile.contact.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.contact.oneOf.0.phone","typeLabel":"string | null"},"whatsapp":{"oneOf":[{"type":"string","description":"A WhatsApp number shoppers can message.","example":null,"uniqueKey":"profile.contact.oneOf.0.whatsapp.oneOf.0","typeLabel":"string"},{"type":"null","description":"A WhatsApp number shoppers can message.","example":null,"uniqueKey":"profile.contact.oneOf.0.whatsapp.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.contact.oneOf.0.whatsapp","typeLabel":"string | null"},"support_hours":{"oneOf":[{"type":"string","description":"Free text, as the merchant wrote it.","example":"Mon-Fri 9am-5pm PT","uniqueKey":"profile.contact.oneOf.0.support_hours.oneOf.0","typeLabel":"string"},{"type":"null","description":"Free text, as the merchant wrote it.","example":"Mon-Fri 9am-5pm PT","uniqueKey":"profile.contact.oneOf.0.support_hours.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.contact.oneOf.0.support_hours","typeLabel":"string | null"},"contact_page_url":{"oneOf":[{"type":"string","format":"uri","description":"The merchant's own contact page, when they host one.","example":"https://example.com/contact","uniqueKey":"profile.contact.oneOf.0.contact_page_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"The merchant's own contact page, when they host one.","example":"https://example.com/contact","uniqueKey":"profile.contact.oneOf.0.contact_page_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.contact.oneOf.0.contact_page_url","typeLabel":"string\u003curi> | null"}},"isRequired":true,"uniqueKey":"profile.contact.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null when the store has no contact details at all.","isRequired":true,"uniqueKey":"profile.contact.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"profile.contact","typeLabel":"object | null"},"addresses":{"type":"object","properties":{"business":{"oneOf":[{"type":"object","description":"The store's registered or trading address.","properties":{"line1":{"oneOf":[{"type":"string","example":"500 Market Street","uniqueKey":"profile.addresses.business.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","example":"500 Market Street","uniqueKey":"profile.addresses.business.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.business.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","example":null,"uniqueKey":"profile.addresses.business.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"profile.addresses.business.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.business.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","example":"San Francisco","uniqueKey":"profile.addresses.business.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","example":"San Francisco","uniqueKey":"profile.addresses.business.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.business.oneOf.0.city","typeLabel":"string | null"},"region":{"oneOf":[{"type":"string","description":"State, province or county.","example":"CA","uniqueKey":"profile.addresses.business.oneOf.0.region.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province or county.","example":"CA","uniqueKey":"profile.addresses.business.oneOf.0.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.business.oneOf.0.region","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","example":"94105","uniqueKey":"profile.addresses.business.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","example":"94105","uniqueKey":"profile.addresses.business.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.business.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"US","uniqueKey":"profile.addresses.business.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 3166-1 alpha-2 country code.","example":"US","uniqueKey":"profile.addresses.business.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.business.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"profile.addresses.business.oneOf.0","typeLabel":"object"},{"type":"null","description":"The store's registered or trading address.","uniqueKey":"profile.addresses.business.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.business","typeLabel":"object | null"},"returns":{"oneOf":[{"type":"object","description":"Where returned items are sent, when it differs from the business address.","properties":{"line1":{"oneOf":[{"type":"string","example":"500 Market Street","uniqueKey":"profile.addresses.returns.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","example":"500 Market Street","uniqueKey":"profile.addresses.returns.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.returns.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","example":null,"uniqueKey":"profile.addresses.returns.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"profile.addresses.returns.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.returns.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","example":"San Francisco","uniqueKey":"profile.addresses.returns.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","example":"San Francisco","uniqueKey":"profile.addresses.returns.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.returns.oneOf.0.city","typeLabel":"string | null"},"region":{"oneOf":[{"type":"string","description":"State, province or county.","example":"CA","uniqueKey":"profile.addresses.returns.oneOf.0.region.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province or county.","example":"CA","uniqueKey":"profile.addresses.returns.oneOf.0.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.returns.oneOf.0.region","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","example":"94105","uniqueKey":"profile.addresses.returns.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","example":"94105","uniqueKey":"profile.addresses.returns.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.returns.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"US","uniqueKey":"profile.addresses.returns.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 3166-1 alpha-2 country code.","example":"US","uniqueKey":"profile.addresses.returns.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.returns.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"profile.addresses.returns.oneOf.0","typeLabel":"object"},{"type":"null","description":"Where returned items are sent, when it differs from the business address.","uniqueKey":"profile.addresses.returns.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.addresses.returns","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"profile.addresses","typeLabel":"object"},"business":{"oneOf":[{"type":"object","description":"The legal identity behind the store, for a legal notice, an invoice footer or a policy page. Null when the merchant has entered none.","properties":{"legal_name":{"oneOf":[{"type":"string","example":"Galactic Core Store LLC","uniqueKey":"profile.business.oneOf.0.legal_name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Galactic Core Store LLC","uniqueKey":"profile.business.oneOf.0.legal_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.business.oneOf.0.legal_name","typeLabel":"string | null"},"registration_number":{"oneOf":[{"type":"string","description":"Company or business registration number.","example":"LLC-2024-118842","uniqueKey":"profile.business.oneOf.0.registration_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Company or business registration number.","example":"LLC-2024-118842","uniqueKey":"profile.business.oneOf.0.registration_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.business.oneOf.0.registration_number","typeLabel":"string | null"},"tax_number":{"oneOf":[{"type":"string","description":"VAT, GST or tax identification number.","example":"94-1234567","uniqueKey":"profile.business.oneOf.0.tax_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"VAT, GST or tax identification number.","example":"94-1234567","uniqueKey":"profile.business.oneOf.0.tax_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.business.oneOf.0.tax_number","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"ISO 3166-1 alpha-2 code of the country whose law the store's policies are written under.","example":"US","uniqueKey":"profile.business.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 3166-1 alpha-2 code of the country whose law the store's policies are written under.","example":"US","uniqueKey":"profile.business.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.business.oneOf.0.country","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"profile.business.oneOf.0","typeLabel":"object"},{"type":"null","description":"The legal identity behind the store, for a legal notice, an invoice footer or a policy page. Null when the merchant has entered none.","isRequired":true,"uniqueKey":"profile.business.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"profile.business","typeLabel":"object | null"},"social":{"type":"array","items":{"type":"object","required":["platform","url"],"properties":{"platform":{"type":"string","enum":["instagram","tiktok","facebook","x","youtube","pinterest","linkedin","whatsapp","threads","snapchat","other"],"example":"instagram","isRequired":true,"uniqueKey":"profile.social.items.[INDEX].platform","typeLabel":"enum\u003cstring>"},"url":{"type":"string","format":"uri","description":"The profile's address. For a named platform it is always on that platform's domain.","example":"https://instagram.com/galactictest","isRequired":true,"uniqueKey":"profile.social.items.[INDEX].url","typeLabel":"string\u003curi>"},"handle":{"oneOf":[{"type":"string","description":"The account name as the merchant wrote it, for display.","example":"@galactictest","uniqueKey":"profile.social.items.[INDEX].handle.oneOf.0","typeLabel":"string"},{"type":"null","description":"The account name as the merchant wrote it, for display.","example":"@galactictest","uniqueKey":"profile.social.items.[INDEX].handle.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.social.items.[INDEX].handle","typeLabel":"string | null"}},"uniqueKey":"profile.social.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"profile.social","typeLabel":"object[]"},"policies":{"type":"array","description":"The published legal documents, without their text. Fetch one with `GET /v1/store/policies/{slug}`.","items":{"type":"object","description":"A published legal document, without its text. Only documents the merchant has published appear; a draft or an unpublished document is never listed.","required":["slug","title","version","effective_date","published_at"],"properties":{"slug":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,47}$","description":"The document's address. The built-in documents are `privacy`, `terms`, `returns`, `shipping`, `cookies`, `imprint` and `accessibility`; a merchant may add documents of their own under any other slug.","example":"privacy","isRequired":true,"uniqueKey":"profile.policies.items.[INDEX].slug","typeLabel":"string"},"title":{"type":"string","example":"Privacy policy","isRequired":true,"uniqueKey":"profile.policies.items.[INDEX].title","typeLabel":"string"},"version":{"type":"integer","minimum":1,"description":"The current published version. Each publish creates a new version.","example":2,"isRequired":true,"uniqueKey":"profile.policies.items.[INDEX].version","typeLabel":"integer"},"effective_date":{"type":"string","format":"date","description":"The date from which this version applies, as set by the merchant.","example":"2026-10-01","isRequired":true,"uniqueKey":"profile.policies.items.[INDEX].effective_date","typeLabel":"string\u003cdate>"},"published_at":{"type":"string","format":"date-time","example":"2026-09-30T12:07:48.007304+00:00","isRequired":true,"uniqueKey":"profile.policies.items.[INDEX].published_at","typeLabel":"string\u003cdate-time>"},"external_url":{"oneOf":[{"type":"string","format":"uri","description":"Set when the merchant hosts this document elsewhere. A storefront links to it instead of rendering the text.","example":null,"uniqueKey":"profile.policies.items.[INDEX].external_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Set when the merchant hosts this document elsewhere. A storefront links to it instead of rendering the text.","example":null,"uniqueKey":"profile.policies.items.[INDEX].external_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.policies.items.[INDEX].external_url","typeLabel":"string\u003curi> | null"}},"uniqueKey":"profile.policies.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"profile.policies","typeLabel":"object[]"},"custom_fields":{"type":"array","description":"Store-level custom entries the merchant has defined and marked public, with their values. Entries without a value are omitted.","items":{"type":"object","properties":{"name":{"type":"string","description":"The key the value is stored under.","example":"founded_year","uniqueKey":"profile.custom_fields.items.[INDEX].name","typeLabel":"string"},"label":{"type":"string","example":"Founded","uniqueKey":"profile.custom_fields.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","description":"The field type, e.g. `text`, `number`, `date`, `select`.","example":"number","uniqueKey":"profile.custom_fields.items.[INDEX].type","typeLabel":"string"},"value":{"description":"The value, typed per the field.","example":2019,"uniqueKey":"profile.custom_fields.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"profile.custom_fields.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"profile.custom_fields","typeLabel":"object[]"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the merchant last saved the profile. Null when it has never been saved.","example":"2026-09-30T12:07:48.007304+00:00","isRequired":true,"uniqueKey":"profile.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the merchant last saved the profile. Null when it has never been saved.","example":"2026-09-30T12:07:48.007304+00:00","isRequired":true,"uniqueKey":"profile.updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"profile.updated_at","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"profile","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"profile":{"contact":{"email":"john.doe@example.com","phone":"+1 415 555 0132","whatsapp":null,"support_hours":"Mon-Fri 9am-5pm PT","contact_page_url":"https://example.com/contact"},"addresses":{"business":{"line1":"500 Market Street","line2":null,"city":"San Francisco","region":"CA","postal_code":"94105","country":"US"},"returns":{"line1":"1200 Harbor Blvd","line2":null,"city":"Oakland","region":"CA","postal_code":"94607","country":"US"}},"business":{"legal_name":"Galactic Core Store LLC","registration_number":"LLC-2024-118842","tax_number":"94-1234567","country":"US"},"social":[{"platform":"instagram","url":"https://instagram.com/galactictest","handle":"@galactictest"},{"platform":"x","url":"https://x.com/galactictest","handle":null}],"policies":[{"slug":"privacy","title":"Privacy policy","version":2,"external_url":null,"published_at":"2026-09-30T12:07:48.007304+00:00","effective_date":"2026-10-01"},{"slug":"terms","title":"Terms of service","version":1,"external_url":null,"published_at":"2026-09-30T12:07:48.007304+00:00","effective_date":"2026-09-30"}],"custom_fields":[],"updated_at":"2026-09-30T12:07:48.007304+00:00"}},"examples":{"Example":{"title":"Example","value":{"profile":{"contact":{"email":"john.doe@example.com","phone":"+1 415 555 0132","whatsapp":null,"support_hours":"Mon-Fri 9am-5pm PT","contact_page_url":"https://example.com/contact"},"addresses":{"business":{"line1":"500 Market Street","line2":null,"city":"San Francisco","region":"CA","postal_code":"94105","country":"US"},"returns":{"line1":"1200 Harbor Blvd","line2":null,"city":"Oakland","region":"CA","postal_code":"94607","country":"US"}},"business":{"legal_name":"Galactic Core Store LLC","registration_number":"LLC-2024-118842","tax_number":"94-1234567","country":"US"},"social":[{"platform":"instagram","url":"https://instagram.com/galactictest","handle":"@galactictest"},{"platform":"x","url":"https://x.com/galactictest","handle":null}],"policies":[{"slug":"privacy","title":"Privacy policy","version":2,"external_url":null,"published_at":"2026-09-30T12:07:48.007304+00:00","effective_date":"2026-10-01"},{"slug":"terms","title":"Terms of service","version":1,"external_url":null,"published_at":"2026-09-30T12:07:48.007304+00:00","effective_date":"2026-09-30"}],"custom_fields":[],"updated_at":"2026-09-30T12:07:48.007304+00:00"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1d9a4ecb-a40d-49b4-829b-7fc8d8510335":{"description":"Unchanged since the `If-None-Match` ETag.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"e5f460f6-1850-4f4a-8af0-aa500ed0f2ac":{"description":"Authentication failed - invalid or missing API key","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":"unauthorized","message":"Missing or invalid Authorization header"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Missing or invalid Authorization header"}}}},"exampleType":"examples"}},"exampleType":"examples"},"48e43fb7-e8be-4095-9f75-5709d5380693":{"description":"Insufficient permissions - operation requires secret key","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":"forbidden","message":"This operation requires a secret key. Publishable keys cover catalogue reads and the actions a shopper takes for themselves."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"This operation requires a secret key. Publishable keys cover catalogue reads and the actions a shopper takes for themselves."}}}},"exampleType":"examples"}},"exampleType":"examples"},"fcf80a4a-2421-4d13-8a08-c0056481895a":{"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"},"11d1e00c-19e5-4e8c-b3fe-1d1ae0a4be5f":{"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"},"d7bc0ff9-dcbe-4bfb-8d3f-2513cdbbbdd3":{"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":{"c78359be-8cdd-4747-aa39-7ffc25709771":{"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":"Get the store profile - Galactic Core API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T11:03:26.745Z","originalFileLocation":"api-reference/store/get-the-store-profile.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=\"Returns the store\u0026#x27;s public business profile: support contact details, business and returns addresses, legal identity, social profiles, the list of published legal documents, and the store-level custom entries the merchant has made public. Everything in the response is intended for display on a storefront, so a publishable key may read it. Draft documents and private custom entries are never included. Contact email and phone fall back to the store\u0026#x27;s own contact details when the merchant has not set dedicated support ones. Responses are cached for up to five minutes and carry an ETag; send it back as If-None-Match to receive 304 Not Modified when nothing has changed. Subscribe to the store.profile_updated webhook event to learn when the profile changes.\">\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=\"Get the store profile - Galactic Core API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the store\u0026#x27;s public business profile: support contact details, business and returns addresses, legal identity, social profiles, the list of published legal documents, and the store-level custom entries the merchant has made public. Everything in the response is intended for display on a storefront, so a publishable key may read it. Draft documents and private custom entries are never included. Contact email and phone fall back to the store\u0026#x27;s own contact details when the merchant has not set dedicated support ones. Responses are cached for up to five minutes and carry an ETag; send it back as If-None-Match to receive 304 Not Modified when nothing has changed. Subscribe to the store.profile_updated webhook event to learn when the profile changes.\">\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/store/get-the-store-profile\">\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=Store\u0026amp;title=Get+the+store+profile\u0026amp;description=Returns+the+store%27s+public+business+profile%3A+support+contact+details%2C+business+and+returns%0Aaddresses%2C+legal+identity%2C+social+profiles%2C+the+list+of+published+leg\u0026amp;theme=e2a958a3415fbc57a167c80a\u0026amp;signature=7ee92a44b0d9722b20c4ad55e1080bf3cfbe8b40867db5fee1d14d77f9bf090f\">\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=\"Get the store profile - Galactic Core API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the store\u0026#x27;s public business profile: support contact details, business and returns addresses, legal identity, social profiles, the list of published legal documents, and the store-level custom entries the merchant has made public. Everything in the response is intended for display on a storefront, so a publishable key may read it. Draft documents and private custom entries are never included. Contact email and phone fall back to the store\u0026#x27;s own contact details when the merchant has not set dedicated support ones. Responses are cached for up to five minutes and carry an ETag; send it back as If-None-Match to receive 304 Not Modified when nothing has changed. Subscribe to the store.profile_updated webhook event to learn when the profile changes.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tybritelabs.mintlify.site/_mintlify/api/og/v2?division=Store\u0026amp;title=Get+the+store+profile\u0026amp;description=Returns+the+store%27s+public+business+profile%3A+support+contact+details%2C+business+and+returns%0Aaddresses%2C+legal+identity%2C+social+profiles%2C+the+list+of+published+leg\u0026amp;theme=e2a958a3415fbc57a167c80a\u0026amp;signature=7ee92a44b0d9722b20c4ad55e1080bf3cfbe8b40867db5fee1d14d77f9bf090f\">\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/store/get-the-store-profile\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/store/get-the-store-profile.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/store/get-the-store-profile#webpage\",\"url\":\"https://docs.tybritelabs.com/api-reference/store/get-the-store-profile\",\"name\":\"Get the store profile\",\"description\":\"Returns the store's public business profile: support contact details, business and returns addresses, legal identity, social profiles, the list of published legal documents, and the store-level custom entries the merchant has made public. Everything in the response is intended for display on a storefront, so a publishable key may read it. Draft documents and private custom entries are never included. Contact email and phone fall back to the store's own contact details when the merchant has not set dedicated support ones. Responses are cached for up to five minutes and carry an ETag; send it back as If-None-Match to receive 304 Not Modified when nothing has changed. Subscribe to the store.profile_updated webhook event to learn when the profile changes.\",\"dateModified\":\"2026-11-18T11:03:26.745Z\",\"isPartOf\":{\"@id\":\"https://docs.tybritelabs.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tybritelabs.com/api-reference/store/get-the-store-profile#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tybritelabs.com/api-reference/store/get-the-store-profile#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Galactic Core API Documentation\",\"item\":\"https://docs.tybritelabs.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get the store profile\",\"item\":\"https://docs.tybritelabs.com/api-reference/store/get-the-store-profile\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tybritelabs.com/api-reference/store/get-the-store-profile#apireference\",\"headline\":\"Get the store profile\",\"name\":\"Get the store profile\",\"description\":\"Returns the store's public business profile: support contact details, business and returns addresses, legal identity, social profiles, the list of published legal documents, and the store-level custom entries the merchant has made public. Everything in the response is intended for display on a storefront, so a publishable key may read it. Draft documents and private custom entries are never included. Contact email and phone fall back to the store's own contact details when the merchant has not set dedicated support ones. Responses are cached for up to five minutes and carry an ETag; send it back as If-None-Match to receive 304 Not Modified when nothing has changed. Subscribe to the store.profile_updated webhook event to learn when the profile changes.\",\"url\":\"https://docs.tybritelabs.com/api-reference/store/get-the-store-profile\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tybritelabs.com/api-reference/store/get-the-store-profile#webpage\"},\"dateModified\":\"2026-11-18T11:03:26.745Z\",\"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/store/get-the-store-profile.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","description":"Returns comprehensive store metadata and configuration in a single API call. Designed for \nLLMs and AI agents to quickly understand store context without making multiple API calls.\n \n**Purpose:**\nThis endpoint consolidates store metadata that would normally require 10+ separate API calls:\n- Store basic info (name, currencies, timezone, the shopping assistant's name and logo, and the\n design system as `store.brand`, which is `null` when the store has none; the\n `store.design_system_updated` webhook event signals that it changed)\n- Catalog overview (products, categories, collections, brands, specifications)\n- Pricing configuration (dynamic pricing, customer tiers, rules)\n- Active promotions (types, counts)\n- Payment methods (providers, configurations)\n- Shipping zones (delivery fees, free thresholds)\n- CMS content (posts, lookbooks)\n- Feature flags (enabled capabilities)\n- Store profile summary (support contact, social profiles, published legal documents)\n \n**Use Cases:**\n- AI agents understanding store capabilities before making recommendations\n- Admin dashboards showing store overview\n- Integration setup wizards checking store configuration\n- Mobile apps caching store metadata on startup\n- Third-party tools discovering available features\n \n**Performance:**\n- Cached for 5 minutes (300 seconds)\n- Parallel data fetching for all sections\n- Optional section filtering to reduce payload size\n- Typical response time: 50-150ms (cached: 10-20ms)\n \n**Selective Loading:**\nUse the `sections` parameter to request only specific data sections, reducing payload size\nby 50-80% when you don't need all information.\n\n**Single-store only.** This endpoint describes one store. A marketplace operator key has no\nsingle store here and receives `403` — use `GET /v1/marketplace/info` for the marketplace's own\ninformation, or `GET /v1/marketplace/info?store_id=\u003cmerchant>` for one merchant within it.\n","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","description":"Returns the store's published legal documents — privacy policy, terms of service, returns,\nshipping and cookie policies, a legal notice, an accessibility statement, and any documents the\nmerchant has added — without their text. A storefront uses this list to render footer links and\na `/policies/{slug}` route for each entry.\n\nOnly documents the merchant has published appear. A document that exists only as a draft, has\nbeen switched off, or has been unpublished is not listed. When `external_url` is set the\nmerchant hosts that document elsewhere, and a storefront links to that address instead.\n","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","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","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":"Get the store profile - 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"]}