Formatbeschreibung: AdvancedShippingNote

Allgemeines

Das XML-Format für Lieferavis – engl. AdvancedShippingNote - basiert auf dem Standardformat für XML-Kataloge. Auf diesem aufbauend wurden verschiedene auf einander abgestimmte Dokumente für Anwendungen innerhalb der Supply-Chain-Prozesse definiert.

Das Dokument AdvancedShippingNote dient der Vorab-Information über Warenlieferungen um auf Empfängerseite automatisiert Prozesse mit den notwendigen Informationen anstoßen zu können:

• Aktualisierung der Lagerbuchhaltung

• Einleitung von Logistik-Prozessen

• Verwaltung der Disposition

• Überwachung der Fakturierung

Die Validierung erfolgt auf Basis der jeweils aktuellsten Schema-Version. Diese ist unter folgender Url erreichbar:

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

Dokumenten-Struktur

Das XML-Format für Lieferavis gliedert sich in 5 Bereiche bestehend aus den Hauptelementen AdvancedShippingNote, Supplier, Client, ShipmentPartner und OrderItems.

Detaillierte Formatbeschreibung

Element AdvancedShippingNote

Beispiel 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="13" currency="Euro"
  vatRate="19" >
</AdvancedShippingNote>

Attribute	Type / Use	Description / Example
advancedShippingNoteID	xs:string required	ASN Nummer des Lieferanten (z.B. ASN-2011-02-14-342)
currency	xs:string optional	Währung (z.B. EURO)
generationDate	xs:dateTime required	Datum u. Zeit der Auftragserstellung (z.B. 2011-02-11T11:48:34)
generatorInfo	xs:string optional	Information zur Generierungsquelle (Bezeichnung/Version der Software) (z.B. Look4 Webservices Test)
schemaMajorVersionID	xs:integer required	Hauptversionsnummer (z.B. 1)
schemaMinorVersionID	xs:integer required	Unterversionsnummer (z.B. 0)
vatRate	xs:decimal optional	Mehrwertsteuersatz (z.B. 19)

Element Supplier

Das Element Supplier beinhaltet alle Informationen zum Lieferanten der bestellten Ware. Es besteht aus einem Unterelement Addresses mit mindestens einem Unterelement Address in dem die Adressdaten für jeweils eine Adresse angegeben werden.

Beispiel 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>

Attribute des Elements Supplier

Attribute	Type / Use	Description / Example
clientSupplierID	xs:string optional	ID des Herstellers beim Kunden (z.B. Woehlk-123456)
responseMail	xs:string optional	Emailadresse für Antworten zu dieser Nachricht (z.B. info@woehlk.com)
supplierID	xs:string required	ID des Lieferanten, UmsatzsteuerID (z.B. DE813058544)
supplierName	xs:string optional	Name des Lieferanten (z.B. Woehlk)
vatID	xs:string optional	Umsatzsteuer-ID des Lieferanten (z.B. DE813058544)

Attribute des Elements Address

Attribute	Type / Use	Description / Example
addressID	xs:string required	Eindeutige Adress-ID. Diese kann später mit einer oder mehreren Bestellungen verknüpft werden. (z.B. 123456)
addressType	xs:NMTOKEN required	Standard Werte: MainAdress, ShippingAddress, BillingAddress (z.B. MainAdress)
city	xs:string required	Stadt (z.B. Schoenkirchen)
clientBranchID	xs:string optional	Kunden-Filialnummer (z.B. 1234)
clientType	xs:NMTOKEN optional	Kundenart (z.B. Retailer)
email	xs:string optional	E-mail (z.B. info@woehlk.com)
fax	xs:string optional	Fax (z.B. +49 (0)800-963 45 55)
isoCountryCode	xs:string required	ISO-Länderkennzeichen (z.B. DE)
name	xs:string required	Name (z.B. Woehlk-Contact-Linsen GmbH)
phone	xs:string optional	Telefon (z.B. +49 (0)800-963 45 55)
street	xs:string required	Strasse (z.B. Buergermeister-Schade-Strasse 12-16)
zip	xs:string required	PLZ (z.B. 24232)

In jedem Address - Element kann jeweils ein Adresssatz definiert werden. Die Angabe mindestens einer Adresse ist zwingend.

