Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 4.6 KB

inventory-adjustment.md

File metadata and controls

46 lines (37 loc) · 4.6 KB
Raw

Inventory Adjustment

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

Structure

Inventory Adjustment

Fields

Name Type Tags Description
id str Optional A unique ID generated by Square for the
InventoryAdjustment.
Constraints: Maximum Length: 100
reference_id str Optional An optional ID provided by the application to tie the
InventoryAdjustment to an external
system.
Constraints: Maximum Length: 255
from_state str (Inventory State) Optional Indicates the state of a tracked item quantity in the lifecycle of goods.
to_state str (Inventory State) Optional Indicates the state of a tracked item quantity in the lifecycle of goods.
location_id str Optional The Square-generated ID of the Location where the related
quantity of items is being tracked.
Constraints: Maximum Length: 100
catalog_object_id str Optional The Square-generated ID of the
CatalogObject being tracked.
Constraints: Maximum Length: 100
catalog_object_type str Optional 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.
Constraints: Maximum Length: 14
quantity str Optional The number of items affected by the adjustment as a decimal string.
Can support up to 5 digits after the decimal point.
Constraints: Maximum Length: 26
total_price_money Money Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
occurred_at str Optional 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.
Constraints: Maximum Length: 34
created_at str Optional An RFC 3339-formatted timestamp that indicates when the inventory adjustment is received.
Constraints: Maximum Length: 34
source Source Application Optional Represents information about the application used to generate a change.
employee_id str Optional The Square-generated ID of the Employee responsible for the
inventory adjustment.
Constraints: Maximum Length: 100
team_member_id str Optional The Square-generated ID of the Team Member responsible for the
inventory adjustment.
Constraints: Maximum Length: 100
transaction_id str Optional The Square-generated ID of the Transaction that
caused the adjustment. Only relevant for payment-related state
transitions.
Constraints: Maximum Length: 255
refund_id str Optional The Square-generated ID of the Refund that
caused the adjustment. Only relevant for refund-related state
transitions.
Constraints: Maximum Length: 255
purchase_order_id str Optional The Square-generated ID of the purchase order that caused the
adjustment. Only relevant for state transitions from the Square for Retail
app.
Constraints: Maximum Length: 100
goods_receipt_id str Optional The Square-generated ID of the goods receipt that caused the
adjustment. Only relevant for state transitions from the Square for Retail
app.
Constraints: Maximum Length: 100
adjustment_group Inventory Adjustment Group Optional -

Example (as JSON)

{
  "id": "id6",
  "reference_id": "reference_id6",
  "from_state": "WASTE",
  "to_state": "RESERVED_FOR_SALE",
  "location_id": "location_id0"
}