ORDERS

Document Sample
ORDERS Powered By Docstoc
					Midwich XML ORDERS Message                                                           Revision 1.19 (10/07/2009)




                                   Midwich Implementation Guide
                                                   for

                                XML Orders Message




Introduction

This document provides the specification for the XML „order message‟ that our trading partner sends to
Midwich specifying the order details.


A GENRSP message will be immediately returned to the trading partner, showing the results of basic
validation. A later check of the AVMESS and processing the messages listed can ascertain the actual results
of submitting the order.


                                               Page 1 of 37
Midwich XML ORDERS Message                                                                Revision 1.19 (10/07/2009)



For an explanation of how Midwich implements XML services and the information we need from you please
refer to the Midwich Implementation Guide for XML Services.


Two complete examples of order messages can be found in Appendix B.


Document Notes

Only segments that are used by Midwich are included in these guidelines
The examples in this document are not exhaustive, different scenarios may contain more or less elements.
This specification may be amended at any time. Midwich will notify you of any changes before the go live
date.


Contacts

If you require any further information on this document or XML trading with Midwich, please contact
edi.admin@midwich.com or to request use of XML services please contact your Sales Representative.


Revision History

Revision      Date           Author             Details
           1.9 3/05/2007    Karl Wright         Updated Purchasing email length, Updated End User Details
                                                orderref length, Added Delivery Instruction Lines.

         1.10 4/05/2007     Geoffrey Walton     Added Deliverycost

         1.11 4/06/2007     Karl Wright         Update <lineno> field length and description.

         1.12 12/06/2007    Karl Wright         Updated field lengths.

         1.13 18/06/2007    Geoffrey Walton     Clarify use of End User‟s PO No

         1.14 22/06/2007    Geoffrey Walton     How Delivery Address elements are used.

         1.15 18/07/2007    Geoffrey Walton     Warehouse bulk deliveries

         1.16 6/08/2007     Geoffrey Walton     Delivery time changes

         1.17 3/01/2008     Geoffrey Walton     Required by date

         1.18 19/05/2009    Geoffrey Walton     Added S&D element

         1.19 10/07/09      Geoffrey Waltno     Carrier and service level documentation



ORDERS                           Purchase order message

A message sent by Midwich’s customers specifying the goods or services to be ordered.


PHP code that will send XML orders to Midwich is available on the Midwich website. This can be easily
integrated into a web site and more php code to monitor the progress of orders and update your system is
also in the same place. http://www.midwich.com/feeds/myfeed/dc_xml.php
                                                Page 2 of 37
Midwich XML ORDERS Message                                                               Revision 1.19 (10/07/2009)




The DTD is shown in full in appendix C, you must ensure that all mandatory elements are
present, even if they are empty.


Common mistakes are to use Midwich details in the originator section or trying to order using the
manufacturer;s part no rather than the Midwich part no or specifying the unit price in pounds rather than in
pence. You should also note that parameters are case sensitive e.g. TRUE not true as are most of the fields
in the Trading Partner section.


Configuration
The configuration section provides elements for processing the order. This section contains the following
elements:
      Trading Partner
      Message Status
      Forcehold
      Fillorkill
      Debuggingoutput
      Message Date / Time


Header
The header section provides elements detailing the basic attributes of the order. This section contains the
following elements:
      Order Reference
      Order date/time
      Date required
      Carrier
      Delivery method
      Delivery cost
      Part Ship
      Delivery Address including delivery instructions
      Invoice Address
      Purchasing Contact
      Customer Invoice Address
      Currency


Lines
The line sections provide elements detailing the products and quantities to be ordered. This section contains
the following elements:
      Line number

                                                 Page 3 of 37
Midwich XML ORDERS Message                                                                 Revision 1.19 (10/07/2009)



      Midwich part number
      Manufacturer part number
      Item description
      Quantity
      Price per item
      Line comment
      Item Fillorkill


Trailer
The trailer section provides elements for free text to be applied to the order. This section contains the
following elements:
      Comment



CONFIGURATION Message Configuration
This section of the document provides a breakdown in detail of the configuration section, including
an example XML snippet.


Overview
This section provides configuration information for the order. In particular, this section defines the customer
who has placed this order, the status of the message and a message date/time.


Example
An example of the configuration section is as follows:



      <configuration>
             <tradingpartner>
                        <originator>
                            <reference>0000123456</reference>
                            <tradingname>Some Company Ltd</tradingname>
                            <technicalemail>john.techie@some.company.com</technicalemail>
                        </originator>
                        <recipient>
                            <reference>0000500193</reference>
                            <tradingname>Midwich Ltd</tradingname>
                        </recipient>
             </tradingpartner>
             <messagestatus>LIVE</messagestatus>
             <fillorkill>FALSE</fillorkill>

                                                  Page 4 of 37
Midwich XML ORDERS Message                                                         Revision 1.19 (10/07/2009)



           <debuggingoutput>TRUE</debuggingoutput>
           <messagedatetime>20030305</ messagedatetime>
     </configuration>



<tradingpartner> Trading Partner Identification
This element defines the trading partners (originator and recipient) involved in this order.

Element Breakdown:

  Element Name                Type                         Length         Format              Status



  <tradingpartner>            -                             n/a             n/a             Mandatory


  <originator>                -                             n/a             n/a             Mandatory


  <reference>                 Numeric                        10             n/a             Mandatory

  <tradingname>               Character                      50             n/a             Mandatory

  <technicalemail>            Character                      50             n/a              Optional


  <recipient>                 -                             n/a             n/a             Mandatory


  <reference>                 Numeric                        10             n/a             Mandatory

  <tradingname>               Character                      50             n/a             Mandatory


  Element Name                Description


  <tradingpartner>            -

  <originator>                The customer and originator of the message.



  <reference>                 It is usually your 10-digit customer number and will be communicated to
                              you during the registration process. Used for the identification of trading
                              partner during translation and subsequent order import process. Midwich
                              will assign this reference number to you.
  <tradingname>               Trading name of partner. As a security check this must agree with the
                              name held by Midwich and will be communicated to you during the
                              registration process.


                                            Page 5 of 37
