Schema

Required fields, TWIN-specific extensions, and API response types for the supply-chain consignment.

Required fields

Three fields are always required when publishing a consignment via the DSC inbox:

Field	Description
`@context`	Must be `https://vocabulary.uncefact.org/unece-context-D23B.jsonld`
`globalId`	Globally unique ID for this consignment (UUID URN recommended)
`identifier`	Your internal business reference (e.g. a house bill of lading)

All other UNECE D23B fields (parties, transport, locations, weights, documents, events…) are optional and validated when present.

Minimal payload:

{
  "@context": "https://vocabulary.uncefact.org/unece-context-D23B.jsonld",
  "type": "Consignment",
  "identifier": "260202-0001",
  "globalId": "260202-1001"
}

TWIN-specific fields

Three application-level fields extend the UNECE standard using a wrapped type that carries both a value and a unit code:

consignmentItemQuantity / packageQuantity

Prop

Type

unece:QuantityTypeValueunion

Quantity numeric value.

Type

string | undefined

unece:QuantityTypeCode?object

Unit of measure code.

Type

IUneceQuantityCode | undefined

@context?union

JSON-LD Context.

Type

UneceContextType | undefined

type"QuantityType"

JSON-LD Type.

Type

"QuantityType"

QuantityTypeValue?string

The numeric value.

Type

string | undefined

QuantityTypeCode?object

The unit code.

Type

IUneceQuantityCode | undefined

weightUnitNetWeightMeasure (array)

Prop

Type

unece:WeightUnitMeasureTypeValueunion

Weight measure numeric value.

Type

string | undefined

unece:WeightUnitMeasureTypeCode?union

Unit of measure code.

Type

UneceWeightUnitMeasureCode | undefined

@context?union

JSON-LD Context.

Type

UneceContextType | undefined

type"WeightUnitMeasureType"

JSON-LD Type.

Type

"WeightUnitMeasureType"

WeightUnitMeasureTypeValue?string

The numeric value.

Type

string | undefined

WeightUnitMeasureTypeCode?union

The unit code.

Type

UneceWeightUnitMeasureCode | undefined

API response types

The shapes returned by TWIN read endpoints. Fields typed as IUnece* come from the UNECE D23B vocabulary — follow the link to see the full field list for any UNECE type.

ConsignmentView

Contains the full UNECE consignment plus TWIN metadata fields. Returned by GET /supply-chain/data-space/consignments/:id.

Prop

Type

@context?union

JSON-LD Context.

Type

UneceContextType | undefined

type"Consignment"

JSON-LD Type.

Type

"Consignment"

applicableAllowanceCharge?array

An allowance or charge applicable to this supply chain consignment.

Type

IUneceTradeAllowanceCharge[] | undefined

applicableCargoInsurance?object

The cargo insurance applicable to this supply chain consignment.

Type

IUneceCargoInsurance | undefined

applicableCurrencyExchange?array

A currency exchange applicable to this supply chain consignment.

Type

IUneceCurrencyExchange[] | undefined

applicableCustomsValuation?array

A cross-border customs valuation applicable to this supply chain consignment.

Type

IUneceCustomsValuation[] | undefined

applicableDangerousGoods?object

Dangerous goods applicable to the transport of this supply chain consignment.

Type

IUneceDangerousGoods | undefined

applicableRegulatoryProcedure?array

A cross-border regulatory procedure applicable to this supply chain consignment.

Type

IUneceRegulatoryProcedure[] | undefined

applicableServiceCharge?array

A logistics service charge applicable to this supply chain consignment, such as freight or insurance charges.

Type

IUneceServiceCharge[] | undefined

associatedDocument?array

A referenced document associated with this supply chain consignment, such as the certificate of origin or dangerous goods note.

Type

IUneceDocument[] | undefined

associatedInvoiceAmount?array

A monetary value of an invoice associated with this supply chain consignment.

Type

IUneceAmountType[] | undefined

associatedInvoiceDiscountAmount?array

A monetary value of the discount on an invoice associated with this supply chain consignment.

Type

IUneceAmountType[] | undefined

associatedInvoiceDiscountPercent?string

A percent that is a discount on an invoice amount associated with this supply chain consignment.

Type

string | undefined

associatedParty?array

A trade party associated with this supply chain consignment.

Type

IUneceTradeParty[] | undefined

atArrivalTransportMovement?object

The logistics transport movement for this supply chain consignment at the point when the means of transport arrives in a country or at a regional border.

Type

IUneceTransportMovement | undefined

atDepartureTransportMovement?object

The logistics transport movement for this supply chain consignment at the point when the means of transport departs a country or regional border.

Type

IUneceTransportMovement | undefined

availabilityDueDateTime?string

The date, time, date time or other date time value when this supply chain consignment is due to be available.

Type

string | undefined

bondedWarehouseStorageEvent?array

A bonded warehouse storage event for this supply chain consignment.

