Inventory
List inventory
Retrieves real-time stock information for all product variants. Stock information is stored in an InventoryItem for each product variant. The response contains up to 50 InventoryItems and supports dynamic cursors for pagination.
get/1.0/commerce/inventory
Request
- Base URLhttps://api.squarespace.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
cursorstring
Identifies where the next page of results should begin. Should be the value of pagination.nextPageCursor from a previous response. If not present or empty, the endpoint returns up to 50 InventoryItems.
Headers
Authorizationstring required
API key or OAuth access token
User-Agentstring required
User Agent
Response
OK
Example response
{
"pagination": {
"hasNextPage": true,
"nextPageCursor": "ewogICJhIiA6ICI2OWNhOWExZjgxNGMwYTY0MmIwMTIzYzkiLAogICJiIiA6ICJJRCIKfQ",
"nextPageUrl": "/1.0/commerce/inventory?cursor=ewogICJhIiA6ICI2OWNhOWExZjgxNGMwYTY0MmIwMTIzYzkiLAogICJiIiA6ICJJRCIKfQ"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.