Object Index / Definition

You are viewing an old version of the API
InventoryAdjustment

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

Properties

Name Description
id
string

A unique ID generated by Square for the InventoryAdjustment.

reference_id
string

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

from_state
string

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

to_state
string

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

location_id
string

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

catalog_object_id
string

The Square generated ID of the CatalogObject being tracked.

catalog_object_type
string

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

quantity
string

Beta

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

Important: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, 2.5 will become 2, and -2.5 will become -3. Read Decimal Quantities (BETA) for more information.

total_price_money
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.

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:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

created_at
string

A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

source
SourceApplication

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

employee_id
string

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

transaction_id
string

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

refund_id
string

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

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.

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.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?