Create a consignment

POST /v1/consignments

Orders join a consignment through consignment_id, or create one inline with POST /v1/orders.

Authentication

Send a token issued in the Zoopit dashboard as Authorization: Bearer <token>.

Request body

Field	Type	Required
tracking_number	null or string
barcode_linear	null or string
barcode_2d	null or string
cargo	array of object
owner	string	yes
carrier	object
delivery	object
recipient	object
sender	object

Responses

201

resource: PartialConsignmentWithId

Field	Type	Required
attributes	object
delivery	object
created_at	string
modified_at	null or string
deleted_at	null or string
created_by	string
modified_by	null or string
deleted_by	null or string
owners	array of string
tags	array of string
tracking_number	null or string
barcode_linear	null or string
barcode_2d	null or string
sender	object
recipient	object
carrier	object
cargo	array of object
id	string	yes

Example

curl -X POST 'https://orders-api.cloud.zoopit.no/v1/consignments'
  -H 'Authorization: Bearer <token>'
  -H 'Content-Type: application/json'
  -d '{ ... }'

Try it in the interactive Orders API reference.

Field descriptions, guides and worked examples are in the full reference, available to customers in the Zoopit dashboard under Accounts → Developer.