v1

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

RetrieveTransferOrder

Retrieves a specific TransferOrder by ID. Returns the complete order details including:

  • Basic information (status, dates, notes)
  • Line items with ordered and received quantities
  • Source and destination Locations
  • Tracking information (if available)
get/v2/transfer-orders/{transfer_order_id}

Path parameters

transfer_order_idstring required

The ID of the transfer order to retrieve

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_456",
    "expected_at": "2025-11-09T05: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": "5",
        "quantity_pending": "5",
        "quantity_received": "0",
        "uid": "1"
      },
      {
        "item_variation_id": "EXAMPLE_ITEM_VARIATION_ID_002",
        "quantity_canceled": "0",
        "quantity_damaged": "0",
        "quantity_ordered": "3",
        "quantity_pending": "3",
        "quantity_received": "0",
        "uid": "2"
      }
    ],
    "notes": "Example transfer order for inventory redistribution between locations",
    "source_location_id": "EXAMPLE_SOURCE_LOCATION_ID_123",
    "status": "STARTED",
    "tracking_number": "TRACK123456789",
    "updated_at": "2025-01-15T10:35:00Z",
    "version": 1753117449752
  }
}