Skip to main content
POST
Buy stock

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required
supplierStoreId
string<uuid>
required

Body

application/json

Buys a supplier's stock in quantity, up front, instead of drawing it one sale at a time.

sourceVariantId
string<uuid>
required

The supplier's variant to buy.

quantity
integer<int32>
required

How many units to buy. Volume terms apply to the whole amount.

Required range: 1 <= x <= 10000
idempotencyKey
string | null

A caller-chosen reference that makes this purchase safe to retry.

Maximum string length: 128

Response

The object was successfully created.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

A descriptive message providing additional context or information about the response.

code
string | null

The error code (if there was an error) to use when referencing the error

data
object
Last modified on August 22, 2026