API ReferenceConsignments
List consignments
GET
/supply-chain/data-space/consignmentsAuthorization
jwtBearerAuthScheme AuthorizationBearer <token>
In: header
Query Parameters
cursor?string
The cursor to request the next chunk of entities.
limit?string
The maximum number of entities to return.
scope?string
The scope of the read: own (the caller's own consignments), shared (only
consignments other organisations shared with the caller) or all (the union).
Defaults to all.
Value in
- "own"
- "shared"
- "all"
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/supply-chain/data-space/consignments?limit=10&scope=all"{ "entities": [ { "id": "string", "aigId": "string", "identifier": "string", "globalId": "string", "transportId": "string", "dateOfEntry": "string", "portOfEntry": "string", "portOfExit": "string", "portOfEntryCode": "string", "portOfExitCode": "string", "portOfEntryCountryId": "string", "portOfExitCountryId": "string", "firstConsignor": {}, "lastConsignee": {}, "tradeParty": [ {} ], "carrierParty": {}, "commodities": [ {} ], "reference": "string", "transportModeCode": "string", "transportMeans": [ {} ], "latestStatus": { "name": "string", "date": "string" }, "dateCreated": "string", "dateUpdated": "string", "payloadVersion": "string" } ], "cursor": "string", "warnings": [ { "code": "discoveryFailed", "provider": "string", "datasetId": "string" } ]}{ "name": "GeneralError", "message": "errorMessage", "properties": { "foo": "bar" }}{ "name": "UnauthorizedError", "message": "errorMessage"}{ "name": "InternalServerError", "message": "errorMessage"}Returns a paginated list of the consignments visible to your organisation: your own plus those partner organisations shared with you through the dataspace.
Rows are deduplicated by consignment identifier, and your own copy wins.