Skip to content

DHL Supply Chain Order XML

This XML format represents a sales order for the picking and despatch of goods from the warehouse to a customer.

Tasks

Minimal XML Sample

The XML below represents the minimum information that needs to be provided to create an order in DHL Supply Chain.

<?xml version="1.0"?>
<Orders>
  <Order>
    <ExternalId>5231</ExternalId>
    <FacilityId>GB_0001</FacilityId>
    <CustomerId>CUST0001</CustomerId>
    <OrderNumber>TESTORDR0001</OrderNumber>
    <OrderType>CustomerOrder</OrderType>
    <OrderDate>2024-07-01T09:00:00Z</OrderDate>
    <ShipTo>
      <CustomerId>CUST0001</CustomerId>
      <AddressName>NE14XF</AddressName>
      <AddressType>CST</AddressType>
      <AddressLine1>6-8 Charlotte Square</AddressLine1>
      <PostCode>NE1 4XF</PostCode>
      <City>Newcastle</City>
      <CountryCode>GB</CountryCode>
    </ShipTo>
    <BillTo>
      <CustomerId>CUST0001</CustomerId>
      <AddressName>NE14XF</AddressName>
      <AddressType>CST</AddressType>
      <AddressLine1>6-8 Charlotte Square</AddressLine1>
      <PostCode>NE1 4XF</PostCode>
      <City>Newcastle</City>
      <CountryCode>GB</CountryCode>
    </BillTo>
    <OrderLines>
      <OrderLine>
        <LineNumber>1</LineNumber>
        <ItemNumber>TEST0001</ItemNumber>
        <OrderedQuantity>12</OrderedQuantity>
      </OrderLine>
    </OrderLines>
  </Order>
</Orders>

In each of the following sections most of the XML has been omitted to make the samples easier to read. The whole structure of the Orders schema is used below as a reference of where fields should be in the object model.

Order

The Order element represents an individual order to create or update in DHL Supply Chain. This element appears within the root Orders collection of the XML document.

Zynk will search for an exiting order in DHL Supply chain with matching FacilityId, CustomerId and OrderNumber values. If a match is found, the existing order will be updated, otherwise a new order will be created.

XML Field Example Field Type Input Description
ExternalId 5231 string Optional Used in conjunction with the Prevent Reprocessing setting. Max 255 chars
FacilityId GB_0001 string Required Used for matching existing orders.
CustomerId CUST0001 string Required Used for matching existing orders.
Division Customer Division string Optional Only applicable to certain WMS.
OrderNumber TESTORDR0001 string Required Used for matching existing orders.
OrderType* CustomerOrder enum Dependant Required when creating a new order.
OrderDate 2024-07-01T09:00:00Z datetime Optional
OrderStatus Picking Begun string Optional
CustomerPurchaseOrderNumber PO-24341 string Optional
CustomerPurchaseOrderType Sales string Optional
CustomerPurchaseOrderDate 2024-07-01T09:00:00Z datetime Optional
CarrierName DPD string Dependant Mandatory for certain WMS. Can only take values that are allowed in the WMS at customer level.
CarrierServiceLevel Next Day string Optional
ServiceLevel Next Day string Dependant Mandatory for certain WMS.
ModeOfTransport Road string Optional Only applicable to certain WMS.
ExpectedDeliveryDate 2024-07-02T09:00:00Z datetime Optional
ExpectedShipmentDate 2024-07-02T09:00:00Z datetime Optional
ActualShipmentDate 2024-07-02T09:00:00Z datetime Optional
BillOfLadingNumber BOL12345 string Optional Only applicable to certain WMS.
InvoiceNumber INV0001 string Optional Only applicable to certain WMS.
ManifestNumber MAN0001 string Optional Only applicable to certain WMS.
CancelledFlag false bool Optional
Priority A string Optional Only applicable to certain WMS.
BillingMethodCode A string Optional Only applicable to certain WMS.
DepartmentNumber DEP1 string Optional
OrderReferenceFields See below Collection Optional The collection of OrderReferenceField elements.
OrderNotes See below Collection Optional The collection of OrderNote elements.
ShipTo See below ContactDetails Dependant Required when creating a new order.
BillTo See below ContactDetails Dependant Required when creating a new order.
RouteTo See below ContactDetails Optional
Seller See below ContactDetails Optional
OrderLines See below Collection Dependant The collection of OrderLine elements. Required when creating a new order.
  • OrderType* - Valid values: AdvancedOrder, CustomerOrder, CartonisationOrder, DistributionOrder, SequencedOrder, SlottedOrder, TransferOrder, VendorReturn, PalletOrder