Element Client

Das Element Client beinhaltet alle Informationen zum Besteller der versandten Ware. Es besteht aus einem Unterelement Addresses mit mindestens einem Unterelement Address in dem die Adressdaten für jeweils eine Adresse angegeben werden.

Beispiel XML-Code:

<Client clientID="00011" clientName="Testkunde11" >
    <Addresses>
        <Address clientType="Retailer" addressID="2"
        addressType="BillingAddress"
        name="Schmidt Optik GmbH Verwaltung"
        street="Hauptstrasse 123" zip="10999" city="Berlin"
        isoCountryCode="DE" phone="+0049 030 123456-0"
        fax="+0049 030 123456-1" email="zentrale@optik-test-schmidt.de" />
    </Addresses>
</Client>

Attribute des Elements Client

Attribute	Type / Use	Description / Example
clientID	xs:string required	Kundennummer (z.B. 012345)
clientName	xs:string optional	Kundenname (z.B. Schmidt Optik GmbH)
responseMail	xs:string optional	Emailadresse für Antworten zu dieser Nachricht (z.B. antwort@optik-test-schmidt.de)
vatID	xs:string optional	Umsatzsteuer-ID des Kunden (z.B. DE713058544)

Attribute des Elements ``Address`` > siehe Attribute unter Element ``Supplier``

In jedem Address-Element kann jeweils ein Adresssatz definiert werden. Die Angabe mindestens einer Adresse ist zwingend.

Element ShipmentPartner

Das Element ShipmentPartner beinhaltet alle Informationen zum der mit dem Versand beauftragten Logistikpartner. Es besteht aus einem Unterelement Addresses mit mindestens einem Unterelement Address in dem die Adressdaten für jeweils eine Adresse angegeben werden.

Beispiel 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>

Attribute des Elements ShipmentPartner

Attribute	Type / Use	Description / Example
responseMail	xs:string optional	Emailadresse für Antworten zu dieser Nachricht (z.B. response@shipment-partner.com)
shipmentPartnerID	xs:string required	ID des Logistikpartners, UmsatzsteuerID (z.B. DE713058544)
shipmentPartnerName	xs:string optional	Name des Logistikpartners (z.B. DHL International)
vatID	xs:string optional	UmsatzsteuerID des Logistikpartners (z.B. DE713058544)

Attribute des Elements ``Address`` > siehe Attribute unter Element ``Supplier``

Element OrderItems

Das Element OrderItems beinhaltet alle Informationen zu den in der Lieferung enthaltenen Auftragspositionen. Es besteht aus beliebig vielen Unterelementen OrderItem. Jedes OrderItem beinhaltet alle Informationen zu der Lieferung einer Auftragsposition eines bestimmten Auftrages. Das heißt ein Lieferavis-Dokument kann auch Informationen zu Auftragspositionen aus mehreren unterschiedlichen Bestellungen beinhalten.

Beispiel 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>

Attribute des Elements OrderItem

