DHL Supply Chain Item XML

This XML format represents products in DHL Supply Chain.

Tasks

• Import Items into DHL Supply Chain

Minimal XML Sample

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

<?xml version="1.0"?>
<Items>
  <Item>
    <FacilityId>GB_0001</FacilityId>
    <CustomerId>CUST0001</CustomerId>
    <ItemNumber>TEST0001</ItemNumber>
    <ItemPart>
      <ItemShortDescription>2 PACK PILLOWCASES, GREY - 50X75CM</ItemShortDescription>
      <ItemLongDescription>2 PACK PILLOWCASES, GREY - 50X75CM</ItemLongDescription>
    </ItemPart>
    <Footprint>
      <CasesPerLayer>1</CasesPerLayer>
      <PalletStackHeight>0</PalletStackHeight>
      <FootprintDetails>
        <FootprintDetail>
          <UomCode>EA</UomCode>
          <UomLevel>1</UomLevel>
          <GrossWeight>1</GrossWeight>
          <NetWeight>1</NetWeight>
          <Length>10</Length>
          <Width>10</Width>
          <Height>10</Height>
          <ThresholdPercentage>50</ThresholdPercentage>
        </FootprintDetail>
      </FootprintDetails>
    </Footprint>
  </Item>
</Items>

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 Items schema is used below as a reference of where fields should be in the object model.

Item

The Item element represents an individual product to create or update in DHL Supply Chain. This element appears within the root Items collection of the XML document.

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

XML Field	Example	Field Type	Input	Description
ExternalId	12345	string	Optional	Used in conjunction with the Prevent Reprocessing setting. Max 255 chars
FacilityId	GB_0001	string	Required	Used for matching existing items.
CustomerId	CUST0001	string	Required	Used for matching existing items.
Division	Customer Division	string	Optional	Only applicable to certain WMS.
ItemNumber	TEST0001	string	Required	Used for matching existing items.
ItemPart	See below	ItemPart	Dependant	Required when creating a new item.
AlternateParts	See below	Collection	Optional	The collection of AlternatePart elements.
Footprint	See below	Footprint	Dependant	Required when creating a new item.
HazardousMaterialDetails	See below	HazardousMaterialDetails	Optional

<?xml version="1.0"?>
<Items>
  <Item>
    <ExternalId>12345</ExternalId>
    <FacilityId>GB_0001</FacilityId>
    <CustomerId>CUST0001</CustomerId>
    <Division>Customer Division</Division>
    <ItemNumber>TEST0001</ItemNumber>
    <ItemPart>
      <!-- See below -->
    </ItemPart>
    <AlternateParts>
      <!-- See below -->
    </AlternateParts>
    <Footprint>
      <!-- See below -->
    </Footprint>
    <HazardousMaterialDetails>
      <!-- See below -->
    </HazardousMaterialDetails>
  </Item>
</Items>

ItemPart

The ItemPart element appears within the Item element of the XML document.