Midwich XML ORDERS Message                                                             Revision 1.19 (10/07/2009)



   Element Name                   Description
   <technicalemail>               Email address of the technical contact at your company. Midwich will use
                                  it to report any errors to you with the XML data you have submitted.


   <recipient>                    The recipient of the message (Midwich), please use the values shown
                                  below.


   <reference>
                                  0000500193

   <tradingname>
                                  Midwich Ltd


      <tradingpartner>
            <originator>
                   <reference>0000123456</reference>
                   <tradingname>Some Company Ltd</tradingname>
                   <technicalemail>john.techie@some.company.com</technicalemail>
            </originator>
            <recipient>
                   <reference>0000500193</reference>
                   <tradingname>Midwich Ltd</tradingname>
            </recipient>
      </tradingpartner>




<messagestatus> Status of Message
The status of the messsage.


The message status element defines whether the message is to be treated as a live message and imported
into the Midwich commercial system, or a test message which should be used purely for testing of the
mapping.


Element Breakdown:

  Element Name                  Type                       Length             Format              Status


  <messagestatus>               Character                      4                n/a             Mandatory


                                                Page 6 of 37
Midwich XML ORDERS Message                                                               Revision 1.19 (10/07/2009)




   Element Name                  Description


   <messagestatus>               The status of the message. Possible values are LIVE for a live message that
                                 should be imported into the Midwich commercial system, or TEST for testing
                                 purposes.


        <messagestatus>LIVE</messagestatus>
   or
        <messagestatus>TEST</messagestatus>




<forcehold>                                  “Hold” The Order

Force Order to be Held.


This element allows trading partners to place orders and release them to our warehouse for picking at a later
time. This is generally used where the Trading Partner allows their customer to cancel the order or lines on
the order for a period of time after they placed their order. Once this time has passed and the Trading Partner
has processed credit card details the order can be released, using a RELORD message, so it can be picked
and despatched.


All order should be released on the day they are placed or cancelled by the Trading Partner sending a
RELORD or DELORD message to Midwich as explained in the XML Implementation Guide.


Note: Where an ORDERS message is received and there is an internal Midwich reason why the order should
not be released, an email is sent to the Midwich Account Manager for them to resolve.


Note: Where a RELORD message is received and there is an internal Midwich reason why the order should
not be released, an email is sent to the Midwich Account Manager and to the Trading Partner‟s Purchasing
contact registered for the account.


Note: Releasing an order after our despatch cut off time or your account manager‟s normal working hours
may result in the goods being despatched the following day.


Element Breakdown:

  Element Name                   Type                         Length            Format              Status




                                                 Page 7 of 37
Midwich XML ORDERS Message                                                                   Revision 1.19 (10/07/2009)



   Element Name                      Type                         Length            Format              Status
   <forcehold>                       Character                        5               n/a              Optional


   Element Name                      Description


   <forcehold>                       The hold setting for the order. Possible values are TRUE to accept the
                                     order, allocate stock if possible but do not despatch it, or FALSE, accept and
                                     process the order according to normal processing rules.


        <forcehold>TRUE</forcehold>
   or
        <forcehold>FALSE</forcehold>




<fillorkill>                                      Specify a “Fill or Kill” order

Force Fill or Kill processing for the order.


If this element is not present, the fill or kill status will default to the setting held by Midwich for the account
submitting the message (usually FALSE).


When set to TRUE, the order will be rejected if there is insufficient available stock for any item line otherwise
the out of stock lines will be put on back order. Thus the FALSE value can be used to force back ordering for
accounts that normally default to TRUE.


Where partship is set to TRUE and parts have to go on back order, an additional delivery charge will be
raised to cover the additional costs incurred in multiple deliveries.


The order level fill or kill supersedes the itemfillorkill.


Element Breakdown:

   Element Name                      Type                         Length            Format              Status


   <fillorkill>                      Character                        5               n/a              Optional


   Element Name                      Description



                                                       Page 8 of 37
Midwich XML ORDERS Message                                                                 Revision 1.19 (10/07/2009)



   Element Name                  Description
   <fillorkill>                  The fill-or-kill setting for the message. Possible values are TRUE to force fill-
                                 or-kill, or FALSE to suppress fill-or-kill.


        <fillorkill>TRUE</fillorkill>
   or
        <fillorkill>FALSE</fillorkill>




<debuggingoutput Create additional debugging
>                output

Create additional debugging output for order.


When set to TRUE, the order import process will generate additional debugging output which will be emailed
to the technical email address and to the purchasing contact email address. This can be useful for test
purposes. The default (if this element is not specified) is FALSE.


Element Breakdown:

   Element Name                  Type                         Length              Format              Status


   <debuggingoutput>             Character                       5                  n/a              Optional


   Element Name                  Description


   <debuggingoutput>             If TRUE, create additional debugging output. If omitted, or FALSE, no
                                 additional debugging output will be generated.


        <debuggingoutput>TRUE</debuggingoutput>
   or
        <debuggingoutput>FALSE</debuggingoutput>




<messagedatetime> Date and Time of Message

                                                  Page 9 of 37
Midwich XML ORDERS Message                                                              Revision 1.19 (10/07/2009)



A date and time stamp for the message.

Element Breakdown:

   Element Name                   Type                       Length             Format              Status


   <messagedatetime>              Character                       12       YYYYMMDDHHMM           Mandatory


   Element Name                   Description


   <messagedatetime>              Date and time stamp for the ORDERS message. This field allows for
                                  accurate tracking of message through the order processing system and to
                                  ensure message is replied to within the agreed timescale.


      <messagedatetime>200303051735</messagedatetime>




HEADER                                        Order Header

This section of the document provides a breakdown in detail of the header section, including an
example XML snippet.


Overview
The header section provides basic order information, including order references, required dates, delivery and
billing addresses, contact details, order currency and end user details.


Example
An example of the header section is as follows:



      <header>
             <orderref>P0034523</orderref>
             <orderdatetime>200302031141</orderdatetime>
             <daterequired>20030203</daterequired>
             <deliverymethod>ND00</deliverymethod>
             <deliveryaddress>
                   <name>John Smith</name>
                   <addr1>A company Ltd</addr1>
                   <addr2>17 The High Street</addr2>
                   <addr3></addr3>
                   <towncity>DUDLEY</towncity>
                   <county>West Midlands</county>

                                                  Page 10 of 37
