DHL Supply Chain ASN Receipt XML
Tasks
This XML format represents a purchase order for the delivery of goods into the warehouse.
Tasks
Minimal XML Sample
The XML below represents the minimum information that needs to be provided to create an ASN receipt in DHL Supply Chain.
<?xml version="1.0"?>
<AsnReceipts>
<AsnReceipt>
<ExternalId>5230</ExternalId>
<FacilityId>GB_0001</FacilityId>
<CustomerId>CUST0001</CustomerId>
<ReceiptNumber>TESTRCPT0001</ReceiptNumber>
<ReceiptType>InboundOrder</ReceiptType>
<ReceiptLines>
<ReceiptLine>
<LineNumber>1</LineNumber>
<ItemNumber>TEST0001</ItemNumber>
<ExpectedQuantity>12</ExpectedQuantity>
</ReceiptLine>
</ReceiptLines>
</AsnReceipt>
</AsnReceipts>
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 AsnReceipts
schema is used below as a reference of where fields should be in the object model.
AsnReceipt
The AsnReceipt
element represents an individual ASN receipt to create or update in DHL Supply Chain. This element appears within the root AsnReceipts
collection of the XML document.
Zynk will search for an exiting ASN receipt in DHL Supply chain with matching FacilityId
, CustomerId
and ReceiptNumber
values. If a match is found, the existing ASN receipt will be updated, otherwise a new ASN receipt will be created.
XML Field | Example | Field Type | Input | Description |
---|---|---|---|---|
ExternalId | 5230 | string | Optional | Used in conjunction with the Prevent Reprocessing setting. Max 255 chars |
FacilityId | GB_0001 | string | Required | Used for matching existing ASN receipts. |
CustomerId | CUST0001 | string | Required | Used for matching existing ASN receipts. |
Division | Customer Division | string | Optional | Only applicable to certain WMS. |
OrderNumber | ORD0001 | string | Optional | |
ReceiptNumber | TESTRCPT0001 | string | Required | Used for matching existing ASN receipts. |
ReceiptDate | 2024-07-01T00:00:00Z | datetime | Optional | |
ReceiptType* | InboundOrder | enum | Dependant | Required when creating a new ASN receipt. |
ReceiptTypeDescription | Inbound Order | string | Optional | |
Waybill | WB0001 | string | Optional | |
SupplierNumber | EU-SUP-01 | string | Dependant | Mandatory for certain WMS. |
ShipmentNumber | EUGENE02 | string | Dependant | Mandatory for certain WMS. |
ReturnReferenceNumber | RCPT000000042 | string | Optional | Only applicable when ReceiptType is Return |
InvoiceNumber | INV0001 | string | Optional | Only applicable when ReceiptType is Return |
OriginalOrderNumber | ORDR0001 | string | Optional | Only applicable when ReceiptType is Return |
ReceiptLines | See below | Collection | Optional | The collection of ReceiptLine elements. |
AssignedCarrierCode | Carrier code | string | Optional | |
TrailerNumber | Trailer number | string | Optional | |
ReceiptReferenceFields | See below | Collection | Optional | The collection of ReceiptReferenceField elements. |
- ReceiptType* - Valid values:
Production
,InboundOrder
,Return
,WorkOrder
,TransferShipment
,Delivery
<?xml version="1.0"?>
<AsnReceipts>
<AsnReceipt>
<ExternalId>5230</ExternalId>
<FacilityId>GB_0001</FacilityId>
<CustomerId>CUST0001</CustomerId>
<Division>Customer Division</Division>
<OrderNumber>ORD001</OrderNumber>
<ReceiptNumber>TESTRCPT0001</ReceiptNumber>
<ReceiptDate>2024-07-01T00:00:00Z</ReceiptDate>
<ReceiptType>InboundOrder</ReceiptType>
<ReceiptTypeDescription>Inbound Order</ReceiptTypeDescription>
<Waybill>WB0001</Waybill>
<SupplierNumber>EU-SUP-01</SupplierNumber>
<ShipmentNumber>EUGENE02</ShipmentNumber>
<ReturnReferenceNumber>RCPT000000042</ReturnReferenceNumber>
<InvoiceNumber>INV0001</InvoiceNumber>
<OriginalOrderNumber>ORDR0001</OriginalOrderNumber>
<ReceiptLines>
<!-- See below -->
</ReceiptLines>
<AssignedCarrierCode>Carrier code</AssignedCarrierCode>
<TrailerNumber>Trailer number</TrailerNumber>
<ReceiptReferenceFields>
<!-- See below -->
</ReceiptReferenceFields>
</AsnReceipt>
</AsnReceipts>
ReceiptLine
The ReceiptLine
element represents an individual line on an ASN receipt. This element appears within the ReceiptLines
collection of the AsnReceipt element.
XML Field | Example | Field Type | Input | Description |
---|---|---|---|---|
LineNumber | 1 | string | Required | |
SubLineNumber | 0000 | string | Optional | |
ItemNumber | TEST0001 | string | Required | |
LotNumber | LOTA | string | Optional | |
SupplierLotNumber | LOTA | string | Optional | |
ExpectedQuantity | 12 | decimal | Optional | |
ReceiveStatus* | Available | enum | Optional | |
RevisionLevel | 1.0 | string | Optional | |
OriginCode | GB | string | Optional | |
ManufactureDate | 2024-07-01T00:00:00Z | datetime | Optional | |
ExpirationDate | 2025-07-01T00:00:00Z | datetime | Optional | |
InventoryAttributeFields | See below | Collection | Optional | The collection of InventoryAttributeField elements. |
ReceiptLineReferenceFields | See below | Collection | Optional | The collection of ReceiptLineReferenceField elements. |
- ReceiveStatus* - Valid values:
Available
,CriticalHold
,Damaged
,Expired
,Hold
,Inspection
,Release
,Returned
,Salvaged
,TimeHold
<?xml version="1.0"?>
<AsnReceipts>
<AsnReceipt>
<ReceiptLines>
<ReceiptLine>
<LineNumber>1</LineNumber>
<SubLineNumber>0000</SubLineNumber>
<ItemNumber>TEST0001</ItemNumber>
<LotNumber>LOTA</LotNumber>
<SupplierLotNumber>LOTA</SupplierLotNumber>
<ExpectedQuantity>12</ExpectedQuantity>
<ReceiveStatus>Available</ReceiveStatus>
<RevisionLevel>1.0</RevisionLevel>
<OriginCode>GB</OriginCode>
<ManufactureDate>2024-07-01T00:00:00Z</ManufactureDate>
<ExpirationDate>2025-07-01T00:00:00Z</ExpirationDate>
<InventoryAttributeFields>
<!-- See below -->
</InventoryAttributeFields>
<ReceiptLineReferenceFields>
<!-- See below -->
</ReceiptLineReferenceFields>
</ReceiptLine>
</ReceiptLines>
</AsnReceipt>
</AsnReceipts>
ReceiptReferenceField
The ReceiptReferenceField
element appears within the ReceiptReferenceFields
collection of the AsnReceipt element.
XML Field | Example | Field Type | Input | Description |
---|---|---|---|---|
ReferenceField | Shipping | string | Optional | |
ReferenceFieldType | Department | string | Optional |
<?xml version="1.0"?>
<AsnReceipts>
<AsnReceipt>
<ReceiptReferenceFields>
<ReceiptReferenceField>
<ReferenceField>Shipping</ReferenceField>
<ReferenceFieldType>Department</ReferenceFieldType>
</ReceiptReferenceField>
</ReceiptReferenceFields>
</AsnReceipt>
</AsnReceipts>
InventoryAttributeField
The InventoryAttributeField
element appears within the InventoryAttributeFields
collection of the ReceiptLine element.
XML Field | Example | Field Type | Input | Description |
---|---|---|---|---|
InventoryAttributeField | Attribute Field | string | Optional | |
InventoryAttributeType | Attribute Type | string | Optional |
<?xml version="1.0"?>
<AsnReceipts>
<AsnReceipt>
<ReceiptLines>
<ReceiptLine>
<InventoryAttributeFields>
<InventoryAttributeField>
<InventoryAttributeField>Attribute Field</InventoryAttributeField>
<InventoryAttributeType>Attribute Field</InventoryAttributeType>
</InventoryAttributeField>
</InventoryAttributeFields>
</ReceiptLine>
</ReceiptLines>
</AsnReceipt>
</AsnReceipts>
ReceiptLineReferenceField
The ReceiptLineReferenceField
element appears within the ReceiptLineReferenceFields
collection of the ReceiptLine element.
XML Field | Example | Field Type | Input | Description |
---|---|---|---|---|
ReferenceField | RCPT1 | string | Optional | |
ReferenceFieldType | vendorreceiptnumber | string | Optional |
<?xml version="1.0"?>
<AsnReceipts>
<AsnReceipt>
<ReceiptLines>
<ReceiptLine>
<ReceiptLineReferenceFields>
<ReceiptLineReferenceField>
<ReferenceField>RCPT1</ReferenceField>
<ReferenceFieldType>vendorreceiptnumber</ReferenceFieldType>
</ReceiptLineReferenceField>
</ReceiptLineReferenceFields>
</ReceiptLine>
</ReceiptLines>
</AsnReceipt>
</AsnReceipts>
Complete XML Sample
This sample shows all data that can be provided via our ASN receipt format.
<?xml version="1.0"?>
<AsnReceipts>
<AsnReceipt>
<ExternalId>5230</ExternalId>
<FacilityId>GB_0001</FacilityId>
<CustomerId>CUST0001</CustomerId>
<Division>Customer Division</Division>
<OrderNumber>ORD001</OrderNumber>
<ReceiptNumber>TESTRCPT0001</ReceiptNumber>
<ReceiptDate>2024-07-01T00:00:00Z</ReceiptDate>
<ReceiptType>InboundOrder</ReceiptType>
<ReceiptTypeDescription>Inbound Order</ReceiptTypeDescription>
<Waybill>WB0001</Waybill>
<SupplierNumber>EU-SUP-01</SupplierNumber>
<ShipmentNumber>EUGENE02</ShipmentNumber>
<ReturnReferenceNumber>RCPT000000042</ReturnReferenceNumber>
<InvoiceNumber>INV0001</InvoiceNumber>
<OriginalOrderNumber>ORDR0001</OriginalOrderNumber>
<ReceiptLines>
<ReceiptLine>
<LineNumber>1</LineNumber>
<SubLineNumber>0000</SubLineNumber>
<ItemNumber>TEST0001</ItemNumber>
<LotNumber>LOTA</LotNumber>
<SupplierLotNumber>LOTA</SupplierLotNumber>
<ExpectedQuantity>12</ExpectedQuantity>
<ReceiveStatus>Available</ReceiveStatus>
<RevisionLevel>1.0</RevisionLevel>
<OriginCode>GB</OriginCode>
<ManufactureDate>2024-07-01T00:00:00Z</ManufactureDate>
<ExpirationDate>2025-07-01T00:00:00Z</ExpirationDate>
<InventoryAttributeFields>
<InventoryAttributeField>
<InventoryAttributeField>Attribute Field</InventoryAttributeField>
<InventoryAttributeType>Attribute Field</InventoryAttributeType>
</InventoryAttributeField>
</InventoryAttributeFields>
<ReceiptLinesReferenceFields>
<ReceiptReferenceField>
<ReferenceField>RCPT1</ReferenceField>
<ReferenceFieldType>vendorreceiptnumber</ReferenceFieldType>
</ReceiptReferenceField>
</ReceiptLinesReferenceFields>
</ReceiptLine>
</ReceiptLines>
<AssignedCarrierCode>Carrier code</AssignedCarrierCode>
<TrailerNumber>Trailer number</TrailerNumber>
<ReceiptReferenceFields>
<ReceiptReferenceField>
<ReferenceField>Shipping</ReferenceField>
<ReferenceFieldType>Department</ReferenceFieldType>
</ReceiptReferenceField>
</ReceiptReferenceFields>
</AsnReceipt>
</AsnReceipts>