Skip to content

Latest commit

 

History

History
55 lines (47 loc) · 4.21 KB

inventory-adjustment.md

File metadata and controls

55 lines (47 loc) · 4.21 KB

Inventory Adjustment

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

Structure

InventoryAdjustment

Fields

Name Type Tags Description
Id string Optional A unique ID generated by Square for the
InventoryAdjustment.
ReferenceId string Optional An optional ID provided by the application to tie the
InventoryAdjustment to an external
system.
FromState string Optional Indicates the state of a tracked item quantity in the lifecycle of goods.
ToState string Optional Indicates the state of a tracked item quantity in the lifecycle of goods.
LocationId string Optional The Square ID of the Location where the related
quantity of items are being tracked.
CatalogObjectId string Optional The Square generated ID of the
CatalogObject being tracked.
CatalogObjectType string Optional The CatalogObjectType of the
CatalogObject being tracked. Tracking is only
supported for the ITEM_VARIATION type.
Quantity string Optional 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.
TotalPriceMoney Models.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.
OccurredAt string Optional 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.
CreatedAt string Optional A read-only timestamp in RFC 3339 format that indicates when Square
received the adjustment.
Source Models.SourceApplication Optional Provides information about the application used to generate an inventory
change.
EmployeeId string Optional The Square ID of the Employee responsible for the
inventory adjustment.
TransactionId string Optional The read-only Square ID of the [Transaction][#type-transaction] that
caused the adjustment. Only relevant for payment-related state
transitions.
RefundId string Optional The read-only Square ID of the [Refund][#type-refund] that
caused the adjustment. Only relevant for refund-related state
transitions.
PurchaseOrderId string Optional The read-only Square ID of the purchase order that caused the
adjustment. Only relevant for state transitions from the Square for Retail
app.
GoodsReceiptId string Optional 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.

Example (as JSON)

{
  "id": null,
  "reference_id": null,
  "from_state": null,
  "to_state": null,
  "location_id": null,
  "catalog_object_id": null,
  "catalog_object_type": null,
  "quantity": null,
  "total_price_money": null,
  "occurred_at": null,
  "created_at": null,
  "source": null,
  "employee_id": null,
  "transaction_id": null,
  "refund_id": null,
  "purchase_order_id": null,
  "goods_receipt_id": null
}