Format description: AdvancedShippingNote

General

The XML format for shipping notification - or AdvancedShippingNote - is based on the standard format for XML catalogs. Building on this several documents for applications within the supply chain processes were defined tailored to each other.

The document AdvancedShippingNote serves as a preliminary information of shipments in order to start automatic processes with the necessary information on the side of the receiver.

• To update book in the stock

• To start logistic processes

• To manage disposition

• To control invoicing

Validation is based on most recent schema version. It is available under the following URL:

https://templates.look4optics.com/v_1_13/AdvancedShippingNote.xsd

Document structure

It is divided into 5 areas consisting of the 5 key elements AdvancedShippingNote, Supplier, Client, ShipmentPartner and OrderItems.

Detailed format description

Element AdvancedShippingNote

Example XML-Code:

<AdvancedShippingNote xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation=
  "https://templates.look4optics.com/v_1_13/AdvancedShippingNote.xsd"
  advancedShippingNoteID="ASN-2017-02-14-342"
  generatorInfo="Look4 Webservices Test" generationDate="2017-02-14T11:48:34"
  schemaMajorVersionID="1" schemaMinorVersionID="12" currency="Euro"
  vatRate="19" >
</AdvancedShippingNote>

Attribute	Type / Use	Description / Example
advancedShippingNoteID	xs:string required	ASN number of supplier (e.g. ASN-2011-02-14-342)
currency	xs:string optional	Currency (e.g. EURO)
generationDate	xs:dateTime required	Date and time of the order status generation (e.g. 2011-02-11T11:48:34)
generatorInfo	xs:string optional	Information about the generation software (e.g. Look4 Webservices Test)
schemaMajorVersionID	xs:integer required	Major version number for the description of the current schema version (e.g. 1)
schemaMinorVersionID	xs:integer required	Minor version number for the description of the current schema version (e.g. 0)
vatRate	xs:decimal optional	Vat rate (e.g. 19)

Element Supplier

The element Supplier includes all information about the supplier of the ordered goods. It consists of a subelement Addresses with at least one subelement Address in which one address is specified.

Example XML-Code:

<Supplier supplierID="DE813058544" supplierName="Woehlk" clientSupplierID="Woehlk-123"
  vatID="DE813058544">
    <Addresses>
        <Address addressID="1" addressType="MainAddress"
        name="Wöhlk-Contact-Linsen GmbH" street="Bürgermeister Schade Str. 16"
        zip="24232" city="Schönkirchen" isoCountryCode="DE"
        phone="+49-431-991-0" fax="+49-431-991-11-02"
        email="info@lieferant.de"/>
    </Addresses>
</Supplier>

Attributes of the element Supplier

Attribute	Type / Use	Description / Example
clientSupplierID	xs:string optional	ID of the supplier at client (e.g. Woehlk-123456)
responseMail	xs:string optional	E-mail address for responses to this message (e.g. info@woehlk.com)
supplierID	xs:string required	GLN code or supplier no. (e.g. DE813058544)
supplierName	xs:string optional	Supplier name (e.g. Woehlk)
vatID	xs:string optional	VAT ID at supplier (e.g. DE813058544)

Attributes of the element Address

Attribute	Type / Use	Description / Example
addressID	xs:string required	Unique ID for an address. This can be linked later to one or more orders. (e.g. 123456)
addressType	xs:NMTOKEN required	Standard values: MainAdress, ShippingAddress, BillingAddress (e.g. MainAdress)
city	xs:string required	City (e.g. Schoenkirchen)
clientBranchID	xs:string optional	Client branch ID (e.g. 1234)
clientType	xs:NMTOKEN optional	Client type (e.g. Retailer)
email	xs:string optional	E-mail (e.g. info@woehlk.com)
fax	xs:string optional	Fax (e.g. +49 (0)800-963 45 55)
isoCountryCode	xs:string required	ISO country code (e.g. DE)
name	xs:string required	(e.g. Woehlk-Contact-Linsen GmbH)
phone	xs:string optional	Phone (e.g. +49 (0)800-963 45 55)
street	xs:string required	Street (e.g. Buergermeister-Schade-Strasse 12-16)
zip	xs:string required	Zip code (e.g. 24232)

In each address element an address record can be defined. At least one address is mandatory.

Element Client

