List consignments

GET /v1/consignments

Consignments in your projects.

Authentication

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

Query parameters

Name	Type	Required
offset	number
limit	number
order	array of array of tuple
where	array of object
select	array of "attributes" | "barcode_2d" | "barcode_linear" | "cargo" | "carrier" | "created_at" | "created_by" | "deleted_at" | "deleted_by" | "delivery" | "id" | "modified_at" | "modified_by" | "owners" | "recipient" | "sender" | "tags" | "tracking_number"

Responses

200

resource: array of 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 GET 'https://orders-api.cloud.zoopit.no/v1/consignments'
  -H 'Authorization: Bearer <token>'

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.