Check availability of variants

Variant availability can vary depending on the defined fit parameter and destination values.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of integers
required

The list of variant ids that need to be checked

ids*
thirdPartyIds
array of objects

The list of third party ids that map to variants in the API

thirdPartyIds
string
string

Two character state code

boolean
Defaults to false

Whether inventory should be considered when checking for availability

enum
Defaults to any

The any fit parameter will return if any of the specified variants are available at any retailer in the network. The best fit parameter will attempt to find products that can be grouped together and fulfilled by a single retailer. The combined fit parameter will only return variants as available if all of them can be fulfilled by a single retailer.

Allowed:
retailerTypes
array of strings
Defaults to standard,merch_only,self_fulfiller

Limit the set of retailers to those matching one of the defined types.

retailerTypes
Allowed:
retailerIds
array of integers

Limit the set of retailers to those matching one of the defined ids.

retailerIds
Response

Language
Credentials
http
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json