XML Field	Example	Field Type	Input	Description
ItemShortDescription	2 PACK PILLOWCASES, GREY - 50X75CM	string	Dependant	Required when creating a new item
ItemLongDescription	2 PACK PILLOWCASES, GREY - 50X75CM	string	Dependant	Required when creating a new item
ItemFamily	AB01	string	Optional
Color	Grey	string	Optional
Fit	Small	string	Optional
LoadLevel*	L	string	Optional
Size	50X75CM	string	Optional
Style	2 Pack	string	Optional
HazardousMaterialFlag	HZ112	string	Optional
ItemTypeCode	PILLOWS	string	Optional
OriginCodeFlag	false	bool	Optional
RevisionLevelFlag	false	bool	Optional
LotTrackingFlag	false	bool	Optional
LotFormatId	12A	string	Optional
SupplierLotFlag	false	bool	Optional
StockingUom	EA	string	Optional
ReceiveStatus*	Available	enum	Optional
ReceiveUom	EA	string	Optional
AgingProfileName	None	string	Optional
TimeToWarnForExpiration	600000	decimal	Optional
FifoWindow	1	decimal	Optional
TimeCode*	D	enum	Optional
VelocityZone	F	string	Optional
AbcCode	D3	string	Optional
SerializationLevel	Pack	string	Optional
SerializationType	Batch	string	Optional
CostPerUnit	8.99	decimal	Optional
CurrencyCode	GBP	string	Optional
ShelfLife	365	decimal	Optional
ShelfLifeTimeCode*	D	enum	Optional
ExpiryManufactureDateTracking	Y	string	Optional
ReceivableFlag	true	bool	Optional
DuplicateSerialAllowed	false	bool	Optional	Only applicable to certain WMS.
MinorSerialFlag	false	bool	Optional	Only applicable to certain WMS.
SmallestAllocateableQuantity	1	string	Optional	Only applicable to certain WMS.
Returnable	true	bool	Optional	Only applicable to certain WMS.
ItemBarCode	10490084316	string	Optional
SupplierItemBarcode	10490084316	string	Optional
CommodityCode	CP9920	string	Optional
StandardTransportationCommodityCode	CP9920	string	Optional	Only applicable to certain WMS.
FreightClass	Small	string	Optional
ProductionInventoryFlag	false	bool	Optional	Only applicable to certain WMS.
ItemReferenceFields	See below	Collection	Optional	The collection of ItemReferenceField elements.

• LoadLevel* - Valid values: L, S, D
• ReceiveStatus* - Valid values: Available, CriticalHold, Damaged, Expired, Hold, Inspection, Release, Returned, Salvaged, TimeHold
• TimeCode* - Valid values: D, H, M
• ShelfLifeTimeCode* - Valid values: D, H, M

<?xml version="1.0"?>
<Items>
  <Item>
    <ItemPart>
      <ItemShortDescription>2 PACK PILLOWCASES, GREY - 50X75CM</ItemShortDescription>
      <ItemLongDescription>2 PACK PILLOWCASES, GREY - 50X75CM</ItemLongDescription>
      <ItemFamily>AB01</ItemFamily>
      <Color>Grey</Color>
      <Fit>Small</Fit>
      <LoadLevel>L</LoadLevel>
      <Size>50X75CM</Size>
      <Style>50X75CM</Style>
      <HazardousMaterialFlag>HZ112</HazardousMaterialFlag>
      <ItemTypeCode>PILLOWS</ItemTypeCode>
      <OriginCodeFlag>false</OriginCodeFlag>
      <RevisionLevelFlag>false</RevisionLevelFlag>
      <LotTrackingFlag>false</LotTrackingFlag>
      <LotFormatId>12A</LotFormatId>
      <SupplierLotFlag>false</SupplierLotFlag>
      <StockingUom>EA</StockingUom>
      <ReceiveStatus>Available</ReceiveStatus>
      <ReceiveUom>EA</ReceiveUom>
      <AgingProfileName>None</AgingProfileName>
      <TimeToWarnForExpiration>600000</TimeToWarnForExpiration>
      <FifoWindow>1</FifoWindow>
      <TimeCode>D</TimeCode>
      <VelocityZone>F</VelocityZone>
      <AbcCode>D3</AbcCode>
      <SerializationLevel>Pack</SerializationLevel>
      <SerializationType>Batch</SerializationType>
      <CostPerUnit>8.99</CostPerUnit>
      <CurrencyCode>GBP</CurrencyCode>
      <ShelfLife>365</ShelfLife>
      <ShelfLifeTimeCode>D</ShelfLifeTimeCode>
      <ExpiryManufactureDateTracking>Y</ExpiryManufactureDateTracking>
      <ReceivableFlag>true</ReceivableFlag>
      <DuplicateSerialAllowed>false</DuplicateSerialAllowed>
      <MinorSerialFlag>false</MinorSerialFlag>
      <SmallestAllocateableQuantity>1</SmallestAllocateableQuantity>
      <Returnable>true</Returnable>
      <ItemBarCode>10490084316</ItemBarCode>
      <SupplierItemBarcode>10490084316</SupplierItemBarcode>
      <CommodityCode>CP9920</CommodityCode>
      <StandardTransportationCommodityCode>CP9920</StandardTransportationCommodityCode>
      <FreightClass>Small</FreightClass>
      <ProductionInventoryFlag>false</ProductionInventoryFlag>
      <ItemReferenceFields>
        <!-- See below -->
      </ItemReferenceFields>
    </ItemPart>
  </Item>
