Inventory Item Object


Inventory Item.

Properties
idstringRead-onlyformat GUID

Inventory item ID.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the inventory item is updated. To prevent conflicting changes, the current revision must be passed when updating the inventory item.

Ignored when creating an inventory item.


createdDatestringRead-onlyformat date-time

Date and time the inventory item was created.


updatedDatestringRead-onlyformat date-time

Date and time the inventory item was created.


variantIdstringformat GUID

Variant ID.


locationIdstringformat GUID

Stores location ID.


productIdstringminLength 1maxLength 36

Product ID.


trackQuantitybooleanRead-only

Whether the quantity is being tracked.


availabilityStatusstringRead-only

Inventory item availability status.

Supported values:

  • OUT_OF_STOCK: Product is out of stock.
  • IN_STOCK: Product is in stock. See quantity field for exact amount in stock.
  • PREORDER: Product is only available for preorder. See preorderInfo field for more info.

preorderInfoPreorderInfo

Item preorder info.


productProductRead-only

Product.


extendedFieldsExtendedFields

Custom field data for the inventory item object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.


ONE OF:

inStockboolean

Tracking method - in stock.

When set to true, the item is available for sale without a quantity limit.


quantityintegerminimum -99999maximum 99999

Tracking method - quantity left in inventory.

Quantity can be negative when decrementing inventory for an order that has already been paid.

Did this help?