Read Consignments

GET /supply-chain/data-space/consignments
Cookie: access_token=<jwt>

{
  "entities": [...],
  "cursor": "<next-page-cursor>"
}

{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"$id": "https://schema.twindev.org/supply-chain/ConsignmentOverview",
	"title": "ConsignmentOverview",
	"description": "Consignment overview interface for listing operations (supports both v1 and v2 payloads).",
	"type": "object",
	"properties": {
		"id": {
			"type": "string",
			"description": "A unique record id for this supply chain consignment in AIG."
		},
		"aigId": {
			"type": "string",
			"description": "The AIG vertex id for this consignment."
		},
		"identifier": {
			"type": "string",
			"description": "Unique identifier representing the consignment in supply chain."
		},
		"globalId": {
			"type": "string",
			"description": "Unique globalId identifier representing the consignment in supply chain."
		},
		"transportId": {
			"type": "string",
			"description": "Transport id for the consignment"
		},
		"dateOfEntry": {
			"type": "string",
			"description": "Entry date of the consignment"
		},
		"portOfEntry": {
			"type": "string",
			"description": "Entry location of the consignment"
		},
		"portOfExit": {
			"type": "string",
			"description": "Exit location of the consignment"
		},
		"firstConsignor": {
			"$ref": "https://schema.twindev.org/unece/UneceTradeParty",
			"description": "The first consignor of the consignment, which is the party that initially sent the goods."
		},
		"lastConsignee": {
			"$ref": "https://schema.twindev.org/unece/UneceTradeParty",
			"description": "The last consignee of the consignment"
		},
		"tradeParty": {
			"type": "array",
			"items": {
				"$ref": "https://schema.twindev.org/unece/UneceTradeParty"
			},
			"description": "The import and exporter of the consignment"
		},
		"carrierParty": {
			"$ref": "https://schema.twindev.org/unece/UneceTradeParty",
			"description": "The carrier party responsible for the consignment"
		},
		"commodities": {
			"type": "array",
			"items": {
				"$ref": "https://schema.twindev.org/unece/UneceConsignmentItem"
			},
			"description": "Commodities in the consignment"
		},
		"reference": {
			"type": "string",
			"description": "Reference field for the goods load (v2)."
		},
		"transportModeCode": {
			"type": "string",
			"description": "Transport mode code."
		},
		"transportMeans": {
			"type": "array",
			"items": {
				"$ref": "https://schema.twindev.org/unece/UneceLogisticsTransportEquipment"
			},
			"description": "Details of the transport means used for the consignment"
		},
		"latestStatus": {
			"type": "object",
			"properties": {
				"name": {
					"type": "string",
					"description": "Status name."
				},
				"date": {
					"type": "string",
					"description": "Status date."
				}
			},
			"required": [
				"name",
				"date"
			],
			"description": "Latest status information e.g. Planned."
		},
		"dateCreated": {
			"type": "string",
			"description": "The date when this entry was created."
		},
		"dateUpdated": {
			"type": "string",
			"description": "The date when this entry was updated."
		},
		"payloadVersion": {
			"type": "string",
			"description": "Payload version (v1 for Consignment, v2 for GoodsLoad)."
		}
	},
	"required": [
		"id",
		"identifier",
		"latestStatus",
		"dateCreated"
	]
}

GET /supply-chain/data-space/consignments/:id
Cookie: access_token=<jwt>

{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"$id": "https://schema.twindev.org/supply-chain/SystemEvent",
	"title": "SystemEvent",
	"description": "System Event.",
	"type": "object",
	"properties": {
		"@context": {
			"$ref": "https://schema.twindev.org/supply-chain/SupplyChainContextType",
			"description": "The JSON-LD context."
		},
		"id": {
			"type": "string",
			"description": "The ID of the system event (URI)."
		},
		"type": {
			"const": "SystemEvent",
			"description": "The JSON-LD type. Always \"SystemEvent\" for system events."
		},
		"typeCode": {
			"$ref": "https://schema.twindev.org/supply-chain/SystemEventTypeCodes",
			"description": "A code specifying the type of system event."
		},
		"source": {
			"$ref": "https://schema.twindev.org/supply-chain/EventObject",
			"description": "The source of the event (app or service)."
		},
		"object": {
			"$ref": "https://schema.twindev.org/supply-chain/EventObject",
			"description": "The directly concerned element (Consignment, Document, etc.)."
		},
		"target": {
			"$ref": "https://schema.twindev.org/supply-chain/EventObject",
			"description": "The affected element from the action (if any)."
		},
		"date": {
			"type": "string",
			"description": "The date and time that the event occurred in ISO 8601 format."
		}
	},
	"required": [
		"type",
		"typeCode",
		"source",
		"object",
		"date"
	]
}

{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"$id": "https://schema.twindev.org/supply-chain/SystemEventTypeCodes",
	"title": "SystemEventTypeCodes",
	"description": "Type for System Event Type Codes.",
	"anyOf": [
		{
			"const": "CREATE"
		},
		{
			"const": "ADD"
		},
		{
			"const": "UPDATE"
		},
		{
			"const": "DELETE"
		},
		{
			"const": "NOTIFY"
		},
		{
			"const": "MATCH"
		},
		{
			"const": "UNMATCHED"
		}
	]
}

GET /supply-chain/data-space/consignments/:id/events
Cookie: access_token=<jwt>

GET /supply-chain/data-space/consignments/:id/documents
Cookie: access_token=<jwt>

GET /supply-chain/data-space/consignments/:id/documents/:documentId
Cookie: access_token=<jwt>