<?xml version="1.0"?>
<Orders>
  <Order>
    <ExternalId>5231</ExternalId>
    <FacilityId>GB_0001</FacilityId>
    <CustomerId>CUST0001</CustomerId>
    <Division>Customer Division</Division>
    <OrderNumber>TESTORDR0001</OrderNumber>
    <OrderType>CustomerOrder</OrderType>
    <OrderDate>2024-07-01T09:00:00Z</OrderDate>
    <OrderStatus>Picking Begun</OrderStatus>
    <CustomerPurchaseOrderNumber>PO-24341</CustomerPurchaseOrderNumber>
    <CustomerPurchaseOrderType>Sales</CustomerPurchaseOrderType>
    <CustomerPurchaseOrderDate>2024-07-01T09:00:00Z</CustomerPurchaseOrderDate>
    <CarrierName>DPD</CarrierName>
    <CarrierServiceLevel>Next Day</CarrierServiceLevel>
    <ServiceLevel>Next Day</ServiceLevel>
    <ModeOfTransport>Road</ModeOfTransport>
    <ExpectedDeliveryDate>2024-07-02T09:00:00Z</ExpectedDeliveryDate>
    <ExpectedShipmentDate>2024-07-02T09:00:00Z</ExpectedShipmentDate>
    <ActualShipmentDate>2024-07-02T09:00:00Z</ActualShipmentDate>
    <BillOfLadingNumber>BOL12345</BillOfLadingNumber>
    <InvoiceNumber>INV0001</InvoiceNumber>
    <ManifestNumber>MAN0001</ManifestNumber>
    <CancelledFlag>false</CancelledFlag>
    <Priority>A</Priority>
    <BillingMethodCode>A</BillingMethodCode>
    <DepartmentNumber>DEP1</DepartmentNumber>
    <OrderReferenceFields>
      <!-- See below -->
    </OrderReferenceFields>
    <OrderNotes>
      <!-- See below -->
    </OrderNotes>
    <ShipTo>
      <!-- See below -->
    </ShipTo>
    <BillTo>
      <!-- See below -->
    </BillTo>
    <RouteTo>
      <!-- See below -->
    </RouteTo>
    <Seller>
      <!-- See below -->
    </Seller>
    <OrderLines>
      <!-- See below -->
    </OrderLines>
  </Order>
</Orders>

OrderReferenceField

The OrderReferenceField element appears within the OrderReferenceFields collection of the Order element.

XML Field Example Field Type Input Description
ReferenceField 4.99 string Optional
ReferenceFieldType* ShippingFee enum Optional
  • ReferenceFieldType* - Valid values: declarationname, dutypaymenttype, dutypaymentnumber, incoterms, exportindicator, portalordernumberecom, shiptodeanumber, alternateSCAC, childBOLNumber, departmentCode, masterBOLNumber, palletExchangeCode, storeNumber, freightAccount, freightTerms, ShippingFee, StoreCode, ChannelType
<?xml version="1.0"?>
<Orders>
  <Order>
    <OrderReferenceFields>
      <OrderReferenceField>
        <ReferenceField>4.99</ReferenceField>
        <ReferenceFieldType>ShippingFee</ReferenceFieldType>
      </OrderReferenceField>
    </OrderReferenceFields>
  </Order>
</Orders>

OrderNote

The OrderNote element appears within the OrderNotes collection of the Order element.

XML Field Example Field Type Input Description
NoteLineNumber 0001 string Required
NoteText Leave by the door string Required
NoteType* ShippingNotes enum Required
NoteTypeDescription Customer note string Optional
  • NoteType* - Valid values: Generic, ShippingNotes, DutyManagement
