The structure below is the SAME as the standard SO structure but has been modified specifically for a type M order.
...
Table of Contents | ||||
---|---|---|---|---|
|
...
XML Segment Information
<ORDERS> | At the beginning of the file | |||||||||
<SO> | At the beginning of each order | Each SO is grouped by field HD3, you can not have multiple SO with the same HD3 data within the same file. | ||||||||
<HD></HD> | Header - One time for each order | MANDATORY segment | ||||||||
<HO></HO> | Header Options - One time for each order | MANDATORY segment | ||||||||
<HU></HU> | Header Underbond - One time for each order | only if needed | <DO></DO> | Delivery Options - One time for each order | only if needed | <HI></HI> | Header Invoice - One time for each order | only if needed | ||
<LD> | Line Detail - Repeats for each product line on the order | MANDATORY <LD> | Line Detail - Repeats for each product line on the order | MANDATORY segment at least once per SO | ||||||
<LO></LO> | Line Options - One time for each LD entry | only if needed | ||||||||
</LD> | ||||||||||
</SO> | At the end of each order | You can then open a new order by using <SO> and repeating the above. | ||||||||
</ORDERS> | End of the file |
Code Block |
---|
<ORDERS>
<SO> <-- can repeat for additional orders
<HD>fields within the segment tag</HD>
<HO>fields within the segment tag</HO>
<HU>fields within the segment tag</HU>
<DO>fields within the segment tag</DO>
<HI>fields within the segment tag</HI>
<HF>fields within the segment tag</HF>
<LD>fields within the segment tag
<LO>fields within the segment tag</LO>
</LD> <-- can repeat with a further <LD>
</SO>
Repeat next <SO>
</ORDERS> |
...
XML Element | XML Key Name | Notes | Type | Length | Requirements | Field Notes or Conditions |
---|---|---|---|---|---|---|
<HU>1 | ExciseDefermentNumber | This is the account code given to the deferment account. | AN | 10 | Conditional | MANDATORY for Excise or Customs warehouse This may not be the deferment number or stock holding customer code as it accommodates cash deferments where HMRC numbers are not issued. Please speak to your warehouse to find out this code |
<HU>2 | CustomsDefermentNumber | This is the account code given to the deferment account. | AN | 10 | Conditional | |
<HU>3 | PayCustomsDuty | B | 1 | Conditional | Should default to “N” for anything leaving the UK | |
<HU>4 | ViaECCountry | If your export goes through an EC country then additional paperwork is required for the goods. | B | 1 | Conditional | From 31/12/2020 no longer used. |
<HU>5 | C426No | Max 8 characters | INT | 8 | Conditional | MANDATORY for Diplomatic Orders (Type D) |
<HU>6 | C185No | Max 8 characters | INT | 8 | Conditional | MANDATORY for NATO Order (Type V) |
<HU>8 | ConsigneeName | The Consignee is the buyer of the goods. Purchasing Customers Name (not where its going but who it is going to) | CH | 50 | Conditional | Conditions : Where the stock holding customer is paying the duty and the order type is = P (Duty Paid) then optional, in all other cases this is mandatory. You can supply this even if it is Type P we would just ignore it. If the country you are supplying to has no post codes / zip codes then add the country code to the postcode field. Address Information for specific Order types: |
<HU>9 | ConsigneeAddress1 | Buyer Address Line 1 | CH | 50 | Conditional | |
<HU>10 | ConsigneeAddress2 | Optional Address field | CH | 50 | Optional | |
<HU>11 | ConsigneeAddress3 | Optional Address field | CH | 50 | Optional | |
ConsigneeAddress4 | Buyer Address TOWN | CH | 50 | Conditional | ||
<HU>13 | ConsigneePostcode | Buyer Postcode or ZIP | AN | 15 | Conditional | |
<HU>15 | ConsigneeCountry | Buyer COUNTRY code | A | 2 | Conditional | |
<HU>16 | ExciseNo | The receiving warehouse excise warehouse number. | AN | 15 | Conditional | Do not send these if you are storing at a 3PL These fields should only be used if your warehouse is solely used by you for your own products. |
<HU>17 | VATNo | The receiving warehouse / customer VAT registration number. Should also contain the country code as the first two digits. - Used for Intra EC movements | AN | 15 | Conditional | |
<HU>18 | CustomsGuarantee | The receiving warehouse customs warehouse number. | AN | 15 | Conditional | |
<HU>20 | TransportName | Underbond Orders - Need to know the transporter name. | AN | 40 | Conditional | |
<HU>21 | TransportAddress1 | if the Transport code is known then this field is not required. | AN | 40 | Conditional | |
<HU>22 | TransportAddress2 | if the Transport code is known then this field is not required. | AN | 40 | Conditional | |
<HU>23 | TransportAddress3 | if the Transport code is known then this field is not required. | AN | 40 | Conditional | |
<HU>24 | TransportAddress4 | if the Transport code is known then this field is not required. | AN | 40 | Conditional | |
<HU>25 | TransportPostcode | if the Transport code is known then this field is not required. | AN | 15 | Conditional | |
<HU>26 | TransportCountry | if the Transport code is known then this field is not required. | A | 2 | Conditional | |
<HU>28 | GuaranteeNo | The HMRC guarantee number being used for the EC movement. | AN | 8 | Conditional | |
<HU>29 | GuaranteeDate | The HMRC guarantee date being used for the EC movement. | DT | 10 | Conditional |
XML DO (Delivery Options) Segment
...
XML Element
...
XML Key Name
...
Notes
...
Data Type
...
Mandatory / Optional / Conditional [M/O/C]
...
<DO>1
...
LabelURL
...
For use with NetDespatch module
...
URL
...
<DO>2
...
ConsignmentNo
...
For use with NetDespatch module
...
N
...
<DO>3
...
CarrierID
...
For use with NetDespatch module
...
AN
...
<DO>4
...
CarrierCode
...
For use with NetDespatch module.
...
AN
...
<DO>5
...
ServiceCodes
...
This is a string of codes seperated by semicolon which assists in the transport planning system.
This is the 'vehicle requirements' for the route planning.
Code - Description
TWO - Two Man Delivery
TLV - Tail Lift Vehicle Required
SDH - Special Delivery Handling - a delivery service requiring the white gloves approach.
SPH - Special Pick Handling - picking handling is important.
REW - Re-Works Required - e.g. Messages / Leaflets adding to the cases
Leave blank if not using; check with your warehouse before using as these codes may be different and they may not be using them.
...
AN
...
Optional - Route planning module within Distribution required
...
<DO>6
...
ServiceLevel
...
This defines a service level other than the standard delivery service levels.
Code - Description
24 - 24 Hours Service
48 - 48 Hour Service
Leave Blank if not using, but check with your warehouse as this is a non standard service.
...
AN
...
Optional - Route planning module within Distribution required
...
<DO>7
...
AreaNumber
...
This defines an area number for the vehicle and is used for automatic routing system to allocate this specific order to a specific vehicle.
This is an INTEGER field
...
AN
...
Optional - Route planning module within Distribution required
...
<DO>8
...
BKContact
...
Booking Contact Name
...
<DO>9
...
BKTel
...
Booking Contact Telephone No
...
<DO>10
...
BKEmail
...
Booking Email Address
...
<DO>11
...
BKRef
...
Booking Reference Number
...
<DO>12
...
DNDB
...
Do not Delivery before dd/mm/yyyy
If you set this field the system will pick the next delivery date on or after the date provided.
...
DT
...
<DO>13
...
DNDA
...
Do not Delivery after dd/mm/yyy
If you set this field the system will pick a delivery date on or before the date provided
If this can not be met then the warehouse will contact you
...
DT
...
<DO>14
...
DNote
...
1 - Electronic Delivery Note sent via email to DP email and no paper copy (Green option)
2 - Electronic Delivery Note sent via email to DP email and paper copy at time of delivery
3 - Paper Delivery note at the time of delivery.
...
IN
...
Will default to 1
...
<DO>15
...
POD
...
You can download a POD any time up to the point where your warehouse state they will retain documents for, so there is no need for POD's to be systematically sent to you unless there is something wrong.
1 - Store POD on warehouse system copy not required
2 - Store POD on warehouse system copy to be send if there is a delivery issue
3 - Store POD on warehouse system and send copy once confirmed
...
IN
...
Will default to 1
...
<DO>16
...
ROR
...
Report Over Ride Feature
If left blank will default to your normal delivery note, however if completed we will use an alternative Delivery note template for this order only
(Please speak to your warehouse before using this)
...
IN
...
Default is BLANK
XML HI (Header Invoicing) Segment - Optional
A service offered by the warehouse – please check availability.
Invoice your customers – warehouse creates the invoices on behalf of the customers. - only send this segment if you will use it.
XML Element
XML Key Name
Notes
Mandatory / Optional / Conditional [M/O/C]
<HI>1
InvoiceName
If left blank then the delivery name, address and postcode are used as the default.
<HI>2
InvoiceAddress1
If left blank then the delivery name, address and postcode are used as the default.
<HI>3
InvoiceAddress2
If left blank then the delivery name, address and postcode are used as the default.
<HI>4
InvoiceAddress3
If left blank then the delivery name, address and postcode are used as the default.
<HI>5
InvoiceAddress4
If left blank then the delivery name, address and postcode are used as the default.
<HI>6
InvoicePostcode
If left blank then the delivery name, address and postcode are used as the default.
<HI>8
InvoiceCountry
If left blank then the delivery name, address and postcode are used as the default.
<HI>10
PricedDeliveryNoteRequired
If used then field LD8 is MANDATORY unless the product information stored by the warehouse contains pricing information.
Delivery Note supplied to the receiver of the goods will be priced and will constitute an invoice.
If the invoice address fields are completed, HI1-HI8 then a separate invoice could be generated as well as the delivery note.
Y/N allowed.
<HI>11
OrderDiscountPercentage
Used to calculate the invoice price for the invoice or priced delivery note
<HI>12
OrderCarraigeCharge1
Used to calculate the invoice price for the invoice or priced delivery note
<HI>13
OrderCarraigeCharge2
Used to calculate the invoice price for the invoice or priced delivery note
<HI>14
OPCOD
Order Payment Cash on Delivery Flag
1 - Yes COD required
Your warehouse may not offer this service.
Optional
Default to 0 = NO
<HI>15
OPType
Order Payment Type
299 - Cash on Delivery
399 - Credit Card on Delivery
599 - Cheque on Delivery
Not all warehouses offer the above services, where they do there could be limitations or additional charges.
Optional
<HI>16
NetTotal
Format decimal (8,2)
<HI>17
SalesTax
Format decimal (8,2)
<HI>18
GrandTotal
Format decimal (8,2)
The total amount of the order OR the amount to be collected in the case of a OPType 4 order
Conditional, if OPCOD = 1 then this field is mandatory
<HI>18
Currency
The three digit currency code as specified in the ISO listing e.g. USD, ZAR, GBP, AUD
XML LD (Line Details) Segment
...