The element Client includes all information to the purchaser of the shipped goods. It consists of a subelement Addresses with at least one subelement Address in which one address is specified.

Example XML-Code:

<Client clientID="00011" clientName="Testkunde11" >
    <Addresses>
        <Address clientType="Retailer" addressID="2"
        addressType="BillingAddress"
        name="Smith Optics Ltd. Administration Office"
        street="Long street 347" zip="DN2 2NE" city="London"
        isoCountryCode="GB" phone="+0044 1302 344 123"
        fax="+0044 1302 344 321" email="central@optician-test-smith.co.uk" />
    </Addresses>
</Client>

Attributes of the element Client

Attribute	Type / Use	Description / Example
clientID	xs:string required	GLN or client no. (e.g. 012345)
clientName	xs:string optional	Client name (e.g. Smith Optics Ltd.)
responseMail	xs:string optional	E-mail address for responses to this message (e.g. response@optician-test-smith.co.uk)
vatID	xs:string optional	VAT ID (e.g. DE713058544)

Attributes of the element Address > see attributes under element Supplier

In each element Address an address record can be defined. At least one address is mandatory.

Element ShipmentPartner

The element ShipmentPartner contains all information about the logistics partner responsible for shipping. It consists of a subelement Addresses with at least one subelement Address in which one address is specified.

Example XML-Code:

<ShipmentPartner shipmentPartnerID="DE123456789"
  shipmentPartnerName="Shipping International" vatID="DE123456789"
  responseMail="mail@shipmentpartner.de">
    <Addresses>
        <Address addressID ="2" addressType ="ShippingAddress"
        name="Shipping International" street="Hafenstraße 1" zip="20059"
        city="Hamburg" isoCountryCode="DE" phone="+49-12345-65498"
        fax="+49-12345-65498" email="mail@shipmentpartner.de"/>
    </Addresses>
</ShipmentPartner>

Attributes of the element ShipmentPartner

Attribute	Type / Use	Description / Example
responseMail	xs:string optional	E-mail address for responses to this message (e.g. response@shipment-partner.com)
shipmentPartnerID	xs:string required	ID of the shipment partner, VAT ID (e.g. DE713058544)
shipmentPartnerName	xs:string optional	Name of the shipment partner (e.g. DHL International)
vatID	xs:string optional	VAT ID of the shipment partner (e.g. DE713058544)

Attributes of the element Address > see attributes under element Supplier

Element OrderItems

The element OrderItems contains all information about the order items that are included in the shipment. It consists of any number subelements OrderItem. Each OrderItem includes all information about the shipment of an order item of a specific order. This means a shipping note document may include information about order items from several different orders.

Example XML-Code:

<OrderItems>
    <OrderItem articleID="A2780" articleName="Contact Life Spheric Box"
      clientOrderItemID="LOOK4-WLK-01" deliveryQuantity="1"
      referenceName="Stock" unitOfMeasure="boxes" clientOrderID="00023-345785"
      netPurchasePrice="10" >
        <Configuration>
            <Feature templateID="UpcCode" selectedValue="123456789123"/>
            <Feature templateID="Diameter" selectedValue="13.6"/>
            <Feature templateID="RadiusBasecurve" selectedValue="8.3"/>
            <Feature templateID="Sphere" selectedValue="-3"/>
        </Configuration>
    </OrderItem>
    <OrderItem articleID="A2780" articleName="Contact Life Spheric Box"
      clientOrderItemID="LOOK4-WLK-02" deliveryQuantity="1"
      referenceName="Stock" unitOfMeasure="boxes" clientOrderID="00023-345785"
      netPurchasePrice="11" >
        <Configuration>
            <Feature templateID="UpcCode" selectedValue="123456789124"/>
            <Feature templateID="Diameter" selectedValue="14.2"/>
            <Feature templateID="RadiusBasecurve" selectedValue="8.8"/>
            <Feature templateID="Sphere" selectedValue="0.25"/>
        </Configuration>
    </OrderItem>
    <OrderItem articleID="A3380" articleName="Premium Spheric 6er Box"
      clientOrderItemID="LOOK4-WLK-03" deliveryQuantity="1"
      referenceName="Stock" unitOfMeasure="boxes" clientOrderID="00023-345785"
      netPurchasePrice="12" >
        <Configuration>
            <Feature templateID="UpcCode" selectedValue="123456789125"/>
            <Feature templateID="Diameter" selectedValue="13.6"/>
            <Feature templateID="RadiusBasecurve" selectedValue="8.3"/>
            <Feature templateID="Sphere" selectedValue="-2.5"/>
        </Configuration>
    </OrderItem>