<?xml version="1.0"?>
<Orders>
  <Order>
    <OrderNotes>
      <OrderNote>
        <NoteLineNumber>0001</NoteLineNumber>
        <NoteText>Leave by the door</NoteText>
        <NoteType>ShippingNotes</NoteType>
        <NoteTypeDescription>Customer note</NoteTypeDescription>
      </OrderNote>
    </OrderNotes>
  </Order>
</Orders>

ContactDetails

The ShipTo, BillTo, RouteTo and Seller child elements of the Order element all take the form of contact details information.

XML Field Example Field Type Input Description
AddressId 0001 string Optional
CustomerId CUST0001 string Dependant Required when creating a new order.
AddressName NE14XF string Dependant Required when creating a new order.
AddressType* CST enum Dependant Required when creating a new order.
AddressLine1 Zynk Software string Dependant Required when creating a new order.
AddressLine2 6-8 Charlotte Square string Optional
AddressLine3 string Optional
PostCode NE1 4XF string Optional
City Newcastle string Dependant Required when creating a new order.
State Tyne & Wear string Optional
CountryCode GB string Dependant Required when creating a new order.
Name John Smith string Optional
PhoneNumber 0191 820 1484 string Optional
Email [email protected] string Optional
ContactName John Smith string Optional
AttentionName John Smith string Optional
  • AddressType* - Valid values: CST
<?xml version="1.0"?>
<Orders>
  <Order>
    <ShipTo>
      <AddressId>0001</AddressId>
      <CustomerId>CUST0001</CustomerId>
      <AddressName>NE14XF</AddressName>
      <AddressType>CST</AddressType>
      <AddressLine1>Zynk Software</AddressLine1>
      <AddressLine2>6-8 Charlotte Square</AddressLine2>
      <AddressLine3></AddressLine3>
      <PostCode>NE1 4XF</PostCode>
      <City>Newcastle</City>
      <State>Tyne &amp; Wear</State>
      <CountryCode>GB</CountryCode>
      <Name>John Smith</Name>
      <PhoneNumber>0191 820 1484</PhoneNumber>
      <Email>[email protected]</Email>
      <ContactName>John Smith</ContactName>
      <AttentionName>John Smith</AttentionName>
    </ShipTo>
  </Order>
</Orders>

OrderLine

The OrderLine element appears within the OrderLines collection of the Order element.

XML Field Example Field Type Input Description
LineNumber 1 string Required
SubLineNumber 0000 string Dependant Mandatory in certain WMS.
ItemNumber TEST0001 string Required
LotNumber LOTA string Optional
SupplierLotNumber LOTA string Optional
OriginalOrderedQuantity 12 decimal Optional
OrderedQuantity 12 decimal Required
UnitOfMeasure* EA enum Optional
SupplierNumber SUPL0001 string Optional
UnitPrice 10.99 decimal Optional
UnitPriceCurrency GBP string Dependant Mandatory in certain WMS.
InventoryStatus* Available enum Optional
RevisionLevel 1.0 string Optional
OriginCode GB string Optional
CancelledFlag false bool Optional
DangerousGoodsCode HZ122 string Optional Only applicable to certain WMS.
ExternalSystemPurchaseOrderNumber PO-23133 string Optional Only applicable to certain WMS.
AccountNumber AC0001 string Optional
MinimumShelfLife 30 decimal Optional
InventoryAttributeFields See below Collection Optional The collection of InventoryAttributeField elements.
OrderLineReferenceFields See below Collection Optional The collection of OrderLineReferenceField elements.
SerialNumbers See below Collection Optional The collection of SerialNumber elements.
OrderLineNotes See below Collection Optional The collection of OrderLineNotes elements.
  • UnitOfMeasure* - Valid values: EA, CS, PA, IP, BO, DR, LA
  • InventoryStatus* - Valid values: Available, CriticalHold, Damaged, Expired, Hold, Inspection, Release, Returned, Salvaged, TimeHold
