Find supported retailers
curl --request GET \
--url https://incarts-api-qob6vapoca-uc.a.run.app/v1/retailers \
--header 'X-Incarts-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-Incarts-API-Key': '<api-key>'}};
fetch('https://incarts-api-qob6vapoca-uc.a.run.app/v1/retailers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://incarts-api-qob6vapoca-uc.a.run.app/v1/retailers"
headers = {"X-Incarts-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"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"
}
}
}
]
}{
"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."
}
]
}
}Endpoints
Find supported retailers
Search retailer choices and routing values for shoppable link generation
GET
https://incarts-api-qob6vapoca-uc.a.run.app
/
v1
/
retailers
Find supported retailers
curl --request GET \
--url https://incarts-api-qob6vapoca-uc.a.run.app/v1/retailers \
--header 'X-Incarts-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-Incarts-API-Key': '<api-key>'}};
fetch('https://incarts-api-qob6vapoca-uc.a.run.app/v1/retailers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://incarts-api-qob6vapoca-uc.a.run.app/v1/retailers"
headers = {"X-Incarts-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"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"
}
}
}
]
}{
"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
Headers
Client-supplied request correlation ID. The API echoes this value when provided.
Required string length:
8 - 128Query Parameters
Retailer provider to search. Only Instacart discovery is available in v1.
Available options:
instacart Case-insensitive search over retailer name, slug, or retailer id.
Required string length:
1 - 120Maximum number of retailers to return.
Required range:
1 <= x <= 100Response
Retailers found.
Show child attributes
Show child attributes
⌘I