Type

IUneceTransportEvent[] | undefined

borderCrossingTransportMovement?array

A border crossing logistics transport movement for this supply chain consignment.

Type

IUneceTransportMovement[] | undefined

cODAmount?object

The monetary value of the COD (Cash On Delivery) amount to be collected by the carrier upon delivery of this supply chain consignment.

Type

IUneceAmountType | undefined

cargoInsuranceInstructionsInformation?string

Cargo insurance instructions, expressed as text, for this supply chain consignment.

Type

string | undefined

cargoToleranceInformation?string

Cargo tolerance information, expressed as text, for this supply chain consignment.

Type

string | undefined

carrierAcceptanceDateTime?string

The date, time, date time or other date time value when this supply chain consignment will be, or has been, accepted by the carrier.

Type

string | undefined

carrierAcceptanceLocation?object

The location where this supply chain consignment will be, or has been, accepted by the carrier.

Type

IUneceLogisticsLocation | undefined

carrierAgentParty?object

The party acting as the agent of the carrier for this supply chain consignment.

Type

IUneceTradeParty | undefined

carrierAssignedId?union

The unique identifier assigned by the carrier to this referenced supply chain consignment, such as a booking reference number when cargo space is reserved prior to loading.

Type

string | IJsonLdValueObject | undefined

carrierParty?object

The carrier party for this supply chain consignment.

Type

IUneceTradeParty | undefined

carrierProvidedInformation?string

Information, expressed as text, provided by the carrier for this supply chain consignment.

Type

string | undefined

chargeableTransportationStageQuantity?object

The number of separately chargeable transportation stages to be covered by this supply chain consignment.

Type

IUneceQuantityType | undefined

classificationDocument?object

The referenced classification document for this supply chain consignment.

Type

IUneceDocument | undefined

connectingCarrierParty?array

A connecting carrier party for this supply chain consignment.

Type

IUneceTradeParty[] | undefined

consigneeAgentParty?object

The party authorized to act for or on behalf of the consignee for this supply chain consignment.

Type

IUneceTradeParty | undefined

consigneeAssignedId?union

The unique identifier assigned by the consignee to this referenced supply chain consignment.

Type

string | IJsonLdValueObject | undefined

consigneeParty?object

The consignee party for this supply chain consignment.

Type

IUneceTradeParty | undefined

consigneeReceiptLocation?object

The location at which this supply chain consignment will be or has been received by the consignee.

Type

IUneceLogisticsLocation | undefined

consignmentItemQuantity?object

The number of consignment items separately defined for transport or customs purposes within this supply chain consignment.

Type

IUneceQuantityType | undefined

consignorAgentParty?object

The party authorized to act for or on behalf of the consignor for this supply chain consignment.

Type

IUneceTradeParty | undefined

consignorAssignedId?union

The unique identifier assigned by the consignor to this referenced supply chain consignment.

Type

string | IJsonLdValueObject | undefined

consignorParty?object

The consignor party for this supply chain consignment.

Type

IUneceTradeParty | undefined

consignorProvidedBorderClearanceInstructions?array

Border clearance instructions provided by the consignor for this supply chain consignment.

Type

IUneceTransportInstructions[] | undefined

consignorProvidedInformation?string

Information, expressed as text, provided by the consignor for this supply chain consignment.

Type

string | undefined

consolidatorParty?object

The party responsible for the consolidation of this supply chain consignment.

Type

IUneceTradeParty | undefined

containerizationIndicator?union

The indication of whether or not this supply chain consignment is to be transported in a container or containers.

Type

boolean | undefined

contractId?union

A contract identifier for this supply chain consignment.

Type

string | IJsonLdValueObject | undefined

contractTermsInformation?string

Information related to contract terms and conditions, expressed as text, for this supply chain consignment.

Type

string | undefined

currencyServiceChargeCurrencyCode?array

A code specifying a service charge currency for this supply chain consignment.

Type

UneceCurrencyCodeList[] | undefined

currencyServiceTariffCurrencyCode?array

A code specifying a service tariff currency for this supply chain consignment.

Type

UneceCurrencyCodeList[] | undefined

customsExportAgentParty?object

The party acting as an agent for, or on behalf of, the consignor with respect to the customs export procedures for this supply chain consignment.

Type

IUneceTradeParty | undefined

customsId?union

A unique identifier, for customs purposes, for this consignment.

Type

string | IJsonLdValueObject | undefined

customsImportAgentParty?object

The party acting as an agent for, or on behalf of, the consignee with respect to the customs import procedures for this supply chain consignment.

Type

IUneceTradeParty | undefined

customsRequiredInvoiceDocument?array

A referenced invoice document required by customs for this supply chain consignment.

Type

IUneceDocument[] | undefined

customsTransitAgentParty?object

The party acting as an agent for, or on behalf of, the consignor with respect to customs transit procedures for this supply chain consignment.