<?xml version="1.0"?>
<Orders>
  <Order>
    <OrderLines>
      <OrderLine>
        <LineNumber>1</LineNumber>
        <SubLineNumber>0000</SubLineNumber>
        <ItemNumber>TEST0001</ItemNumber>
        <LotNumber>LOTA</LotNumber>
        <SupplierLotNumber>LOTA</SupplierLotNumber>
        <OriginalOrderedQuantity>12</OriginalOrderedQuantity>
        <OrderedQuantity>12</OrderedQuantity>
        <UnitOfMeasure>EA</UnitOfMeasure>
        <SupplierNumber>SUPL0001</SupplierNumber>
        <UnitPrice>10.99</UnitPrice>
        <UnitPriceCurrency>GBP</UnitPriceCurrency>
        <InventoryStatus>Available</InventoryStatus>
        <RevisionLevel>1.0</RevisionLevel>
        <OriginCode>GB</OriginCode>
        <CancelledFlag>false</CancelledFlag>
        <DangerousGoodsCode>HZ122</DangerousGoodsCode>
        <ExternalSystemPurchaseOrderNumber>PO-23133</ExternalSystemPurchaseOrderNumber>
        <AccountNumber>AC0001</AccountNumber>
        <InventoryAttributeFields>
          <!-- See below -->
        </InventoryAttributeFields>
        <OrderLineReferenceFields>
          <!-- See below -->
        </OrderLineReferenceFields>
        <SerialNumbers>
          <!-- See below -->
        </SerialNumbers>
        <OrderLineNotes>
          <!-- See below -->
        </OrderLineNotes>
      </OrderLine>
    </OrderLines>
  </Order>
</Orders>

InventoryAttributeField

The InventoryAttributeField element appears within the InventoryAttributeFields collection of the OrderLine element.

XML Field Example Field Type Input Description
InventoryAttributeField Attribute Field string Optional Only applicable to certain WMS.
InventoryAttributeType Attribute Type string Optional Only applicable to certain WMS. 
<?xml version="1.0"?>
<Orders>
  <Order>
    <OrderLines>
      <OrderLine>
        <InventoryAttributeFields>
          <InventoryAttributeField>
            <InventoryAttributeField>Attribute Field</InventoryAttributeField>
            <InventoryAttributeType>Attribute Field</InventoryAttributeType>
          </InventoryAttributeField>
        </InventoryAttributeFields>
      </OrderLine>
    </OrderLines>
  </Order>
</Orders>

OrderLineReferenceField

The OrderLineReferenceField element appears within the OrderLineReferenceFields collection of the OrderLine element.

XML Field Example Field Type Input Description
ReferenceField RCPT1 string Optional
ReferenceFieldType* vendorreceiptnumber string Optional
  • ReferenceFieldType* - Valid values: vatnumber, eorinumber, reasonforexport, typeofexport, externalsystempurchaseordernbr, assettype, customerpartnumber, countryoforigin, ucc-128
<?xml version="1.0"?>
<Orders>
  <Order>
    <OrderLines>
      <OrderLine>
        <OrderLineReferenceFields>
          <OrderLineReferenceField>
            <ReferenceField>RCPT1</ReferenceField>
            <ReferenceFieldType>vendorreceiptnumber</ReferenceFieldType>
          </OrderLineReferenceField>
        </OrderLineReferenceFields>
      </OrderLine>
    </OrderLines>
  </Order>
</Orders>

SerialNumber

The SerialNumber element appears within the SerialNumbers collection of the OrderLine element.

XML Field Example Field Type Input Description
SerialNumber SN198V312B string Optional Only applicable to certain WMS. 
<?xml version="1.0"?>
<Orders>
  <Order>
    <OrderLines>
      <OrderLine>
        <SerialNumbers>
          <SerialNumber>SN198V312B</SerialNumber>
        </SerialNumbers>
      </OrderLine>
    </OrderLines>
  </Order>
</Orders>

OrderLineNote

The OrderLineNote element appears within the OrderLineNotes collection of the OrderLine element.

XML Field Example Field Type Input Description
NoteLineNumber 0001 string Required
NoteText Leave by the door string Required
NoteType* ShippingNotes enum Required
NoteTypeDescription Customer note string Optional
  • NoteType* - Valid values: Generic, ShippingNotes, DutyManagement
