Availability

Retrieves detailed product information and availability for specified UPCs based on location

Endpoint Details

POST /catalog/availability

Headers

Header
Value

Content-Type

application/json

Authorization

Bearer <YOUR_ACCESS_TOKEN>

Body

Parameter
Type
Description
Required

upcs

array<string>

Array of UPCs to check availability. Maximum: 70 UPCs

grouping

array<string>

Array of grouping IDs to check availability. Maximum: 70 grouping IDs

ids

array<string>

Array of product IDs to check availability. Maximum: 70 IDs

loc

Location object for determining availability. If no address is provided there will not be availability for the requested products.

shouldShowOffHours

boolean

When true, returns onDemand retailers outside their operating hours

isLegacy

boolean

Whether to return legacy identifiers

isLean

boolean

Whether to return a minimal response format

refresh

boolean

When set to true, a new access token will be generated and returned

circle-info

At least one of upcs, grouping, or ids must be provided.

Response Details

Field
Type
Description

statusCode

number

HTTP status code of the response

message

string

A brief message describing the result of the API call

metadata

Contains metadata about the API call

auth

Authentication object, only when refresh in true

navigation

Navigation schema

products

Array of matched products

retailers

Array of available retailers

Metadata Object

Field
Type
Description

languages

Array<string>

List of supported languages for the response, e.g. ["en"]

timestamp

string

Unix timestamp (in milliseconds) when the response was generated

timezone

string

Timezone used for the response, always "UTC"

requestId

string

Unique identifier for the API request. Used for debugging and support

path

string

API path

version

string

API version used for the request

Sample Request and Response

Last updated