NAV Navbar
Spot
JSON XML

Introduction

A documentation Platform, made by developers for developers to support the daily business in international freight transports and logistics.

You can use our standard interfaces to create transport order, get or send shipment data as well as get/send status information/milestones about specific shipments.

The API is only available for internal use by SPOT customers. Interested in SPOT? Contact us, it’s free!

General

Message Structure

Structured Files

For easier understanding and implementation there is a default message header in each file. We provide this header in CSV, XML, JSON etc. to provide information about the file transfer itself.

MessageHeader

"messageHeader": {
    "messageId": "1",
    "messageDate": "2017-02-08",
    "messageTime": "11:52:26",
    "messageType": "transport.eventUpdate",
    "messageVersion": "V1.0",
    "messageScope": "TEST"
}
<messageHeader>
    <messageId>244016</messageId>
    <messageDate>2017-04-05</messageDate>
    <messageTime>00:18:06</messageTime>
    <messageType>transport.clientTransportOrder</messageType>
    <messageVersion>1.0</messageVersion>
    <messageScope>PROD</messageScope>
</messageHeader>
Property Type Mandatory Description
messageId String M Identifier for tracing in case of error/debugging.
messageDate String M Date of message transfer in format YYYY-MM-DD as defined by ISO 8601.
messageTime String M UTC Time of message transfer in format hh:mm:ss as defined by ISO 8601.
messageType String M Unique identifier to distinguish between different message types.
messageVersion String M Message version.
messageScope String M Valid values: DEV, TEST, PROD

Transport

Client Transport Orders

CREATE Client Transport Order

messageType: transport.clientTransportOrder

{
    "messageHeader":{...},
    "clientTransportOrder":{...}
}
<?xml version="1.0" encoding="UTF-8" ?>
<clientTransportOrders>
    <messageHeader>...</messageHeader>
    <ClientTransportOrder>...</ClientTransportOrder>
</clientTransportOrders>

Creates a transport order in our SPOT system.

FTP folder: /in/transport/clientTransportOrder

Sample files

The sample files are provided in 3 levels of detail: Small, Medium and Large. Small only contains the bare necessities needed to create an order in our system, whereas for large almost all possible fields of the respective modality are filled.

While it is possible to send us orders with only the minimum of data provided, it is highly recommended to provide as much information as possible.

Property Type Mandatory Description
messageHeader MessageHeader M Message Header information.
ClientTransportOrder ClientTransportOrder M Transport Order

ClientTransportOrder

"ClientTransportOrder":{
  "businessDirection": "EXPORT",
  "cargoDescription": [{...}],
  "containerDefinition": {...},
  "customerAccountNumber": "string",
  "deliveryTerm": {...},
  "mainCategory": "FCL",
  "mainModality": "AIR",
  "orderDetails": {...},
  "participants": {...},
  "routingInformation": {...}
}
<ClientTransportOrder>
  <businessDirection>EXPORT</businessDirection>
  <cargoDescription>...</cargoDescription>
  <containerDefinition>...</containerDefinition>
  <customerAccountNumber>string</customerAccountNumber>
  <deliveryTerm>...</deliveryTerm>
  <mainCategory>FCL</mainCategory>
  <mainModality>AIR</mainModality>
  <orderDetails>...</orderDetails>
  <participants>...</participants>
  <routingInformation>...</routingInformation>
</ClientTransportOrder>
Property Type Mandatory Description
businessDirection String M Identifies direction of goods from principals viewpoint.
Valid values: IMPORT, EXPORT, TRIANGLE
cargoDescription Array[CargoDescription] M Transport cargo description. For FCL/REEFER per container.
containerDefinition ContainerDefinition C Mandatory for SEA FCL, REEFER
deliveryTerm DeliveryTerm M IncoTerm and Location
mainCategory String C Defines the subtype of the transport modality. Mandatory for SEA shipments.
Valid values for ROAD: FTL, LTL, GROUPAGE
Valid values for SEA: FCL, LCL, REEFER
mainModality String M Modality of transport. Valid values: AIR, ROAD, SEA, AIR_SEA, SEA_AIR
customerAccountNumber String M Your SPOT account number. This is used to associate the created order with your company or office.
orderDetails OrderDetails O Additional detail information
participants Participants M Parties participating in a transport
routingInformation RoutingInformation M Information about the transport routing and dates

OrderDetails

"orderDetails": {
    "insurance": {...},
    "paymentDefinition": {...},
    "references": [{...}],
    "serviceSpecification": {...},
    "transportDetails": {...}
}
  <orderDetails>
    <insurance>...</insurance>
    <paymentDefinition>...</paymentDefinition>
    <references>...</references>
    <serviceSpecification>...</serviceSpecification>
    <transportDetails>...</transportDetails>
  </orderDetails>
Property Type Mandatory Description
insurance Insurance O Insurance details
references Array[TransportOrderReference] O Shipment references
paymentDefinition PaymentDefinition O Payment details
transportDetails TransportDetails O Additional transport details
serviceSpecification ServiceSpecification O Additional transport services

TransportDetails

"transportDetails": {
  "oceanCarrier": {...},
  "carrierBookingNumber": "string",
  "carrierContractNumber": "string",
  "hawb": "string",
  "hbl": "string",
  "mawb": "string",
  "mbl": "string",
  "plateNumber": "string",
  "vesselName": "string",
  "voyageNumber": "string"
}
<transportDetails>
  <oceanCarrier>...</oceanCarrier>
  <carrierBookingNumber>string</carrierBookingNumber>
  <carrierContractNumber>string</carrierContractNumber>
  <hawb>string</hawb>
  <hbl>string</hbl>
  <mawb>string</mawb>
  <mbl>string</mbl>
  <plateNumber>string</plateNumber>
  <vesselName>string</vesselName>
  <voyageNumber>string</voyageNumber>
</transportDetails>
Property Type Mandatory Description
oceanCarrier OceanCarrier O Provide for designated carrier.
carrierContractNumber String O
carrierBookingNumber 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.
vesselName String O Name of carrier vessel.
voyageNumber String O Vessel voyage number.
plateNumbers Array[String] O Truck plate numbers.

RoutingInformation

"routingInformation":{
    "pickup":{...},
    "delivery":{...},
    "airportOfDeparture":{...},
    "airportOfArrival":{...},
    "portOfLoading":{...},
    "portOfDischarge":{...}
}
<routingInformation>
    <airportOfArrival>...</airportOfArrival>
    <airportOfDeparture>...</airportOfDeparture>
    <delivery>...</delivery>
    <pickup>...</pickup>
    <portOfDischarge>... </portOfDischarge>
    <portOfLoading>...</portOfLoading>
</routingInformation>
Property Type Mandatory Description
pickup RoutingPickup M Information to pickup
delivery RoutingDelivery O Information to delivery
airportOfDeparture RoutingPointAirport O
airportOfArrival RoutingPointAirport O
portOfLoading RoutingPointSeaport O
portOfDischarge RoutingPointSeaport O

RoutingPickup

"pickup": {
  "desiredPickup": {...},
  "estimatedCargoReadiness": {...},
  "estimatedPickup": {...},
  "remark": "string",
  "shipperSelfDelivery": false
}
<pickup>
  <desiredPickup>...</desiredPickup>
  <estimatedCargoReadiness>...</estimatedCargoReadiness>
  <estimatedPickup>...</estimatedPickup>
  <remark>string</remark>
  <shipperSelfDelivery>false</shipperSelfDelivery>
</pickup>
Property Type Mandatory Description
estimatedCargoReadiness ApiDate M Defines date when goods are ready for transport
desiredPickup ApiDateFromTo O Defines time frame of desired pickup of goods.
estimatedPickup ApiDate O Defines date for estimated pickup of goods. Only processed if EDI-Partner is an Agent or shipperSelfDelivery = true.
shipperSelfDelivery Boolean O
remark String O Additional comments for pickup.

RoutingDelivery

"delivery":{
    "desiredDelivery":{...},
    "estimatedDelivery":{...},
    "consigneeSelfPickup": false,
    "remark":"string"
}
<delivery>
    <consigneeSelfPickup>false</consigneeSelfPickup>
    <desiredDelivery>...</desiredDelivery>
    <estimatedDelivery>...</estimatedDelivery>
    <remark>string</remark>
</delivery>
Property Type Mandatory Description
consigneeSelfPickup Boolean O
desiredDelivery ApiDateFromTo O Defines time frame of desired delivery of goods.
estimatedDelivery ApiDate O Defines date for estimated delivery of goods. Only processed if EDI-Partner is an Agent or consigneeSelfPickup = true.
remark String O Additional comments for delivery.

RoutingPointAirport

"airportOfDeparture":{
    "iataCode":"string",
    "estimatedDate":{...}
 }
<airportOfDeparture>
  <estimatedDate>...</estimatedDate>
  <iataCode>string</iataCode>
</airportOfDeparture>

Property Type Mandatory Description
iataCode String M IATA 3-letter airport code.
estimatedDate ApiDate O If known, estimated arrival date (if airportOfArrival) / estimated departure date (if airportOfDeparture) can be provided here.

RoutingPointSeaport

"portOfLoading":{
    "estimatedDate":{...},     
    "terminal":"string",
    "unlocode":"string" 
}
<portOfLoading>
  <estimatedDate>...</estimatedDate>
  <terminal>string</terminal>
  <unlocode>string</unlocode>
</portOfLoading>
Property Type Mandatory Description
estimatedDate ApiDate O If known, estimated arrival date (if portOfDischarge) / estimated departure date (if portOfLoading) can be provided here.
terminal String O Container terminal.
unlocode String M UNLOCODE 5-letter location code.

