Skip to main content
POST
Create transfer

Authorizations

X-API-Key
string
header
required

Integration API Key (Integrations → New Integration).

Headers

Idempotency-Key
string

Optional. Unique key per operation (max. 100 characters, valid for 24 h per integration). A retry with the same key and the same body returns the original response (header Idempotent-Replayed: true) without repeating the operation; with a different body, or while the first is still in progress, it returns 409.

Maximum string length: 100

Body

application/json
origin_branch_id
string<uuid>
required
destination_branch_id
string<uuid>
required

Different from the source.

products
object[]
required
Required array length: 1 - 500 elements
notes
string
Maximum string length: 1000
reference_number
string
Maximum string length: 100
complete
boolean

true = create and complete in the same operation.

Response

Transfer created

status
boolean
required
Example:

true

data
object
required