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
4 enum supported values:
UNKNOWN_AVAILABILITY_STATUSOUT_OF_STOCKIN_STOCKPREORDER

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.
preorderInfoobject

Item preorder info.

productobjectRead-only

Product.

extendedFieldsobject

Custom field data for the inventory item object.

Extended fields must be configured in the Wix Dev Center 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 -100000maximum 1000000

Tracking method - quantity left in inventory.

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

Was this helpful?
Yes
No