<?xml version="1.0"?>
<Orders>
  <Order>
    <OrderLines>
      <OrderLine>
        <OrderLineNotes>
          <OrderLineNote>
            <NoteLineNumber>0001</NoteLineNumber>
            <NoteText>Leave by the door</NoteText>
            <NoteType>ShippingNotes</NoteType>
            <NoteTypeDescription>Customer note</NoteTypeDescription>
          </OrderLineNote>
        </OrderLineNotes>
      </OrderLine>
    </OrderLines>
  </Order>
</Orders>

Complete XML Sample

This sample shows all data that can be provided via our order XML format.

<?xml version="1.0"?>
<Orders>
  <Order>
    <ExternalId>5231</ExternalId>
    <FacilityId>GB_0001</FacilityId>
    <CustomerId>CUST0001</CustomerId>
    <Division>Customer Division</Division>
    <OrderNumber>TESTORDR0001</OrderNumber>
    <OrderType>CustomerOrder</OrderType>
    <OrderDate>2024-07-01T09:00:00Z</OrderDate>
    <OrderStatus>Picking Begun</OrderStatus>
    <CustomerPurchaseOrderNumber>PO-24341</CustomerPurchaseOrderNumber>
    <CustomerPurchaseOrderType>Sales</CustomerPurchaseOrderType>
    <CustomerPurchaseOrderDate>2024-07-01T09:00:00Z</CustomerPurchaseOrderDate>
    <CarrierName>DPD</CarrierName>
    <CarrierServiceLevel>Next Day</CarrierServiceLevel>
    <ServiceLevel>Next Day</ServiceLevel>
    <ModeOfTransport>Road</ModeOfTransport>
    <ExpectedDeliveryDate>2024-07-02T09:00:00Z</ExpectedDeliveryDate>
    <ExpectedShipmentDate>2024-07-02T09:00:00Z</ExpectedShipmentDate>
    <ActualShipmentDate>2024-07-02T09:00:00Z</ActualShipmentDate>
    <BillOfLadingNumber>BOL12345</BillOfLadingNumber>
    <InvoiceNumber>INV0001</InvoiceNumber>
    <ManifestNumber>MAN0001</ManifestNumber>
    <CancelledFlag>false</CancelledFlag>
    <Priority>A</Priority>
    <BillingMethodCode>A</BillingMethodCode>
    <DepartmentNumber>DEP1</DepartmentNumber>
    <OrderReferenceFields>
      <OrderReferenceField>
        <ReferenceField>Shipping</ReferenceField>
        <ReferenceFieldType>Department</ReferenceFieldType>
      </OrderReferenceField>
    </OrderReferenceFields>
    <OrderNotes>
      <OrderNote>
        <NoteLineNumber>0001</NoteLineNumber>
        <NoteText>Leave by the door</NoteText>
        <NoteType>ShippingNotes</NoteType>
        <NoteTypeDescription>Customer note</NoteTypeDescription>
      </OrderNote>
    </OrderNotes>
    <ShipTo>
      <AddressId>0001</AddressId>
      <CustomerId>CUST0001</CustomerId>
      <AddressName>NE14XF</AddressName>
      <AddressType>CST</AddressType>
      <AddressLine1>Zynk Software</AddressLine1>
      <AddressLine2>6-8 Charlotte Square</AddressLine2>
      <AddressLine3></AddressLine3>
      <PostCode>NE1 4XF</PostCode>
      <City>Newcastle</City>
      <State>Tyne &amp; Wear</State>
      <CountryCode>GB</CountryCode>
      <Name>John Smith</Name>
      <PhoneNumber>0191 820 1484</PhoneNumber>
      <Email>[email protected]</Email>
      <ContactName>John Smith</ContactName>
      <AttentionName>John Smith</AttentionName>
    </ShipTo>
    <BillTo>
      <AddressId>0001</AddressId>
      <CustomerId>CUST0001</CustomerId>
      <AddressName>NE14XF</AddressName>
      <AddressType>CST</AddressType>
      <AddressLine1>Zynk Software</AddressLine1>
      <AddressLine2>6-8 Charlotte Square</AddressLine2>
      <AddressLine3></AddressLine3>
      <PostCode>NE1 4XF</PostCode>
      <City>Newcastle</City>
      <State>Tyne &amp; Wear</State>
      <CountryCode>GB</CountryCode>
      <Name>John Smith</Name>
      <PhoneNumber>0191 820 1484</PhoneNumber>
      <Email>[email protected]</Email>
      <ContactName>John Smith</ContactName>
      <AttentionName>John Smith</AttentionName>
    </BillTo>
    <RouteTo>
      <AddressId>0001</AddressId>
      <CustomerId>CUST0001</CustomerId>
      <AddressName>NE14XF</AddressName>
      <AddressType>CST</AddressType>
      <AddressLine1>Zynk Software</AddressLine1>
      <AddressLine2>6-8 Charlotte Square</AddressLine2>
      <AddressLine3></AddressLine3>
      <PostCode>NE1 4XF</PostCode>
      <City>Newcastle</City>
      <State>Tyne &amp; Wear</State>
      <CountryCode>GB</CountryCode>
      <Name>John Smith</Name>
      <PhoneNumber>0191 820 1484</PhoneNumber>
      <Email>[email protected]</Email>
      <ContactName>John Smith</ContactName>
      <AttentionName>John Smith</AttentionName>
    </RouteTo>
    <Seller>
      <AddressId>0001</AddressId>
      <CustomerId>CUST0001</CustomerId>
      <AddressName>NE14XF</AddressName>
      <AddressType>CST</AddressType>
      <AddressLine1>Zynk Software</AddressLine1>
      <AddressLine2>6-8 Charlotte Square</AddressLine2>
      <AddressLine3></AddressLine3>
      <PostCode>NE1 4XF</PostCode>
      <City>Newcastle</City>
      <State>Tyne &amp; Wear</State>
      <CountryCode>GB</CountryCode>
      <Name>John Smith</Name>
      <PhoneNumber>0191 820 1484</PhoneNumber>
      <Email>[email protected]</Email>
      <ContactName>John Smith</ContactName>
      <AttentionName>John Smith</AttentionName>
    </Seller>
    <OrderLines>
      <OrderLine>
        <LineNumber>1</LineNumber>
        <SubLineNumber>0000</SubLineNumber>
        <ItemNumber>TEST0001</ItemNumber>
        <LotNumber>LOTA</LotNumber>
        <SupplierLotNumber>LOTA</SupplierLotNumber>
        <OriginalOrderedQuantity>12</OriginalOrderedQuantity>
        <OrderedQuantity>12</OrderedQuantity>
        <UnitOfMeasure>EA</UnitOfMeasure>
        <SupplierNumber>SUPL0001</SupplierNumber>
        <UnitPrice>10.99</UnitPrice>
        <UnitPriceCurrency>GBP</UnitPriceCurrency>
        <InventoryStatus>Available</InventoryStatus>
        <RevisionLevel>1.0</RevisionLevel>
        <OriginCode>GB</OriginCode>
        <CancelledFlag>false</CancelledFlag>
        <DangerousGoodsCode>HZ122</DangerousGoodsCode>
        <ExternalSystemPurchaseOrderNumber>PO-23133</ExternalSystemPurchaseOrderNumber>
        <AccountNumber>AC0001</AccountNumber>
        <InventoryAttributeFields>
          <InventoryAttributeField>
            <InventoryAttributeField>Attribute Field</InventoryAttributeField>
            <InventoryAttributeType>Attribute Field</InventoryAttributeType>
          </InventoryAttributeField>
        </InventoryAttributeFields>
        <OrderLineReferenceFields>
          <OrderLineReferenceField>
            <ReferenceField>RCPT1</ReferenceField>
            <ReferenceFieldType>vendorreceiptnumber</ReferenceFieldType>
          </OrderLineReferenceField>
        </OrderLineReferenceFields>
        <SerialNumbers>
          <SerialNumber>SN198V312B</SerialNumber>
        </SerialNumbers>
        <OrderLineNotes>
          <OrderLineNote>
            <NoteLineNumber>0001</NoteLineNumber>
            <NoteText>Leave by the door</NoteText>
            <NoteType>ShippingNotes</NoteType>
            <NoteTypeDescription>Customer note</NoteTypeDescription>
          </OrderLineNote>
        </OrderLineNotes>
      </OrderLine>
    </OrderLines>
  </Order>
</Orders>