Booking XML format

This is the XML format used for reporting a booking. When a booking is made, the XML is sent from Leaps to the “broker”. In some cases, the XML isn't sent until 19:00 GMT the same evening.

The booking XML has the following structure:

<header>
  <consignmentlist>
    <consignment>
      <creationdata> ... </creationdata>
      <part> ... </part>
      <pdinstructions> ... </pdinstructions>
      <transportservice> ... </transportservice>
      <reference> ... </reference>
      <paymentinstructions> ... </paymentinstructions>
      <goodsitem> ... </goodsitem>
    </consignment>
  </consignmentlist>
  <invoicing></invoicing>
</header>

There may be multiple <part> elements, these are identified by a part attribute.

<othercharges> contains 0 or more <othercharge> elements.

Values

Dates are specified as YYYY-MM-DD. Time is specified as HH:MM. Date+time is specified as YYYY-MM-DD HH:MM.

Decimal values are specified using . (full stop) as decimal point. No thousand-separator is allowed.

All text must be specified in UTF-8.

Dimensions are specified in meters. Weight is specified in kgs. Volume is specified in m3.

Header

The <header> element includes some or all of the following attributes:

<header sender="ONESHELL" receiver="UNB" doctype="STDBOOK" datetime="2015-01-01 12:35:30" test="1">

sender is always ONESHELL.

receiver is the UNB adresse of product selected. If the booking goes through CCS there will be two products selected: the product selected by the user, and the product selected by CCS. The receiver attribute refers to the product selected by the user.

doctype is either STDBOOK or CCSBOOK or GROUPED.  The value CCSBOOK is used when CCS has processed the booking. GROUPED means that multiple shipments are included in the <consignmentlist>.

test is 1 if this is a test booking.

Creation data

The <creationdata> element holds some of the following:

<bookingid> ... </bookingid>
<bookingcreated>2015-01-01 12:25:00</bookingcreated>
<bookedbyname>Willy Wonka</bookedbyname>
<bookedbyemail>will@wonka.com</bookedbyemail>
<portalname>Candy</portalname>
<portalid>150</portalid>
<customertype>CSA</customertype>
<xmlversion>1</xmlversion>

<bookingid> is the SLI no of the booking (if doctype=STDBOOK) or the AWB no (if doctype=CCSBOOK or if the booking was forwarded from another system or if the AWB no was specified in the EDI XML).

<customertype> can have the following values

Part

There may be multiple <part> elements. A <part> element is idenfitied by the role attribute, which can be either consignor, consignee, ordering, pickup or delivery, eg.

<part role="consignor"> ... </part>

The <part> element holds some or all of these elements:

<address>
  <id>DKCHOCFAC</id>
  <name>Chocolate Factory</name>
  <address1>Nuts Road 1</address1>
  <address2>Almond Building</address2>
  <postcode>1234</postcode>
  <city>Candy Town</city>
  <state>Cornwall</state>
  <countrycode>UK</countrycode>
  <unloc>UKCAN</unbloc>
</address>
<communication>
  <phone>+40 1232123123</phone>
  <email>c@coco.com</email>
  <contactperson>Charlie</contactperson>
</communication>

Pickup/Delivery instructions

The <pdinstructions> element describes pickup and delivery; it holds some of the following elements:

<pdinstructions>
  <pickup>
    <pdate>2015-12-31</pdate>
    <earliest>07:30</earliest>
    <latest>20:30</latest>
    <pinstructions>Please call in advance</pinstructions>
    <pickupbycarrier>no</pickupbycarrier>
  </pickup>
  <delivery>
    <ddate>2016-01-07</ddate>
    <dinstructions>Leave package behind the building</dinstructions>
  </delivery>
</pdinstructions>

The elements <ddate>, <pinstructions> and <dinstructions> are optional.

<pickupbycarrier> is only allowed for DHL and TNT shipments; it defaults to no. 

Transport service

The <transportservice> element holds some of the following elements:

