{
"error": {
"code": "validation_failed",
"message": "products is required for walmart add_to_cart links.",
"correlationId": "req_01JZ4TCZ7AG9P9W38V4VNQ7W4B",
"details": [
{
"field": "products",
"message": "At least one product is required."
}
]
}
}
{
"error": {
"code": "validation_failed",
"message": "products is required for walmart add_to_cart links.",
"correlationId": "req_01JZ4TCZ7AG9P9W38V4VNQ7W4B",
"details": [
{
"field": "products",
"message": "At least one product is required."
}
]
}
}
{
"error": {
"code": "validation_failed",
"message": "products is required for walmart add_to_cart links.",
"correlationId": "req_01JZ4TCZ7AG9P9W38V4VNQ7W4B",
"details": [
{
"field": "products",
"message": "At least one product is required."
}
]
}
}
{
"error": {
"code": "validation_failed",
"message": "products is required for walmart add_to_cart links.",
"correlationId": "req_01JZ4TCZ7AG9P9W38V4VNQ7W4B",
"details": [
{
"field": "products",
"message": "At least one product is required."
}
]
}
}
{
"error": {
"code": "validation_failed",
"message": "products is required for walmart add_to_cart links.",
"correlationId": "req_01JZ4TCZ7AG9P9W38V4VNQ7W4B",
"details": [
{
"field": "products",
"message": "At least one product is required."
}
]
}
}
Use this endpoint before creating Instacart shopping list, recipe, or product detail links when you
need the store-specific routing value.
Instacart shopping list and recipe links use retailerId. Instacart product detail links use the
retailer slug in retailer.
Authorizations
X-Incarts-API-Key
string
header
required
Headers
X-Correlation-ID
string
Client-supplied request correlation ID. The API echoes this value when provided.
Required string length: 8 - 128
Query Parameters
provider
enum<string>
required
Retailer provider to search. Only Instacart discovery is available in v1.
Available options:
instacart
query
string
Case-insensitive search over retailer name, slug, or retailer id.
Required string length: 1 - 120
limit
integer
default:50
Maximum number of retailers to return.
Required range: 1 <= x <= 100
Response
Retailers found.
data
object[]
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Incarts API","colors":{"primary":"#7E58A5","light":"#8F6AB8","dark":"#5F3F87"},"logo":{"light":"https://mintcdn.com/incarts/h552Se_NXcmvGTw6/assets/Incarts_logo_wo_slogan_-_diff_font.png?fit=max\u0026auto=format\u0026n=h552Se_NXcmvGTw6\u0026q=85\u0026s=d2a24941b7aee43dc8bf92af7a7f5ab4","dark":"https://mintcdn.com/incarts/h552Se_NXcmvGTw6/assets/Incarts_logo_wo_slogan_-_diff_font.png?fit=max\u0026auto=format\u0026n=h552Se_NXcmvGTw6\u0026q=85\u0026s=d2a24941b7aee43dc8bf92af7a7f5ab4"},"favicon":"https://mintcdn.com/incarts/-LFCmHcjZ98Ulm2G/assets/favicon.png?fit=max\u0026auto=format\u0026n=-LFCmHcjZ98Ulm2G\u0026q=85\u0026s=5c118636348343e98570e3d290144904","api":{"openapi":"openapi/incarts-public-api.v1.yaml","params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"],"prefill":true,"autogenerate":true},"url":"full"},"banner":{"content":"**Beta:** The Incarts API is actively evolving. Endpoint behavior and schemas may change as we expand product, project, and campaign APIs.","dismissible":true,"type":"info"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"incarts","hasAudioNarration":false,"actualSubdomain":"incarts","customDomains":["docs-api.incarts.co"],"gitSource":{"type":"github","owner":"incarts-co","repo":"incarts-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae9582a46eff8e14e00a075:success","clientVersion":"0.0.4142","searchFilterCounts":[{"language":"default","tag":"Use the API","count":12},{"language":"default","tag":"API reference","count":7},{"language":"default","tag":"Core workflows","count":7},{"language":"default","tag":"Endpoints","count":6},{"language":"default","tag":"Get started","count":4},{"language":"default","tag":"Overview","count":1},{"language":"default","tag":"In development","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/list-retailers","slug":"/api-reference/endpoint/list-retailers","pageMetadata":{"title":"Find supported retailers","description":"Search retailer choices and routing values for shoppable link generation","openapi":"openapi/incarts-public-api.v1.yaml GET /v1/retailers","href":"/api-reference/endpoint/list-retailers"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Search retailer choices and routing values for shoppable link generation\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Tip}=_components;if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use this endpoint before creating Instacart shopping list, recipe, or product detail links when you\nneed the store-specific routing value.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Instacart shopping list and recipe links use `,_jsx(_components.code,{children:`retailerId`}),`. Instacart product detail links use the\nretailer slug in `,_jsx(_components.code,{children:`retailer`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Find supported retailers","description":"Search retailer choices and routing values for shoppable link generation","openapi":"openapi/incarts-public-api.v1.yaml GET /v1/retailers","href":"/api-reference/endpoint/list-retailers"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Retailers"],"summary":"Find supported retailers","operationId":"listRetailers","description":"Search retailer choices and routing values for shoppable link generation","parameters":["6499dc61-1494-4f95-8644-974cf7ae67b0","8bbe8bd9-3fbf-4a2b-9bc7-13c44085decf","536874b7-252c-4ae1-90ef-a0deae778e84","b47dde4b-c054-48cf-9d2f-8adbe35d51b2"],"responses":{"200":"c7dbb7cb-9110-48fe-978b-2b62ecd74595","400":"d0d84ac6-17f5-4e76-b840-58e826c27d7f","401":"a25d342a-074e-4321-9aae-7c685d0f8d14","403":"b069e33b-08ff-446a-b755-11a7b5a28567","429":"60ca0470-c447-4c2a-a99d-b3e881a083c3","500":"f937e4e1-4c18-4e67-ace1-1c635ab518d3"},"method":"get","type":"path","servers":["115ff798-0f88-4c4c-abef-15b1e5c6f3b5"],"security":["a42dcf70-8f23-4788-8e05-5d0e1265b038"],"path":"/v1/retailers","baseUrlOptions":["https://incarts-api-qob6vapoca-uc.a.run.app"],"title":"Find supported retailers","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"6499dc61-1494-4f95-8644-974cf7ae67b0":{"name":"provider","in":"query","required":true,"description":"Retailer provider to search. Only Instacart discovery is available in v1.","schema":{"type":"string","enum":["instacart"],"isRequired":true,"description":"Retailer provider to search. Only Instacart discovery is available in v1.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"instacart"},"8bbe8bd9-3fbf-4a2b-9bc7-13c44085decf":{"name":"query","in":"query","required":false,"description":"Case-insensitive search over retailer name, slug, or retailer id.","schema":{"type":"string","minLength":1,"maxLength":120,"isRequired":false,"description":"Case-insensitive search over retailer name, slug, or retailer id.","uniqueKey":"","typeLabel":"string"},"example":"target"},"536874b7-252c-4ae1-90ef-a0deae778e84":{"name":"limit","in":"query","required":false,"description":"Maximum number of retailers to return.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50,"isRequired":false,"description":"Maximum number of retailers to return.","uniqueKey":"","typeLabel":"integer"},"example":25},"b47dde4b-c054-48cf-9d2f-8adbe35d51b2":{"name":"X-Correlation-ID","in":"header","required":false,"description":"Client-supplied request correlation ID. The API echoes this value when provided.","schema":{"type":"string","minLength":8,"maxLength":128,"isRequired":false,"description":"Client-supplied request correlation ID. The API echoes this value when provided.","uniqueKey":"","typeLabel":"string"},"example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B"}},"responses":{"c7dbb7cb-9110-48fe-978b-2b62ecd74595":{"description":"Retailers found.","headers":{"X-Correlation-ID":{"description":"Request correlation ID generated by the API or echoed from `X-Correlation-ID`.","schema":{"type":"string"},"example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["provider","name","locationCount","usage"],"properties":{"provider":{"type":"string","enum":["instacart"],"isRequired":true,"uniqueKey":"data.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Display name for the retailer.","example":"Target","isRequired":true,"uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"locationCount":{"type":"integer","minimum":1,"description":"Number of Firestore retailer rows grouped into this retailer choice.","example":184,"isRequired":true,"uniqueKey":"data.items.[INDEX].locationCount","typeLabel":"integer"},"usage":{"type":"object","additionalProperties":false,"properties":{"shoppingList":{"type":"object","additionalProperties":false,"required":["routingMode","retailerId"],"properties":{"routingMode":{"type":"string","enum":["specific"],"isRequired":true,"uniqueKey":"data.items.[INDEX].usage.shoppingList.routingMode","typeLabel":"enum\u003cstring>"},"retailerId":{"type":"string","minLength":1,"example":"648","isRequired":true,"uniqueKey":"data.items.[INDEX].usage.shoppingList.retailerId","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].usage.shoppingList","typeLabel":"object"},"recipe":{"type":"object","additionalProperties":false,"required":["routingMode","retailerId"],"properties":{"routingMode":{"type":"string","enum":["specific"],"isRequired":true,"uniqueKey":"data.items.[INDEX].usage.recipe.routingMode","typeLabel":"enum\u003cstring>"},"retailerId":{"type":"string","minLength":1,"example":"648","isRequired":true,"uniqueKey":"data.items.[INDEX].usage.recipe.retailerId","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].usage.recipe","typeLabel":"object"},"productDetail":{"type":"object","additionalProperties":false,"required":["routingMode","retailer"],"properties":{"routingMode":{"type":"string","enum":["specific"],"isRequired":true,"uniqueKey":"data.items.[INDEX].usage.productDetail.routingMode","typeLabel":"enum\u003cstring>"},"retailer":{"type":"string","minLength":1,"example":"target","isRequired":true,"uniqueKey":"data.items.[INDEX].usage.productDetail.retailer","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].usage.productDetail","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].usage","typeLabel":"object"},"retailerId":{"type":"string","description":"Instacart numeric retailer id. Use this with `options.instacart.retailerId` for shopping list and recipe links.","example":"648","uniqueKey":"data.items.[INDEX].retailerId","typeLabel":"string"},"slug":{"type":"string","description":"Instacart retailer slug. Use this with `options.instacart.retailer` for product detail links.","example":"target","uniqueKey":"data.items.[INDEX].slug","typeLabel":"string"},"services":{"type":"array","description":"Fulfillment services observed across matching locations.","items":{"type":"string","uniqueKey":"data.items.[INDEX].services.items.[INDEX]","typeLabel":"string"},"example":["delivery","pickup"],"uniqueKey":"data.items.[INDEX].services","typeLabel":"string[]"},"categories":{"type":"array","description":"Retailer categories observed across matching locations.","items":{"type":"string","uniqueKey":"data.items.[INDEX].categories.items.[INDEX]","typeLabel":"string"},"example":["grocery"],"uniqueKey":"data.items.[INDEX].categories","typeLabel":"string[]"},"samplePostalCodes":{"type":"array","description":"Small sample of postal codes represented by the grouped locations.","items":{"type":"string","uniqueKey":"data.items.[INDEX].samplePostalCodes.items.[INDEX]","typeLabel":"string"},"example":["10001","60601"],"uniqueKey":"data.items.[INDEX].samplePostalCodes","typeLabel":"string[]"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"instacart":{"title":"instacart","value":{"data":[{"provider":"instacart","name":"Target","retailerId":"648","slug":"target","services":["delivery","pickup"],"categories":["grocery"],"locationCount":184,"samplePostalCodes":["10001","60601"],"usage":{"shoppingList":{"routingMode":"specific","retailerId":"648"},"recipe":{"routingMode":"specific","retailerId":"648"},"productDetail":{"routingMode":"specific","retailer":"target"}}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d0d84ac6-17f5-4e76-b840-58e826c27d7f":{"description":"Request body, path, or header is malformed.","headers":{"X-Correlation-ID":{"description":"Request correlation ID generated by the API or echoed from `X-Correlation-ID`.","schema":{"type":"string"},"example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","correlationId"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code.","example":"validation_failed","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error summary.","example":"products is required for walmart add_to_cart links.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"correlationId":{"type":"string","example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B","isRequired":true,"uniqueKey":"error.correlationId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["field","message"],"properties":{"field":{"type":"string","example":"products","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","example":"At least one product is required.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"products is required for walmart add_to_cart links.","correlationId":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B","details":[{"field":"products","message":"At least one product is required."}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"a25d342a-074e-4321-9aae-7c685d0f8d14":{"description":"API key is missing or invalid.","headers":{"X-Correlation-ID":{"description":"Request correlation ID generated by the API or echoed from `X-Correlation-ID`.","schema":{"type":"string"},"example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","correlationId"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code.","example":"validation_failed","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error summary.","example":"products is required for walmart add_to_cart links.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"correlationId":{"type":"string","example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B","isRequired":true,"uniqueKey":"error.correlationId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["field","message"],"properties":{"field":{"type":"string","example":"products","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","example":"At least one product is required.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"products is required for walmart add_to_cart links.","correlationId":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B","details":[{"field":"products","message":"At least one product is required."}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"b069e33b-08ff-446a-b755-11a7b5a28567":{"description":"API key is valid but does not have access to the requested project or scope.","headers":{"X-Correlation-ID":{"description":"Request correlation ID generated by the API or echoed from `X-Correlation-ID`.","schema":{"type":"string"},"example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","correlationId"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code.","example":"validation_failed","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error summary.","example":"products is required for walmart add_to_cart links.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"correlationId":{"type":"string","example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B","isRequired":true,"uniqueKey":"error.correlationId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["field","message"],"properties":{"field":{"type":"string","example":"products","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","example":"At least one product is required.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"products is required for walmart add_to_cart links.","correlationId":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B","details":[{"field":"products","message":"At least one product is required."}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"60ca0470-c447-4c2a-a99d-b3e881a083c3":{"description":"Rate limit exceeded.","headers":{"X-Correlation-ID":{"description":"Request correlation ID generated by the API or echoed from `X-Correlation-ID`.","schema":{"type":"string"},"example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","correlationId"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code.","example":"validation_failed","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error summary.","example":"products is required for walmart add_to_cart links.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"correlationId":{"type":"string","example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B","isRequired":true,"uniqueKey":"error.correlationId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["field","message"],"properties":{"field":{"type":"string","example":"products","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","example":"At least one product is required.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"products is required for walmart add_to_cart links.","correlationId":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B","details":[{"field":"products","message":"At least one product is required."}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"f937e4e1-4c18-4e67-ace1-1c635ab518d3":{"description":"Unexpected server error.","headers":{"X-Correlation-ID":{"description":"Request correlation ID generated by the API or echoed from `X-Correlation-ID`.","schema":{"type":"string"},"example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B"}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message","correlationId"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code.","example":"validation_failed","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error summary.","example":"products is required for walmart add_to_cart links.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"correlationId":{"type":"string","example":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B","isRequired":true,"uniqueKey":"error.correlationId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["field","message"],"properties":{"field":{"type":"string","example":"products","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","example":"At least one product is required.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"products is required for walmart add_to_cart links.","correlationId":"req_01JZ4TCZ7AG9P9W38V4VNQ7W4B","details":[{"field":"products","message":"At least one product is required."}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a42dcf70-8f23-4788-8e05-5d0e1265b038":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-Incarts-API-Key","scopes":[]}}},"servers":{"115ff798-0f88-4c4c-abef-15b1e5c6f3b5":{"url":"https://incarts-api-qob6vapoca-uc.a.run.app","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Incarts-API-Key","scopes":[]},"schema":{"title":"X-Incarts-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-Incarts-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi/incarts-public-api.v1.yaml"},"subdomain":"incarts","siteName":"Incarts API","title":"Find supported retailers - Incarts API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-22T19:49:10.224Z","originalFileLocation":"api-reference/endpoint/list-retailers.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=\"Search retailer choices and routing values for shoppable link generation\">\u003cmeta data-mint-head name=\"application-name\" content=\"Incarts API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/incarts/tWd5ET2FzSm9t2Qj/_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/incarts/tWd5ET2FzSm9t2Qj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/incarts/tWd5ET2FzSm9t2Qj/_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/incarts/tWd5ET2FzSm9t2Qj/_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/incarts/tWd5ET2FzSm9t2Qj/_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/incarts/tWd5ET2FzSm9t2Qj/_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/incarts/tWd5ET2FzSm9t2Qj/_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/incarts/tWd5ET2FzSm9t2Qj/_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/incarts/tWd5ET2FzSm9t2Qj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Find supported retailers - Incarts API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search retailer choices and routing values for shoppable link generation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Incarts API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs-api.incarts.co/api-reference/endpoint/list-retailers\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://incarts.mintlify.site/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=Find+supported+retailers\u0026amp;description=Search+retailer+choices+and+routing+values+for+shoppable+link+generation\u0026amp;theme=01969d819242e106747ca90b\u0026amp;signature=920a57f03e27cb53eb09b1bda5586cd8bbce51d58a5c4734f3ea2c12acc7159f\">\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=\"Find supported retailers - Incarts API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search retailer choices and routing values for shoppable link generation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://incarts.mintlify.site/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=Find+supported+retailers\u0026amp;description=Search+retailer+choices+and+routing+values+for+shoppable+link+generation\u0026amp;theme=01969d819242e106747ca90b\u0026amp;signature=920a57f03e27cb53eb09b1bda5586cd8bbce51d58a5c4734f3ea2c12acc7159f\">\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/incarts/tWd5ET2FzSm9t2Qj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Incarts API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7E58A5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs-api.incarts.co/api-reference/endpoint/list-retailers\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/list-retailers.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs-api.incarts.co/#organization\",\"name\":\"Incarts API\",\"url\":\"https://docs-api.incarts.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/incarts/h552Se_NXcmvGTw6/assets/Incarts_logo_wo_slogan_-_diff_font.png?fit=max\u0026auto=format\u0026n=h552Se_NXcmvGTw6\u0026q=85\u0026s=d2a24941b7aee43dc8bf92af7a7f5ab4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs-api.incarts.co#website\",\"name\":\"Incarts API\",\"url\":\"https://docs-api.incarts.co\",\"publisher\":{\"@id\":\"https://docs-api.incarts.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs-api.incarts.co/api-reference/endpoint/list-retailers#webpage\",\"url\":\"https://docs-api.incarts.co/api-reference/endpoint/list-retailers\",\"name\":\"Find supported retailers\",\"description\":\"Search retailer choices and routing values for shoppable link generation\",\"dateModified\":\"2026-05-22T19:49:10.224Z\",\"isPartOf\":{\"@id\":\"https://docs-api.incarts.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs-api.incarts.co/api-reference/endpoint/list-retailers#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs-api.incarts.co/api-reference/endpoint/list-retailers#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs-api.incarts.co/api-reference/endpoint/get-health\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Find supported retailers\",\"item\":\"https://docs-api.incarts.co/api-reference/endpoint/list-retailers\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs-api.incarts.co/api-reference/endpoint/list-retailers#apireference\",\"headline\":\"Find supported retailers\",\"name\":\"Find supported retailers\",\"description\":\"Search retailer choices and routing values for shoppable link generation\",\"url\":\"https://docs-api.incarts.co/api-reference/endpoint/list-retailers\",\"mainEntityOfPage\":{\"@id\":\"https://docs-api.incarts.co/api-reference/endpoint/list-retailers#webpage\"},\"dateModified\":\"2026-05-22T19:49:10.224Z\",\"publisher\":{\"@id\":\"https://docs-api.incarts.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs-api.incarts.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Incarts API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Incarts API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/list-retailers.md","siteName":"Incarts API","nav":{"global":null,"tabs":[{"tab":"Use the API","pages":[{"title":"Use the API","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","icon":"terminal","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"title":"Check service health","openapi":"openapi/incarts-public-api.v1.yaml GET /health","href":"/api-reference/endpoint/get-health"},{"title":"Check service readiness","openapi":"openapi/incarts-public-api.v1.yaml GET /ready","href":"/api-reference/endpoint/get-readiness"},{"title":"Create a shoppable link","description":"Create a shoppable Incarts link for a supported retailer intent or custom URL","openapi":"openapi/incarts-public-api.v1.yaml POST /v1/links","href":"/api-reference/endpoint/create-link"},{"title":"Find supported retailers","openapi":"openapi/incarts-public-api.v1.yaml GET /v1/retailers","href":"/api-reference/endpoint/list-retailers"},{"title":"Get a shoppable link","description":"Retrieve an existing shoppable link by ID","openapi":"openapi/incarts-public-api.v1.yaml GET /v1/links/{linkId}","href":"/api-reference/endpoint/get-link"},{"title":"Create a QR code","openapi":"openapi/incarts-public-api.v1.yaml POST /v1/links/{linkId}/qr-codes","href":"/api-reference/endpoint/create-qr-code-for-link"}]}]}]},"basePath":"","title":"Find supported retailers - Incarts API","buildId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","deploymentId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-2rM1qxPw.js","dist-pFDdfjRe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-5ydLOnhV.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-NXj-Rqjv.js","utils-m0thOP-_.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D13EKcfm.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema--XTdfsEb.js","snippetPresets-D3s4lmAH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-ChURybxL.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DL8CiXq2.js","shallow-DI2-YB2E.js","getApiPlaygroundDisplay-DxbW7b_y.js","CodeSnippet-CiNYS0pP.js","CodeSnippets-BT87bThu.js","Page-DSpdRuhM.js","getPastedJson-F_g_IrFQ.js","icon-CCIG5BAs.js","MethodPill-DY3E0jwx.js","DuplicateIcon-BN88xnEg.js","createIcon-VCCc5HO5.js","DynamicMarkdown-CaSwclgK.js","SectionHeading-DXV8nWhc.js","axios-vUo_bRtp.js","Markdown-CV32Re6G.js","AssistantPageLink-BUGO5bPJ.js"]}