InventoryAdjustment Object

Name	Description
`id string`	A unique ID generated by Square for the `InventoryAdjustment`.
`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.
`created_at string`	A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment.
`employee_id string`	The Square ID of the Employee responsible for the inventory adjustment.
`from_state string`	The `InventoryState` of the related quantity of items before the adjustment.
`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.
`location_id string`	The Square ID of the Location where the related quantity of items are being tracked.
`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.
`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.
`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.
`reference_id string`	An optional ID provided by the application to tie the `InventoryAdjustment` to an external system.
`refund_id string`	The read-only Square ID of the [Refund][#type-refund] that caused the adjustment. Only relevant for refund-related state transitions.
`source SourceApplication`	Read-only information about the application that caused the inventory adjustment.
`to_state string`	The `InventoryState` of the related quantity of items after the adjustment.
`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.
`transaction_id string`	The read-only Square ID of the [Transaction][#type-transaction] that caused the adjustment. Only relevant for payment-related state transitions.

A unique ID generated by Square for the InventoryAdjustment.


        
  
  
          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.

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


        
  
  
          employee_id
        


        

        
            string

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

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


        
  
  
          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.


        
  
  
          location_id
        


        

        
            string

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


        
  
  
          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.


        
  
  
          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.

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.


        
  
  
          reference_id
        


        

        
            string

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

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


        
  
  
          source
        


        

        
              
                SourceApplication

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

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


        
  
  
          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.


        
  
  
          transaction_id
        


        

        
            string

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

Object Index / Definition

You are viewing an old version of the API

All Versions

InventoryAdjustment

Properties

Share Feedback

Object Index / Definition You are viewing an old version of the API 2019-12-17 Version 2019-12-17 All Versions Inventory​Adjustment

Properties

Share Feedback

Object Index / Definition

You are viewing an old version of the API

All Versions

InventoryAdjustment