Object Index
You are viewing an old version of the API
InventoryAdjustment
Object Index
Represents a change in state or quantity of product inventory at a particular time and location.
Properties
Name | Description |
---|---|
id
|
A unique ID generated by Square for the
|
reference_
|
An optional ID provided by the application to tie the
|
from_
|
The |
to_
|
The |
location_
|
The Square ID of the Location where the related quantity of items are being tracked. |
catalog_
|
The Square generated ID of the
|
catalog_
|
The |
quantity
|
The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. |
total_
|
The read-only total price paid for goods associated with the
adjustment. Present if and only if |
occurred_
|
A client-generated timestamp in RFC 3339 format that indicates when
the adjustment took place. For write actions, the 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 |
created_
|
Read only A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment. 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 |
source
|
Read-only information about the application that caused the inventory adjustment. |
employee_
|
The Square ID of the Employee responsible for the inventory adjustment. |
transaction_
|
The read-only Square ID of the [Transaction][#type-transaction] that caused the adjustment. Only relevant for payment-related state transitions. |
refund_
|
The read-only Square ID of the [Refund][#type-refund] that caused the adjustment. Only relevant for refund-related state transitions. |
purchase_
|
The read-only Square ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app. |
goods_
|
The read-only Square ID of the Square goods receipt that caused the adjustment. Only relevant for state transitions from the Square for Retail app. |