Attribute	Type / Use	Description / Example
addressID	xs:string optional	Adress-ID (z.B. 123456)
advancedShippingNoteItemID	xs:string optional	Eindeutige ASN Positionsnummer (z.B. ASN-2011-02-14-342-01)
articleID	xs:string required	Eindeutige Artikelnummer beim Lieferanten (z.B. A2780)
articleName	xs:string optional	Name des Artikels (z.B. Contact Life Spheric Box)
articleType	xs:string optional	Artikel Typ (z.B. contactlenses)
chargeNumber	xs:string optional	Chargen Nummer. Material-Chargennummer für weiche Kontaktlinsen. (z.B. CH63674343)
clientArticleID	xs:string optional	Eindeutige Artikelnummer beim Kunden (z.B. CL-CLSB-1234)
clientArticleName	xs:string optional	Eindeutige Artikelnummer beim Kunden (z.B. Woehlk - Contact Life Spheric Box)
clientOrderID	xs:string required	ID des Auftrags beim Besteller (z.B. 00023-345785)
clientOrderItemID	xs:string required	ID des Auftrags beim Besteller (z.B. LOOK4-WLK-01)
expirationDate	xs:date optional
deliveryDate	xs:dateTime optional	Lieferdatum, voraussichtlicher Wareneingang beim Kunden (z.B. 2011-02-15T11:48:34)
deliveryQuantity	xs:integer required	Gelieferte Menge in Einheiten einer Auftragsposition wie sie im Katalog definiert sind (z.B. 1)
descr	xs:string optional	Name des Artikels (z.B. Contact Life Spheric Box)
eanCode	xs:string optional	EAN-Code, 13 Ziffern (z.B. 7234567891234)
grossPrice	xs:decimal optional	(z.B. 16.00)
lotNumber	xs:string optional	Lot Nummer. Seriennummer für Fassungen und formstabile Kontaktlinsen. (z.B. LN95184623)
netPurchasePrice	xs:decimal optional	Netto-Einkaufspreis (z.B. 11.00)
orderDate	xs:dateTime optional	Bestelldatum (z.B. 2011-02-11T11:48:34)
orderedQuantity	xs:integer optional	Bestellte Menge in Einheiten einer Auftragsposition wie sie im Katalog definiert sind (z.B. 1)
orderItemStatus	xs:string optional	Auftragsstatus beim Lieferanten entsprechend Statidefinition in Dokument Orderstatus (z.B. 5)
orderItemType	xs:NMTOKEN optional	Positionsart: standard, freeOfCharge, returns (z.B. standard)
orderTransmissionType	xs:NMTOKEN optional	Bestellung Übermittlungstyp (z.B. edi)
referenceName	xs:string optional	Kommission zur Bestellposition, z.B. Name des Endkunden oder Referenz in Empfängersoftware (z.B. Stock)
shipmentPartnerID	xs:string optional	ID des Logistikpartners, der mit der Zustellung der Lieferung beauftragt ist (z.B. DE713058544)
shippingDate	xs:dateTime optional	Versanddatum, Warenausgang beim Lieferanten (z.B. 2011-02-14T11:48:34)
supplierOrderID	xs:string optional	(z.B. 123456)
supplierOrderItemID	xs:string optional	(z.B. Smith-WLK-01)
trackingID	xs:string optional	TrackingID beim LogistikPartner über den z.B. Infos zum Versandstatus abgefragt werden können (z.B. TR12341234)
trackingUrl	xs:string optional	URL über die beim Logistik-Partner Infos zum Versandsatus abgefragt werden können (z.B. http://www.dhl.de/content/de/de/paket/kundenservice/sendungsverfolgung.html)
unitOfMeasure	xs:NMTOKEN optional	Bestellmengeneinheit, Standard Werte: bottles, boxes, pieces (z.B. boxes)
upcCode	xs:string optional	UPC-Code, 12 Ziffern (z.B. 723456789123)

Element Feature

Innerhalb einer Configuration können mehrere Features zugeordnet sein. Die Features ergeben sich aus der Definition des Artikels im Produktkatalog (catalog.xml). Hier müssen zumindest alle Produkteigenschaften angegeben sein, die im Katalog als bestellrelevant (mit dem Attribut includeInOrder=true) definiert sind. So ist sicher gestellt, dass der Artikel eindeutig identifiziert werden kann.

Attribute des Elements Feature

Attribute	Type / Use	Description / Example
selectedValue	xs:string required	Wert der entsprechenden Produkteigenschaft (z.B. 14.2)
templateID	xs:string required	Name des Parameters (z.B. Diameter)

Problematik der genauen Identifikation eines Artikels beim Empfänger

Für Artikel die elektronisch bestellt wurden oder Artikel, die über einen Barcode (EAN/UPC-Code) verfügen ist die genaue Identifikation des Artikels unproblematisch. Ist keines von beiden der Fall, so ist es zwingend erforderlich, dass die Feature-Liste in Configuration garantiert alle wesentlichen Features umfasst, die im Katalog als Features mit includeInOrder=true gekennzeichnet sind.

Beispielcode einer Datei 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="13" 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="Schmidt Optik GmbH Verwaltung"
        street="Hauptstrasse 123" zip="10999" city="Berlin"
        isoCountryCode="DE" phone="+0049 030 123456-0"
        fax="+0049 030 123456-1" email="zentrale@optik-test-schmidt.de" />
    </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>