searchInventoryItems( )

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.
Method Declaration
Copy
Method Parameters
optionsSearchInventoryItemsOptions
Returns
Return Type:Promise<SearchInventoryItemsResponse>
Was this helpful?
Yes
No