Sign in

v1

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

SearchTransferOrders

Searches for transfer orders using filters. Returns a paginated list of matching TransferOrders sorted by creation date.

Common search scenarios:

  • Find orders for a source Location
  • Find orders for a destination Location
  • Find orders in a particular TransferOrderStatus
post/v2/transfer-orders/search

Request body

cursorstring

Pagination cursor from a previous search response

limitinteger

Maximum number of results to return (1-100)

Example request

{
  "cursor": "eyJsYXN0X3VwZGF0ZWRfYXQiOjE3NTMxMTg2NjQ4NzN9",
  "limit": 10,
  "query": {
    "filter": {
      "destination_location_ids": [
        "EXAMPLE_DEST_LOCATION_ID_456"
      ],
      "source_location_ids": [
        "EXAMPLE_SOURCE_LOCATION_ID_123"
      ],
      "statuses": [
        "STARTED",
        "PARTIALLY_RECEIVED"
      ]
    },
    "sort": {
      "field": "UPDATED_AT",
      "order": "DESC"
    }
  }
}

Response

Success

cursorstring

Pagination cursor for fetching the next page of results

Example response

{
  "cursor": "eyJsYXN0X3VwZGF0ZWRfYXQiOjE3NTMxMTU1NDBfMTIzfQ==",
  "transfer_orders": [
    {
      "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"
        }
      ],
      "notes": "Inventory rebalance between stores",
      "source_location_id": "EXAMPLE_SOURCE_LOCATION_ID_123",
      "status": "STARTED",
      "tracking_number": "TRACK123456789",
      "updated_at": "2025-01-15T10:32:00Z",
      "version": 1753118664873
    },
    {
      "created_at": "2025-01-14T14:20:00Z",
      "destination_location_id": "EXAMPLE_DEST_LOCATION_ID_456",
      "expected_at": "2025-11-08T12:00:00Z",
      "id": "EXAMPLE_TRANSFER_ORDER_ID_456",
      "line_items": [
        {
          "item_variation_id": "EXAMPLE_ITEM_VARIATION_ID_002",
          "quantity_canceled": "0",
          "quantity_damaged": "0",
          "quantity_ordered": "10",
          "quantity_pending": "3",
          "quantity_received": "7",
          "uid": "1"
        }
      ],
      "notes": "Seasonal stock transfer",
      "source_location_id": "EXAMPLE_SOURCE_LOCATION_ID_123",
      "status": "PARTIALLY_RECEIVED",
      "updated_at": "2025-01-15T09:45:00Z",
      "version": 1753115540123
    }
  ]
}