</Items>

ItemReferenceField

The ItemReferenceField element appears within the ItemReferenceFields collection of the ItemPart element.

XML Field	Example	Field Type	Input	Description
ReferenceField	4.99	string	Optional
ReferenceFieldType*	ShippingFee	enum	Optional

• OrderType* - Valid values: declarationname, dutypaymenttype, dutypaymentnumber, incoterms, exportindicator, portalordernumberecom, shiptodeanumber, alternateSCAC, childBOLNumber, departmentCode, masterBOLNumber, palletExchangeCode, storeNumber, freightAccount, freightTerms, ShippingFee, StoreCode, ChannelType

<?xml version="1.0"?>
<Items>
  <Item>
    <ItemPart>
      <ItemReferenceFields>
        <ItemReferenceField>
          <ReferenceField>4.99</ReferenceField>
          <ReferenceFieldType>ShippingFee</ReferenceFieldType>
        </ItemReferenceField>
      </ItemReferenceFields>
    </ItemPart>
  </Item>
</Items>

AlternatePart

The AlternatePart element appears within the AlternateParts collection of the Item element.

XML Field	Example	Field Type	Input	Description
AlternateItemNumber	TEST0002	string	Optional
AlternateItemType	PILLOWS	string	Required
UomCode	EA	string	Optional
UomQuantity	1	decimal	Optional

<?xml version="1.0"?>
<Items>
  <Item>
    <AlternateParts>
      <AlternatePart>
        <AlternateItemNumber>TEST0002</AlternateItemNumber>
        <AlternateItemType>PILLOWS<AlternateItemType>
        <UomCode>EA</UomCode>
        <UomQuantity>1</UomQuantity>
      </AlternatePart>
    </AlternateParts>
  </Item>
</Items>

Footprint

The Footprint element appears within the Item element of the XML document.

XML Field	Example	Field Type	Input	Description
FootprintCode	FP0001	string	Dependant	Mandatory for certain WMS.
LongDescription	2 PACK PILLOWCASES, GREY - 50X75CM	string	Required
ShortDescription	2 PACK PILLOWCASES, GREY - 50X75CM	string	Optional
CasesPerLayer	1	decimal	Required
PalletStackHeight	1	string	Optional
FootprintDetails	See below	Collection	Required	The collection of FootprintDetail elements.

<?xml version="1.0"?>
<Items>
  <Item>
    <Footprint>
      <FootprintCode>FP0001</FootprintCode>
      <LongDescription>2 PACK PILLOWCASES, GREY - 50X75CM</LongDescription>
      <ShortDescription>2 PACK PILLOWCASES, GREY - 50X75CM</ShortDescription>
      <CasesPerLayer>1</CasesPerLayer>
      <PalletStackHeight>1</PalletStackHeight>
      <FootprintDetails>
        <!-- See below -->
      </FootprintDetails>
    </Footprint>
  </Item>
</Items>

FootprintDetail

The FootprintDetail element appears within the FootprintDetails collection of the Footprint element.

XML Field	Example	Field Type	Input	Description
FootprintCode	FP0001	string	Optional
UomCode	EA	string	Required
UomLevel	1	decimal	Required
UomQuantity	1	decimal	Optional
UnitUomFlag	true	bool	Optional
CaseFlag	false	bool	Optional
PackFlag	false	bool	Optional
PalletFlag	false	bool	Optional
BulkPickingFlag	false	bool	Optional
CartonizationFlag	false	bool	Optional
CartonDistributionFlag	false	bool	Optional
LayerFlag	false	bool	Optional
GrossWeight	0.2	decimal	Required
GrossWeightUom*	KG	enum	Optional
NetWeight	0.2	decimal	Required
NetWeightUom*	KG	enum	Optional
Length	21.5	decimal	Required
LengthUom*	CM	enum	Optional
Width	10.2	decimal	Required
WidthUom*	CM	enum	Optional
Height	1.5	decimal	Required
HeightUom*	CM	enum	Optional
ThresholdPercentage	50	decimal	Required

