Search transfer ordersBeta

POST

/v2/transfer-orders/search

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

Permissions:INVENTORY_READ

Try in API Explorer

Link to section

Request body

Example code

Link to section

query

The search query

Link to section

cursor

string

Pagination cursor from a previous search response

Link to section

limit

integer(32-bit)

Maximum number of results to return (1-100)

Min

Max

100

Link to section

Response fields

Link to section

transfer_orders

List of transfer orders matching the search criteria

Link to section

cursor

string

Pagination cursor for fetching the next page of results

Link to section

errors

Any errors that occurred during the request

Link to section

Examples

All versions ->

POST /v2/transfer-orders/search

curl https://connect.squareup.com/v2/transfer-orders/search \
  -X POST \
  -H 'Square-Version: 2025-10-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": {
      "filter": {
        "source_location_ids": [
          "EXAMPLE_SOURCE_LOCATION_ID_123"
        ],
        "destination_location_ids": [
          "EXAMPLE_DEST_LOCATION_ID_456"
        ],
        "statuses": [
          "STARTED",
          "PARTIALLY_RECEIVED"
        ]
      },
      "sort": {
        "field": "UPDATED_AT",
        "order": "DESC"
      }
    },
    "cursor": "eyJsYXN0X3VwZGF0ZWRfYXQiOjE3NTMxMTg2NjQ4NzN9",
    "limit": 10
  }'

Response JSON

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

Search transfer ordersBeta

Request body

Response fields

Error descriptions