Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

A draft transfer: two locations and at least one line of an item, a positive exact decimal quantity, and its lot or serials.

from_location_id
string<uuid>
required
to_location_id
string<uuid>
required
lines
object[]
required
Required array length: 1 - 20 elements
id
string<uuid> | null

A UUIDv7 the client chose for a new transfer, so it can name the transfer before it hears back. Ignored on an update.

note
string | null
Maximum string length: 1000

Response

TransferResource

data
TransferResource · object
required