<transportservice>
  <product>Airfreight Basic</product>
  <productid>AS3</productid>
  <tsproductid>CX</tsproductid> 
  <userselectedproduct>Airfreight Discount</userselectedproduct>
  <userselectedproductid>AS3</userselectedproductid>
  <deliverytype>DD</delivertype>
  <combiterms>DAP</combiterms>
  <todcountry>DE</todcountry>
  <todcity>Berlin</todcity>
  <reliabletoduty>yes</reliabletoduty>
  <goodsvalue>123.2</goodsvalue>
  <goodscurrency>DKK</goodscurrency>
  <unb>DKCPH</unb>
  <officeid>123</officeid>
  <pickuptransportcompany>Bobs Parcel Service<pickuptransportcompany>
  <trade>export</trade>
  <pickupagent>DHL</pickupagent>
</transportservice>

The elements <todcity>, <todcountry>, <goodsvalue> and <goodscurrency> are optional. The elements <userselectedproduct> and <userselectedproductid> are only included if the shipment was handled by CCS.

<productid> is always in UPPERCASE.

Possible values for <trade> are: export, import and crosstrade.

Reference

The <references> elements should various references, like senders reference etc.

The following elements may be included - all are optional:

<references>
  <sendersreference>123456678</sendersreference>
  <receiversreference>3455678</receiversreference>
  <slirefno>330234234</slirefno>
  <hawbno>345345345</hawbno>
  <senderref>456456</senderref>
  <packageid>567567</packageid>
  <invoiceno>678678</invoiceno>
  <salesproductno>789789</salesproductno>
  <purchaseorderno>23424</purchaseorderno>
  <productioncode>34535</productioncode>
  <shipmentreferenceno>456456</shipmentreferenceno>
  <sellersreference>56757</sellersreference>
  <salesorderno>45643</salesorderno>
  <cargocontrolno>567834</cargocontrolno>
  <carriertrackingno>475686</carriertrackingno>
</references>

<hawbno> is set to the SLI no if the Product ID includes 'CE' or 'CX'.

Payment instructions

The <paymentinstructions> element may hold the following elements; <accountno> is optional.

<paymentinstructions>
  <paymentmethod>Collect</paymentmethod>
  <accountno>2342343234</accountno>
  <dhlvalue>234</dhlvalue>
  <dhlcurrency>DKK</dhlcurrency>
  <generateinvoice>no</generateinvoice>
</paymentinstructions>

<paymentmethod> can be either Collect, Prepaid or 3. party.

If <generateinvoice> is set to yes then the carrier will generate the invoice (DHL only).

Goods items

There may be multiple <goodsitem> elements; each holds some of the following elements:

<goodsitem>
  <noofpackages>3</noofpackages>
  <licenceplate>2342342342342342</licenseplate>
  <weight>12.34</weight>
  <volume>0.008</volume>
  <width>20</width>
  <length>20</length>
  <height>20</height>
  <packagetype>Drum</packagetype>
  <packagecode>DRM</packagecode>
  <goodsdescribetion>Stuff and stuff</goodsdescription>
  <shippingmark>More stuff</shippingmark>
  <dangerous>yes</dangerous>
  <article>
    <articlenumber>1</articlenumber>
    <articlename>Stuff</articlename>
    <articlequantity>3</articlequantity>
    <articleunitprice>30</articleunitprice>
    <articlecurrency>DKK</articlecurrency>
  </article>
  <chargeableweight>1.6</chargeableweight>
</goodsitem>

<article>, <width>, <length> and <height> are optional. There may be multiple <article>.

<weight> and <volume> is specified per package.

<licenseplate> is currently only used for DHL shipments.

Confirmation

The <confirmation> element holds some of the following elements:

<confirmation>
  <p2></p2>
  <p3></p3>
  <distributionnote></distributionnote>
  <confirmationnote></confirmationnote>
</confirmation>

Invoicing

The <invoicing> element holds the following:

<totals>
  <pricing>123.32</pricing>
  <pricing-currency>DKK</pricing-currency>
  <costing>98.33</costing>
  <costing-currency>DKK</costing-currency>
</totals>