Midwich XML ORDERS Message                                              Revision 1.19 (10/07/2009)



                 <postcode>DY2 OBY</postcode>
                 <country>GB</country>
                 <telephone>01379 649341</telephone>
                 <delin1>Please deliver parcel after 2pm</delin1>
           </deliveryaddress>
           <invoiceaddress>
                 <addr1>Purchase Ledger Department</addr1>
                 <addr2>B Company Ltd</addr2>
                 <addr3>Gilray Road</addr3>
                 <towncity>DISS</towncity>
                 <county>Norfolk</county>
                 <postcode>IP22 4YT</postcode>
                 <country>GB</country>
           </invoiceaddress>
           <purchasingcontact>
                 <name>Nick Heppleston</name>
                 <telephone>01379 649341</telephone>
                 <fax>01379 649200</fax>
                 <email>nick.heppleston@bcompany.com</email>
           </purchasingcontact>
           <enduserdetails>
                 <orderref>372764</orderref>
                 <accountnumber>01746382</accountnumber>
                 <invoiceaddress>
                       <addr1>Mr James Hardy</addr1>
                       <addr2>45 Wellington Road</addr2>
                       <addr3>Newton Flotman</addr3>
                       <towncity>DISS</towncity>
                       <county>Norfolk</county>
                       <postcode>IP20 5DT</postcode>
                       <country>GB</country>
                 </invoiceaddress>
           </enduserdetails>
           <currency>GBP</currency>


     </header>   <orderrefTrading Partner Order Reference
>
The trading partner’s order reference (purchase order number), this will appear on the
despatch note unless the endusr orderref is supplied in the message, in which case that
value will be used.

                                         Page 11 of 37
Midwich XML ORDERS Message                                                         Revision 1.19 (10/07/2009)



Element Breakdown:

  Element Name                 Type                      Length           Format              Status


  <orderref>                   Character                     15              n/a            Mandatory


  Element Name                 Description


  <orderref>                   The trading partner order reference (purchase order number).



     <orderef>P0034523</orderef>




<orderdatetime>                         Order Date and Time Stamp

The date and time the order was raised on the trading partner's system.

Element Breakdown:

  Element Name                 Type                      Length           Format              Status


  <orderdatetime>              Character                     12       YYYYMMDDHHMM          Mandatory


  Element Name                 Description


  <orderdatetime>              The date and time the order was raised on the trading partner's system.



     <orderdatetime>200302031141</orderdatetime>




<daterequired>                          Date Goods Required

The date on which the goods should be delivered. This can be up to 7 days from the date the
order. Normally we will pick and despatch the goods the day before this date for next day delivery.

Deliveries for Saturday, Sunday and bank holidays and the first working day after will be picked
and despatched on the last working day before the holiday.


                                             Page 12 of 37
Midwich XML ORDERS Message                                                          Revision 1.19 (10/07/2009)



e.g. orders to be delivered on Saturday Sunday and Monday will be despatched on the previous
Friday, but not delivered until the Monday unless a Saturday Service level has been selected.

Orders for Good Friday will be picked on the Thursday and delivered on the following Tuesday.
Christmas deliveries will vary depending on our closure policy.

Element Breakdown:

  Element Name                 Type                      Length          Format                Status


  <daterequired>               Character                     8        YYYYMMDD               Mandatory


  Element Name                 Description


  <daterequired>               The date on which goods should be delivered.



     <daterequired>20030203</daterequired>




<carrier>                               Carrier

The carrier by which goods are requested to be sent by, if the value is not one of the
accepted values or blank then the default defined by your account manager will be used.

Element Breakdown:

  Element Name                 Type                      Length          Format                Status


  <carrier>                    Character                     3                n/a             Optional


  Element Name                 Description




                                             Page 13 of 37
Midwich XML ORDERS Message                                                         Revision 1.19 (10/07/2009)



  Element Name               Description
  <carrier>                  The carrier by which goods are to be sent by.
                             Possible values are:


                                     TAR – City Link (Default), note CityLink have taken over Target
                                     COL – Collection
                             Certain customers will need to specify NAR and a code provided by their
                             account manager for bulk shipments to their warehouse.
                             Where Midwich have agreed for other methods of delivery to be
                             implemented the valid combinations of carrier and delivery methods that
                             can be used will be communicated to you.
                             Note: If the value COL is passed as the deliverymethod, carrier will be set
                             to COLL irrespective of the value passed in this element.
                             You must contact our sales team to arrange a mutually convenient date
                             and time to collect your order from our warehouse.



     <carrier>TAR</carrier>



<deliverymethod> Delivery Method
The delivery method that will be used with this order.

A Delivery charge will be calculated using our standard wt/price matrix and a line 9000
added to your order.

The charge will then appear as line 9000, with a Midwich Part Number of “DEL” in all
subsequent messages.

Element Breakdown:

  Element Name                Type                      Length           Format               Status


  <deliverymethod>            Character                    15                n/a            Mandatory


  Element Name               Description




                                           Page 14 of 37
Midwich XML ORDERS Message                                                              Revision 1.19 (10/07/2009)



   Element Name                   Description
   <deliverymethod>               The delivery method to be applied to the order.


                                  Possible values for Carrier TAR are:
                                      ND09 – Next day pre 9am delivery
                                      ND10 – Next day pre 10.30am delivery
                                      ND12 – Next day pre 12 noon delivery
                                      ND00 – Next day delivery
                                      SA10 – Saturday pre 10.30am delivery
                                      SA00 – Saturday delivery
                                  Possible values for Carrier COL are:
                                      COLL – Collect the from our warehouse
                                     Where values that were valid are used they are converted to the
                                  corresponding new value.
                                  Note: If the value COLL is passed the Carrier will automatically be set to
                                  COL.
                                  You must contact our sales team to arrange a mutually convenient date
                                  and time to collect your order from our warehouse