Type

IUneceTradeParty | undefined

dangerousGoodsNotifierParty?object

The party responsible for providing the dangerous goods notification in accordance with the dangerous goods regulations relevant for this supply chain consignment.

Type

IUneceTradeParty | undefined

declaredForCustomsLocation?object

The location of this supply chain consignment as declared for customs.

Type

IUneceLogisticsLocation | undefined

declaredValueForCarriageAmount?object

The monetary value of this supply chain consignment as declared by the shipper or his agent for the purpose of varying the carrier's level of liability from that provided in the contract of carriage, in case of loss or damage to goods or delayed delivery.

Type

IUneceAmountType | undefined

declaredValueForCustomsAmount?object

The monetary value declared for customs purposes for this supply chain consignment.

Type

IUneceAmountType | undefined

deconsolidatorParty?object

The party responsible for the deconsolidation of this supply chain consignment.

Type

IUneceTradeParty | undefined

deliveryInformation?string

The delivery information, expressed as text, for this supply chain consignment.

Type

string | undefined

deliveryInstructions?array

Delivery instructions for this supply chain consignment.

Type

IUneceDeliveryInstructions[] | undefined

deliveryParty?object

The party to whom this supply chain consignment will be, or has been, delivered.

Type

IUneceTradeParty | undefined

deliveryTransportEvent?object

The delivery event for this supply chain consignment.

Type

IUneceTransportEvent | undefined

demurrageInformation?string

Demurrage information, expressed as text, for this supply chain consignment.

Type

string | undefined

despatchParty?object

The party from whom this supply chain consignment will be or has been despatched.

Type

IUneceTradeParty | undefined

destinationCountry?object

The destination country for this supply chain consignment.

Type

IUneceCountry | undefined

devanningEvent?array

A transport devanning event for this referenced supply chain consignment, i.e. the unloading of this consignment at the place of delivery.

Type

IUneceTransportEvent[] | undefined

estimatedApplicableServiceCharge?array

An estimated logistics service charge applicable to this supply chain consignment, such as freight or insurance charges.

Type

IUneceServiceCharge[] | undefined

examinationEvent?array

An examination event for this supply chain consignment.

Type

IUneceTransportEvent[] | undefined

exportCountry?object

The export country for this supply chain consignment.

Type

IUneceCountry | undefined

exportExitDateTime?string

The date, time, date time or other date time value when this supply chain consignment will exit, or has exited from the last port, airport, or border post of the country of export.

Type

string | undefined

exportGeopoliticalRegion?object

The geopolitical region of export for this supply chain consignment.

Type

IUneceGeopoliticalRegion | undefined

exporterParty?object

The party who exports this supply chain consignment.

Type

IUneceTradeParty | undefined

fOBAmount?object

The monetary value that has to be, or has been, paid for this supply chain consignment as calculated under FOB (Free on Board) delivery terms.

Type

IUneceAmountType | undefined

finalDestinationCountry?object

The final destination country for this supply chain consignment.

Type

IUneceCountry | undefined

finalDestinationLocation?object

The final destination location for this supply chain consignment.

Type

IUneceLogisticsLocation | undefined

freightForwarderAssignedId?union

The unique identifier assigned by the freight forwarder to this referenced supply chain consignment.

Type

string | IJsonLdValueObject | undefined

freightForwarderParty?object

The freight forwarder party for this supply chain consignment.

Type

IUneceTradeParty | undefined

globalId?union

A global identifier of this supply chain consignment.

Type

string | IJsonLdValueObject | undefined

goodsReleaseRestriction?string

A goods release restriction, expressed as text, for this supply chain consignment.

Type

string | undefined

groupingCentreParty?array

A grouping centre party for this supply chain consignment.

Type

IUneceTradeParty[] | undefined

handlingInstructions?array

Handling instructions for this supply chain consignment, such as where or how specified packages or containers are to be loaded on a means of transport.

Type

IUneceHandlingInstructions[] | undefined

haulageInstructions?array

Haulage instructions for this supply chain consignment.

Type

IUneceHaulageInstructions[] | undefined

identifier?union

A unique identifier for this referenced supply chain consignment.

Type

string | IJsonLdValueObject | undefined

importCountry?object

The import country for this supply chain consignment.

Type

IUneceCountry | undefined

importerParty?object

The party who imports this supply chain consignment.

Type

IUneceTradeParty | undefined

includedConsignment?array

A referenced consignment included in this supply chain consignment.

Type

IUneceConsignment[] | undefined

includedConsignmentItem?array

A referenced consignment item included in this referenced supply chain consignment.

Type

IUneceConsignmentItem[] | undefined

includedTareGrossWeightMeasure?object

The measure of the gross weight (mass) including the tare weight of this supply chain consignment.

Type

IUneceMeasureType | undefined

information?string

Information, expressed as text, for this supply chain consignment.

Type