Participants

"participants": {
    "consignee": {...},
    "controllingAgent": {...},
    "delivery": {...},
    "destinationAgent": {...},
    "destinationHub": {...},
    "destinationWarehouse": {...},
    "exportCustomsBroker": {...},
    "importCustomsBroker": {...},
    "mainInvoiceTo": {...},
    "notifyAgent": {...},
    "officeInCharge": {...},
    "originAgent": {...},
    "originHub": {...},
    "originWarehouse": {...},
    "pickup": {...},
    "principal": {...},
    "shipper": {...},
    "shippersTradingCompany": {...},
    "thirdParties": [...]
}
<participants>
    <consignee>...</consignee>
    <controllingAgent>...</controllingAgent>
    <delivery>...</delivery>
    <destinationAgent>...</destinationAgent>
    <destinationHub>...</destinationHub>
    <destinationWarehouse>...</destinationWarehouse>
    <exportCustomsBroker>...</exportCustomsBroker>
    <importCustomsBroker>...</importCustomsBroker>
    <mainInvoiceTo>...</mainInvoiceTo>
    <notifyAgent>...</notifyAgent>
    <officeInCharge>...</officeInCharge>
    <originAgent>...</originAgent>
    <originHub>...</originHub>
    <originWarehouse>...</originWarehouse>
    <pickup>...</pickup>
    <principal>...</principal>
    <shipper>...</shipper>
    <shippersTradingCompany>...</shippersTradingCompany>
    <thirdParties>...</thirdParties>
</participants>
Property Type Mandatory Description
shipper Party M Party providing the goods.
consignee Party M Party receiving the goods.
pickup Party O Pickup location. If not provided, it will be assumed to be the same as shipper.
delivery Party O Delivery location. If not provided, it will be assumed to be the same as consignee.
principal Party M Owner of the transport order.
officeInCharge PartyOfficeInCharge M Freight forwarder handling office.
mainInvoiceTo Party M Party which will be billed for transport. Is normally the same as the principal.
exportCustomsBroker Party O
importCustomsBroker Party O
originWarehouse Party O
destinationWarehouse Party O
shippersTradingCompany Party O
thirdParties Array[Party] O
originAgent PartyAgent O Not available if mainModality is ROAD.
destinationAgent PartyAgent O Not available if mainModality is ROAD.
originHub PartyAgent O Only applicable if mainModality is ROAD.
destinationHub PartyAgent O Only applicable if mainModality is ROAD.
controllingAgent PartyAgent O
notifyAgent PartyAgent O

PartyAgent

"controllingAgent": {
  "accountNumber": "string",
  "contacts": [{...}],
  "externalPartyIdentifier": "string",
}
<controllingAgent>
    <accountNumber>string</accountNumber>
    <contacts>...</contacts>
    <externalPartyIdentifier>string</externalPartyIdentifier>
</controllingAgent>
Property Type Mandatory Description
accountNumber String M SPOT internal account number.
externalPartyIdentifier String O EDI-Partners identifier for a party. If provided it functions in the same way as the accountNumber
contacts Array[Contact] O

PartyOfficeInCharge

"officeInCharge": {
    "accountNumber": "123456",
    "officeRole":"string",
    "externalPartyIdentifier":"string",
    "contacts":[{...}]
}
<officeInCharge>
  <accountNumber>string</accountNumber>
  <contacts>...</contacts>
  <externalPartyIdentifier>string</externalPartyIdentifier>
  <officeRole>CONTROLLING_AGENT</officeRole>
</officeInCharge>
Property Type Mandatory Description
accountNumber String M SPOT internal account number.
officeRole String O Valid values: ORIGIN_AGENT, DESTINATION_AGENT, CONTROLLING_AGENT
externalPartyIdentifier String O EDI-Partners identifier for a party. If provided it functions in the same way as the accountNumber
contacts Array[Contact] O

Shipments

GET Shipment

messageType: transport.shipment

{
    "messageHeader":{...},
    "Shipment":{...}
}
<?xml version="1.0" encoding="UTF-8" ?>
<shipments>
    <messageHeader>...</messageHeader>
    <Shipment>...</Shipment>
</shipments>

Get shipment data from SPOT.

FTP folder if provided on our FTP and not pushed to partner FTP: /out/transport/shipment

Sample files: XML

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.

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

Shipment

{
  "cargoDescription": [{...}],
  "containerDefinition": {...},
  "events": [{...}],
  "mainCategory": "FCL",
  "mainModality": "AIR",
  "participants": {...},
  "routingInformation": [{...}],
  "shipmentDetails": {...},
  "trackingId": "string"
}
<Shipment>
  <cargoDescription>...</cargoDescription>
  <containerDefinition>...</containerDefinition>
  <events>...</events>
  <mainCategory>FCL</mainCategory>
  <mainModality>AIR</mainModality>
  <participants>...</participants>
  <routingInformation>...</routingInformation>
  <shipmentDetails>...  </shipmentDetails>
  <trackingId>string</trackingId>
</Shipment>
Property Type Mandatory Description
cargoDescription 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
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

"participants": {
    "airHub": {...},
    "consignee": {...},
    "controllingAgent": {...},
    "delivery": {...},
    "destinationAgent": {...},
    "destinationHub": {...},
    "destinationWarehouse": {...},
    "exportCustomsBroker": {...},
    "exportConsolidationHub": {...},
    "importCustomsBroker": {...},
    "exportDeconsolidationHub": {...},
    "mainInvoiceTo": {...},
    "notifyAgent": {...},
    "originAgent": {...},
    "originHub": {...},
    "originWarehouse": {...},
    "pickup": {...},
    "principal": {...},
    "seaHub": {...},
    "shipper": {...},
    "shippersTradingCompany": {...},
    "thirdParties": [{...}],
    "transitHubs": [{...}]
}
<participants>
    <airHub>...</airHub>
    <consignee>...</consignee>
    <controllingAgent>...</controllingAgent>
    <delivery>...</delivery>
    <destinationAgent>...</destinationAgent>
    <destinationHub>...</destinationHub>
    <destinationWarehouse>...</destinationWarehouse>
    <exportCustomsBroker>...</exportCustomsBroker>
    <exportConsolidationHub>...</exportConsolidationHub>
    <importCustomsBroker>...</importCustomsBroker>
    <importDeconsolidationHub>...</importDeconsolidationHub>
    <mainInvoiceTo>...</mainInvoiceTo>
    <notifyAgent>...</notifyAgent>
    <originAgent>...</originAgent>
    <originHub>...</originHub>
    <originWarehouse>...</originWarehouse>
    <pickup>...</pickup>
    <principal>...</principal>
    <seaHub>...</seaHub>
    <shipper>...</shipper>
    <shippersTradingCompany>...</shippersTradingCompany>
    <thirdParties>...</thirdParties>
    <transitHubs>...</transitHubs>
</participants>
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

ShipmentRoutingInformation

"routingInformation": {
    "delivery": {...},
    "pickup": {...},
    "routingPoints": [{...}]
}
<routingInformation>
    <delivery>...</delivery>
    <pickup>...</pickup>
    <routingPoints>...</routingPoints>
</routingInformation>
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

"routingPoints": [{
    "city": "string",
    "countryCode": "string",
    "estimatedArrival": {...},
    "estimatedDeparture": {...},
    "iataCode": "string",
    "legModality": "SEA_FCL",
    "realArrival": {...},
    "realDeparture": {...},
    "remark": "string",
    "routingPointType": "PICKUP",
    "unlocode": "string",
    "zipCode": "string"
}]
<routingPoints>
  <city>string</city>
  <countryCode>string</countryCode>
  <estimatedArrival>...</estimatedArrival>
  <estimatedDeparture>...</estimatedDeparture>
  <iataCode>string</iataCode>
  <legModality>SEA_FCL</legModality>
  <realArrival>...</realArrival>
  <realDeparture>...</realDeparture>
  <remark>string</remark>
  <routingPointType>PICKUP</routingPointType>
  <unlocode>string</unlocode>
  <zipCode>string</zipCode>
</routingPoints>
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.

ShipmentRoutingPointPickup

"pickup": {
  "city": "string",
  "countryCode": "string",
  "desiredPickup": {...},
  "estimatedCargoReadiness": {...},
  "estimatedPickup": {...},
  "iataCode": "string",
  "legModality": "SEA_FCL",
  "realCargoReadiness": {...},
  "realPickup": {...},
  "remark": "string",
  "routingPointType": "PICKUP",
  "shipperSelfDelivery": true,
  "unlocode": "string",
  "zipCode": "string"
}
<pickup>
  <city>string</city>
  <countryCode>string</countryCode>
  <desiredPickup>...</desiredPickup>
  <estimatedCargoReadiness>...</estimatedCargoReadiness>
  <estimatedPickup>...</estimatedPickup>
  <iataCode>string</iataCode>
  <legModality>SEA_FCL</legModality>
  <realCargoReadiness>...</realCargoReadiness>
  <realPickup>...</realPickup>
  <remark>string</remark>
  <routingPointType>PICKUP</routingPointType>
  <shipperSelfDelivery>true</shipperSelfDelivery>
  <unlocode>string</unlocode>
  <zipCode>string</zipCode>
</pickup>
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