The following example indicates the order should be on a next day delivery (pre 12 noon).


      <deliverymethod>ND12</deliverymethod>



<deliverycost>                               Delivery Cost

The delivery charge supplied by you calculated using a method agreed by you and your
account manager. The delivery cost is returned by the ORDVAL message.

For certain customers, with the agreement of the account manager, this field can be used
to pass over the agreed delivery charge Midwich will make. These charges will be
reviewed on a regular basis and debit/credit notes may be raised where the incorrect
values was passed.

This will appear as line 9000, with a Midwich Part Number of “DEL” in all subsequent
messages.

Element Breakdown:

  Element Name                     Type                     Length             Format              Status


  <deliverycost>                   Numeric                      n/a              n/a              Optional


                                                Page 15 of 37
Midwich XML ORDERS Message                                                                   Revision 1.19 (10/07/2009)



   Element Name                      Description


   <deliverycost>                    Cost, in pence, of the delivery agreed by you and your account manager.



        <deliverycost>500</deliverycost>



<partship>                                      Allow part ship orders

Allows orders to be part shipped if not all items are available.


If this element is not present, it will default to FALSE.


When set to TRUE as stock becomes available it will be shipped. Our normal policy is to despatch the entire
order in one shipment.


Where partship is set to TRUE and parts have gone on back order causing multiple deliveries, an additional
delivery charge will be raised to cover the additional costs incurred by Midwich.


Element Breakdown:

   Element Name                    Type                         Length              Format              Status


   <partship>                      Character                        5                n/a               Optional


   Element Name                    Description


   <partship>                      The partship setting for the message. Possible values are TRUE to allow
                                   part shipments or FALSE to only despatch the order when all lines are
                                   available.


        <partship>TRUE</partship>
   or
        <partship>FALSE</partship>




<deliveryaddress> Delivery Address

                                                    Page 16 of 37
Midwich XML ORDERS Message                                                           Revision 1.19 (10/07/2009)



Should contain the address to which the order will be delivered. If there is data in the Name
or Addr1 element then it is assumed that the rest of the address is valid. To get the order to
be delivered to the default address held on our system leave these 2 elements empty.

Element Breakdown:

  Element Name                Type                      Length              Format              Status


  <deliveryaddress>           -                             n/a              n/a              Mandatory
  <name>                      Character                     40               n/a               Optional

  <addr1>                     Character                     40               n/a              Mandatory

  <addr2>                     Character                     30               n/a               Optional

  <addr3>                     Character                     30               n/a               Optional

  <addr4>                     Character                     30               n/a               Optional

  <towncity>                  Character                     30               n/a              Mandatory

  <county>                    Character                     30               n/a              Mandatory

  <postcode>                  Character                     10               n/a              Mandatory

  <country>                   Character                     2                n/a              Mandatory

  <telephone>                 Character                     25               n/a              Mandatory

  <delin1>                    Character                     40               n/a               Optional

  <delin2>                    Character                     40               n/a               Optional

  <delin3>                    Character                     40               n/a               Optional

  <delin4>                    Character                     40               n/a               Optional


  Element Name                Description



  <deliveryaddress>           Party to whom the goods will be delivered.
  <name>                      Contact name, if not present will use addr1
  <addr1>                     Address line one
  <addr2>                     Address line two
  <addr3>                     Address line three
  <addr4>                     Address line four
  <towncity>                  Town / City. In line with PO standards please supply in uppercase.
  <county>                    County


                                            Page 17 of 37
Midwich XML ORDERS Message                                                          Revision 1.19 (10/07/2009)



  Element Name               Description
  <postcode>                 Post code
  <country>                  Country (see Appendix A for country codes)
  <telephone>                Will be used where delivery problems are encountered, please supply
                             wherever possible as it improves the first time delivery rates.
  <delin1>                   Delivery instructions line 1, this will appear on the delivery note regardless
                             of destination.
  <delin2>                   Delivery instructions line 2, this will appear on the delivery note regardless
                             of destination.
  <delin3>                   Delivery instructions line 3, this will appear on the delivery note regardless
                             of destination.
  <delin4>                   Delivery instructions line 4, this will appear on the delivery note regardless
                             of destination.



            <deliveryaddress>
                 <name>John Smith</name>
                 <addr1>A company Ltd</addr1>
                 <addr2>17 The High Street</addr2>
                 <addr3></addr3>
                 <towncity>DUDLEY</towncity>
                 <county>West Midlands</county>
                 <postcode>DY2 OBY</postcode>
                 <country>GB</country>
                 <telephone>01379 649341</telephone>
                 <delin1>Please deliver parcel after 2pm</delin1>
            </deliveryaddress>




<invoiceaddress> Invoice Address
Invoice address for the order. Where it is not provided Midwich will use our stored address.

Element Breakdown:

  Element Name               Type                       Length             Format              Status


  <invoiceaddress>           -                             n/a                n/a            Mandatory
  <addr1>                    Character                     40                 n/a            Mandatory

  <addr2>                    Character                     30                 n/a             Optional


                                           Page 18 of 37
Midwich XML ORDERS Message                                                           Revision 1.19 (10/07/2009)



  Element Name                 Type                      Length             Format              Status
  <addr3>                      Character                     30              n/a               Optional

  <towncity>                   Character                     30              n/a              Mandatory

  <county>                     Character                     30              n/a              Mandatory

  <postcode>                   Character                     10              n/a              Mandatory

  <country>                    Character                     2               n/a              Mandatory


  Element Name                 Description



  <invoiceaddress>             Party to whom goods are to be invoiced
  <addr1>                      Address line one
  <addr2>                      Address line two
  <addr3>                      Address line three
  <towncity>                   Town / City. In line with PO standards please supply in uppercase.
  <county>                     County
  <postcode>                   Post code
  <country>                    Country (see Appendix A for country codes)



            <invoiceaddress>
                 <addr1>Purchase Ledger Department</addr1>
                 <addr2>B Company Ltd</addr2>
                 <addr3>Gilray Road</addr3>
                 <towncity>DISS</towncity>
                 <county>Norfolk</county>
                 <postcode>IP22 4YT</postcode>
                 <country>GB</country>
            </invoiceaddress>