</OrderItems>

Attributes of the element OrderItem

Attribute	Type / Use	Description / Example
addressID	xs:string optional	Address ID (e.g. 123456)
advancedShippingNoteItemID	xs:string optional	Unique ASN item number (e.g. ASN-2011-02-14-342-01)
articleID	xs:string required	Unique article number at supplier (e.g. A2780)
articleName	xs:string optional	Name of the article (e.g. Contact Life Spheric Box)
articleType	xs:string optional	Item type (as defined in the template, e.g. contactlenses, others) (e.g. contactlenses)
chargeNumber	xs:string optional	Charge number. Material charge no. for soft contact lenses. (e.g. CH63674343)
clientArticleID	xs:string optional	Unique article number at client (e.g. CL-CLSB-1234)
clientArticleName	xs:string optional	Article name at client (e.g. Woehlk - Contact Life Spheric Box)
clientOrderID	xs:string required	ID of the order at the purchaser, sender software of the order (e.g. 00023-345785)
clientOrderItemID	xs:string required	Unique number within the under the clientOrderID defined order at the purchaser, sender software of the order (e.g. LOOK4-WLK-01)
expirationDate	xs:date optional
deliveryDate	xs:dateTime optional	Delivery date, estimated receipt at the customer (e.g. 2011-02-15T11:48:34)
deliveryQuantity	xs:integer required	Delivered quantity in units of an order item like defined in the catalog (e.g. 1)
descr	xs:string optional	Description of the article (e.g. Contact Life Spheric Box)
eanCode	xs:string optional	EAN-Code, 13-digit (e.g. 7234567891234)
grossPrice	xs:decimal optional	Gross price (e.g. 16.00)
lotNumber	xs:string optional	Lot number. Serial no. for frames and individual contact lenses. (e.g. LN95184623)
netPurchasePrice	xs:decimal optional	Net purchase price (e.g. 11.00)
orderDate	xs:dateTime optional	Order date (e.g. 2011-02-11T11:48:34)
orderedQuantity	xs:integer optional	Ordered quantity in units of an order item like defined in the catalog (e.g. 1)
orderItemStatus	xs:string optional	Order status at supplier according to status definition in document order status (e.g. 5)
orderItemType	xs:NMTOKEN optional	(e.g. standard)
orderTransmissionType	xs:NMTOKEN optional	Order transmission type (e.g. edi)
referenceName	xs:string optional	Commission for the purchase order item, such as name of end customer or reference in recipient software (e.g. Stock)
shipmentPartnerID	xs:string optional	ID of logistics partner which is entrusted with the delivery of the shipment (e.g. DE713058544)
shippingDate	xs:dateTime optional	Shipping date, shipment at supplier (e.g. 2011-02-14T11:48:34)
supplierOrderID	xs:string optional	Order no. supplier (e.g. 123456)
supplierOrderItemID	xs:string optional	Order line no. supplier (e.g. Smith-WLK-01)
trackingID	xs:string optional	Tracking ID at logistics partner with which e.g. information about the shipment status can be queried (e.g. TR12341234)
trackingUrl	xs:string optional	URL at logistics (e.g. http://www.dhl.de/content/de/de/paket/kundenservice/sendungsverfolgung.html)
unitOfMeasure	xs:NMTOKEN optional	Unit of measure, standard values: bottles, boxes, pieces (e.g. boxes)
upcCode	xs:string optional	UPC-Code, 12-digit (e.g. 723456789123)

Element Feature

Several features can be assigned within a configuration. The features result from the definition of the article in the product catalog (catalog.xml). Here at least all product properties must be specified, that are defined in the catalog as relevant for order (with the attribute includeInOrder=true). So is ensured that the article can be uniquely identified.

Attributes of the element Feature

Attribute	Type / Use	Description / Example
selectedValue	xs:string required	Values according to the parameter (e.g. 14.2)
templateID	xs:string required	Name of the parameter (e.g. Diameter)

Issue of the exact identification of an item at the recipient

For items that were ordered electronically or items that have a bar code (EAN/UPC code) the exact identification of the article is easy.

If none of it is the case, it is mandatory that the feature list in Configuration definitely contains all basic features that are defined in the catalog as feature with includeInOrder=true.

Example code of a file AdvancedShippingNote.xml

<AdvancedShippingNote xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation=
  "https://templates.look4optics.com/v_1_13/AdvancedShippingNote.xsd"
  advancedShippingNoteID="ASN-2017-02-14-342"
  generatorInfo="Look4 Webservices Test" generationDate="2017-02-14T11:48:34"
  schemaMajorVersionID="1" schemaMinorVersionID="12" currency="Euro"
  vatRate="19" >
    <Supplier supplierID="DE813058544" supplierName="Woehlk"
      vatID="DE813058544">
        <Addresses>
            <Address addressID="1" addressType="MainAddress"
              name="Wöhlk-Contact-Linsen GmbH"
              street="Bürgermeister Schade Str. 16" zip="24232"
              city="Schönkirchen" isoCountryCode="DE" phone="+49-431-991-0"
              fax="+49-431-991-11-02" email="info@lieferant.de"/>
        </Addresses>
    </Supplier>
    <Client clientID="00011" clientName="Testkunde11">
        <Addresses>
            <Address clientType="Retailer" addressID="2"
              addressType="BillingAddress"
              name="Smith Optics Ltd. Administration Office"
              street="Long street 347" zip="DN2 2NE" city="London"
              isoCountryCode="GB" phone="+0044 1302 344 123"
              fax="+0044 1302 344 321"
              email="central@optician-test-smith.co.uk" />
        </Addresses>
    </Client>
    <ShipmentPartner shipmentPartnerID="DE123456789"
      shipmentPartnerName="Shipping International" vatID="DE123456789"
      responseMail="mail@shipmentpartner.de">
        <Addresses>
            <Address addressID ="2" addressType ="ShippingAddress"
              name="Shipping International" street="Hafenstraße 1"
              zip="20059" city="Hamburg" isoCountryCode="DE"
              phone="+49-12345-65498" fax="+49-12345-65498"
              email="mail@shipmentpartner.de"/>
        </Addresses>
    </ShipmentPartner>
    <OrderItems>
    <OrderItem articleID="A2780" articleName="Contact Life Spheric Box"
      clientOrderItemID="LOOK4-WLK-01" deliveryQuantity="1"
      referenceName="Stock" unitOfMeasure="boxes" clientOrderID="00023-345785"
      netPurchasePrice="10" >
        <Configuration>
            <Feature templateID="UpcCode" selectedValue="123456789123"/>
            <Feature templateID="Diameter" selectedValue="13.6"/>
            <Feature templateID="RadiusBasecurve" selectedValue="8.3"/>
            <Feature templateID="Sphere" selectedValue="-3"/>
        </Configuration>
    </OrderItem>
    <OrderItem articleID="A2780" articleName="Contact Life Spheric Box"
      clientOrderItemID="LOOK4-WLK-02" deliveryQuantity="1"
      referenceName="Stock" unitOfMeasure="boxes" clientOrderID="00023-345785"
      netPurchasePrice="11" >
        <Configuration>
            <Feature templateID="UpcCode" selectedValue="123456789124"/>
            <Feature templateID="Diameter" selectedValue="14.2"/>
            <Feature templateID="RadiusBasecurve" selectedValue="8.8"/>
            <Feature templateID="Sphere" selectedValue="0.25"/>
        </Configuration>
    </OrderItem>
    <OrderItem articleID="A3380" articleName="Premium Spheric 6er Box"
      clientOrderItemID="LOOK4-WLK-03" deliveryQuantity="1"
      referenceName="Stock" unitOfMeasure="boxes" clientOrderID="00023-345785"
      netPurchasePrice="12" >
        <Configuration>
            <Feature templateID="UpcCode" selectedValue="123456789125"/>
            <Feature templateID="Diameter" selectedValue="13.6"/>
            <Feature templateID="RadiusBasecurve" selectedValue="8.3"/>
            <Feature templateID="Sphere" selectedValue="-2.5"/>
        </Configuration>
    </OrderItem>
</OrderItems>
</AdvancedShippingNote>