POST

Query Inventory


Returns a list of up inventory items, given the provided paging, sorting and filtering. See Stores Pagination for more information.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Products
Read Products
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores-reader/v2/inventoryItems/query

Body Params
queryQuery
Response Object
inventoryItemsArray <InventoryItemV2>

Inventory items.


metadataMetadata

Display metadata.


totalResultsinteger

Number of total results.

Request
cURL
curl -X POST https://www.wixapis.com/stores/v2/inventoryItems/query \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary ' {} }'
Response
JSON
{ "inventoryItems": [ { "id": "b22b2a79-52b3-e8e2-721e-1779a82dc414", "externalId": "4dd4d586-ad4c-171d-8de1-e88657d23beb", "productId": "4dd4d586-ad4c-171d-8de1-e88657d23beb", "trackQuantity": false, "variants": [ { "variantId": "00000000-0000-0000-0000-000000000000", "inStock": false, "quantity": 0, "availableForPreorder": true } ], "lastUpdated": "2022-11-24T15:10:55.789Z", "numericId": "1669215583914000", "preorderInfo": { "enabled": true, "message": "Expected to ship on June" } }, { "id": "a420a4c4-4b88-13c1-c970-6eef58fb7985", "externalId": "5bdf5b3b-b477-ec3e-368f-9110a704867a", "productId": "5bdf5b3b-b477-ec3e-368f-9110a704867a", "trackQuantity": true, "variants": [ { "variantId": "da6fbb9d-c65d-4908-8108-d2f99f216921", "inStock": false }, { "variantId": "a0e8bd24-546f-46ee-83a4-5d24513b4133", "inStock": false, "quantity": -1 }, { "variantId": "4d612768-c53b-4dc8-9fb5-066a8699d930", "inStock": true, "quantity": 2 }, { "variantId": "1acc8160-81bd-45ce-b31f-4e62c918872c", "inStock": false } ], "lastUpdated": "2022-11-21T14:04:26.977Z", "numericId": "1669039466977000", "preorderInfo": {} } ], "metadata": { "items": 100, "offset": 0 }, "totalResults": 2 }
Errors

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

Did this help?