<purchasingcontact> Purchasing Contact

The person in your company to whom queries regarding the order should be directed.


Element Breakdown:


                                             Page 19 of 37
Midwich XML ORDERS Message                                                                     Revision 1.19 (10/07/2009)



   Element Name                       Type                      Length                Format              Status


   <purchasingcontact>                -                             n/a                n/a              Mandatory
   <name>                             Character                     25                 n/a              Mandatory

   <telephone>                        Character                     25                 n/a              Mandatory

   <fax>                              Character                     25                 n/a              Mandatory

   <email>                            Character                     60                 n/a              Mandatory


   Element Name                       Description



   <purchasingcontact>                -
   <name>                             Full name (including title) of contact person
   <telephone>                        Direct dial telephone number of named contact (DDI)
   <fax>                              Fax number for named contact
   <email>                            E-mail address of named contact



              <purchasingcontact>
                     <name>Nick Heppleston</name>
                     <telephone>01379 649341</telephone>
                     <fax>01379 649200</fax>
                     <email>nick.heppleston@bcompany.com</email>
              </purchasingcontact>




<enduserdetails> Customer Invoice Address
Additional end user information.


This section allows end user details to be captured and in future to populate dispatch notes etc. so that they
are tailored entirely to the trading partner.


Note: If this functionality is not required, leave these elements blank.


Element Breakdown:


                                                    Page 20 of 37
Midwich XML ORDERS Message                                                         Revision 1.19 (10/07/2009)



  Element Name               Type                           Length        Format              Status


  <enduserdetails>           -                               n/a             n/a             Optional
  <orderref>                 Character                        20             n/a            Mandatory

  <accountnumber>            Character                        20             n/a            Mandatory

  <invoiceaddress>           -                                30             n/a            Mandatory

  <addr1>                    Character                        40             n/a            Mandatory

  <addr2>                    Character                        30             n/a             Optional

  <addr3>                    Character                        30             n/a             Optional

  <towncity>                 Character                        30             n/a            Mandatory

  <county>                   Character                        30             n/a            Mandatory

  <postcode>                 Character                        10             n/a            Mandatory

  <country>                  Character                        2              CC             Mandatory


  Element Name               Description



  <enduserdetails>           -

                             Trading partner's customer‟s order reference, this will appear on the
                             delivery note regardless of destination. Normally only populated for direct
  <orderref>                 deliveries to the customer‟s address. Leave empty if the goods will be
                             delivered to your warehouse for onward shipment and you require your PO,
                             as supplied in the <header> <orderref>, on the delivery note.
  <accountnumber>            Trading partner's customer account number

  <invoiceaddress>           Party to which goods are to be billed

  <addr1>                    Address line one

  <addr2>                    Address line two

  <addr3>                    Address line three

  <towncity>                 Town / City. In line with PO standards please supply in uppercase.

  <county>                   County

  <postcode>                 Post code

  <country>                  Country (see Appendix A for country codes)



     <enduserdetails>
            <orderref>372764</orderref>
            <accountnumber>01746382</accountnumber>

                                            Page 21 of 37
Midwich XML ORDERS Message                                                          Revision 1.19 (10/07/2009)



           <invoiceaddress>
                 <addr1>Mr James Hardy</addr1>
                 <addr2>45 Wellington Road</addr2>
                 <addr3>Newton Flotman</addr3>
                 <towncity>DISS</towncity>
                 <county>Norfolk</county>
                 <postcode>IP20 5DT</postcode>
                 <country>GB</country>
           </invoiceaddress>
      </enduserdetails>




<currency>                                Order Currency

The currency to be applied to the order.

Element Breakdown:

  Element Name                  Type                      Length           Format              Status


  <currency>                    Character                     4             n/a              Mandatory


  Element Name                  Description


  <currency>                    The currency to be applied to the order.


                                Possible currency codes are:


                                    GBP – Pounds Sterling
                                    EUR – Euros – Not yet available




      <currency>GBP</currency>




LINE                                      Order Line/s

This section of the document provides a breakdown in detail of the line section, including an
example XML snippet.

                                              Page 22 of 37
Midwich XML ORDERS Message                                                               Revision 1.19 (10/07/2009)




Overview
The line section provides details of each line in the order including the Midwich part number, manufacturer
part number, item description, quantity and the price per item.


Example
An example of a line section is as follows:



      <line>
             <lineno>10</lineno>
             <midwpartno>DIMAGES304</midwpartno>
             <manupartno>U2770101C</manupartno>
             <itemdesc>3.3M Mega Pixel, 4x Zoom, Digital Camera</itemdesc>
             <quantity>10</quantity>
             <priceperitem>27000</priceperitem>
             <comment>This is a line comment</comment>
      </line>




<lineno>                                      Line Number

The order line number.

If requested we can pass back the line numbers provided by you if required. These line numbers
will appear in ORDRSP, ORDSTAT, BACKORD, DESADV messages. They can also be used in
DELORD messages.

NOTE: We are not able to pass back “your” line number for manually entered orders and delivery
lines created by Midwich.

Element Breakdown:

   Element Name                     Type                      Length            Format              Status


   <lineno>                         Numeric                       4                -              Mandatory


   Element Name                     Description


   <lineno>                         Line numbers must always end in 0.
                                    If your account is configured to use your own line numbers, the lowest
                                    number we accept is 10.

                                                  Page 23 of 37
Midwich XML ORDERS Message                                                Revision 1.19 (10/07/2009)




     <lineno>10</lineno>




<midwpartno> Midwich Part Number
The Midwich part number to be ordered. This element must be present as the manu part no
is not unique on our system.

Element Breakdown:

  Element Name               Type                      Length    Format              Status


  <midwpartno>               Character                     22       -              Mandatory


  Element Name               Description


  <midwpartno>               Midwich part number.



     <midwpartno>DIMAGES304</midwpartno>




<manupartno> Manufacturer's Part Number
The manufacturer part number to be ordered. This information is used as comment only, no
validation is carried out on this number.

As Midwich can have several part numbers for one manufacturer‟s part no, the Midwich
part number must be specified. This allows for clearance stock, special offers and bundles
to be ordered electronically.