string | undefined

insuranceApplicableCurrencyExchange?array

A currency exchange applicable to an insurance charge for this supply chain consignment.

Type

IUneceCurrencyExchange[] | undefined

insurancePremiumAmount?object

The monetary value of the insurance premium for this supply chain consignment.

Type

IUneceAmountType | undefined

insuranceValueAmount?object

The monetary value of this supply chain consignment as covered by an insurance policy.

Type

IUneceAmountType | undefined

intermediateConsigneeParty?array

A party that is an intermediate consignee for this supply chain consignment.

Type

IUneceTradeParty[] | undefined

invoiceApplicableCurrencyExchange?array

A currency exchange applicable to the invoice for this supply chain consignment.

Type

IUneceCurrencyExchange[] | undefined

invoiceeAssociatedParty?array

An invoicee trade party associated with this supply chain consignment.

Type

IUneceTradeParty[] | undefined

linearUnitLoadingLengthMeasure?array

A measure of the loading length which is the length along a means of transport over which the complete width and height is needed for loading all the goods items in this supply chain consignment.

Type

IUneceLinearUnitMeasureType[] | undefined

loadingBaseportLocation?object

The baseport location at which this supply chain consignment is to be loaded on a means of transport according to the transport contract.

Type

IUneceLogisticsLocation | undefined

loadingInformation?string

Loading information, expressed as text, for this supply chain consignment, such as advice and instructions.

Type

string | undefined

loadingInstructions?array

Loading instructions for this supply chain consignment.

Type

IUneceTransportInstructions[] | undefined

loadingListQuantity?object

The number of loading lists, manifests or similar documents for this supply chain consignment.

Type

IUneceQuantityType | undefined

loadingLocation?object

The logistics location where the supply chain consignment is loaded.

Type

IUneceLogisticsLocation | undefined

loadingSequenceNumeric?string

The loading sequence number for this supply chain consignment.

Type

string | undefined

localConsigneeAgentParty?object

The local party authorized to act for or on behalf of the consignee for this supply chain consignment.

Type

IUneceTradeParty | undefined

mainCarriageTransportMovement?array

A main carriage logistics transport movement for this supply chain consignment.

Type

IUneceTransportMovement[] | undefined

manifestAssociatedDocument?array

A referenced manifest document associated to this supply chain consignment.

Type

IUneceDocument[] | undefined

natureIdentificationCargo?object

Transport cargo details of this supply chain consignment sufficient to identify its nature for customs, statistical or transport purposes.

Type

IUneceCargo | undefined

nilCarriageValueIndicator?union

The indication of whether or not this supply chain consignment has a nil value for carriage.

Type

boolean | undefined

nilCustomsValueIndicator?union

The indication of whether or not this supply chain consignment has a nil value for customs.

Type

boolean | undefined

nilInsuranceValueIndicator?union

The indication of whether or not this supply chain consignment has a nil value for insurance.

Type

boolean | undefined

notifiedParty?array

A party who has been or will be notified about this supply chain consignment.

Type

IUneceTradeParty[] | undefined

onCarriageTransportMovement?array

An on-carriage logistics transport movement for this supply chain consignment.

Type

IUneceTransportMovement[] | undefined

onwardRoutingLocation?array

An onward routing location for this supply chain consignment.

Type

IUneceLogisticsLocation[] | undefined

originCountry?array

A country of origin for this supply chain consignment.

Type

IUneceCountry[] | undefined

originGeopoliticalRegion?object

The geopolitical region of origin for this supply chain consignment.

Type

IUneceGeopoliticalRegion | undefined

originalDespatchLocation?object

The location from which this supply chain consignment was originally despatched.

Type

IUneceLogisticsLocation | undefined

packageQuantity?object

The number of packages within this supply chain consignment.

Type

IUneceQuantityType | undefined

packageType?string

A type of package, expressed as text, for this supply chain consignment.

Type

string | undefined

physicalShippingMarks?array

Physical logistics shipping marks and barcoding information related to this supply chain consignment.

Type

IUneceShippingMarks[] | undefined

pickUpEvent?object

The pick-up event for this supply chain consignment.

Type

IUneceTransportEvent | undefined

pickUpParty?object

The pick-up trade party for this supply chain consignment.

Type

IUneceTradeParty | undefined

preCarriageTransportMovement?array

A pre-carriage logistics transport movement for this supply chain consignment.

Type

IUneceTransportMovement[] | undefined

previousAdministrativeDocument?array

A previous administrative referenced document for this supply chain consignment.

Type

IUneceDocument[] | undefined

reExportCountry?array

A re-export country for this supply chain consignment.

Type

IUneceCountry[] | undefined

relatedBookingType?string

The type of booking, expressed as text, related to this supply chain consignment.

Type

string | undefined

relatedTradeTransaction?array

A trade transaction related to this supply chain consignment.

Type

