v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

Inventory

DeprecatedBatchChangeInventory

Deprecated version of BatchChangeInventory after the endpoint URL is updated to conform to the standard convention.

post/v2/inventory/batch-change

Request body

idempotency_keystring required

A client-supplied, universally unique identifier (UUID) for the request.

See Idempotency in the API Development 101 section for more information.

ignore_unchanged_countsboolean

Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: true.

Example request

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

Response

Success

Example response

{
  "counts": [
    {
      "calculated_at": "2016-11-16T22:28:01.223Z",
      "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
      "catalog_object_type": "ITEM_VARIATION",
      "location_id": "C6W5YS5QM06F5",
      "quantity": "53",
      "state": "IN_STOCK"
    }
  ],
  "errors": []
}