"delivery": {
  "city": "string",
  "consigneeSelfPickup": true,
  "countryCode": "string",
  "desiredDelivery": {...},
  "estimatedDelivery": {...},
  "iataCode": "string",
  "legModality": "SEA_FCL",
  "realDelivery": {...},
  "remark": "string",
  "routingPointType": "PICKUP",
  "unlocode": "string",
  "zipCode": "string"
}
<delivery>
  <city>string</city>
  <consigneeSelfPickup>true</consigneeSelfPickup>
  <countryCode>string</countryCode>
  <desiredDelivery>...</desiredDelivery>
  <estimatedDelivery>...</estimatedDelivery>
  <iataCode>string</iataCode>
  <legModality>SEA_FCL</legModality>
  <realDelivery>...</realDelivery>
  <remark>string</remark>
  <routingPointType>PICKUP</routingPointType>
  <unlocode>string</unlocode>
  <zipCode>string</zipCode>
</delivery>
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 ApiDate O Time frame of desired delivery of cargo.

ShipmentDetails

"shipmentDetails": {
    "deliveryTerm": {...},
    "electronicFreight": "string",
    "hblOriginalRequired": true,
    "insurance": {...},
    "paymentDefinition": {...},
    "references": [{...}],
    "serviceSpecification": {...},
    "shipmentTransportDetails": {...}
}
<shipmentDetails>
    <deliveryTerm>...</deliveryTerm>
    <electronicFreight>string</electronicFreight>
    <hblOriginalRequired>true</hblOriginalRequired>
    <insurance>...</insurance>
    <paymentDefinition>...</paymentDefinition>
    <references>...</references>
    <serviceSpecification>...</serviceSpecification>
    <shipmentTransportDetails>...</shipmentTransportDetails>
</shipmentDetails>
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

"shipmentTransportDetails": {
  "carrierContractNumber": "string",
  "flightNumbers": ["string"],
  "hawb": "string",
  "hbl": "string",
  "mawb": "string",
  "mbl": "string",
  "oceanCarrier": {...},
  "plateNumbers": ["string"],
  "roadCarrier": "string",
  "vesselName": "string",
  "voyageNumber": "string"
}
<shipmentTransportDetails>
  <carrierContractNumber>string</carrierContractNumber>
  <flightNumbers>string</flightNumbers>
  <hawb>string</hawb>
  <hbl>string</hbl>
  <mawb>string</mawb>
  <mbl>string</mbl>
  <oceanCarrier>...</oceanCarrier>
  <plateNumbers>string</plateNumbers>
  <roadCarrier>string</roadCarrier>
  <vesselName>string</vesselName>
  <voyageNumber>string</voyageNumber>
</shipmentTransportDetails>
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

Shipment Events

The below described list provides an overview about the main event types.

The full list of all event types can be found here.

Identifier Type Description
84 REAL Order confirmation
13 ESTIMATED Estimated cargo readiness
15 REAL Cargo ready
9 REAL PICKED UP
5 ESTIMATED Estimated departure
7 REAL DEPARTED
21 REAL PreAlert processed
1 ESTIMATED Estimated arrival
4 REAL ARRIVED
10 ESTIMATED Estimated delivery
12 REAL DELIVERED

Shipment Event Updates

POST/GET Event update

messageType: transport.eventUpdate

{
    "messageHeader": {...},
    "trackingId": "string",
    "transportReferences": [{...}],
    "references": [{...}],
    "events": [{...}]
}
<eventUpdate>
    <messageHeader>...</messageHeader>
    <trackingId>string</trackingId>
    <transportReferences>...</transportReferences>
    <references>...</references>
    <events>...</events>
</eventUpdate>

This is used to either create events in our SPOT system or to receive event information when events are updated on your shipment.

Sample files: XML

FTP folder:

For inbound event updates: /in/transport/eventUpdate

For outbound event updates, if provided on our FTP and not pushed to partner FTP: /out/transport/eventUpdate

Property Type Mandatory Description
messageHeader MessageHeader M Message Header information.
trackingId String M Shipment tracking ID (SPOT ID).
transportReferences Array[TransportReference] O Array of transport references.
references Array[TransportOrderReference] O Array of references. (Customer/Partner/…)
events Array[Event] M Array of events.

TransportReference

"transportReferences": [{
    "referenceType":"string",
    "value":"string"
}]
<transportReference>
    <referenceType>...</referenceType>
    <value>...</value>
</transportReference>
Property Type Mandatory Description
referenceType String M Type of transport reference MAWB, HAWB, MBL, HBL, JOBFILE_UKW_POSITION.
value String M Reference value.

Documents

Upload (Document only)

Example filename: 100149780_T103_testdocument.pdf

Using this method, only the document itself is needed but the filename must strictly follow the below described format, as the for the upload necessary metadata will be parsed from the filename.

Filename format: <spotTrackingId>_<documentType>_<filename>.<extensions>

FTP folder: /in/transport/document

Property Type Mandatory Description
<spotTrackingId> String M SPOT shipment id. Used to assigne document to shipment.
<documentType> String M SPOT 4-letter document code. (Document type code list)
<filename> String M Filename which will be shown on uploaded document in SPOT.
<extension> String M Fileextension. E.g.: .pdf

Upload (Document + metadata)

Example document name: hardcopyPOD_12345.pdf
Example metadata name: hardcopyPOD_12345.xml

For the second method an additional metadata file is needed. This allows for the use of multiple and additional reference types. It is recommended to give the metadata file the same name as the document.

FTP folder: /in/transport/document

DocumentMetadata

{
    "filename" : "testdocument.pdf",
    "documentType" : "T103",
    "shipmentReferences":[{...}]
}
<?xml version="1.0" encoding="UTF-8" ?>
<documentMetadata>
    <filename>testdocument.pdf</filename>
    <documentType>T103</documentType>
    <shipmentReferences>...</shipmentReferences>
</documentMetadata>
Property Type Mandatory Description
filename String M Filename of document
documentType String M SPOT 4-letter document code. (Document type code list)
shipmentReferences Array[DocumentUploadReferences] M Array of references used to find shipment

DocumentUploadReferences

"shipmentReferences":[{
    "type":"TRACKING_ID",
    "value":"100149780"
}]
<shipmentReferences>
    <type>TRACKING_ID</type>
    <value>100149780</value>
</shipmentReferences>
Property Type Mandatory Description
type String M Type of reference. Valid values: TRACKING_ID, MAWB, HAWB, MBL, HBL, JOBFILE_UKW_POSITION
value String M Reference value.

Common Transport Objects

CargoDescription

"cargoDescription": [{
    "containerIndex":1,
    "cargoDetails": [{...}],
    "chargeableWeight": 0,
    "currencyCode": "string",
    "dangerousGoods": [{...}],
    "loadingMeters": 0,
    "valueOfGoods": 0
}]
<cargoDescription>
    <containerIndex>1</containerIndex>
    <cargoDetails>...</cargoDetails>
    <chargeableWeight>1.1</chargeableWeight>
    <currencyCode>string</currencyCode>
    <dangerousGoods>...</dangerousGoods>
    <loadingMeters>1.1</loadingMeters>
    <valueOfGoods>1.1</valueOfGoods>
</cargoDescription>
Property Type Mandatory Description
containerIndex Integer O Running number for association with container
cargoDetails Array[CargoDetails] M
valueOfGoods BigDecimal O
currencyCode String C ISO 4217 three letter currency code. Mandatory if valueOfGoods is provided
chargeableWeight BigDecimal O
loadingMeters BigDecimal O
dangerousGoods Array[DangerousGoods] O

CargoDetails

"cargoDetails": [{
    "description": "string",
    "height": 0,
    "length": 0,
    "packageTypeCode": "string",
    "pieces": 0,
    "volume": 0,
    "weight": 0,
    "width": 0
 }]
<cargoDetails>
    <description>string</description>
    <height>1</height>
    <length>1</length>
    <packageTypeCode>string</packageTypeCode>
    <pieces>1</pieces>
    <volume>1.123</volume>
    <weight>1.1</weight>
    <width>1</width>
</cargoDetails>
Property Type Mandatory Description
pieces Integer M
packageTypeCode String M SPOT package type code (Package type code list)
description String M
weight BigDecimal O Weight in kg
width Integer O Width in cm
height Integer O Height in cm
length Integer O Length in cm
volume BigDecimal O Volume in m³. Will only be taken over if no dimensions are provided. If dimensions are provided, volume will be automatically calculated.

Contact

"contacts": [{
  "emailBusiness": "string",
  "emailOther": "string",
  "externalReference": "string",
  "fax": {...},
  "firstName": "string",
  "jobRole": "string",
  "jobTitle": "string",
  "lastName": "string",
  "mobile": {...},
  "phoneBusiness": {...},
  "phoneOther": {...},
  "salutation": "MR",
  "title": "string"
}]
<contacts>
    <emailBusiness>string</emailBusiness>
    <emailOther>string</emailOther>
    <externalReference>string</externalReference>
    <fax>...</fax>
    <firstName>string</firstName>
    <jobRole>string</jobRole>
    <jobTitle>string</jobTitle>
    <lastName>string</lastName>
    <mobile>...</mobile>
    <phoneBusiness>...</phoneBusiness>
    <phoneOther>...</phoneOther>
    <salutation>MR</salutation>
    <title>string</title>
</contacts>
Property Type Mandatory Description
salutation String M Valid values: MR, MS
title String O
firstName String M
lastName String M
jobTitle String O
jobRole String O
phoneBusiness Phone O Contact business phone number.
phoneOther Phone O Additional phone number.
mobile Phone O Contact mobile phone number.
fax Phone O Contact fax number.
emailBusiness String O Contact business email address.
emailOther String O Additional email address.

ContainerDefinition