IUneceSupplyChainTradeTransaction[] | undefined

reportedLogisticsStatus?array

A logistics status reported for this supply chain consignment.

Type

IUneceLogisticsStatus[] | undefined

riskFactorCode?string

The code specifying a risk factor for this supply chain consignment.

Type

string | undefined

sequenceNumeric?string

The sequence number for this referenced supply chain consignment.

Type

string | undefined

serviceChargeApplicableCurrencyExchange?array

A currency exchange applicable to a service charge for this supply chain consignment.

Type

IUneceCurrencyExchange[] | undefined

shipFromParty?object

The ship from party for this supply chain consignment.

Type

IUneceTradeParty | undefined

shipStoresIndicator?union

The indication of whether or not this supply chain consignment is for ship stores, such as for consumption on the means of transport.

Type

boolean | undefined

shipToParty?object

The ship to party for this supply chain consignment.

Type

IUneceTradeParty | undefined

shippedOnboardDateTime?string

A date, time, date time, or other date time value when this supply chain consignment is shipped onboard.

Type

string | undefined

specifiedDeliveryTerms?array

Delivery terms specified for this supply chain consignment.

Type

IUneceDeliveryTerms[] | undefined

specifiedInspectionEvent?array

An inspection event specified for this supply chain consignment.

Type

IUneceInspectionEvent[] | undefined

specifiedLogisticsStatus?array

Logistics status information specified for this supply chain consignment.

Type

IUneceLogisticsStatus[] | undefined

specifiedRiskAnalysisResult?array

A result of a logistics risk analysis calculation specified for this supply chain consignment.

Type

IUneceRiskAnalysisResult[] | undefined

specifiedSupplyChainReference?array

A reference specified for this supply chain consignment.

Type

IUneceSupplyChainReference[] | undefined

specifiedTransportMovement?array

A logistics transport movement specified for this supply chain consignment.

Type

IUneceTransportMovement[] | undefined

statementNote?array

A statement note for this referenced supply chain consignment.

Type

IUneceNote[] | undefined

storageEvent?array

A storage event for this supply chain consignment.

Type

IUneceTransportEvent[] | undefined

summaryDescription?string

A textual summary description of this supply chain consignment.

Type

string | undefined

totalAllowanceChargeAmount?object

The total monetary value of all allowances and charges for this supply chain consignment.

Type

IUneceAmountType | undefined

totalChargeAmount?object

The total monetary value of all freight and other service charges for this supply chain consignment.

Type

IUneceAmountType | undefined

totalCollectChargeAmount?object

The total monetary value of all freight and other service charges which are to be collected from the consignee at or after delivery for this supply chain consignment.

Type

IUneceAmountType | undefined

totalDisbursementAmount?object

The monetary value of total disbursement for this supply chain consignment, such as the amount to be collected by the carrier according to the order given by the consignor.

Type

IUneceAmountType | undefined

totalExportExitToImportEntryChargeAmount?object

The monetary value of the total charge or charges of freight, insurance and other services for this supply chain consignment calculated from the export exit location to the import entry location.

Type

IUneceAmountType | undefined

totalPrepaidChargeAmount?object

The total monetary value of all freight and other service charges which have been paid in advance for this supply chain consignment.

Type

IUneceAmountType | undefined

totalTareWeightMeasure?object

The measure of the total tare weight (mass) of this supply chain consignment.

Type

IUneceMeasureType | undefined

tradedParcelId?union

A traded parcel identifier for this supply chain consignment.

Type

string | IJsonLdValueObject | undefined

transitCountry?array

A transit country for this supply chain consignment.

Type

IUneceCountry[] | undefined

transitLocation?array

A location of transit for this supply chain consignment.

Type

IUneceLogisticsLocation[] | undefined

transportContractDocument?object

The referenced transport contract document for this supply chain consignment, such as an airwaybill or a seawaybill.

Type

IUneceDocument | undefined

transportEquipmentQuantity?array

A number of pieces of transport equipment, such as containers or similar unit load devices, in this supply chain consignment.

Type

IUneceQuantityType[] | undefined

transportEquipmentSplitGoodsIndicator?union

The indication of whether or not the goods in this supply chain consignment are split across more than one piece of transport equipment.

Type

boolean | undefined

transportEvent?array

An event occurring during the transport of this supply chain consignment.

Type

IUneceTransportEvent[] | undefined

transportPackage?array

Transport packages for this supply chain consignment.

Type

IUnecePackage[] | undefined

transportService?array

A transport service for this supply chain consignment.

Type

IUneceService[] | undefined

transportServicePaymentArrangementCode?union

The code specifying the payment arrangements for this supply chain consignment.

Type

UneceTransportServicePaymentArrangementCodeList | undefined

transportServicesBuyerParty?object

The party which is the buyer of the transport services for this supply chain consignment.

Type

IUneceTradeParty | undefined

transportSplitDescription?string

