v1
latestOpenAPI 3.0.12026-07-242871595.3 MBGet all inventory items
Displays line items for each category in the inventory for an order.
Path parameters
Merchant identifier.
Query parameters
Filter fields to display search results: [lowStock, modifiedTime, hidden, itemCode, available, option.id, modifierGroup.id, autoManage, price, id, sku, defaultTaxRates, tags.id, alternateName, isRevenue, tags.name, deleted, item.id, name, itemStock.quantity, itemGroup.id, isAgeRestricted, ageRestrictedType, minimumAge]
Additional information provided as an expanded response: [tags, categories, taxRates, modifierGroups, itemStock, options, ageRestricted]
Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.
Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000
Headers
Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>
Response
Successful response. Displays up to 1000 line items for each category in the inventory.
Example response
{
"elements": [
{
"isAgeRestricted": true,
"ageRestrictedType": "ALCOHOL",
"minimumAge": 21
}
]
}