This part no

Element Breakdown:

  Element Name               Type                      Length    Format              Status


  <manupartno>               Character                     15       -              Mandatory


                                           Page 24 of 37
Midwich XML ORDERS Message                                                      Revision 1.19 (10/07/2009)



  Element Name                 Description


  <manupartno>                 Manufacturer part number.



     <manupartno>U2770101C</manupartno>




<itemdesc>                               Item Description

A short description of the product.

Where the Midwich part number and the manufacturer‟s part no are not valid and the
account is not set up to reject orders with invalid parts this field will be used to identify the
correct part number otherwise this information is used as comment only, no validation is
carried out on it.

Element Breakdown:

  Element Name                 Type                      Length        Format              Status


  <itemdesc>                   Character                     35           -              Mandatory


  Element Name                 Description


  <itemdesc>                   Short description of the product.



     <itemdesc>3.3M Mega Pixel, 4x Zoom, Digital Camera</itemdesc>




<quantity>                               Quantity Ordered

The quantity to be ordered.

Element Breakdown:

  Element Name                 Type                      Length        Format              Status




                                             Page 25 of 37
Midwich XML ORDERS Message                                                         Revision 1.19 (10/07/2009)



  Element Name                   Type                       Length        Format              Status
  <quantity>                     Numeric                       15            -              Mandatory


  Element Name                   Description


  <quantity>                     The quantity to be ordered.



      <quantity>10</quantity>




<priceperitem>                             Price Per Item

The price per x1 of the item to be ordered.

Element Breakdown:

  Element Name                   Type                       Length        Format              Status


  <priceperitem>                 Numeric                       15            -              Mandatory


Element Description:

  Element Name                   Description


  <priceperitem>                 The price per unit of the line item.


                                 Note: Price must be in pence.



      <priceperitem>27000</priceperitem>




<shipanddebit> Ship and Debit
The ship and debit code that has been given to the customer for a project price. By passing this
code to Midwich a vendor supported price can be ordered electronically. Where the ship and debit
is invalid or the priceperitem passed over is incorrect the order line will be rejected. Ship and
debits can be invalid if the code does not exist, the price has expired or all of the qty ordered is no
longer available on the Ship and debit. It will be ignored if the legth is less than 4 characters
                                               Page 26 of 37
Midwich XML ORDERS Message                                                          Revision 1.19 (10/07/2009)




Element Breakdown:

  Element Name                  Type                      Length           Format              Status



  <   shipanddebit >            Character                     8                -              Optional


Element Description:

  Element Name                  Description



  <   shipanddebit >            The ship and debit code that has been given to the customer for a project
                                price.



       <shipanddebit>SDQ12345</shipanddebit>




<specialbidref> Special Bid Reference
The Special Bid Reference code that has been given to the customer for a project price. By
passing this code to Midwich a vendor supported price can be ordered electronically. Where the
Special Bid Reference is invalid or the priceperitem passed over is incorrect the order line will be
rejected. Where a specialbidref and a shipanddebit are both passed over only the shipanddebit will
be processed. Special Bid References can be invalid if the code does not exist, the price has
expired or all of the qty ordered is no longer available on the Special Bid Reference.

Element Breakdown:

  Element Name                  Type                      Length           Format              Status



  <specialbidref>               Character                     15               -              Optional


Element Description:

  Element Name                  Description



  <specialbidref>               The Special Bid Reference code that has been given to the customer for a
                                project price.



       <specialbidref>MMM345.756REF</specialbidref>


                                              Page 27 of 37
Midwich XML ORDERS Message                                                                  Revision 1.19 (10/07/2009)




<comment>                                         Line Comment

Item line comment.

These comments are for your internal use only as they are not stored on Midwich‟s system or read by human
operators.

Element Breakdown:

   Element Name                        Type                        Length          Format              Status


   <comment>                           Text                           50              -               Optional


   Element Name                        Description


   <comment>                           An optional freeform text comment for item line.



       <comment>This is a line comment</comment>



<itemfillorkill>                                  Specify a “Fill or Kill” item

Force Fill or Kill processing for the order line.


If this element is not present, the fill or kill status will default to FALSE.


When set to TRUE, the order line will be rejected when there is insufficient stock available, otherwise the line
will be put on back order.


Where part ship is set to TRUE and parts go on back order causing multiple deliveries, an additional delivery
charge will be raised to cover the additional costs incurred by Midwich.


The order level fill or kill supersedes the itemfillorkill.


Element Breakdown:

   Element Name                      Type                          Length          Format              Status




                                                      Page 28 of 37
Midwich XML ORDERS Message                                                                    Revision 1.19 (10/07/2009)



   Element Name                   Type                          Length              Format               Status
   <itemfillorkill>               Character                        5                   n/a              Optional


   Element Name                   Description


   <itemfillorkill>               The fill-or-kill setting for the item line. Possible values are TRUE to force fill-
                                  or-kill, or FALSE to suppress fill-or-kill.


        <itemfillorkill>TRUE</itemfillorkill>
   or
        <itemfillorkill>FALSE</itemfillorkill>



TRAILER                                        Order Trailer

This section of the document provides a breakdown in detail of the trailer section, including an
example XML snippet.


Overview
The trailer section provides elements for free text comments to be passed with the order.


Example
An example of the trailer section is as follows:



        <trailer>
             <comment>Please note that this is a direct ship</comment>
        <trailer>




<comment>                                      Order Comment

A free text area for order comments.

These comments are for your internal use only as they are not stored on Midwich‟s system or read by human
operators.

Element Breakdown:

   Element Name                      Type                       Length              Format               Status

                                                   Page 29 of 37
Midwich XML ORDERS Message                                               Revision 1.19 (10/07/2009)



  Element Name               Type                      Length   Format              Status


  <comment>                  Character                     50     -               Mandatory


  Element Name               Description


  <comment>                  Free text comment area



     <comment>Please note that this is a direct ship</comment>




          APPENDIX A – COUNTRY

                                    CODES




                                           Page 30 of 37