The textual description of the transport split of this referenced supply chain consignment across different transport means or transport equipment.

Type

string | undefined

transshipmentLocation?array

A transshipment location for this supply chain consignment.

Type

IUneceLogisticsLocation[] | undefined

transshipmentPermissionIndicator?union

The indication of whether or not transshipment is permitted for this supply chain consignment.

Type

boolean | undefined

unloadingBaseportLocation?object

The baseport location at which this supply chain consignment is to be unloaded from a means of transport according to the transport contract.

Type

IUneceLogisticsLocation | undefined

unloadingLocation?object

The logistics location where the supply chain consignment is unloaded.

Type

IUneceLogisticsLocation | undefined

unloadingSequenceNumeric?string

The unloading sequence number for this supply chain consignment.

Type

string | undefined

utilizedTransportEquipment?array

Logistics transport equipment utilized for this supply chain consignment.

Type

IUneceLogisticsTransportEquipment[] | undefined

vanningEvent?object

The vanning event for this supply chain consignment, i.e. the loading of this consignment at the place of original despatch.

Type

IUneceTransportEvent | undefined

volumeUnitGrossVolumeMeasure?array

A measure of the gross volume, normally calculated by multiplying the maximum length, width and height of this supply chain consignment.

Type

IUneceVolumeUnitMeasureType[] | undefined

volumeUnitNetVolumeMeasure?array

A measure of the net volume of this supply chain consignment item which excludes all packaging.

Type

IUneceVolumeUnitMeasureType[] | undefined

warehouseArrivalDateTime?string

The date, time, date time or other date time value of the arrival of this supply chain consignment at a warehouse.

Type

string | undefined

warehouseDepositorParty?array

A party depositing goods in a warehouse for this supply chain consignment.

Type

IUneceTradeParty[] | undefined

warehouseKeeperParty?array

A party taking responsibility for goods stored in a warehouse for this supply chain consignment.

Type

IUneceTradeParty[] | undefined

warehouseOperatorParty?array

A party that operates a warehouse in which goods are stored for this supply chain consignment.

Type

IUneceTradeParty[] | undefined

warehouseStorageEvent?array

A warehouse storage event for this referenced supply chain consignment.

Type

IUneceTransportEvent[] | undefined

weightUnitChargeableWeightMeasure?array

A measure of a chargeable weight of this supply chain consignment.

Type

IUneceWeightUnitMeasureType[] | undefined

weightUnitGrossWeightMeasure?array

A measure of the gross weight (mass) of this supply chain consignment which includes the weight of packaging but which excludes the weight of any transport equipment.

Type

IUneceWeightUnitMeasureType[] | undefined

weightUnitNetWeightMeasure?array

A measure of the net weight (mass) of this consignment which excludes the weight of packaging of this supply chain consignment and that of any transport equipment.

Type

IUneceWeightUnitMeasureType[] | undefined

idstring

Unique urn representing the AIG vertex.

Type

string

createdstring

When was the consignment created.

Type

string

updatedstring

When was the consignment last updated.

Type

string

includedConsignments?array

Associated consignments.

Type

IConsignmentView[] | undefined

documentsarray

Goods Load documents.

Type

IDocument[]

eventsarray

Consignment events Data.

Type

IJsonLdNodeObject[]

systemEvents?array

System events associated with the consignment.

Type

ISystemEvent[] | undefined

resolvedTransportMode?object

Resolved transport mode code.

Type

IResolvedUneceCode | undefined

resolvedTransportEquipment?array

Resolved transport equipment codes.

Type

ITransportEquipmentSummary[] | undefined

ResolvedUneceCode

Shape of resolvedTransportMode and items inside resolvedTransportEquipment[].transportMeansTypes.

Prop

Type

rawstring

The raw UNECE code string (e.g., "unece:TransportModeCodeList#3").

Type

string

codestring

The extracted code (e.g., "3").

Type

string

labelstring

Human-readable label from UnCodeLists (e.g., "Road transport").

Type

string

TransportEquipmentSummary

Shape of items inside resolvedTransportEquipment.

Prop

Type

identifier?string

The equipment identifier.

Type

string | undefined

transportMeansTypes?array

Resolved transport means type codes.

Type

IResolvedUneceCode[] | undefined

EventView

Nested inside ConsignmentView.events.

Prop

Type

typeCodestring

A code specifying the type of supply chain event.

Type

string

occurrenceDateTimestring

The date and time that the event occurred in ISO 8601 format.

Type

string

occurrenceLocation?object

The referenced geographical location for the occurrence of this supply chain event.

Type

{ name: string; identifier?: string; } | undefined

DocumentAttachment

Returned by GET /supply-chain/data-space/consignments/:id/documents.

Prop

Type

idstring

The unique id of the latest revision in storage.

Type

string

documentIdstring

The business identifier of the document in supply chain e.g. INV-12345.

Type

string