• GrossWeightUom* - Valid values: G, KG, OZ, LB, TON, MTON, LTON
• NetWeightUom* - Valid values: G, KG, OZ, LB, TON, MTON, LTON
• LengthUom* - Valid values: CM, DM, M, MM, FT, IN, YD
• WidthUom* - Valid values: CM, DM, M, MM, FT, IN, YD
• HeightUom* - Valid values: CM, DM, M, MM, FT, IN, YD

<?xml version="1.0"?>
<Items>
  <Item>
    <Footprint>
      <FootprintDetails>
        <FootprintDetail>
          <FootprintCode>FP0001</FootprintCode>
          <UomCode>EA</UomCode>
          <UomLevel>1</UomLevel>
          <UomQuantity>1</UomQuantity>
          <UnitUomFlag>true</UnitUomFlag>
          <CaseFlag>false</CaseFlag>
          <PackFlag>false</PackFlag>
          <PalletFlag>false</PalletFlag>
          <BulkPickingFlag>false</BulkPickingFlag>
          <CartonizationFlag>false</CartonizationFlag>
          <CartonDistributionFlag>false</CartonDistributionFlag>
          <LayerFlag>false</LayerFlag>
          <GrossWeight>0.2</GrossWeight>
          <GrossWeightUom>KG</GrossWeightUom>
          <NetWeight>0.2</NetWeight>
          <NetWeightUom>KG</NetWeightUom>
          <Length>21.5</Length>
          <LengthUom>CM</LengthUom>
          <Width>21.5</Width>
          <WidthUom>CM</WidthUom>
          <Height>1.5</Height>
          <HeightUom>CM</HeightUom>
          <ThresholdPercentage>50</ThresholdPercentage>
        </FootprintDetail>
      </FootprintDetails>
    </Footprint>
  </Item>
</Items>

HazardousMaterialDetails

The HazardousMaterialDetails element appears within the Item element of the XML document.

XML Field	Example	Field Type	Input	Description
UnNumber	UN0001	string	Required
Class	Corrosives	string	Optional
SubRisk	Acid	string	Optional
PackingGroup	II	string	Optional
PackingInstructions	Double bag	string	Optional
HazardousMaterialUOM	EA	string	Optional
MaximumHazardousMaterialQuantity	3	decimal	Optional
SpecialProvisions	Road transport only	string	Optional
HazardLabel	Corrosive Substance	string	Optional
ShippingName	Corrosive Substance	string	Optional
TechnicalName	Hydrochloric Acid	string	Optional
SecondaryDescription	Hydrochloric Acid	string	Optional
FlashPointTemperature	100	decimal	Optional
FlashPointTemperatureUom*	CE	enum	Optional
ExemptionReferenceNumber	EXMP0001	string	Optional
RegulationSet	RS0001	string	Optional
HazardousMaterialReferences	See below	Collection	Optional	The collection of FootprintDetail elements.

• FlashPointTemperatureUom* - Valid values: FA, CE

<?xml version="1.0"?>
<Items>
  <Item>
    <HazardousMaterialDetails>
      <UnNumber>UN0001</UnNumber>
      <Class>Corrosives</Class>
      <SubRisk>Acid</SubRisk>
      <PackingGroup>II</PackingGroup>
      <PackingInstructions>Double bag</PackingInstructions>
      <HazardousMaterialUOM>EA</HazardousMaterialUOM>
      <MaximumHazardousMaterialQuantity>3<MaximumHazardousMaterialQuantity>
      <SpecialProvisions>Road transport only</SpecialProvisions>
      <HazardLabel>Corrosive Substance</HazardLabel>
      <ShippingName>Corrosive Substance</ShippingName>
      <TechnicalName>Hydrochloric Acid</TechnicalName>
      <SecondaryDescription>Hydrochloric Acid<SecondaryDescription>
      <FlashPointTemperature>100</FlashPointTemperature>
      <FlashPointTemperatureUom>CE</FlashPointTemperatureUom>
      <ExemptionReferenceNumber>EXMP0001</ExemptionReferenceNumber>
      <RegulationSet>RS0001</RegulationSet>
      <HazardousMaterialReferences>
        <!-- See below -->
      </HazardousMaterialReferences>
    </HazardousMaterialDetails>
  </Item>
