List pending transfers

GET /api/v1/inventory/transfers/pending

Get all draft and pending transfers awaiting shipment with cursor-based pagination.

Operation ID: list_pending_transfers_api_v1_inventory_transfers_pending_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

cursor string: Cursor for pagination
limit integer: Pagination limit
direction string default: next: Pagination direction: 'next' or 'prev'
include_total_count boolean default: False: Whether to include total count (expensive - avoid if possible)
sort_by string: Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.
descending boolean default: True: Sort direction: true for descending (newest/largest first), false for ascending

Responses

200 Successful Response

Schema: TransferListResponse

items array · TransferResponse requiredTransferResponse

28 fields

id string required
business_id string required
transfer_number string
status TransferStatusEnum requiredTransferStatusEnum
from_location_id string required
to_location_id string required
from_location LocationSummary
to_location LocationSummary
transfer_date string · date
expected_arrival_date string · date
received_date string · date
tracking_number string
carrier string
notes string
items array · TransferItemResponse
total_items integer
total_quantity integer
total_received_quantity integer
has_discrepancy boolean
is_editable boolean
can_ship boolean
can_receive boolean
can_cancel boolean
shipped_by_user_id string
received_by_user_id string
version integer
created_at string · date-time required
updated_at string · date-time required

total_count integer

next_cursor string

prev_cursor string

has_next boolean

has_prev boolean

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/inventory/transfers/pending

bash

curl -X GET 'https://api.ondayzero.com/api/v1/inventory/transfers/pending' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/inventory/transfers/pending', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/inventory/transfers/pending", headers=headers)
data = response.json()