"containerDefinition": {
    "containers": [{...}],
    "currencyCode": "string",
    "generalCargoDescription": "string",
    "goodsValue": 0,
    "totalPieces": 0,
    "totalVolume": 0,
    "totalWeight": 0
}
<containerDefinition>
    <containers>...</containers>
    <currencyCode>string</currencyCode>
    <generalCargoDescription>string</generalCargoDescription>
    <goodsValue>1.1</goodsValue>
    <totalPieces>1</totalPieces>
    <totalVolume>1.1</totalVolume>
    <totalWeight>1.1</totalWeight>
</containerDefinition>
Property Type Mandatory Description
containers Array[Container] M Specify details per container.
generalCargoDescription String M
goodsValue BigDecimal O Value of goods in all containers.
currencyCode String C ISO 4217 three letter currency code. Mandatory if goodsValue is provided.
totalPieces Integer O Overall pieces of goods.
totalVolume BigDecimal O Overall volume of goods.
totalWeight BigDecimal O Overall weight of goods.

Container

"containers": [{
    "containerIndex": 0,
    "containerNumber": "",
    "containerCode": "",
    "sealNumber": "",
    "atbNumber": "",
    "references":[{...}],
    "additionalAttributes":[...]
}]
<containers>
  <additionalAttributes>GOH</additionalAttributes>
  <atbNumber>string</atbNumber>
  <containerCode>string</containerCode>
  <containerIndex>1</containerIndex>
  <containerNumber>string</containerNumber>
  <references>...</references>
  <sealNumber>string</sealNumber>
</containers>
Property Type Mandatory Description
containerIndex Integer M Running number identifying a container.
containerNumber String O ISO 6346 container number.
containerCode String C ISO 6346 Standard Container Code. Mandatory for SEA FCL.
sealNumber String O
atbNumber String O
references Array[TransportOrderReference] O References on container level
additionalAttributes Array[String] O Garments on hanger: GOH, Non-operated reefer: ROH, Shippers own container: SOC

Event

"events": [{
    "eventTypeIdentifier": "string",
    "eventTypeName": "string",
    "eventTimestamp": {...},
    "remark": "string",
    "containerNumber": "string",
    "eventLocation": {...},
    "additionalAttributes": [{...}]
}]
<events>
    <eventTypeIdentifier>7</eventTypeIdentifier>
    <eventTypeName>DEPARTED</eventTypeName>
    <eventTimestamp>...<eventTimestamp>
    <remark>Shipment departed from VIE</remark>
    <containerNumber/>
    <eventLocation>...</eventLocation>
    <additionalAttributes>...</additionalAttributes>
</events>
Property Type Mandatory Description
eventTypeIdentifier String M Identifier of eventType. (Event type list)
eventTypeName String M Full name of the event.
eventTimestamp ApiDate M Date of event occurrence.
eventLocation EventLocation M Location of event occurrence.
remark String O A remark to the event.
additionalAttributes Array[EventAdditionalAttribute] C Array of additional attributes to an event.
containerNumber String O ISO 6346 container number. If provided, event will only be set on this container.

EventLocation

"eventLocation": {
    "locationType": "string",
    "unlocodeLocation": {...},
    "iataLocation": {...},
    "addressLocation": {...},
    "freeLocation": {...}
}
<eventLocation>
    <locationType>string</locationType>
    <unlocodeLocation>...</unlocodeLocation>
    <iataLocation>...</iataLocation>
    <addressLocation>...</addressLocation>
    <freeLocation>...</freeLocation>
</eventLocation>

This defines the location of the event occurrence. Depending on the value of locationType, the corresponding object needs to be provided.

Property Type Mandatory Description
locationType String M type identifier of the location UNLOCODE, IATA, ADDRESS, FREE.
unlocodeLocation EventUnlocodeLocation C location of type UNLOCODE.
iataLocation EventIataLocation C location of type IATA.
addressLocation EventAddressLocation C location of type ADDRESS.
freeLocation EventFreeLocation C location of type FREE.

EventUnlocodeLocation

"unlocodeLocation": {
    "unlocode":"string"
}
<unlocodeLocation>
    <unlocode>string</unlocode>
</unlocodeLocation>
Property Type Mandatory Description
unlocode String M UNLOCODE 5-letter location code.

EventIataLocation

"iataLocation": {
    "iataCode":"string"
}
<iataLocation>
    <iataCode>string</iataCode>
</iataLocation>
Property Type Mandatory Description
iataCode String M IATA 3-letter airport code.

EventAddressLocation

"addressLocation": {
    "city":"string",
    "street":"string",
    "postCode":"string",
    "countryCode":"string"
}
<addressLocation>
    <city>string</city>
    <street>string</street>
    <postcode>string</postcode>
    <countryCode>string</countryCode>
</addressLocation>
Property Type Mandatory Description
city String M Name of the city/location.
street String O Street address part (including house, store, door numbers).
postCode String O postal code of the city/location.
countryCode String M ISO country code (ISO 3166-1 Alpha-2).

EventFreeLocation

"freeLocation": {
    "name" : "string"
}
<freeLocation>
    <name>string</name>
</freeLocation>
Property Type Mandatory Description
name String M any free-text location information.

EventAdditionalAttribute

"additionalAttributes": [{
    "identifier":"string",
    "value":"string"
}]
<additionAttribute>
    <identifier>string</identifier>
    <value>string</value>
</additionAttribute>

Some events have additional attributes e.g.: DELIVERED has an attribute POD Name, which gives information about who accepted the delivery.

Property Type Mandatory Description
identifier String M Identifier of attribute. (Additional attributes list)
value String M Attribute value

Insurance

"insurance": {
    "currencyCode": "string",
    "requiredBy": "CONSIGNEE",
    "value": 0
}
<insurance>
    <currencyCode>string</currencyCode>
    <requiredBy>CONSIGNEE</requiredBy>
    <value>1.1</value>
</insurance>
Property Type Mandatory Description
value BigDecimal O Insurance value.
currencyCode String C ISO 4217 three letter currency code. Mandatory if value is provided.
requiredBy String O party/contact who requires insurance, if applicable. Valid values: SHIPPER, CONSIGNEE, PRINCIPAL

OceanCarrier

"oceanCarrier":{
    "name":"string",
    "scac":"string"
}
<oceanCarrier>
    <name>string</name>
    <scac>string</scac>
</oceanCarrier>
Property Type Mandatory Description
scac String M SCAC of carrier.
name String O Name of carrier.

Party

"shipper": {
  "accountNumber": "string",
  "city": "string",
  "contacts": [{...}],
  "countryCode": "string",
  "email": "string",
  "externalPartyIdentifier":"string",
  "externalReference": "string",
  "fax": {...},
  "matchCode": "string",
  "name": "string",
  "otherPhone": {...},
  "phone": {...},
  "state": "string",
  "street": "string",
  "zipCode": "string"
}
<shipper>
  <accountNumber>string</accountNumber>
  <city>string</city>
  <contacts>...</contacts>
  <countryCode>string</countryCode>
  <email>string</email>
  <externalPartyIdentifier>string</externalPartyIdentifier>
  <externalReference>string</externalReference>
  <fax>...</fax>
  <matchCode>string</matchCode>
  <name>string</name>
  <otherPhone>...</otherPhone>
  <phone>...</phone>
  <state>string</state>
  <street>string</street>
  <zipCode>string</zipCode>
</shipper>
Property Type Mandatory Description
accountNumber String O SPOT internal account number. If provided no additional info required.
name String C Mandatory if no accountNumber or externalPartyIdentifier is provided.
externalPartyIdentifier String O EDI-Partners identifier for a party. If provided it functions in the same way as the accountNumber
externalReference String O
matchCode String O
city String C Mandatory if no accountNumber or externalPartyIdentifier is provided.
street String C Mandatory if no accountNumber or externalPartyIdentifier is provided.
zipCode String O
state String O
countryCode String C ISO country code (ISO 3166-1 Alpha-2). Mandatory if no accountNumber or externalPartyIdentifier is provided.
phone Phone O
fax Phone O
email String O
webSite String O
otherPhone Phone O
contacts Array[Contact] O

PaymentDefinition

"paymentDefinition": {
  "cashOnDelivery": 0,
  "codCurrencyCode": "string",
  "letterOfCredit": "string",
  "termsOfPayment": "CASH_AGAINST_DOCUMENT"
}
<paymentDefinition>
  <cashOnDelivery>1.1</cashOnDelivery>
  <codCurrencyCode>string</codCurrencyCode>
  <letterOfCredit>string</letterOfCredit>
  <termsOfPayment>CASH_AGAINST_DOCUMENT</termsOfPayment>
</paymentDefinition>
Property Type Mandatory Description
termsOfPayment String O Defines the terms of payment.
Valid values: LETTER_OF_CREDIT, OPEN_ACCOUNT, COD, CASH_AGAINST_DOCUMENT, SHIPMENT_RELEASE_AFTER_CONFIRMATION_ONLY, PAID_IN_ADVANCE
cashOnDelivery BigDecimal C value for Cash-On-Delivery. Mandatory if termsOfDelivery is set to COD
codCurrencyCode String C ISO 4217 three letter currency code. Mandatory if cashOnDeliveryValue is provided.
letterOfCreditNumber String C Mandatory if termsOfDelivery is set to LETTER_OF_CREDIT

ServiceSpecification

"serviceSpecification": {
  "billOfLoadingType": "EMPTY",
  "serviceDefinition": "ECONOMY",
  "specialHandlingClassification": [
    "GARMET_ON_HANGER"
  ],
  "temperatureFrom": 0,
  "temperatureTo": 0
}
<serviceSpecification>
  <billOfLoadingType>EMPTY</billOfLoadingType>
  <serviceDefinition>ECONOMY</serviceDefinition>
  <specialHandlingClassification>GARMET_ON_HANGER</specialHandlingClassification>
  <temperatureFrom>1.1</temperatureFrom>
  <temperatureTo>1.1</temperatureTo>
