Creates multiple inventory items.

Decrements quantities of multiple inventory items.

Decrements quantities of multiple inventory items by variant and location.

Deletes multiple inventory items.

Increments quantities of multiple inventory items.

Increments quantities of multiple inventory items by variant and location.

Updates multiple inventory items.

Each time an inventory item is updated, revision increments by 1. The current revision must be passed when updating an inventory item. This ensures you're working with the latest inventory item and prevents unintended overwrites.

Updates multiple inventory items, given the provided filter.

Each time an inventory item is updated, revision increments by 1. The current revision must be passed when updating an inventory item. This ensures you're working with the latest inventory item and prevents unintended overwrites.

Creates an inventory item. The combination of variantId and locationId is unique.

Deletes an inventory item.

Retrieves an inventory item.

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

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

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

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.

Updates an inventory item.

Each time the inventory item is updated, revision increments by 1. The current revision must be passed when updating the inventory item. This ensures you're working with the latest inventory item and prevents unintended overwrites.

Triggered when an inventory item is created.

Triggered when an inventory item is deleted.

Triggered when an inventory item's stock is updated.

Triggered when an inventory item is updated.

Triggered when an inventory item is updated.

Adds a sort to a query, sorting by the specified properties in ascending order.

The ascending() function refines a InventoryItemsQueryBuilder to sort by the value of propertyName in ascending order. You can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. ascending() sorts the results in the order the properties are passed. You can sort the following types:

• Number: Sorts numerically.
• Date: Sorts by date and time.
• String: Sorts lexicographically, so 'abc' comes after 'XYZ'. If a property contains a number stored as a string (for example, '0'), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.

Adds a sort to a query, sorting by the specified properties in descending order.

The descending() function refines a InventoryItemsQueryBuilder to sort by the value of propertyName in descending order. You can specify multiple properties for sorting in descending order by passing each property name as an additional argument. descending() sorts the results in the order the properties are passed. You can sort the following types:

• Number: Sorts numerically.
• Date: Sorts by date and time.
• String: Sorts lexicographically, so 'abc' comes after 'XYZ'. If a property contains a number stored as a string (for example, '0'), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.

Refines a query to match items where the specified property equals the specified value.

The eq() function refines a InventoryItemsQueryBuilder to match only items where the value of the specified propertyName equals the specified value. eq() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. Matching strings with eq() is case-sensitive, so 'text' isn't equal to 'Text'.

Refines a query to match items where the specified property contains a value.

The exists() function refines a InventoryItemsQueryBuilder to only match items where the value of the specified propertyName doesn't equal null or undefined. exists() checks for either existence or non-existence based on the boolen parameter. Note that exists() does match items where the value of the specified propertyName is an empty string or an invalid value. exists() is only useful for properties which don't contain default values and therefore their values may be unassigned.

Returns the query results.

The find() function returns a Promise that resolves to the query results and metadata. The Promise is rejected if find() is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.

Refines a query to match items where the specified property is greater than or equal to the specified value.

The ge() function refines a InventoryItemsQueryBuilder to match only items where the value of the specified propertyName is greater than or equal to the specified value. ge() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. If a property contains a number stored as a string (for example, '0'), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared:

• Number: Compares numerically.
• Date: Compares JavaScript Date objects.
• String: Compares lexicographically, so 'abc' is greater than 'ABC'.

Refines a query to match items where the specified property is greater than the specified value.

The gt() function refines a InventoryItemsQueryBuilder to match only items where the value of the specified propertyName is greater than the specified value. gt() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. If a property contains a number stored as a string (for example, '0'), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared:

• Number: Compares numerically.
• Date: Compares JavaScript Date objects.
• String: Compares lexicographically, so 'abc' is greater than 'ABC'.

Refines a query to match items whose specified property contains any of the specified values.

The hasSome() function refines a InventoryItemsQueryBuilder to match only items where the value of the specified propertyName equals any of the specified values. Matching strings with hasSome() is case-sensitive, so 'text' isn't equal to 'Text'. If the specified property is an array, hasSome() matches if any of that array's elements equal any of the specified values.

Refines a query to only match items where the specified property conatins any of the values in the provided array of values.

The in() function refines a InventoryItemsQueryBuilder to match only items where the specified propertyName is equal to any of the values in the provided array. Matching strings with in() is case-sensitive, so 'text' isn't equal to 'Text'.

Refines a query to match items where the specified property is less than or equal to the specified value.

The le() function refines a InventoryItemsQueryBuilder to match only items where the value of the specified propertyName is less than or equal to the specified value. le() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. If a property contains a number stored as a string (for example, '0'), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared:

• Number: Compares numerically.
• Date: Compares JavaScript Date objects.
• String: Compares lexicographically, so 'ABC' is less than 'abc'.

Limits the number of items the query returns.

The limit() function defines the number of results a query returns in each page. Only one page of results is retrieved at a time. You can use the next() and prev() functions to navigate the pages of a query result.

Refines a query to match items where the specified property is less than the specified value.

The le() function refines a InventoryItemsQueryBuilder to match only items where the value of the specified propertyName is less than the specified value. le() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. If a property contains a number stored as a string (for example, '0'), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared:

• Number: Compares numerically.
• Date: Compares JavaScript Date objects.
• String: Compares lexicographically, so 'ABC' is less than 'abc'.

Refines a query to match items where the specified property doesn't equal the specified value.

The ne() function refines a InventoryItemsQueryBuilder to match only items where the value of the specified propertyName doesn't equal the specified value. ne() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. Matching strings with ne() is case-sensitive, so 'text' isn't equal to 'Text'.

Refines a query that skips to a specific record.

The skipTo() function refines a InventoryItemsQueryBuilder to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the cursors object in previous call's response. Then you can skip to cursors.prev to return items before the cursor, or cursors.next to return items after the cursor.

When using skipTo(), the filters and the sorting order of the original query can't be changed. Only the limit() property of the query can be changed.

Refines a query to match items where the specified property starts with the specified value.

The startsWith() function refines a InventoryItemsQueryBuilder to match only items where the value of the specified propertyName starts with the specified string. Matching with startsWith() is case-sensitive, so 'TEXT' doesn't start with 'text'. You can only use startsWith() with a property whose value is a string.