Shipment Data - EDI Portal Spotworx

Shipment

messageType: transport.shipment

Get shipment data from Cargo Partner.

The sample files provided are based on real world shipments where parties and references have been changed for privacy reasons.

You can also get into contact with our Integration Competence Center and we will provide you with real examples based on your shipments

Sample files:

JSON XML

{
	"messageHeader": {...},
	"Shipment": {...}
}

Property	Type	Mandatory	Description
messageHeader	MessageHeader	M	Message Header information.
Shipment	Shipment	M	Shipment information

GET Shipment

JSON XML

"...": {
  "cargoDescriptions": [{...}],
  "containerDefinition": {...},
  "events": [{...}],
  "mainCategory": "FCL",
  "mainModality": "AIR",
  "shipmentStatus": "CARGO_EXPECTED_FOR_TRANSPORT",
  "participants": {...},
  "routingInformation": {...},
  "shipmentDetails": {...},
  "trackingId": "string"
}

Property	Type	Mandatory	Description
cargoDescriptions	Array[CargoDescription]	M	Transport cargo description. For FCL/REEFER per container.
containerDefinition	ContainerDefinition	C	Available for SEA FCL/REEFER.
events	Array[Event]	M	List of transport events
mainCategory	String	C	Valid values for ROAD: `FTL, LTL, GROUPAGE` Valid values for SEA: `FCL, LCL, REEFER`. Not available for `AIR`
mainModality	String	M	Modality of transport. Values: `AIR, ROAD, SEA, AIR_SEA, SEA_AIR`
shipmentStatus	String	O	Information about the shipment status. Values: `CARGO_EXPECTED_FOR_TRANSPORT`, `CARGO_READY_FOR_TRANSPORT`, `PICKED_UP`, `DEPARTED`, `ARRIVED`, `DELIVERED`.
participants	ShipmentParticipants	M	Parties participating in a transport
routingInformation	ShipmentRoutingInformation	M	Information about shipment routing
shipmentDetails	ShipmentDetails	M	Additional shipment details
trackingId	String	M	SPOT Shipment tracking ID. (SPOT ID)

ShipmentParticipants

JSON XML

"...": {
	"airHub": {...},
	"consignee": {...},
	"controllingAgent": {...},
	"delivery": {...},
	"destinationAgent": {...},
	"destinationHub": {...},
	"destinationWarehouse": {...},
	"exportCustomsBroker": {...},
	"exportConsolidationHub": {...},
	"importCustomsBroker": {...},
	"exportDeconsolidationHub": {...},
	"mainInvoiceTo": {...},
	"notifyAgent": {...},
	"originAgent": {...},
	"originHub": {...},
	"originWarehouse": {...},
	"pickup": {...},
	"principal": {...},
	"seaHub": {...},
	"shipper": {...},
	"shippersTradingCompany": {...},
	"thirdParties": [{...}],
	"transitHubs": [{...}]
}

Property	Type	Mandatory	Description
airHub	Party	O
consignee	Party	M
controllingAgent	Party	M	Office in charge of transport.
delivery	Party	C	Delivery location. Not available if `shipperSelfDelivery` is true.
destinationAgent	Party	O	Not available if `mainModality` is `ROAD`.
destinationHub	Party	C	Only available if `mainModality` is `ROAD` and `mainCategory` is `GROUPAGE`.
destinationWarehouse	Party	O
exportCustomsBroker	Party	O
exportConsolidationHub	Party	O
importCustomsBroker	Party	O
importDeconsolidationHub	Party	O
mainInvoiceTo	Party	M	Party which will be invoiced.
notifyAgent	Party	O
originAgent	Party	O	Not available if `mainModality` is `ROAD`.
originHub	Party	C	Only available if `mainModality` is `ROAD` and `mainCategory` is `GROUPAGE`.
originWarehouse	Party	O
pickup	Party	C	Pickup location. Not available if `consigneeSelfPickup` is true.
principal	Party	M	Owner of the transport order.
seaHub	Party	O
shipper	Party	M
shippersTradingCompany	Party	O
thirdParties	Array[Party]	O
transitHubs	Array[Party]	O

To following parties are only visible for agents:

airHub
seaHub
transitHubs
exportConsolidationHub
importDeconsolidationHub

ShipmentRoutingInformation

JSON XML

"...": {
	"delivery": {...},
	"pickup": {...},
	"routingPoints": [{...}]
}

Property	Type	Mandatory	Description
pickup	ShipmentRoutingPointPickup	M	Information to pickup
routingPoints	Array[ShipmentRoutingPoint]	O	Information to routing points between Pickup and Delivery (e.g. Port of loading, Port of discharge, ...)
delivery	ShipmentRoutingPointDelivery	M	Information to delivery

ShipmentRoutingPoint

JSON XML

"...": {
	"city": "string",
	"countryCode": "string",
	"estimatedArrival": {...},
	"estimatedDeparture": {...},
	"iataCode": "string",
	"legModality": "SEA_FCL",
	"realArrival": {...},
	"realDeparture": {...},
	"remark": "string",
	"routingPointType": "PICKUP",
	"unlocode": "string",
	"zipCode": "string"
}

