Inventory status
Last updated
Shopper APIs reference
Last updated
To check a product's inventory status, provide its ID or external reference ID as the {id}. If you provide an invalid ID, the system will ignore it. You will receive an empty collection with a 200 status if you don't provide any ID.
/v1/shoppers/me/products/inventory-status
Provide your client identifier.
Provide the authorized or anonymous token for a shopper.
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.
Provide the identifier for the company that owns the product. If you do not provide the companyId, the call will use the default company associated with the API key.
Provide the external reference identifier for your product. The externalReferenceId is your company's internal identifier or stock keeping unit (SKU) for a product.
Provide a comma separated-list of identifiers of one or more products to include in the response.
To check the availability of a product or multiple products, provide the product ID or an external reference ID as a query parameter. If you provide an invalid ID, the system will ignore it. You will receive an empty collection with a 200 status if you don't provide any ID.
/v1/shoppers/me/products/{productId}/inventory-status
Provide the product identifier.
Provide your client identifier.
Provide the authorized or anonymous token for a shopper.
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.