</serviceSpecification>
Property Type Mandatory Description
billOfLoading String O Valid values: EMPTY, EXPRESS_BL_REQUIRED, ORIGINAL_BL_REQUIRED
serviceDefinition String O Valid values: ECONOMY, EXPRESS, EMERGENCY
Default if not provided: ECONOMY
specialHandlingClassification Array[String] O Valid values: GARMET_ON_HANGER, HEAVY_LIFT, HUMIDITY_CONTROLLED, OVERSIZED, ROLL_ON_OFF, TEMPERATURE_CONTROLLED, VALUABLE_CARGO
temperatureFrom Decimal C Min. temperature. Mandatory if specialHandlingClassification contains TEMPERATURE_CONTROLLED
temperatureTo Decimal C Max. temperature. Mandatory if specialHandlingClassification contains TEMPERATURE_CONTROLLED

TransportOrderReference

"references": [{
    "referenceType":"string",
    "referenceKey":"string",
    "referenceNumber":"string"
}]
<references>
    <referenceType>string</referenceType>
    <referenceKey>string</extReferenceType>
    <referenceNumber>string</value>
</references>
Property Type Mandatory Description
referenceType String M Type of reference. (List of SPOT reference types)
referenceKey String O Key for referenceNumber assignment (For example EDI-Partner reference type).
referenceNumber String M Reference value.

Logistics

Receipt Avisos

CREATE Receipt Avisos

messageType: logistics.receiptaviso

{
    "messageHeader":{...},
    "aviso":{...}
}
<?xml version="1.0" encoding="UTF-8" ?>
<avisos>
    <messageHeader>...</messageHeader>
    <aviso>...</aviso>
</avisos>
Property Type Mandatory Description
messageHeader MessageHeader M Message Header information.
aviso Aviso M Aviso

Aviso

"aviso" : {
  "comment": "string",
  "forwarderCode": "string",
  "forwarderReference": "string",
  "goodsInDate": {...},
  "positions": [{...}],
  "references": {...},
  "supplierCode": "string",
  "supplierReference": "string",
  "warehouse": {...}
}
<aviso>
  <comment>string</comment>
  <forwarderCode>string</forwarderCode>
  <forwarderReference>string</forwarderReference>
  <goodsInDate>...</goodsInDate>
  <positions>...</positions>
  <references>...</references>
  <supplierCode>string</supplierCode>
  <supplierReference>string</supplierReference>
  <warehouse>...</warehouse>
</aviso>
Property Type Length Mandatory Description
warehouse Warehouse M Warehouse information
supplierCode String 13 M WMS supplier code
supplierReference String 35 O Reference of supplier
forwarderCode String 13 M WMS forwarder code
forwarderReference String 35 O Reference of forwarder
references ClientReferences M 3rd party references
goodsInDate ApiDate M Planned entry date of goods into warehouse
comment String 180 O Comments to the aviso
positions Array[AvisoPosition] M Aviso positions

AvisoPosition

"positions": [{
    "bestBeforeDate": {...},
    "clientPositionNo": "string",
    "item": {...},
    "mheReference": "string",
    "packingUnit": "string",
    "productionDate": {...},
    "quantity": 0
}]
<positions>
    <bestBeforeDate>...</bestBeforeDate>
    <clientPositionNo>string</clientPositionNo>
    <item>...</item>
    <mheReference>string</mheReference>
    <packingUnit>string</packingUnit>
    <productionDate>...</productionDate>
    <quantity>1</quantity>
</positions>
Property Type Length Mandatory Description
item Item M
quantity Integer 10 M Quantity in pieces (packing unit, smallest unit)
clientPositionNo String 5 O
packingUnit String 3 O
mheReference String 35 O Reference MHE (=Mechanical Handling Equipment), e.g. SSCC-Number
bestBeforeDate ApiDate O Goods expiration date, if applicable to item
productionDate ApiDate O Goods production date, if applicable to item

Receipt Orders

CREATE Receipt Order

messageType: logistics.receiptOrder

{
    "messageHeader":{...},
    "receiptOrder":{...}
}
<?xml version="1.0" encoding="UTF-8" ?>
<receiptOrders>
    <messageHeader>...</messageHeader>
    <receiptOrder>...</receiptOrder>
</receiptOrders>
Property Type Mandatory Description
messageHeader MessageHeader M Message Header information.
receiptOrder ReceiptOrder M Receipt Order

ReceiptOrder

"receiptOrder" : {
  "comment": "string",
  "forwarderCode": "string",
  "forwarderReference": "string",
  "positions": [{...}],
  "receiverCode": "string",
  "references": {...},
  "supplierCode": "string",
  "supplierReference": "string",
  "warehouse": {...}
}
<receiptOrder>
  <comment>string</comment>
  <forwarderCode>string</forwarderCode>
  <forwarderReference>string</forwarderReference>
  <positions>.../positions>
  <receiverCode>string</receiverCode>
  <references>...</references>
  <supplierCode>string</supplierCode>
  <supplierReference>string</supplierReference>
  <warehouse>...</warehouse>
</receiptOrder>
Property Type Length Mandatory Description
warehouse Warehouse M Warehouse information
supplierCode String 13 M WMS supplier code
supplierReference String 35 O Reference of supplier
forwarderCode String 13 O WMS forwarder code
forwarderReference String 35 M Reference of forwarder
receiverCode String 13 O WMS receiver code
references ClientReferences M 3rd party references
comment String 60 O Comments to the receipt order
positions Array[ReceiptOrderPositions] M Receipt order positions

ReceiptOrderPosition

"positions": [{
  "bestBeforeDate": {...},
  "blockReason": "string",
  "clientPositionNo": "string",
  "customsReference": "string",
  "item": {...},
  "mheReference": "string",
  "packingUnit": "string",
  "productionDate": {...},
  "quantity": 0
}]
<positions>
    <bestBeforeDate>...</bestBeforeDate>
    <blockReason>string</blockReason>
    <clientPositionNo>string</clientPositionNo>
    <customsReference>string</customsReference>
    <item>...</item>
    <mheReference>string</mheReference>
    <packingUnit>string</packingUnit>
    <productionDate>...</productionDate>
    <quantity>1</quantity>
</positions>
Property Type Length Mandatory Description
item Item M
quantity Integer 10 M Quantity in pieces (packing unit,smallest unit)
clientPositionNo String 5 O
packingUnit String 3 O
mheReference String 35 O Reference MHE (=Mechanical Handling Equipment), e.g. SSCC-Number
bestBeforeDate ApiDate O Goods expiration date, if applicable to item
productionDate ApiDate O Production date, if applicable to item
customsReference String 35 O
blockReason String 3 O

Receipt Confirmations

GET Receipt Confirmations

messageType: logistics.receiptConfirmation

{
    "messageHeader":{...},
    "receiptOrderConfirmation":{...}
}
<?xml version="1.0" encoding="UTF-8" ?>
<receiptOrderConfirmations>
    <messageHeader>...</messageHeader>
    <receiptOrderConfirmation>...</receiptOrderConfirmation>
</receiptOrderConfirmations>
Property Type Mandatory Description
messageHeader MessageHeader M Message Header information.
receiptConfirmation ReceiptConfirmation M

ReceiptConfirmation

"receiptConfirmation" : {
  "forwarder": {...},
  "forwarderReference": "string",
  "positions": [{...}],
  "receiptOrderNo": "string",
  "references": {...},
  "supplier": {...},
  "supplierReference": "string",
  "goodsInDate": {...},
  "warehouse": {...}
}
<receiptConfirmation>
  <forwarder>...</forwarder>
  <forwarderReference>string</forwarderReference>
  <positions>...</positions>
  <receiptOrderNo>string</receiptOrderNo>
  <references>...</references>
  <supplier>...</supplier>
  <supplierReference>string</supplierReference>
  <goodsInDate>...</goodsInDate>
  <warehouse>...</warehouse>
</receiptConfirmation>
Property Type Length Mandatory Description
warehouse Warehouse M Warehouse information
receiptOrderNo String 10 M
supplier LogisticsParty O
forwarder LogisticsParty O
references ClientReferences M 3rd party references
supplierReference String 35 O Reference of supplier
forwarderReference String 35 O Reference of forwarder
goodsInDate ApiDate O Entry date of goods into warehouse
positions ReceiptConfirmationPosition M Receipt confirmation positions

ReceiptConfirmationPosition

"positions": [{
      "bestBeforeDate": {...},
      "clientPositionNo": "string",
      "customsReference": "string",
      "fifoDate": {...},
      "item": {...},
      "mheReference": "string",
      "packingUnit": "string",
      "positionNo": 0,
      "productionDate": {...},
      "quantity": 0,
      "receiptAvisoPositionNo": "string",
      "ssccNo": "string",
      "variableQuantity": 1,
      "volume": 0,
      "weight": 0
}]
<positions>
    <bestBeforeDate>...</bestBeforeDate>
    <clientPositionNo>string</clientPositionNo>
    <customsReference>string</customsReference>
    <fifoDate>...</fifoDate>
    <item>...</item>
    <mheReference>string</mheReference>
    <packingUnit>string</packingUnit>
    <positionNo>1</positionNo>
    <productionDate>...</productionDate>
    <quantity>1</quantity>
    <receiptAvisoPositionNo>string</receiptAvisoPositionNo>
    <ssccNo>string</ssccNo>
    <variableQuantity>1</variableQuantity>
    <volume>1.1</volume>
    <weight>1.1</weight>
