<- Object

Object

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.

Link to section

reference_id

string

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

Link to section

from_state

string

The inventory state of the related quantity of items before the adjustment.

Link to section

to_state

string

Link to section

location_id

string

The Square-generated ID of the Location where the related quantity of items is being tracked.

Link to section

catalog_object_id

string

Link to section

catalog_object_type

string

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.

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.

Link to section

total_price_money

Read only The 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 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

Link to section

created_at

string

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

Link to section

source

Read only Information about the application that caused the inventory adjustment.

Link to section

employee_id

string

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

Link to section

team_member_id

string

The Square-generated ID of the Team Member responsible for the inventory adjustment.

Link to section

transaction_id

string

Read only The Square-generated ID of the Transaction that caused the adjustment. Only relevant for payment-related state transitions.

Link to section

refund_id

string

Read only The Square-generated ID of the Refund that caused the adjustment. Only relevant for refund-related state transitions.

Link to section

purchase_order_id

string

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.

Link to section

goods_receipt_id

string

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.

Link to section

adjustment_group

Beta

Read only An adjustment group bundling the related adjustments of item variations through stock conversions in a single inventory event.