Represents a change in state or quantity of product inventory at a particular time and location.
<- Object
Object
Represents a change in state or quantity of product inventory at a particular time and location.
An optional ID provided by the application to tie the InventoryAdjustment to an external system.
The inventory state of the related quantity of items before the adjustment.
The inventory state of the related quantity of items after the adjustment.
The Square-generated ID of the Location where the related quantity of items is being tracked before the adjustment.
The Square-generated ID of the Location where the related quantity of items is being tracked after the adjustment.
The Square-generated ID of the CatalogObject being tracked.
The type of the CatalogObject being tracked.
The Inventory API supports setting and reading the "catalog_object_type": "ITEM_VARIATION" field value. In addition, it can also read the "catalog_object_type": "ITEM" field value that is set by the Square Restaurants app.
The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point.
Read only The total price paid for goods associated with the adjustment. Present if and only if to_state is SOLD. Always non-negative.
A client-generated RFC 3339-formatted timestamp that indicates when the inventory adjustment took place. For inventory adjustment updates, the occurred_at timestamp cannot be older than 24 hours or in the future relative to the time of the request.
Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:
UTC: 2020-01-26T02:25:34Z
Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
Read only An RFC 3339-formatted timestamp that indicates when the inventory adjustment is received.
Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:
UTC: 2020-01-26T02:25:34Z
Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
Read only Information about the application that caused the inventory adjustment.
The Square-generated ID of the Employee responsible for the inventory adjustment.
The Square-generated ID of the Team Member responsible for the inventory adjustment.
Read only The Square-generated ID of the Transaction that caused the adjustment. Only relevant for payment-related state transitions.
Read only The Square-generated ID of the Refund that caused the adjustment. Only relevant for refund-related state transitions.
Read only The Square-generated ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
Read only The Square-generated ID of the goods receipt that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
Read only An adjustment group bundling the related adjustments of item variations through stock conversions in a single inventory event.
The total amount paid by the merchant to the supplying vendor for these units of the product. This field is only applicable for stock receive adjustments that introduce stock into the system (from_state is NONE or UNLINKED_RETURN). May be empty. This field will only accept writes if the merchant has an active subscription for either Retail Plus, Restaurants Plus, or Restaurants Premium.
The Square-generated ID of the Vendor from which the merchant purchased this product. This field is only applicable for stock receive adjustments that introduce stock into the system (from_state is NONE or UNLINKED_RETURN). This field will only accept writes if the merchant has an active subscription for either Retail Plus, Restaurants Plus, or Restaurants Premium.
Read only The Square-generated ID of the InventoryPhysicalCount (recount) that generated this adjustment, if applicable. The quantity of an adjustment generated by a physical count cannot be edited.