Property	Type	Mandatory	Description
remark	String	O
routingPointType	String	M	Valid values: `EXPORT_CONSOLIDATION_HUB, ORIGIN_WAREHOUSE, DEPARTURE_AIRPORT, PORT_OF_LOADING, TRANSIT_HUB, ORIGIN_HUB, SEA_HUB, AIR_HUB, DESTINATION_HUB, ARRIVAL_AIRPORT, PORT_OF_DISCHARGE, IMPORT_DECONSOLIDATION_HUB, DESTINATION_WAREHOUSE, FINAL_DESTINATION, UNASSIGNED_HUB`
legModality	String	O	If specified, shows transport modality between this and the next routing point.
countryCode	String	C	Routing point location ISO country code (ISO 3166-1 Alpha-2)
city	String	C	Routing point location city
zipCode	String	C	Routing point location zipCode
iataCode	String	C	3-letter IATA location code of routing point.
unlocode	String	C	5-letter UnLocode location of routing point.
estimatedArrival	ApiDate	O	Estimated arrival at specified routing location.
realArrival	ApiDate	O	Actual arrival at specified routing location.
estimatedDeparture	ApiDate	O	Estimated departure from specified routing location.
realDeparture	ApiDate	O	Actual departure from specified routing location.

To following routing point types are only visible for agents:

EXPORT_CONSOLIDATION_HUB
TRANSIT_HUB
ORIGIN_HUB
SEA_HUB
AIR_HUB
DESTINATION_HUB
IMPORT_DECONSOLIDATION_HUB
UNASSIGNED_HUB

ShipmentRoutingPointPickup

JSON XML

"...": {
  "city": "string",
  "countryCode": "string",
  "desiredPickup": {...},
  "estimatedCargoReadiness": {...},
  "estimatedPickup": {...},
  "iataCode": "string",
  "legModality": "SEA_FCL",
  "realCargoReadiness": {...},
  "realPickup": {...},
  "remark": "string",
  "routingPointType": "PICKUP",
  "shipperSelfDelivery": true,
  "unlocode": "string",
  "zipCode": "string"
}

Property	Type	Mandatory	Description
remark	String	O
routingPointType	String	M	Valid values: `PICKUP, PLACE_OF_RECEIPT`
legModality	String	O	If specified, shows transport modality between this and the next routing point.
countryCode	String	C	Routing point location ISO country code (ISO 3166-1 Alpha-2)
city	String	C	Routing point location city
zipCode	String	O	Routing point location zipCode
iataCode	String	C	3-letter IATA location code of routing point.
unlocode	String	C	5-letter UnLocode location of routing point.
estimatedCargoReadiness	ApiDate	M	Estimated date when cargo will be ready for transport.
realCargoReadiness	ApiDate	O	Actual date when cargo was ready for transport.
estimatedPickup	ApiDate	O	Estimated date when cargo will be picked up.
realPickup	ApiDate	O	Actual date when cargo was picked up.
desiredPickup	ApiDateFromTo	O	Time frame of desired pickup of cargo.
shipperSelfDelivery	Boolean	O

ShipmentRoutingPointDelivery

JSON XML

"...": {
  "city": "string",
  "consigneeSelfPickup": true,
  "countryCode": "string",
  "desiredDelivery": {...},
  "estimatedDelivery": {...},
  "iataCode": "string",
  "legModality": "SEA_FCL",
  "realDelivery": {...},
  "remark": "string",
  "routingPointType": "PICKUP",
  "unlocode": "string",
  "zipCode": "string"
}

Property	Type	Mandatory	Description
remark	String	O
routingPointType	String	M	Valid values: `PLACE_OF_HANDOVER, DELIVERY`
legModality	String	O	If specified, shows transport modality between this and the next routing point.
countryCode	String	C	Routing point location ISO country code (ISO 3166-1 Alpha-2)
city	String	C	Routing point location city
zipCode	String	C	Routing point location zipCode
iataCode	String	C	3-letter IATA location code of routing point.
unlocode	String	C	5-letter UnLocode location of routing point.
consigneeSelfPickup	Boolean	O
estimatedDelivery	ApiDate	O	Estimated date when cargo will be delivered.
realDelivery	ApiDate	O	Actual date when cargo was delivered.
desiredDelivery	ApiDateFromTo	O	Time frame of desired delivery of cargo.

ShipmentDetails

JSON XML

"...": {
    "deliveryTerm": {...},
    "electronicFreight": "string",
    "hblOriginalRequired": true,
    "insurance": {...},
    "paymentDefinition": {...},
    "references": [{...}],
    "serviceSpecification": {...},
    "shipmentTransportDetails": {...}
}

Property	Type	Mandatory	Description
deliveryTerm	DeliveryTerm	M	IncoTerm and Location
electronicFreight	String	O
hblOriginalRequired	Boolean	O
insurance	Insurance	O	Insurance details
paymentDefinition	PaymentDefinition	O	Payment information
references	Array[TransportOrderReference]	O	Shipment references
serviceSpecification	ServiceSpecification	O	Additional transport services
shipmentTransportDetails	ShipmentTransportDetails	O	Additional transport details

ShipmentTransportDetails

JSON XML

"...": {
  "carrierContractNumber": "string",
  "flightNumbers": ["string"],
  "hawb": "string",
  "hbl": "string",
  "mawb": "string",
  "mbl": "string",
  "oceanCarrier": {...},
  "plateNumbers": ["string"],
  "roadCarrier": "string",
  "vesselName": "string",
  "voyageNumber": "string"
}

Property	Type	Mandatory	Description
carrierContractNumber	String	O
flightNumbers	Array[String]	O
mbl	String	O	Master-BoL number
hbl	String	O	House-BoL number
mawb	String	O	Master-AWB number
hawb	String	O	House-AWB number
oceanCarrier	OceanCarrier	O	Information about ocean carrier
plateNumbers	Array[String]	O	Truck plate numbers
roadCarrier	String	O	Name of road carrier
vesselName	String	O	Name of carrier vessel
voyageNumber	String	O	Vessel voyage number

Transport Common Objects Item Master