Create Shipment

Legacy Documentation

You are viewing legacy documentation. These APIs are maintained for partners with existing implementations. New projects should use v2.

View the current GraphQL API Reference → | View the current REST API Reference →

POST 
/orders/:lookupKey/:lookupValue/shipments

Create a shipment which marks orderItems as delivered and adds track and trace information to the order.

Fields

Name	Required
deliveryId	yes
deliveryDate	no
supplier	yes
colli	no
notes	no
shipDate	no
items	yes
items.sku	yes
items.name	yes
items.supplierCode	no
items.quantity	yes
items.cancelled	no Default is 0
items.notes	no
items.externalLineId	no
tracktrace	no
tracktrace.carrierName	yes
carrierName.code	yes

Request

Responses

200

Create Shipment - 200

Response Headers

Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id

400

Create Shipment - 400 (invalid schema)

Response Headers

Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id

404

Create Shipment - 404 (order not found)

Response Headers

Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id