Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
TransferOrder

UpdateTransferOrder

Updates an existing transfer order. This endpoint supports sparse updates, allowing you to modify specific fields without affecting others.

Creates a transfer_order.updated webhook event.

put/v2/transfer-orders/{transfer_order_id}

Path parameters

transfer_order_idstring required

The ID of the transfer order to update

Request body

idempotency_keystring required

A unique string that identifies this UpdateTransferOrder request. Keys must contain only alphanumeric characters, dashes and underscores

versioninteger

Version for optimistic concurrency

Example request

{
  "idempotency_key": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "transfer_order": {
    "destination_location_id": "EXAMPLE_DEST_LOCATION_ID_101",
    "expected_at": "2025-11-10T08:00:00Z",
    "line_items": [
      {
        "quantity_ordered": "7",
        "uid": "1"
      },
      {
        "item_variation_id": "EXAMPLE_NEW_ITEM_VARIATION_ID_003",
        "quantity_ordered": "2"
      },
      {
        "remove": true,
        "uid": "2"
      }
    ],
    "notes": "Updated: Priority transfer due to low stock at destination",
    "source_location_id": "EXAMPLE_SOURCE_LOCATION_ID_789",
    "tracking_number": "TRACK987654321"
  },
  "transfer_order_id": "EXAMPLE_TRANSFER_ORDER_ID_123",
  "version": 1753109537351
}

Response

Success

Example response

{
  "transfer_order": {
    "created_at": "2025-01-15T10:30:00Z",
    "created_by_team_member_id": "EXAMPLE_TEAM_MEMBER_ID_789",
    "destination_location_id": "EXAMPLE_DEST_LOCATION_ID_101",
    "expected_at": "2025-11-10T08:00:00Z",
    "id": "EXAMPLE_TRANSFER_ORDER_ID_123",
    "line_items": [
      {
        "item_variation_id": "EXAMPLE_ITEM_VARIATION_ID_001",
        "quantity_canceled": "0",
        "quantity_damaged": "0",
        "quantity_ordered": "7",
        "quantity_pending": "7",
        "quantity_received": "0",
        "uid": "1"
      },
      {
        "item_variation_id": "EXAMPLE_NEW_ITEM_VARIATION_ID_003",
        "quantity_canceled": "0",
        "quantity_damaged": "0",
        "quantity_ordered": "2",
        "quantity_pending": "2",
        "quantity_received": "0",
        "uid": "3"
      }
    ],
    "notes": "Updated: Priority transfer due to low stock at destination",
    "source_location_id": "EXAMPLE_SOURCE_LOCATION_ID_789",
    "status": "DRAFT",
    "tracking_number": "TRACK987654321",
    "updated_at": "2025-01-15T11:15:00Z",
    "version": 1753122900456
  }
}