queryInventoryItems( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 1,000 inventory items, given the provided filtering, sorting, and cursor paging.

For field support for filters and sorting, see Inventory Items: Supported Filters and Sorting.

To learn about working with Query endpoints, see API Query Language, and Sorting and Paging.

PROPERTYSUPPORTED FILTERS & SORTING
inStockeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
quantityeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_ideq(),ne(),exists(),in(),hasSome(),startsWith()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
variantIdeq(),ne(),exists(),in(),hasSome(),startsWith()
locationIdeq(),ne(),exists(),in(),hasSome(),startsWith()
productIdeq(),ne(),exists(),in(),hasSome(),startsWith()
preorderInfo.enabledeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read v3 catalog
Manage v3 catalog
Read inventory in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Did this help?