</positions>
Property Type Length Mandatory Description
positionNo Integer 5 M Position number
receiptAvisoPositionNo String 10 M
clientPositionNo String 5 O
fifoDate ApiDate O
item ReceiptConfirmationItem M
mheReference String 35 O Reference MHE (=Mechanical Handling Equipment)
packingUnit String 3 O
quantity Integer 10 M Quantity in pieces (packing unit,smallest unit)
ssccNo String 18 O SSCC-Number
variableQuantity Integer 10.4 O Variable Quantity (running meter)
customsReference String 35 O Customs reference
productionDate ApiDate O Goods production date, if applicable to item
bestBeforeDate ApiDate O Goods expiration date, if applicable to item
volume BigDecimal 10.6 O Position volume in m³
weight BigDecimal 10.4 O Position weight in kg

ReceiptConfirmationItem

"item": {
    "batchNo": "string",
    "allocationNo": "string",
    "descriptions": {...},
    "eanCode": "string",
    "itemCode": "string",
}
<item>
   <batchNo>string</batchNo>
   <allocationNo>string</allocationNo>
   <descriptions>...</descriptions>
   <eanCode>string</eanCode>
   <itemCode>string</itemCode>

</item>
Property Type Length Mandatory Description
itemCode String 20 M Item number defined in item master database
batchNo String 35 O Batch number
allocationNo String 35 O Allocation number, if item is reserved for a project for example
eanCode String 13 O European Article Number
descriptions ItemDescriptions O Item descriptions

Dispatch Orders

CREATE Dispatch Orders

messageType: logistics.dispatchOrder

{
    "messageHeader":{...},
    "dispatchOrder":[{...}]
}
<?xml version="1.0" encoding="UTF-8" ?>
<dispatchOrder>
    <messageHeader>...</messageHeader>
    <dispatchOrder>...</dispatchOrder>
</dispatchOrder>

Creates a dispatch order in our warehouse system.

Property Type Mandatory Description
messageHeader MessageHeader M Message Header information.
dispatchOrder DispatchOrder M Array of dispatch orders.

DispatchOrder

"dispatchOrder" : {
    "cashOnDelivery": 0,
    "codCurrencyCode": "string",
    "deliveryDate": {...},
    "deliveryNoteComment": "string",
    "deliveryNoteCommentHeader": "string",
    "deliveryTerms": {...},
    "forwarderCode": "string",
    "orderReference": "string",
    "position": [{...}],
    "receiver": {...},
    "references": {...},
    "warehouse": {...}
}
<dispatchOrder>
    <warehouse>...</warehouse>
    <references>...</references>
    <cashOnDelivery>1.1</cashOnDelivery>
    <codCurrencyCode>string</codCurrencyCode>
    <deliveryTerms>...</deliveryTerms>
    <forwarderCode>string</forwarderCode>
    <receiver>...</receiver>
    <deliveryNoteComment>string</deliveryNoteComment>
    <deliveryNoteCommentHeader>string</deliveryNoteCommentHeader>
    <deliveryDate>...</deliveryDate>
    <orderReference>string</orderReference>
    <positions>...</positions>
</dispatchOrder>
Property Type Length Mandatory Description
warehouse Warehouse M Information about warehouse.
references ClientReferences M References from customer.
cashOnDelivery BigDecimal 15.5 O Cash on delivery.
codCurrencyCode String 3 O Cash on delivery currency code.
deliveryTerm DeliveryTerm O
forwarderCode String 13 O Forwarder code defined in forwarder master database.
receiver LogisticsParty M Receiver of dispatch order
deliveryDate String 10 O
deliveryNoteCommentHeader String 35 O
deliveryNoteComment String 160 O
orderReference String 35 O
positions Array[DispatchOrderPosition] M Positions of dispatch orders.

DispatchOrderPosition

"positions": [{
        "currencyCode": "string",
        "customsReference": "string",
        "item": {...},
        "packingUnit": "string",
        "pricePerItem": 0,
        "quantity": 0,
        "totalPrice": 0
    }
]
<positions>
    <currencyCode>string</currencyCode>
    <customsReference>string</customsReference>
    <item>...</item>
    <packingUnit>string</packingUnit>
    <pricePerItem>1.1</pricePerItem>
    <quantity>1</quantity>
    <totalPrice>1.1</totalPrice>
</positions>
Property Type Length Mandatory Description
quantity Integer 10 M Quantity in pieces (packing unit level 1).
item Item M Item per dispatch order position
totalPrice BigDecimal 15.5 O
pricePerItem BigDecimal 15.5 O
currencyCode String 3 O ISO 4217 three letter currency code.
customsReference String 35 O customs reference about item.
packingUnit String 3 O packingUnit for item.

Dispatch Confirmations

GET Dispatch Confirmations

messageType: logistics.dispatchConfirmation

{
    "messageHeader":{...},
    "dispatchConfirmation":{...}
}
<?xml version="1.0" encoding="UTF-8" ?>
<dispatchConfirmation>
    <messageHeader>...</messageHeader>
    <dispatchConfirmation>...</dispatchConfirmation>
</dispatchConfirmation>

A customer receives a dispatch confirmation for delivery of goods from a warehouse to a receiver.

Property Type Mandatory Description
messageHeader MessageHeader M Message Header information.
dispatchConfirmation DispatchConfirmation M Dispatch confirmation

DispatchConfirmation

"dispatchConfirmation" : {
  "deliveryNoteNo": "string",
  "deliveryTerm": {...},
  "dispatchOrderNo": "string",
  "forwarder": {...},
  "orderDate": {...},
  "positions": [{...}],
  "receiver": {...},
  "references": {...},
  "shippingMode": "ABH",
  "warehouse": {...}
}
<dispatchConfirmation>
  <deliveryNoteNo>string</deliveryNoteNo>
  <deliveryTerm>...</deliveryTerm>
  <dispatchOrderNo>string</dispatchOrderNo>
  <forwarder>...</forwarder>
  <orderDate>...</orderDate>
  <positions>...</positions>
  <receiver>...</receiver>
  <references>...</references>
  <shippingMode>ABH</shippingMode>
  <warehouse>...</warehouse>
</dispatchConfirmation>
Property Type Length Mandatory Description
warehouse Warehouse M Information about warehouse.
references ClientReferences M 3rd party references
deliveryNoteNo String 10 O
forwarder LogisticsParty M Forwarder of dispatch Confirmation
receiver LogisticsParty M Receiver of dispatch Confirmation
deliveryTerm DeliveyTerm M IncoTerm and Location
shippingMode String 3 O Valid values: ABH, SPE, PARABH=pick-up, SPE=freight forwarder, PAR=parcel service
orderDate ApiDate O
positions Array[DispatchConfirmationPosition] M Positions of dispatch orders.

DispatchConfirmationPosition

"positions": [{
  "bestBeforeDate": {...},
  "clearingUnit": "string",
  "clientPositionNumber": "string",
  "currencyCode": "string",
  "customsReference": "string",
  "item": {...},
  "mhe": "string",
  "mheReference": "string",
  "packagingUnit": "string",
  "positionNumber": "string",
  "positionType": "string",
  "pricePerItem": 0,
  "productionDate": {...},
  "quantity": 0,
  "ssccNumber": "string",
  "totalPrice": 0,
  "variableQuantity": 0,
  "volume": 0,
  "weight": 0
}]
<positions>
    <bestBeforeDate>...</bestBeforeDate>
    <clearingUnit>string</clearingUnit>
    <clientPositionNumber>string</clientPositionNumber>
    <currencyCode>string</currencyCode>
    <customsReference>string</customsReference>
    <item>...</item>
    <mhe>string</mhe>
    <mheReference>string</mheReference>
    <packagingUnit>string</packagingUnit>
    <positionNumber>string</positionNumber>
    <positionType>string</positionType>
    <pricePerItem>1.1</pricePerItem>
    <productionDate>...</productionDate>
    <quantity>1</quantity>
    <ssccNumber>string</ssccNumber>
    <totalPrice>1.1</totalPrice>
    <variableQuantity>1</variableQuantity>
    <volume>1.1</volume>
    <weight>1.1</weight>
</positions>
Property Type Length Mandatory Description
bestBeforeDate ApiDate O Goods expiration date, if applicable to item
productionDate ApiDate O Goods production date, if applicable to item
clientPositionNo String 5 O
item DispatchConfirmationItem M
mhe String 3 O Mechanical Handling Equipment
mheReference String 35 O Reference MHE (=Mechanical Handling Equipment), e.g. SSCC-Number
packagingUnit String 3 O
positionNo String 5 M Position number
positionType String 1 O
quantity Integer 10 M Quantity in pieces (packing unit,smallest unit)
ssccNo String 18 O SSCC Number
variableQuantity Integer 10.4 O Variable Quantity (running meter)
currencyCode String 3 C ISO 4217 three letter currency code. Mandatory if totalPrice or pricePerItem is provided
clearingUnit String 15 O
customsReference String 35 O Customs reference
totalPrice BigDecimal 15.5 O Total price of position
pricePerItem BigDecimal 15.5 O Price per item
weight BigDecimal 10.4 O Position weight in kg
volume BigDecimal 10.6 O Position volume in m³

DispatchConfirmationItem

"item": {
    "allocationNo": "string",
    "batchNo": "string",
    "descriptions": {...},
    "eanCode": "string",
    "itemCode": "string"
}
<item>
  <allocationNo>string</allocationNo>
  <batchNo>string</batchNo>
  <descriptions>...</descriptions>
  <eanCode>string</eanCode>
  <itemCode>string</itemCode>
