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

Multi-item atomic mode

source_location_id
string<uuid>
required

Also accepted: from_location_id

dest_location_id
string<uuid>
required

Also accepted: to_location_id

items
object[]
required
Minimum array length: 1
notes
string

Response

Transfer initiated (draft status; GL fires on submit). The data.availability_warnings array lists any line item whose requested quantity exceeds source-location availability at create time (warn-at-create, hard-block-at-ship; NetSuite/Acumatica transfer-order pattern). Draft creation is not blocked, but shipping a short line returns a 400 insufficient_stock. The array is empty when every item has enough on hand at the source.

object
enum<string>
Available options:
inventory_transfer_result
data
object