API ReferenceConsignments
Get a consignment
GET
/supply-chain/data-space/consignments/{consignmentId}Authorization
jwtBearerAuthScheme AuthorizationBearer <token>
In: header
Path Parameters
consignmentId*string
The id of the consignment to get — its globalId, identifier or AIG urn.
Query Parameters
scope?string
The scope of the read: own (the caller's own view), shared (only the contributions
other organisations shared about the consignment) or all (the merged view, with those
contributions joined into the caller's own events, documents and system events).
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/CONS-001"{ "id": "string", "created": "string", "updated": "string", "includedConsignments": [ {} ], "documents": [ { "href": "string", "@context": [ "https://schema.org", "https://schema.twindev.org/documents/", "https://schema.twindev.org/common/" ], "type": "Document", "id": "string", "documentRevision": 0, "blobStorageId": "string", "integrity": "string", "attestationId": "string", "dateCreated": "string", "dateModified": "string", "dateDeleted": "string", "organizationIdentity": "string", "userIdentity": "string" } ], "events": [ {} ], "systemEvents": [ { "@context": "https://schema.twindev.org/supply-chain", "id": "string", "type": "SystemEvent", "typeCode": "CREATE", "source": { "id": "string", "type": "string", "detail": { "property1": {}, "property2": {} } }, "object": { "id": "string", "type": "string", "detail": { "property1": {}, "property2": {} } }, "target": { "id": "string", "type": "string", "detail": { "property1": {}, "property2": {} } }, "date": "string" } ], "resolvedTransportMode": { "raw": "string", "code": "string", "label": "string" }, "resolvedTransportEquipment": [ { "identifier": "string", "transportMeansTypes": [ { "raw": "string", "code": "string", "label": "string" } ] } ]}{ "name": "GeneralError", "message": "errorMessage", "properties": { "foo": "bar" }}{ "name": "UnauthorizedError", "message": "errorMessage"}{ "name": "InternalServerError", "message": "errorMessage"}Returns the full consignment. :id accepts globalId or identifier.
The view is assembled by co-contribution: events, documents and system events that partners shared about the same consignment are merged into your arrays — they join your own entries, never replace them.