</item>
Property Type Length Mandatory Description
itemCode String 20 M Item number defined in item master database
batchNo String 35 O Batch number
allocationNo String 35 O Allocation number, if item is reserved for a project for example
descriptions ItemDescriptions O Item descriptions
eanCode String 13 O European Article Number

Inventory Reports

GET Inventory Reports

messageType: logistics.inventoryReport

Get inventory report for stock items.

Example Inventory Report by Item, Position

Inventory Report

{
    "messageHeader":{...},
    "inventory":{...}
}
<?xml version="1.0" encoding="UTF-8" ?>
<inventories>
    <messageHeader>...</messageHeader>
    <inventory>...</inventory>
</inventories>
Property Type Mandatory Description
messageHeader MessageHeader M Message Header information.
inventory Inventory M

Inventory

"inventory":{
  "positions": [{...}],
  "warehouse": {...}
}
<Inventory>
  <positions>...</position>
  <warehouse>...</warehouse>
</Inventory>
Property Type Mandatory Description
warehouse Warehouse M Information about warehouse.
positions Array[InventoryPosition] M Array of inventory positions.

InventoryPosition

"positions": [{
      "bestBeforeDate": {...},
      "item": {...},
      "packaging1": {...},
      "packaging2": {...},
      "packaging3": {...},
      "packaging4": {...},
      "packaging5": {...},
      "packaging6": {...},
      "variableQuantity": 0,
      "volume": 0,
      "weight": 0
}]
<positions>
    <bestBeforeDate>...</bestBeforeDate>
    <item>...</item>
    <packaging1>...</packaging1>
    <packaging2>...</packaging2>
    <packaging3>...</packaging3>
    <packaging4>...</packaging4>
    <packaging5>...</packaging5>
    <packaging6>...</packaging6>
    <variableQuantity>1</variableQuantity>
    <volume>1.1</volume>
    <weight>1.1</weight>
</positions>
Property Type Length Mandatory Description
bestBeforeDate ApiDate M Expiration date
packaging1 Packaging M VPA level 1
packaging2 Packaging O VPA level 2
packaging3 Packaging O VPA level 3
packaging4 Packaging O VPA level 4
packaging5 Packaging O VPA level 5
packaging6 Packaging O VPA level 6
item InventoryItem O Item for this position.
variableQuantity BigDecimal 10.4 O Variable quantity
volume BigDecimal 10.4 O Volume in m³.
weight BigDecimal 10.6 O Weight in kg.

InventoryItem

"item": {
    "allocationNo": "string",
    "batchNo": "string",
    "descriptions": {...},
    "eanCode": "string",
    "itemCode": "string",
    "itemGroup": "string",
    "itemSubGroup": "string"
}
<item>
  <allocationNo>string</allocationNo>
  <batchNo>string</batchNo>
  <descriptions>...</descriptions>
  <eanCode>string</eanCode>
  <itemCode>string</itemCode>
  <itemGroup>string</itemGroup>
  <itemSubGroup>string</itemSubGroup>
</item>
Property Type Length Mandatory Description
itemCode String 20 M Item code
batchNo String 35 O Batch number
allocationNo String 35 O Allocation number
itemGroup String 3 O Item group
itemSubGroup String 3 O Item subgroup
description ItemDescriptions O Descriptions

Master Data

CREATE/GET Items

messageType: logistics.items

{
    "messageHeader":{...},
    "items":[{...}]
}
<?xml version="1.0" encoding="UTF-8" ?>
<items>
    <messageHeader>...</messageHeader>
    <items>...</items>
</items>
Property Type Mandatory Description
messageHeader MessageHeader M Message Header information.
items Array[MasterDataItem] M Master data object.

MasterDataItem

"items": [{
        "allocationNo": "string",
        "batchNo": "string",
        "blockReason": "string",
        "clearingUnit": "string",
        "descriptions": {...},
        "family": "string",
        "fifoLifo": "string",
        "group": "string",
        "itemCode": "string",
        "matchCode": "string",
        "maximalStock": 0,
        "minimalStock": 0,
        "origin": "string",
        "receiptDispatchAllowed": "string",
        "reorderStock": 0,
        "serialNo": "string",
        "subGroup": "string",
        "typeFifo": "string",
        "vpaLevel": [{....}],
        "warehouse": {...}
    }
]
<ItemMaster>
    <items>
        <allocationNo>string</allocationNo>
        <batchNo>string</batchNo>
        <blockReason>string</blockReason>
        <clearingUnit>string</clearingUnit>
        <descriptions>...</descriptions>
        <family>string</family>
        <fifoLifo>string</fifoLifo>
        <group>string</group>
        <itemCode>string</itemCode>
        <matchCode>string</matchCode>
        <maximalStock>1</maximalStock>
        <minimalStock>1</minimalStock>
        <origin>string</origin>
        <receiptDispatchAllowed>string</receiptDispatchAllowed>
        <reorderStock>1</reorderStock>
        <serialNo>string</serialNo>
        <subGroup>string</subGroup>
        <typeFifo>string</typeFifo>
        <vpaLevel>...</vpaLevel>
        <warehouse>...</warehouse>
    </items>
</ItemMaster>
Property Type Mandatory Description
warehouse Warehouse M Warehouse information.
descriptions ItemDescriptions M Unique key, always uppercase (example A4711-02)
family String O Itemfamily
group String O Itemgroup
subGroup String O Itemsubgroup
origin String O Origin
serialNo String O Serialnumber
typeFifo String O “Entry date” (4) or “Production date” (2) or “Expiration date” (2)
fifoLifo String O FIFO (1) or LIFO (2)
blockReason String O Block Reason
clearingUnit String O
minimalStock Integer O Minimal stock quantity
reorderStock Integer O reordered stock quantity
maximalStock Integer O Maximal stock quantity
receiptDispatchAllowed String O Aviso or receipt order allowed? Yes / No (1/0)
matchCode String O Matchcode
vpaLevel MasterDataVpa O Packaging level, only VPA Level 1 is mandatory

MasterDataVpa

"vpaLevel": [{
        "allocationNo": "string",
        "batchNo": "string",
        "eanCode": "string",
        "height": 0,
        "itemCode": "string",
        "length": 0,
        "level": "string",
        "measurement": "string",
        "piecesPerVpa": "string",
        "vpa": "string",
        "weight": 0,
        "width": 0
    }
]
<vpaLevel>
    <allocationNo>string</allocationNo>
    <batchNo>string</batchNo>
    <eanCode>string</eanCode>
    <height>1.1</height>
    <itemCode>string</itemCode>
    <length>1.1</length>
    <level>string</level>
    <measurement>string</measurement>
    <piecesPerVpa>string</piecesPerVpa>
    <vpa>string</vpa>
    <weight>1.1</weight>
    <width>1.1</width>
</vpaLevel>
Property Type Mandatory Description
itemCode String M
batchNo String O Is batch number required for stock in ? Yes / No (1/0)
allocationNo String O Not used in MasterDataItem
eanCode String O EAN code
height BigDecimal M
length BigDecimal M
weight BigDecimal M
width BigDecimal M
level String M Packaging level
measurement String O Measurement in cm
piecesPerVpa String O Pieces per packaging level

Common Logistics Objects

Warehouse

"warehouse":{
    "location":"BTS",
    "operative":"STRING"
}
<warehouse>
    <location>BTS</location>
    <operative>STRING</operative>
</warehouse>
Property Type Length Mandatory Description
location String 3 M Code were the Warehouse is located.
operative String 10 M Name of operative in warehouse system.

ClientReferences

"references": {
    "customerReference1": "string",
    "customerReference2": "string"
}
<references>
    <customerReference1>string</customerReference1>
    <customerReference2>string</customerReference2>
</references>
Property Type Length Mandatory Description
customerReference1 String 35 M Reference, all lines with the same reference are one dispatch order.
customerReference2 String 35 O Reference from customer.

Item

"item": {
    "allocationNo": "string",
    "batchNo": "string",
    "itemCode": "string"
}
<item>
  <allocationNo>string</allocationNo>
  <batchNo>string</batchNo>
  <itemCode>string</itemCode>
</item>
Property Type Length Mandatory Description
itemCode String 20 M Item number defined in item master database
batchNo String 35 O Batch number
allocationNo String 35 O Allocation number, if item is reserved for a project for example

ItemDescriptions

"descriptions": {
  "description1": "string",
  "description2": "string",
  "description3": "string",
  "description4": "string"
}
<descriptions>
    <description1>string</description1>
    <description2>string</description2>
    <description3>string</description3>
    <description4>string</description4>
</descriptions>
Property Type Length Mandatory Description
description1 String 35 M Item description 1
description2 String 35 O Item description 2
description3 String 35 O Item description 3
description4 String 35 O Item description 4

LogisticsParty

"logisticsParty": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "code": "string",
    "country": "string",
    "email": "string",
    "fax": {...},
    "name1": "string",
    "name2": "string",
    "phone": {...},
    "zipCode": "string"
}
<logisticsParty>
    <address1>string</address1>
    <address2>string</address2>
    <city>string</city>
    <code>string</code>
    <country>string</country>
    <email>string</email>
    <fax>...</fax>
    <name1>string</name1>
    <name2>string</name2>
    <phone>...</phone>
   <zipCode>string</zipCode>
</logisticsParty>
Property Type Length Mandatory Description
code String 13 C WMS party code. If provided no additional information is required.
name1 String 35 C Mandatory if no code is provided.
name2 String 35 O
country String 3 C ISO country code (ISO 3166-1 Alpha-2). Mandatory if no code is provided.
city String 35 C Mandatory if no code is provided.
zipCode String 13 O
address1 String 35 C Mandatory if no code is provided.
address2 String 35 O
fax Phone 25 O
phone Phone 25 O
email String 50 O