Midwich XML ORDERS Message                                                   Revision 1.19 (10/07/2009)



AT     AUSTRIA                                IS     ICELAND
BE     BELGIUM                                IT     ITALY
BG     BULGARIA                               LB     LEBANON
BY     BELARUS                                LI     LIECHTENSTEIN
CH     SWITZERLAND                            LT     LITHUANIA
CY     CYPRUS                                 LU     LUXEMBOURG MC     MONACO
CZ     CZECH REPUBLIC                         MD     MOLDOVA, REPUBLIC OF
DE     GERMANY                                MG     MADAGASCAR
DK     DENMARK                                MK     MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
EE     ESTONIA                                MT     MALTA
ES     SPAIN                                  NL     NETHERLANDS
FI     FINLAND                                NO     NORWAY
FR     FRANCE                                 PL     POLAND
GB     UNITED KINGDOM GI     GIBRALTAR        PT     PORTUGAL
GL     GREENLAND                              RO     ROMANIA
GR     GREECE                                 RU     RUSSIAN FEDERATION
HR     CROATIA                                SE     SWEDEN
HU     HUNGARY                                SK     SLOVAKIA
IE     IRELAND                                TR     TURKEY
IL     ISRAEL                                 US     UNITED STATES




            APPENDIX B – EXAMPLE

                  ORDER MESSAGES

Example 1



<?xml version="1.0" standalone="yes" ?>
<!-- Midwich Order Message -->
<order>
      <configuration>
            <tradingpartner>
                 <originator>
                       <reference>103985</reference>
                       <tradingname>Some Company Ltd</tradingname>
                 </originator>
                 <recipient>
                       <reference>10743352</reference>
                       <tradingname>Midwich Ltd</tradingname>
                 </recipient>
                                         Page 31 of 37
Midwich XML ORDERS Message                                     Revision 1.19 (10/07/2009)



           </tradingpartner>
           <messagestatus>LIVE</messagestatus>
           <messagedatetime>200302031345</messagedatetime>
     </configuration>
     <header>
           <orderref>P0034523</orderref>
           <orderdatetime>200302031141</orderdatetime>
           <daterequired>20030203</daterequired>
           <deliverymethod>ND00</deliverymethod>
           <deliveryaddress>
                 <name>John Smith</name>
                 <addr1>A company Ltd</addr1>
                 <addr2>17 The High Street</addr2>
                 <addr3></addr3>
                 <towncity>DUDLEY</towncity>
                 <county>West Midlands</county>
                 <postcode>DY2 OBY</postcode>
                 <country>GB</country>
                 <telephone>01379 649341</telephone>
           </deliveryaddress>
           <invoiceaddress>
                 <addr1>Purchase Ledger Department</addr1>
                 <addr2>B Company Ltd</addr2>
                 <addr3>Gilray Road</addr3>
                 <towncity>DISS</towncity>
                 <county>Norfolk</county>
                 <postcode>IP22 4YT</postcode>
                 <country>GB</country>
           </invoiceaddress>
           <purchasingcontact>
                 <name>Nick Heppleston</name>
                 <telephone>01379 649341</telephone>
                 <fax>01379 649200</fax>
                 <email>nick.heppleston@bcompany.com</email>
           </purchasingcontact>
           <enduserdetails>
                 <orderref>372764</orderref>
                 <accountnumber>01746382</accountnumber>
                 <invoiceaddress>
                       <addr1>Mr James Hardy</addr1>
                       <addr2>45 Wellington Road</addr2>
                       <addr3>Newton Flotman</addr3>
                       <towncity>DISS</towncity>

                                         Page 32 of 37
Midwich XML ORDERS Message                                           Revision 1.19 (10/07/2009)



                       <county>Norfolk</county>
                       <postcode>IP20 5DT</postcode>
                       <country>GB</country>
                 </invoiceaddress>
           </enduserdetails>
           <currency>GBP</currency>
     </header>
     <line>
           <lineno>10</lineno>
           <midwpartno>DIMAGES304</midwpartno>
           <manupartno>U2770101C</manupartno>
           <itemdesc>3.3M Mega Pixel, 4x Zoom, Digital Camera</itemdesc>
           <quantity>10</quantity>
           <priceperitem>27000</priceperitem>
           <comment>Please notify if cannot fullfil!</comment>
     </line>
     <line>
           <lineno>20</lineno>
           <midwpartno>DIMAGE7I</midwpartno>
           <manupartno>u2779101a</manupartno>
           <itemdesc>5.2M Mega Pixel, 20-200x Zoom, Digital Camera</itemdesc>
           <quantity>5</quantity>
           <priceperitem>82295</priceperitem>
     </line>
     <trailer>
           <comment>Please note that this is a direct ship</comment>
     </trailer>
</order>
Example 2
<?xml version="1.0" standalone="yes" ?>
<!-- Midwich Order Message -->
<order>
     <configuration>
           <tradingpartner>
                 <originator>
                       <reference>103985</reference>
                       <tradingname>Some Company Ltd</tradingname>
                 </originator>
                 <recipient>
                       <reference>10743352</reference>
                       <tradingname>Midwich Ltd</tradingname>
                 </recipient>

                                       Page 33 of 37
Midwich XML ORDERS Message                                     Revision 1.19 (10/07/2009)



           </tradingpartner>
           <messagestatus>LIVE</messagestatus>
           <messagedatetime>20030203</messagedatetime>
     </configuration>
     <header>
           <orderref>P0034523</orderref>
           <orderdatetime>200302031141</orderdatetime>
           <daterequired>20030203</daterequired>
           <deliverymethod>ND00</deliverymethod>
           <deliveryaddress>
                 <name>John Smith</name>
                 <addr1>A company Ltd</addr1>
                 <addr2>17 The High Street</addr2>
                 <addr3></addr3>
                 <towncity>DUDLEY</towncity>
                 <county>West Midlands</county>
                 <postcode>DY2 OBY</postcode>
                 <country>GB</country>
                 <telephone>01379 649341</telephone>
           </deliveryaddress>
           <invoiceaddress>
                 <addr1>Purchase Ledger Department</addr1>
                 <addr2>B Company Ltd</addr2>
                 <addr3>Gilray Road</addr3>
                 <towncity>DISS</towncity>
                 <county>Norfolk</county>
                 <postcode>IP22 4YT</postcode>
                 <country>GB</country>
           </invoiceaddress>
           <purchasingcontact>
                 <name>Nick Heppleston</name>
                 <telephone>01379 649341</telephone>
                 <fax>01379 649200</fax>
                 <email>nick.heppleston@bcompany.com</email>
           </purchasingcontact>
           <enduserdetails>
                 <orderref>372764</orderref>
                 <accountnumber>01746382</accountnumber>
                 <invoiceaddress>
                       <addr1>Mr Ashley Peek</addr1>
                       <addr2>45 Scott Road</addr2>
                       <addr3>Sandal</addr3>
                       <towncity>WAKEFIELD</towncity>

                                         Page 34 of 37
