Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 1.54 KB

batch-change-inventory-request.md

File metadata and controls

38 lines (30 loc) · 1.54 KB

Batch Change Inventory Request

Structure

BatchChangeInventoryRequest

Fields

Name Type Tags Description
idempotencyKey string Required A client-supplied, universally unique identifier (UUID) for the
request.

See Idempotency in the
API Development 101 section for more
information.
Constraints: Minimum Length: 1, Maximum Length: 128
changes InventoryChange[] | undefined Optional 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.
ignoreUnchangedCounts boolean | undefined Optional Indicates whether the current physical count should be ignored if
the quantity is unchanged since the last physical count. Default: true.

Example (as JSON)

{
  "changes": [
    {
      "physical_count": {
        "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
        "location_id": "C6W5YS5QM06F5",
        "occurred_at": "2016-11-16T22:25:24.878Z",
        "quantity": "53",
        "reference_id": "1536bfbf-efed-48bf-b17d-a197141b2a92",
        "state": "IN_STOCK",
        "team_member_id": "LRK57NSQ5X7PUD05"
      },
      "type": "PHYSICAL_COUNT"
    }
  ],
  "idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe",
  "ignore_unchanged_counts": true
}