POST

Search Inventory Items

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 inventory items, given the provided filtering, sorting, and cursor paging.

Search Inventory Items runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • cursorPaging.limit is 100

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

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

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.
Endpoint
POST
https://www.wixapis.com/stores/v3/inventory-items/search
Body Params
searchSearch

Search options.

Response Object
inventoryItemsArray <InventoryItem>minItems 1maxItems 1000

List of inventory items.

pagingMetadataPagingMetadata

Paging metadata.

aggregationDataAggregationData

Aggregation data.

Request
cURL
curl POST 'https://www.wixapis.com/stores/v3/inventory-items/search' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
    "search": {
      "sort": [
        {
          "fieldName": "createdDate",
          "order": "DESC"
        }
      ],
      "filter": {
        "createdDate": {
          "$gt": "2024-04-24T10:22:53"
        }
      },
      "cursorPaging": {
        "limit": 2
      }
    }
  }'
Response
JSON
{
  "inventoryItems": [
    {
      "id": "fb913045-b421-4d09-804f-352fbe784465",
      "revision": "1",
      "createdDate": "2024-06-27T09:33:47.432Z",
      "updatedDate": "2024-06-27T09:33:54.060Z",
      "variantId": "f27ee649-ba6b-493d-b758-75816208cf2e",
      "locationId": "d85fbb4d-e415-49b1-98bc-9d22ec338cb1",
      "productId": "babd2bcc-ea03-4b63-8053-0ec59c73fc36",
      "quantity": 110,
      "trackQuantity": true,
      "availabilityStatus": "IN_STOCK",
      "preorderInfo": {
        "enabled": false,
        "counter": null,
        "limit": null,
        "message": null,
        "quantity": null
      },
      "product": {
        "name": "t shirt",
        "directCategoryIds": [
          "05f9cc2f-b5df-4287-aa32-3314179192b8"
        ]
      },
      "extendedFields": null
    },
    {
      "id": "a83212bc-1c1e-4645-b391-a9fed7f930f6",
      "revision": "2",
      "createdDate": "2024-06-27T09:33:47.432Z",
      "updatedDate": "2024-07-02T08:44:39.299Z",
      "variantId": "590cef15-c81d-4ed7-970c-1ff879946306",
      "locationId": "d85fbb4d-e415-49b1-98bc-9d22ec338cb1",
      "productId": "babd2bcc-ea03-4b63-8053-0ec59c73fc36",
      "quantity": 105,
      "trackQuantity": true,
      "availabilityStatus": "IN_STOCK",
      "preorderInfo": {
        "enabled": false,
        "counter": null,
        "limit": null,
        "message": null,
        "quantity": null
      },
      "product": {
        "name": "t shirt",
        "directCategoryIds": [
          "05f9cc2f-b5df-4287-aa32-3314179192b8"
        ]
      },
      "extendedFields": null
    }
}
Errors

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

Did this help?