<- Object

Object

All versions ->

InventoryAdjustment

Represents a change in state or quantity of product inventory at a particular time and location.

Link to section

Properties

Link to section

id

string

A unique ID generated by Square for the InventoryAdjustment.

Max Length
100
Link to section

reference_id

string

An optional ID provided by the application to tie the InventoryAdjustment to an external system.

Max Length
255
Link to section

from_state

string

The InventoryState of the related quantity of items before the adjustment.

Link to section

to_state

string

The InventoryState of the related quantity of items after the adjustment.

Link to section

location_id

string

The Square ID of the Location where the related quantity of items are being tracked.

Max Length
100
Link to section

catalog_object_id

string

The Square generated ID of the CatalogObject being tracked.

Max Length
100
Link to section

catalog_object_type

string

The CatalogObjectType of the CatalogObject being tracked. Tracking is only supported for the ITEM_VARIATION type.

Max Length
14
Link to section

quantity

string

The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point.

Max Length
26
Link to section

total_price_money

The read-only total price paid for goods associated with the adjustment. Present if and only if to_state is SOLD. Always non-negative.

Link to section

occurred_at

string

A client-generated timestamp in RFC 3339 format that indicates when the adjustment took place. For write actions, 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

Max Length
34
Link to section

created_at

string

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

Max Length
34
Link to section

source

Read-only information about the application that caused the inventory adjustment.

Link to section

employee_id

string

The Square ID of the Employee responsible for the inventory adjustment.

Max Length
100
Link to section

transaction_id

string

The read-only Square ID of the [Transaction][#type-transaction] that caused the adjustment. Only relevant for payment-related state transitions.

Max Length
255
Link to section

refund_id

string

The read-only Square ID of the [Refund][#type-refund] that caused the adjustment. Only relevant for refund-related state transitions.

Max Length
255
Link to section

purchase_order_id

string

The read-only Square ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app.

Max Length
100
Link to section

goods_receipt_id

string

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.

Max Length
100