documentCodeUneceDocumentCodeList

The UNECE document type code.

Type

UneceDocumentCodeList

documentType?string

The human-readable document type eg Commercial Invoice, Packing List etc.

Type

string | undefined

documentRevisionnumber

The revision of the document as a 0-based index.

Type

number

metadata?object

Blob and version metadata for the latest revision.

Type

IDocumentAttachmentMetadata | undefined

hrefstring

The GET URL to retrieve the latest revision's content.

Type

string

history?array

Previous revisions of this document, sorted ascending by documentRevision.

Type

IDocumentAttachmentHistoryEntry[] | undefined

DocumentAttachmentMetadata

Shape of DocumentAttachment.metadata.

Prop

Type

encodingFormat?string

The MIME type of the document blob (e.g. "application/pdf").

Type

string | undefined

blobSize?number

The size of the document blob in bytes.

Type

number | undefined

fileExtension?string

The file extension of the document blob (e.g. "pdf").

Type

string | undefined

DocumentAttachmentHistoryEntry

Shape of items inside DocumentAttachment.history.

Prop

Type

idstring

The unique id of this revision in storage.

Type

string

documentRevisionnumber

The revision number as a 0-based index.

Type

number

hrefstring

The GET URL to retrieve this revision's content.

Type

string

DocumentCreateResult

Response body after a successful document upload.

Prop

Type

identifierstring

Identifier of the document.

Type

string

versionId?string

Revision of the document, if available.

Type

string | undefined

aigIdstring

AIG vertex id of the created or updated document.

Type

string

SupplyChainAppDocument

The object field shape when using Add to attach a document via the DSC inbox.

Prop

Type

@contextunion

JSON-LD Context.

Type

(UneceContextType | undefined) & UneceContextType

type"Document"

JSON-LD Type.

Type

"Document"

acceptablePeriod?object

The specified period within which this referenced document may be accepted.

Type

IUneceSpecifiedPeriod | undefined

acceptanceDateTime?string

The date, time, date time, or other date time value of the acceptance of this referenced document.

Type

string | undefined

attachedBinaryFile?array

A specified binary file attached to this referenced document.

Type

IUneceBinaryFile[] | undefined

attachmentBinaryObject?string

A binary object that is attached or otherwise appended to this referenced document.

Type

string | undefined

authenticatedOriginalIndicator?union

The indication of whether or not this referenced document is an authenticated original.

Type

boolean | undefined

categoryCode?string

The code specifying the category of this referenced document.

Type

string | undefined

communicationChannelCode?union

The code specifying the channel by which this referenced document is sent, such as mail, email, fax.

Type

UneceCommunicationChannelCodeList | undefined

contractualClause?array

A contractual clause of this referenced document.

Type

IUneceClause[] | undefined

controlRequirementIndicator?union

The indication of whether or not this referenced document requires a control.

Type

boolean | undefined

copyIndicator?union

The indication of whether or not the referenced document is a copy.

Type

boolean | undefined

copyIssuedQuantity?object

The number of copies issued of this referenced document.

Type

IUneceQuantityType | undefined

copyRequiredQuantity?object

The number of copies required of this referenced document.

Type

IUneceQuantityType | undefined

creationDateTime?string

The date, time, date time, or other date time value of the creation of this referenced document.

Type

string | undefined

description?string

A textual description for this referenced document.

Type

string | undefined

documentAmendmentPurposeCode?string

The code specifying the purpose of an amendment to this referenced document.

Type

string | undefined

documentLanguageId?union

An identifier for a language used in this referenced document.

Type

string | ({ "@index"?: string | undefined; "@context"?: IJsonLdContextDefinitionRoot | undefined; } & { "@value": null | boolean | number | string; "@language"?: string | undefined; "@direction"?: "ltr" | "rtl" | null | undefined; }) | ({ "@index"?: string | undefined; "@context"?: IJsonLdContextDefinitionRoot | undefined; } & { "@value": null | boolean | number | string; "@type": string; }) | ({ "@index"?: string | undefined; "@context"?: IJsonLdContextDefinitionRoot | undefined; } & { "@value": null | boolean | number | string | IJsonLdJsonObject | IJsonLdJsonArray; "@type": "@json"; }) | undefined

documentLineStatusCode?union

The code specifying the status of a line in this referenced document.

Type

UneceLineStatusCodeList | undefined

documentStatusCode?union

The code specifying the status for this referenced document.

Type

UneceDocumentStatusCodeList | undefined

documentType?string

A type, expressed as text, for this referenced document.

Type

string | undefined

documentTypeCodeunion

The code specifying the type of referenced document.

Type

effectiveSpecifiedPeriod?object

The specified period within which this referenced document is effective.

Type

IUneceSpecifiedPeriod | undefined

electronicPresentationIndicator?union

The indication of whether or not this referenced document is presented in an electronic format.

Type

boolean | undefined

globalId?union

