Applies adjustments and counts to the provided item quantities.
Open in API Reference
A client-supplied, universally unique identifier (UUID) for the request.
See Idempotency in the API Development 101 section for more information.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order.
Contains details about the inventory adjustment when type is ADJUSTMENT, and is unset for all other change types.
type
ADJUSTMENT
A unique ID generated by Square for the InventoryAdjustment.
InventoryAdjustment
The Square-generated ID of the CatalogObject being tracked.
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.
"catalog_object_type": "ITEM_VARIATION"
"catalog_object_type": "ITEM"
The Square-generated ID of the Employee responsible for the inventory adjustment.
The inventory state of the related quantity of items before the adjustment.
The Square-generated ID of the Location where the related quantity of items is being tracked.
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.
occurred_at
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
The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point.
An optional ID provided by the application to tie the InventoryAdjustment to an external system.
The Square-generated ID of the Team Member responsible for the inventory adjustment.
The inventory state of the related quantity of items after the adjustment.
Contains details about the physical count when type is PHYSICAL_COUNT, and is unset for all other change types.
PHYSICAL_COUNT
Contains details about the inventory transfer when type is TRANSFER, and is unset for all other change types.
TRANSFER
Note: An InventoryTransfer object can only be set in the input to the BatchChangeInventory endpoint when the seller has an active Retail Plus subscription.
Indicates how the inventory change is applied. See InventoryChangeType for all possible values.
Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: true.
true
// No response received yet.