POST
Request a stock transfer between locations

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Body

application/json

Records an INTENT and moves nothing: the transfer lands as requested and no inventory level changes until POST /stock-transfers/{transferId}/complete. Stock is not held or reserved in the meantime, so a completion can still fail for insufficient stock. NOT structurally idempotent, because a transfer has no natural key: the same variant may legitimately move between the same two locations twice in a day. A retry inside the idempotency window is deduplicated; one outside it creates a second transfer, which can be cancelled with no stock having moved.

variant_id
string
required

A transfer moves a VARIANT, not a product: two sizes of one shirt are separate stock.

from_location_id
string
required
to_location_id
string
required

Must differ from from_location_id.

quantity
integer
required

Positive, at most 1000000.

Response

Created

data
object