Admin APIShipments
Set a shipment's contents
Replaces what is in the box. Each line can take at most what no other
(non-cancelled) shipment has claimed; see GET .../unshipped-items.
Authorization
bearer_auth AuthorizationBearer <token>
Authorization: Bearer <token>. Either a session access token from POST /auth/login (refresh it with POST /auth/refresh) or a store API token (mobi_st_…). A store API token works only for the store it was issued in, and can do at most what its issuing user can there, narrowed to the scopes it was issued with.
In: header
Path Parameters
store_id*string
Store id
Format
uuidorder_id*string
Order id
Format
uuidshipment_id*string
Shipment id
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/shipments/497f6eca-6276-4993-bfeb-53cbbbba6f08/items" \ -H "Content-Type: application/json" \ -d '{ "items": [ { "order_item_id": "c3e40b5c-b9ae-413a-b96e-5aa0514f5ae6", "quantity": 0 } ] }'{
"carrier_name": "string",
"cdf_price_id": 0,
"cdf_quotation_code": "string",
"cost_cents": 0,
"created_at": "2019-08-24T14:15:22Z",
"delivered_at": "2019-08-24T14:15:22Z",
"freight_external_order_code": "string",
"freight_payer": "string",
"freight_provider_code": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"items": [
{
"order_item_id": "c3e40b5c-b9ae-413a-b96e-5aa0514f5ae6",
"ordered_quantity": 0,
"quantity": 0,
"sku": "string",
"title": "string"
}
],
"notes": "string",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"shipped_at": "2019-08-24T14:15:22Z",
"status": "draft",
"store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",
"tracking_code": "string",
"tracking_events": [
{
"comment": "string",
"datetime": "string",
"event": "string",
"occurred_at": "2019-08-24T14:15:22Z"
}
],
"tracking_json": {},
"updated_at": "2019-08-24T14:15:22Z"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}