queryInventoryItems( )


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

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

Learn more about the differences between Query and Search methods.

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(),gt(),lt(),le(),ge()
_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(),gt(),lt(),le(),ge()
locationIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge()
productIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
trackQuantityeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
availabilityStatuseq(),ne(),exists(),in(),hasSome(),ascending(),descending()
preorderInfo.enabledeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
product.nameeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
product.directCategoryIdseq(),ne(),exists(),in(),hasSome(),hasAll(),ascending(),descending()
product.variantNameeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
product.variantSkueq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
Permissions
Read inventory in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?