</Items>

HazardousMaterialReference

The HazardousMaterialReference element appears within the HazardousMaterialReferences collection of the HazardousMaterialDetails element.

XML Field	Example	Field Type	Input	Description
HazardousMaterialReferenceField	7	string	Optional
HazardousMaterialReferenceFieldType*	numericalSize	enum	Optional

• HazardousMaterialReferenceFieldType* - Valid values: hazforDisposalFlag, temperatureConditionsIndicator, hazardStorageLevel, numericalSize

<?xml version="1.0"?>
<Items>
  <Item>
    <HazardousMaterialDetails>
      <HazardousMaterialReferences>
        <HazardousMaterialReference>
          <HazardousMaterialReferenceField>7</HazardousMaterialReferenceField>
          <HazardousMaterialReferenceFieldType>numericalSize</HazardousMaterialReferenceFieldType>
        </HazardousMaterialReference>
      </HazardousMaterialReferences>
    </HazardousMaterialDetails>
  </Item>
</Items>

Complete XML Sample

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

<?xml version="1.0"?>
<Items>
  <Item>
    <ExternalId>12345</ExternalId>
    <FacilityId>GB_0001</FacilityId>
    <CustomerId>CUST0001</CustomerId>
    <Division>Customer Division</Division>
    <ItemNumber>TEST0001</ItemNumber>
    <ItemPart>
      <ItemShortDescription>2 PACK PILLOWCASES, GREY - 50X75CM</ItemShortDescription>
      <ItemLongDescription>2 PACK PILLOWCASES, GREY - 50X75CM</ItemLongDescription>
      <ItemFamily>AB01</ItemFamily>
      <Color>Grey</Color>
      <Fit>Small</Fit>
      <LoadLevel>L</LoadLevel>
      <Size>50X75CM</Size>
      <Style>50X75CM</Style>
      <HazardousMaterialFlag>HZ112</HazardousMaterialFlag>
      <ItemTypeCode>PILLOWS</ItemTypeCode>
      <OriginCodeFlag>false</OriginCodeFlag>
      <RevisionLevelFlag>false</RevisionLevelFlag>
      <LotTrackingFlag>false</LotTrackingFlag>
      <LotFormatId>12A</LotFormatId>
      <SupplierLotFlag>false</SupplierLotFlag>
      <StockingUom>EA</StockingUom>
      <ReceiveStatus>Available</ReceiveStatus>
      <ReceiveUom>EA</ReceiveUom>
      <AgingProfileName>None</AgingProfileName>
      <TimeToWarnForExpiration>600000</TimeToWarnForExpiration>
      <FifoWindow>1</FifoWindow>
      <TimeCode>D</TimeCode>
      <VelocityZone>F</VelocityZone>
      <AbcCode>D3</AbcCode>
      <SerializationLevel>Pack</SerializationLevel>
      <SerializationType>Batch</SerializationType>
      <CostPerUnit>8.99</CostPerUnit>
      <CurrencyCode>GBP</CurrencyCode>
      <ShelfLife>365</ShelfLife>
      <ShelfLifeTimeCode>D</ShelfLifeTimeCode>
      <ExpiryManufactureDateTracking>Y</ExpiryManufactureDateTracking>
      <ReceivableFlag>true</ReceivableFlag>
      <DuplicateSerialAllowed>false</DuplicateSerialAllowed>
      <MinorSerialFlag>false</MinorSerialFlag>
      <SmallestAllocateableQuantity>1</SmallestAllocateableQuantity>
      <Returnable>true</Returnable>
      <ItemBarCode>10490084316</ItemBarCode>
      <SupplierItemBarcode>10490084316</SupplierItemBarcode>
      <CommodityCode>CP9920</CommodityCode>
      <StandardTransportationCommodityCode>CP9920</StandardTransportationCommodityCode>
      <FreightClass>Small</FreightClass>
      <ProductionInventoryFlag>false</ProductionInventoryFlag>
      <ItemReferenceFields>
        <ItemReferenceField>
          <ReferenceField>4.99</ReferenceField>
          <ReferenceFieldType>ShippingFee</ReferenceFieldType>
        </ItemReferenceField>
      </ItemReferenceFields>
    </ItemPart>
    <AlternateParts>
      <AlternatePart>
        <AlternateItemNumber>TEST0002</AlternateItemNumber>
        <AlternateItemType>PILLOWS<AlternateItemType>
        <UomCode>EA</UomCode>
        <UomQuantity>1</UomQuantity>
      </AlternatePart>
    </AlternateParts>
    <Footprint>
      <FootprintCode>FP0001</FootprintCode>
      <LongDescription>2 PACK PILLOWCASES, GREY - 50X75CM</LongDescription>
      <ShortDescription>2 PACK PILLOWCASES, GREY - 50X75CM</ShortDescription>
      <CasesPerLayer>1</CasesPerLayer>
      <PalletStackHeight>1</PalletStackHeight>
      <FootprintDetails>
        <FootprintDetail>
          <FootprintCode>FP0001</FootprintCode>
          <UomCode>EA</UomCode>
          <UomLevel>1</UomLevel>
          <UomQuantity>1</UomQuantity>
          <UnitUomFlag>true</UnitUomFlag>
          <CaseFlag>false</CaseFlag>
          <PackFlag>false</PackFlag>
          <PalletFlag>false</PalletFlag>
          <BulkPickingFlag>false</BulkPickingFlag>
          <CartonizationFlag>false</CartonizationFlag>
          <CartonDistributionFlag>false</CartonDistributionFlag>
          <LayerFlag>false</LayerFlag>
          <GrossWeight>0.2</GrossWeight>
          <GrossWeightUom>KG</GrossWeightUom>
          <NetWeight>0.2</NetWeight>
          <NetWeightUom>KG</NetWeightUom>
          <Length>21.5</Length>
          <LengthUom>CM</LengthUom>
          <Width>21.5</Width>
          <WidthUom>CM</WidthUom>
          <Height>1.5</Height>
          <HeightUom>CM</HeightUom>
          <ThresholdPercentage>50</ThresholdPercentage>
        </FootprintDetail>
      </FootprintDetails>
    </Footprint>
    <HazardousMaterialDetails>
      <UnNumber>UN0001</UnNumber>
      <Class>Corrosives</Class>
      <SubRisk>Acid</SubRisk>
      <PackingGroup>II</PackingGroup>
      <PackingInstructions>Double bag</PackingInstructions>
      <HazardousMaterialUOM>EA</HazardousMaterialUOM>
      <MaximumHazardousMaterialQuantity>3<MaximumHazardousMaterialQuantity>
      <SpecialProvisions>Road transport only</SpecialProvisions>
      <HazardLabel>Corrosive Substance</HazardLabel>
      <ShippingName>Corrosive Substance</ShippingName>
      <TechnicalName>Hydrochloric Acid</TechnicalName>
      <SecondaryDescription>Hydrochloric Acid<SecondaryDescription>
      <FlashPointTemperature>100</FlashPointTemperature>
      <FlashPointTemperatureUom>CE</FlashPointTemperatureUom>
      <ExemptionReferenceNumber>EXMP0001</ExemptionReferenceNumber>
      <RegulationSet>RS0001</RegulationSet>
      <HazardousMaterialReferences>
        <HazardousMaterialReference>
          <HazardousMaterialReferenceField>7</HazardousMaterialReferenceField>
          <HazardousMaterialReferenceFieldType>numericalSize</HazardousMaterialReferenceFieldType>
        </HazardousMaterialReference>
      </HazardousMaterialReferences>
    </HazardousMaterialDetails>
  </Item>
</Items>