Record shipments of queue fulfillment orders (batch, one result per entry)

Up to 100 entries, each a shipment the caller already made of one shippable fulfillment order, recorded through the shipments create unit (rows, credits, stock move, facts and legacy messages in one transaction per entry). items default to every open line of the fulfillment order. Non-atomic by default: each entry is its own transaction and the answer carries one result per entry (a shipment, or the error that refused it; the request itself answers 200). atomic: true (at most 25 entries) runs one transaction, all or nothing: the first refusal answers its error with the entry index. A fulfillment order that is not in the queue is 409 fulfillment_order_not_shippable. Never buys a label.

Scope: shipments:write, channel:write or admin.

Idempotency: send Idempotency-Key; a retry with the same key replays the first answer.

Rate limit: write class, 1,200 requests per minute per tenant by default (read class 6,000). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Body Params
shipments
array of objects
required
length between 1 and 100
shipments*
string
required
length between 1 and 300

The fulfillment order: uuid, legacy 24-hex id or ext::.

string
length between 1 and 255

The integration's own id for the document, unique within its channel.

date-time

ISO-8601, UTC.

string
^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

A uuid, or a legacy 24-hex id.

string
length between 3 and 3

ISO 4217; default the order currency.

items
array of objects
length between 1 and 500
items
string
^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

A uuid, or a legacy 24-hex id.

string
length between 1 and 64

The order line uuid (or its 24-hex line id).

string
length between 1 and 100

The order line's externalLineId.

string
^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

A uuid, or a legacy 24-hex id.

string
length between 1 and 255
integer
required
1 to 1000000
string
^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

A uuid, or a legacy 24-hex id.

string
^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

A uuid, or a legacy 24-hex id.

carrier
object

A Kentro carrier adapter by id (its name is the carrier name), or a carrier name.

string
length between 1 and 100
string
length between 1 and 2048
string
length between 1 and 50
integer
0 to 3650
package
object
length ≤ 24
^[0-9]{1,14}(\.[0-9]{1,8})?$

A non-negative decimal amount in currency units ("12.50"); numbers are accepted.

length ≤ 24
^[0-9]{1,14}(\.[0-9]{1,8})?$

A non-negative decimal amount in currency units ("12.50"); numbers are accepted.

length ≤ 24
^[0-9]{1,14}(\.[0-9]{1,8})?$

A non-negative decimal amount in currency units ("12.50"); numbers are accepted.

boolean
thirdPartyBilling
object
string
^(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|[0-9a-fA-F]{24})$

A uuid, or a legacy 24-hex id.

shipTo
object
integer
0 to 2147483647
string
length ≤ 5000
inventory
object
metadata
object

Keys 1 to 100 characters, values up to 1000.

boolean

false (default): every entry is its own transaction and the answer carries one result per entry. true: one transaction, all or nothing, at most 25 entries.

Headers
string
length between 7 and 50

Any string of 7 to 50 characters that identifies this request (an order number, a webhook id). A retry with the same key and the same body answers the first result with Idempotent-Replayed: true; the same key with a different body is 422 idempotency_key_reused; a concurrent request with the same key is 409 in_progress with Retry-After. Recommended on every write.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json