Packaging

"packaging1": {
    "packagingUnit": "string",
    "quantity": 0
}
<packaging1>
  <packagingUnit>string</packagingUnit>
  <quantity>1</quantity>
</packaging1>
Property Type Length Mandatory Description
packagingUnit String 3 M
quantity Integer 10 O

Procurement

Purchase Orders

CREATE Purchase Orders

messageType: procurement.purchaseOrder

{
    "messageHeader":{...},
    "purchaseOrder":[{...}]
}
<?xml version="1.0" encoding="UTF-8" ?>
<purchaseOrder>
    <messageHeader>...</messageHeader>
    <purchaseOrder>...</purchaseOrder>
</purchaseOrder>

Create purchase orders in our purchase order management system

Property Type Mandatory Description
messageHeader MessageHeader M Message Header information.
purchaseOrders PurchaseOrder M Array of purchase orders.

PurchaseOrder

"purchaseOrders" : {
    "deliveryTerm": {...},
    "destinationCountryCode": "string",
    "lineItems": [{...}],
    "mainModality": "AIR",
    "orderDate": {...},
    "originCountryCode": "string",
    "parties": [{...}],
    "poReference": "string",
    "sourceIdentifier": "string"
}
<?xml version="1.0"?>

<PurchaseOrder>
    <deliveryTerm>...</deliveryTerm>
    <destinationCountryCode>string</destinationCountryCode>
    <lineItems>...</lineItems>
    <mainModality>AIR</mainModality>
    <orderDate>...</orderDate>
    <originCountryCode>string</originCountryCode>
    <parties>...</parties>
    <poReference>string</poReference>
    <sourceIdentifier>string</sourceIdentifier>
</PurchaseOrder>
Property Type Mandatory Description
deliveryTerm DeliveryTerm M
destinationCountryCode String M
lineItems Array[PurchaseOrderLineItem] M
mainModality String M
orderDate ApiDate M
originCountryCode String M
parties Array[PurchaseOrderParty] M
poReference String M
sourceIdentifier String M

Common Procurements Objects

PurchaseOrderLineItem

"lineItems": [{
        "article": {...},
        "cargoReady": {...},
        "cargoReadiness": {...},
        "desiredDelivery": {...},
        "estimatedArrival": {...},
        "estimatedDeparture": {...},
        "grossWeight": 0,
        "leadTime": 0,
        "mainModality": "AIR",
        "plannedQuantity": 0,
        "preCarriageTime": 0,
        "quantity": 0,
        "reference": "string",
        "volume": 0
    }
}
<lineItems>
    <article>...</article>
    <cargoReady>...</cargoReady>
    <cargoReadiness>...</cargoReadiness>
    <desiredDelivery>...</desiredDelivery>
    <estimatedArrival>...</estimatedArrival>
    <estimatedDeparture>...</estimatedDeparture>
    <grossWeight>1.1</grossWeight>
    <leadTime>1</leadTime>
    <mainModality>AIR</mainModality>
    <plannedQuantity>1</plannedQuantity>
    <preCarriageTime>1</preCarriageTime>
    <quantity>1</quantity>
    <reference>string</reference>
    <volume>1.1</volume>
</lineItems>
Property Type Mandatory Description
article PurchaseOrderArticle M
cargoReadiness ApiDate C
cargoReady ApiDateFromTo C
desiredDelivery ApiDateFromTo C
estimatedArrival ApiDate C
estimatedDeparture ApiDate C
grossWeight BigDecimal O
leadTime Integer O
mainModality String M
plannedQuantity Integer O
preCarriageTime Integer O
quantity Integer M
reference String M
volume BigDecimal O

PurchaseOrderArticle

"article": {
    "articleAttributes": [{...}],
    "code": "string",
    "customsTariffNumber": "string",
    "dangerousGoods": {...},
    "description": "string",
    "eanCode": "string",
    "nameLocalDescription": "string",
    "netPrice": 0,
    "netWeight": 0,
    "originCountry": "string"
}
<article>
    <articleAttributes>...</articleAttributes>
    <code>string</code>
    <customsTariffNumber>string</customsTariffNumber>
    <dangerousGoods>...</dangerousGoods>
    <description>string</description>
    <eanCode>string</eanCode>
    <nameLocalDescription>string</nameLocalDescription>
    <netPrice>1.1</netPrice>
    <netWeight>1.1</netWeight>
    <originCountry>string</originCountry>
</article>
Property Type Mandatory Description
articleAttributes Array[ArticleAttributes] M
code String M Articlecode
customsTariffNumber String O
dangerousGoods DangerousGoods M
description String M
eanCode String O
nameLocalDescription String O
netPrice BigDecimal O
netWeight BigDecimal O
originCountry String O

ArticleAttributes

"article": [{
        "key": {...},
        "value": {...},
    }
}
<article>
    <key>...</key>
    <value>...</value>
</article>
Property Type Mandatory Description
key String O
value String C

PurchaseOrderParty

"parties": [{
        "contacts": [{...}],
        "partyId": 415645,
        "partyType": "PRINCIPAL"
    }
]
<parties>
    <contacts>...</contacts>
    <partyId>415645</partyId>
    <partyType>PRINCIPAL</partyType>
</parties>
Property Type Mandatory Description
contacts Array[PurchaseOrderContact] O
partyId Integer M
partyType String M

PurchaseOrderParty

"parties": [{
        "contacts": [{...}],
        "partyId": 415645,
        "partyType": "PRINCIPAL"
    }
]
<parties>
    <contacts>...</contacts>
    <partyId>415645</partyId>
    <partyType>PRINCIPAL</partyType>
</parties>
Property Type Mandatory Description
contactPersonId Array[PurchaseOrderContact] O
partyId Integer C
partyType String C

PurchaseOrderContact

"contacts": [{
        "contactPersonId": 0,
        "emailBusiness": "string",
        "firstName": "string",
        "lastName": "string",
        "mobile": "string",
        "phoneBusiness": "string",
        "type": "PERSON"
    }
]
<contacts>
    <contactPersonId>1</contactPersonId>
    <emailBusiness>string</emailBusiness>
    <firstName>string</firstName>
    <lastName>string</lastName>
    <mobile>string</mobile>
    <phoneBusiness>string</phoneBusiness>
    <type>PERSON</type>
</contacts>
Property Type Mandatory Description
contactPersonId Integer C If an Id will be provided all other fields can be ignored.
emailBusiness String C
firstName String C
lastName String C
mobile String C
phoneBusiness String C
type String C

Global Objects

ApiDate

"estimatedCargoReadiness":{
    "date":"date",
    "time":"time",
}
<estimatedCargoReadiness>
    <date>string</date>
    <time>string</time>
</estimatedCargoReadiness>
Property Type Length Mandatory Description
date String 10 M Date in format YYYY-MM-DD as defined by ISO 8601.
time String 8 O Local time of location in format hh:mm:ss as defined by ISO 8601.

ApiDateFromTo

"desiredPickup":{
    "dateFrom":"date",
    "timeFrom":"time",
    "dateTo":"date",
    "timeTo":"time",
}
<desiredPickup>
    <dateFrom>string</dateFrom>
    <dateTo>string</dateTo>
    <timeFrom>string</timeFrom>
    <timeTo>string</timeTo>
</desiredPickup>
Property Type Length Mandatory Description
dateFrom String 10 O Date in format YYYY-MM-DD as defined by ISO 8601.
dateTo String 10 O Date in format YYYY-MM-DD as defined by ISO 8601.
timeFrom String 8 O Local time of location in format hh:mm:ss as defined by ISO 8601.
timeTo String 8 O Local time of location in format hh:mm:ss as defined by ISO 8601.

DangerousGoods

"dangerousGoods": [{
    "classification": "string",
    "packagingGroup": "string",
    "unNumber": "string"
}]
<dangerousGoods>
    <classification>string</classification>
    <packagingGroup>string</packagingGroup>
    <unNumber>string</unNumber>
</dangerousGoods>
Property Type Mandatory Description
classification String M Dangerous goods classification
packagingGroup String C packaging group, if assigned to the IMO class
unNumber String M 4-digit number codes defined by the UN Committee of Experts on the Transport of Dangerous Goods

DeliveryTerm

"deliveryTerm": {
    "deliveryTerm": "string",
    "deliveryTermLocation": "string",
}
<deliveryTerm>
    <deliveryTerm>CFR</deliveryTerm>
    <deliveryTermLocation>string</deliveryTermLocation>
</deliveryTerm>
Property Type Mandatory Description
deliveryTerm String M 3-letter Incoterms® code. (List of Incoterms®).
deliveryTermLocation String M Location of delivery term.

More information regarding the Incoterms® rules can be found at the Incoterms® rules 2010 page of the International Chamber of Commerce and/or on the Wikipedia article regarding Incoterms® rules.

“Incoterms” is a trademark of the International Chamber of Commerce.

Phone

"phoneBusiness"{
    "countryCode": "string",
    "areaCode": "string",
    "localNumber": "string"
}
<phoneBusiness>
  <areaCode>string</areaCode>
  <countryCode>string</countryCode>
  <localNumber>string</localNumber>
</phoneBusiness>
Property Type Mandatory Description
countryCode String O ITU phone calling country code (e.g. 43 for Austria, 1 for USA, 852 for Hong Kong).
areaCode String O Area code within the country.
localNumber String M Local connection number (If number cannot be split put whole number here.)