Midwich XML ORDERS Message                                       Revision 1.19 (10/07/2009)



                       <county>West Yorkshire</county>
                       <postcode>WF4 7RE</postcode>
                       <country>GB</country>
                 </invoiceaddress>
           </enduserdetails>
           <currency>GBP</currency>
     </header>
     <line>
           <lineno>10</lineno>
           <midwpartno>PHASER7300N</midwpartno>
           <manupartno>7300V_MN</manupartno>
           <itemdesc> Phaser 7300N A3 Colour LED Printer </itemdesc>
           <quantity>10</quantity>
           <priceperitem>314200</priceperitem>
           <shipanddebit>SDQ12345</shipanddebit>
     </line>
     <line>
           <lineno>20</lineno>
           <midwpartno>PHASER7300DN</midwpartno>
           <manupartno>7300V_MDN</manupartno>
           <itemdesc>Phaser 7300N A3 Colour LED Printer</itemdesc>
           <quantity>25</quantity>
           <priceperitem>333800</priceperitem>
           <specialbidref>X4.6754V7</specialbidref>
     </line>
     <trailer>
           <comment>Please note that this is a direct ship</comment>
     </trailer>
</order>




                                       Page 35 of 37
Midwich XML ORDERS Message                                      Revision 1.19 (10/07/2009)




    APPENDIX C – Data Definition
<?xml version="1.0" encoding="UTF-8"?>
<!ELEMENT order (configuration,header,line+,trailer?)>
<!ELEMENT configuration
(tradingpartner,messagestatus,forcehold?,fillorkill?,debuggingoutput?,forcelocat
ion?,messagedatetime)>
<!ELEMENT tradingpartner (originator,recipient)>
<!ELEMENT originator (reference,tradingname,technicalemail?)>
<!ELEMENT recipient (reference,tradingname)>
<!ELEMENT reference (#PCDATA)>
<!ELEMENT tradingname (#PCDATA)>
<!ELEMENT technicalemail (#PCDATA)>
<!ELEMENT messagestatus (#PCDATA)>
<!ELEMENT debuggingoutput (#PCDATA)>
<!ELEMENT forcehold (#PCDATA)>
<!ELEMENT forcelocation (#PCDATA)>
<!ELEMENT messagedatetime (#PCDATA)>
<!ELEMENT header
(orderref,orderdatetime,daterequired,carrier?,deliverymethod,deliverycost?,parts
hip?,stationary?,deliveryaddress,invoiceaddress,purchasingcontact,enduserdetails
,currency)>
<!ELEMENT orderref (#PCDATA)>
<!ELEMENT orderdatetime (#PCDATA)>
<!ELEMENT daterequired (#PCDATA)>
<!ELEMENT carrier (#PCDATA)>
<!ELEMENT deliverymethod (#PCDATA)>
<!ELEMENT deliverycost (#PCDATA)>
<!ELEMENT partship (#PCDATA)>
<!ELEMENT stationary (#PCDATA)>
<!ELEMENT fillorkill (#PCDATA)>
<!ELEMENT deliveryaddress
(name?,addr1,addr2?,addr3?,addr4?,towncity,county,postcode,country,telephone?,de
lin1?,delin2?,delin3?,delin4?)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT addr1 (#PCDATA)>
<!ELEMENT addr2 (#PCDATA)>
<!ELEMENT addr3 (#PCDATA)>
<!ELEMENT addr4 (#PCDATA)>
<!ELEMENT towncity (#PCDATA)>
<!ELEMENT county (#PCDATA)>
<!ELEMENT postcode (#PCDATA)>
<!ELEMENT country (#PCDATA)>
<!ELEMENT telephone (#PCDATA)>
<!ELEMENT delin1 (#PCDATA)>
<!ELEMENT delin2 (#PCDATA)>
<!ELEMENT delin3 (#PCDATA)>
<!ELEMENT delin4 (#PCDATA)>
<!ELEMENT invoiceaddress (addr1,addr2?,addr3?,towncity,county,postcode,country)>
<!ELEMENT purchasingcontact (name,telephone,fax,email)>
<!ELEMENT fax (#PCDATA)>
<!ELEMENT email (#PCDATA)>
<!ELEMENT enduserdetails (orderref,accountnumber,invoiceaddress)>
<!ELEMENT accountnumber (#PCDATA)>
<!ELEMENT currency (#PCDATA)>

                                   Page 36 of 37
Midwich XML ORDERS Message                                      Revision 1.19 (10/07/2009)



<!ELEMENT line
(lineno,midwpartno,manupartno,itemdesc,quantity,priceperitem,shipanddebit?,speci
albidref?,comment?,itemfillorkill?)>
<!ELEMENT lineno (#PCDATA)>
<!ELEMENT midwpartno (#PCDATA)>
<!ELEMENT manupartno (#PCDATA)>
<!ELEMENT itemdesc (#PCDATA)>
<!ELEMENT quantity (#PCDATA)>
<!ELEMENT priceperitem (#PCDATA)>
<!ELEMENT shipanddebit (#PCDATA)>
<!ELEMENT trailer (comment)>
<!ELEMENT comment (#PCDATA)>
<!ELEMENT itemfillorkill (#PCDATA)>




                                   Page 37 of 37

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:28
posted:10/18/2011
language:English
pages:37