Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Query Inventory

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

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

This endpoint requires the Read Products or the Manage Products permission scope.

POST

https://www.wixapis.com/stores/v2/inventoryItems/query

Body Params

NAME
TYPE
DESCRIPTION
query

object

Response Object

NAME
TYPE
DESCRIPTION
inventoryItems

Array<object>

metadata

object

totalResults

integer

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Example 1

Request

curl

Copy Code
1curl -X POST https://www.wixapis.com/stores/v2/inventoryItems/query \
2 -H 'Content-Type: application/json' \
3 -H 'Authorization: <AUTH>' \
4 --data-binary '
5 {}
6 }'

Response

json

1
2{
3 "inventoryItems": [
4 {
5 "id": "0ff8f8b0-2857-5974-193e-8283c21fde00",
6 "externalId": "f007074f-d7a8-a68b-e6c1-7d7c3de021ff",
7 "trackQuantity": false,
8 "variants": [ {
9 "variantId": "00000000-0000-0000-0000-000000000000",
10 "inStock": false,
11 "quantity": 0
12 }],
13 "lastUpdated": "2020-02-11T12:30:04.961Z",
14 "numericId": "1579429500810000"
15 },
16 {
17 "id": "be547028-fb08-b962-75e8-3f3e56da9ee3",
18 "externalId": "41ab8fd7-04f7-469d-8a17-c0c1a925611c",
19 "trackQuantity": false,
20 "variants": [
21 {
22 "variantId": "00000000-0000-0001-0005-9a596c8e6f10",
23 "inStock": true,
24 "quantity": 0
25 },
26 {
27 "variantId": "00000000-0000-0002-0005-9a596c8e6f10",
28 "inStock": true,
29 "quantity": 0
30 }
31 ],
32 "lastUpdated": "2020-01-29T09:22:18.599Z",
33 "numericId": "1576742838020000"
34 }
35 ],
36 "metadata": {
37 "items": 100,
38 "offset": 0
39 },
40 "totalResults": 2
41}
Example 2