InventoryQuantity

object
Represents the quantity of inventory items with the specific name at the specific location.
Fields
name ● String
The name identifying the inventory quantities.
Inventory stateDescription
availableThe inventory that a merchant can sell. Available inventory isn’t committed to any orders and isn’t part of incoming transfers.
on_handThe total number of units that are physically at a location. The on_hand state equals the sum of inventory quantities that are in the available, committed and unavailable states.
committedThe number of units that are part of a placed order but aren't fulfilled. When a draft order is created, the inventory isn't committed until the draft order is completed and an order is created.
unavailableThe on-hand units that are temporarily set aside. For example, a merchant might want to set on-hand units aside for holds or inspection.
quantity ● Int
The quantity of the specified name.
updatedAt ● Date
The date and time of the last quantity update.
Status and error codes
For detailed information about common codes, see Status and error codes.
Map
InventoryQuantity
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.