Skip to main content
GET
List inventory transfers (warehouse, intercompany, FBA inbound)

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

X-Location-Id
string<uuid>

Active location pill (Layer 4 isolation). Takes precedence over the location_id query parameter. The wrapper enforces the precedence ladder header > qp > admin entity-wide, matching listOrdersV1 / listReturnsV1 / listPackagesV1 / listLabelsV1 / listSerialsV1.

Query Parameters

location_id
string<uuid>

Filter to a single warehouse location (Layer 4). Used only when X-Location-Id is absent. A transfer is included whenever its location_from_id OR location_to_id matches.

location_ids
string

Comma-separated list of location UUIDs (multi-location restriction; user_locations gate). When supplied, supersedes both location_id and X-Location-Id. Each transfer is included when EITHER endpoint sits in the array.

status
enum<string>
Available options:
draft,
submitted,
pending_approval,
approved,
rejected,
in_transit,
working,
shipped,
receiving,
received,
closed,
cancelled,
all
transfer_type
enum<string>
Available options:
internal,
intercompany,
fba_inbound,
all

Transfer number prefix match plus trigram similarity (> 0.3).

page
integer
default:1
Required range: x >= 1
per_page
integer
default:25
Required range: 1 <= x <= 100

Response

Paginated transfer list with stats rollup

data
object[]
total
integer
page
integer
per_page
integer
total_pages
integer
stats
object