Skip to main content
POST

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

Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Body

application/json
location_from_id
string<uuid>
required

Source warehouse.

location_to_id
string<uuid>
required

Destination warehouse.

items
object[]
required
Minimum array length: 1
entity_to_id
string<uuid>

Destination entity (defaults to API-key entity for internal transfers; different entity creates an intercompany transfer).

transfer_type
enum<string>

Explicit type override. Usually auto-detected from entity_from/entity_to.

Available options:
internal,
intercompany,
fba_inbound
requires_approval
boolean

Intercompany only. Defaults to true; set false to auto-approve.

notes
string
initiated_by
string<uuid>

User UUID who initiated the transfer.

expected_ship_date
string<date> | null
expected_receive_date
string<date> | null
carrier
string | null
tracking_number
string | null
transfer_notes
string | null

Response

Transfer created in draft status with hydrated items array

data
object