A unique global identifier for this referenced document.

Type

string | IJsonLdValueObject | undefined

identifierunion

A unique identifier for this referenced document.

Type

(string | IJsonLdValueObject | undefined) & (string | IJsonLdValueObject)

includedAmount?array

A monetary value included in this referenced document.

Type

IUneceAmountType[] | undefined

includedNote?array

A note included in this referenced document.

Type

IUneceNote[] | undefined

information?string

Information, expressed as text, for this referenced document.

Type

string | undefined

issueDateTimestring

The formatted date or date time for the issuance of this referenced document.

Type

string

issueLogisticsLocation?object

The logistics related location where this referenced document has been issued.

Type

IUneceLogisticsLocation | undefined

issuerAssignedId?union

The unique issuer assigned identifier for this referenced document.

Type

string | IJsonLdValueObject | undefined

issuerParty?object

The trade related party that issues this referenced document.

Type

IUneceTradeParty | undefined

issuerSpecifiedInstructions?array

Handling instructions specified by the issuer for this referenced document.

Type

IUneceDocumentHandlingInstructions[] | undefined

itemIdentificationId?union

The unique identifier of an item in this referenced document.

Type

string | IJsonLdValueObject | undefined

lineCountNumeric?string

The number of lines for this referenced document.

Type

string | undefined

lineId?union

The unique identifier of a line in this referenced document.

Type

string | IJsonLdValueObject | undefined

lineItemQuantity?object

The number of line items in this referenced document.

Type

IUneceQuantityType | undefined

lodgementLocation?object

The logistics related location where this referenced document has been lodged.

Type

IUneceLogisticsLocation | undefined

messageFunctionPurposeCode?union

The code specifying the purpose of this referenced document.

Type

UneceMessageFunctionCodeList | undefined

name?string

A name, expressed as text, for this referenced document.

Type

string | undefined

originalIssuedQuantity?object

The number of originals issued of this referenced document.

Type

IUneceQuantityType | undefined

originalRequiredQuantity?object

The number of originals required of this referenced document.

Type

IUneceQuantityType | undefined

pageId?union

The identifier of the page for this referenced document.

Type

string | IJsonLdValueObject | undefined

previousRevisionId?union

An identifier for a previous revision of this referenced document.

Type

string | IJsonLdValueObject | undefined

processCondition?string

A process condition, expressed as text, for this referenced document.

Type

string | undefined

processConditionCode?string

The code specifying the process condition for this referenced document.

Type

string | undefined

proprietaryType?string

A proprietary type, expressed as text, for this referenced document.

Type

string | undefined

receiptDateTime?string

The date, time, date time, or other date time value for the formal receipt of this referenced document.

Type

string | undefined

recipientTradeParty?array

A trade related party that receives this referenced document.

Type

IUneceTradeParty[] | undefined

referenceDateTime?string

The reference date or date time for this referenced document.

Type

string | undefined

referenceRelationshipTypeCode?string

The code specifying the type of relationship between this referenced document and another artefact, such as a replacement of an original document.

Type

string | undefined

referenceTypeCode?string

The code specifying the reference type of this referenced document.

Type

string | undefined

remarks?string

A remark, expressed as text, regarding this referenced document.

Type

string | undefined

reportCountNumeric?string

The report count for this referenced document.

Type

string | undefined

revision?string

A revision, expressed as text, for this referenced document.

Type

string | undefined

revisionDateTime?string

A date, time, date time or other date time value for the revision of this referenced document.

Type

string | undefined

revisionId?union

A unique identifier for a revision of this referenced document.

Type

string | IJsonLdValueObject | undefined

sectionName?string

A section name, expressed as text, for this referenced document.

Type

string | undefined

senderTradeParty?object

The trade related party that sends this referenced document.

Type

IUneceTradeParty | undefined

signatoryAuthentication?array

A signatory authentication for this referenced document.

Type

IUneceAuthentication[] | undefined

specifiedDocumentStatus?array

Status information specified for this referenced document.

Type

IUneceDocumentStatus[] | undefined

status?string

A status, expressed as text, for this referenced document.

Type

string | undefined

subordinateLineId?union

The identifier of the subordinate line of this referenced document.

Type

string | IJsonLdValueObject | undefined

subtypeCode?string

A code specifying a subtype of this referenced document.

Type

string | undefined

totalIssueCountNumeric?string

The total issue count for this referenced document.

Type

string | undefined

uRIIdunion

The unique Uniform Resource Identifier (URI) for this referenced document.

Type

(string | IJsonLdValueObject | undefined) & (string | IJsonLdValueObject)

validityPeriod?array

A period of validity specified for this referenced document.

Type

IUneceSpecifiedPeriod[] | undefined

versionIdunion

The identifier for the version of this referenced document.

Type

(string | IJsonLdValueObject | undefined) & (string | IJsonLdValueObject)

Schema

On this page