Formatbeschreibung_Order_Orderresponse_11_11_2005
Transcrição
Formatbeschreibung_Order_Orderresponse_11_11_2005
Formatbeschreibung „Orders – (Bestellungen) und Orderresponse (Statusaustausch für CL-Bestellungen)“ Arbeitsdokument erstellt von: Georg Weiß LOOK4 COMPANY GmbH Schwarzkehlchenweg 4 79111 Freiburg am: 20.10.2005 Formatbeschreibung_Order_Orderresponse_26_10_2005.doc Seite 1 von 10 1 Inhaltsverzeichnis 1 Inhaltsverzeichnis......................................................................................................................... 2 2 Aufbau des Bestellformates (Order) .............................................................................................. 3 2.1 Das Element Order .................................................................................................................... 3 2.2 Das Element client ..................................................................................................................... 4 2.3 Das Element OrderItems ............................................................................................................ 5 2.3.1 Das Element Configuration .........................................................................................6 3 Beispiel-XML-Code für eine komplette Bestellung ........................................................................ 7 4 Aufbau des Formates für Austausch von Auftragsstati (OrderResponse) .................................... 8 4.1 Das Element OrderResponse ..................................................................................................... 8 4.2 Das Element OrderItem .............................................................................................................. 8 4.2.1 Standardwerte für das Attribut orderStatus ..................................................................9 5 Beispiel-XML-Code für eine Statusaustauschdatei ....................................................................... 9 5.1 HTML -Dokumentation zum Katalog-Schema ............................................................................. 10 5.2 HTML -Dokumentation zum Templates-Schema ......................................................................... 10 5.3 HTML -Dokumentation zum Orders-Schema............................................................................... 10 5.4 HTML -Dokumentation zum OrderResponce-Schema ................................................................. 10 5.5 Spezielle Anwendungsbeispiele................................................................................................ 10 Formatbeschreibung_Order_Orderresponse_26_10_2005.doc Seite 2 von 10 2 Aufbau des Bestellformates (Order) Das Bestellformat Basiert auf dem Katalogformat. Es gliedert sich in die zwei Bereiche Client, OrderItems. Im Kopfbereich werden allgemeine Informationen zur Bestellung definiert. Dann besteht die Möglichkeit optional Adressinformationen zum Besteller anzugeben. Im Anschluss erfolgt die Beschreibung der einzelnen Auftragspositionen. Hier sind alle Produktmerkmale enthalten, die im Katalog als bestellrelevant (includeInOrder = true)definiert sind. Jede Auftragsposition enthält eine gültige Konfiguration aus den im Katalog definierte n Konfigurationsvarianten. 2.1 Das Element Order Das Element Order enthält die Elemente Client (Informationen zum Besteller) und OrderItems (Bestellpositionen) Das Element Order beginnt mit der Definition allgemeiner Informationen zur Bestellung. Für die Beschreibung stehen nachfolgende Attribute zur Verfügung: Attribut supplierID supplierName customerOrderID generationDate generatorInfo catalogID catalogName Beschreibung UstID des Herstellers an den die Bestellung gesendet wird Name des Herstellers an den die Bestellung gesendet wird ID der Bestellung (des Übertragungssatzes) auf Senderseite Datum/Zeit der Auftragserstellung Information zur Generierungsquelle (Bezeichnung/Version der Software) Version des Katalogformates auf dessen Basis die Erfassung der Auftragspositionen erfolgte Name des Kataloges auf dessen Basis die Erfassung erfolgte. Typ required optional required required optional optional optional <order catalogID="1.1" catalogName="Produktkatalog Wöhlk 2004/2005" supplierID="CIBA" clientOrderID="00001-334455667788" generationDate="06.10.2005 11:16" generatorInfo="P&P EASY Version 1.242" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.cl-forum.de/Schema/Orders.xsd"> Formatbeschreibung_Order_Orderresponse_26_10_2005.doc Seite 3 von 10 2.2 Das Element client Das Element Client enthält die zwei Attribute clientID (Kundennummer beim Lieferanten) und clientName (Firmenname). Zusätzlich können optional noch Adressangaben gemacht werden. (z.B. Lieferadresse – ggf. auch für Endkunden, falls diese nicht mit der Bestelladresse übereinstimmt) Das Element Address hat folgende Attribute: Attribut addressID addressType Beschreibung AdressID Eindeutige ID für eine Adresse. Diese kann später einem oder mehreren Aufträgen zugeordnet werden > Abweichende Lieferadresse Adresstyp Standardwerte: MainAdress (Hauptadresse) OtherShippingAdress (abweichende Lieferadresse) BillingAdress (Rechnungsadresse) clientType Beispiel Typ 12 required MainAdress required StandardClient Otto Meier GmbH Augenoptik und Schmuck Hauptstraße 456 89643 Frankfurt DE 07421-93 02 893 07421-93 02 894 [email protected] required required optional required required required required optional optional optional Kundenart: Standardwerte: Retailer (Händler) Consumer (Endverbraucher) Firmenname name Firmenname2 name2 Straße street Postleitzahl zip Ort city isoCountryCode ISO-Ländercode Telefon phone Fax fax Email email Beispiel-XML-Code: <Addresses> <Address clientType="Retailer" adressID="1" addressType="ShippingAddress" name="Otto Meier GmbH" name2="Augenoptik und Schmuck" street="Hauptstraße 456" zip="89643" city="Frankfurt" isoCountryCode="DE" phone="07421-93 02 893" fax="07421-93 02 894" email="[email protected]"/> <!-- Abweichende Lieferadresse / z.B. Filial -Adesse--> <Address clientType="Consumer" adressID="2" addressType="ShippingAddress" name="Herr Georg Müller" street="Kundenweg 56" zip="89643" city="Heimhausen " isoCountryCode="DE" phone="07421-93 02 893" fax="07421-93 02 894 "/> <!-- Abweichende Lieferadresse - Endverbraucher --> <Address adressID="3" addressType="BillingAddress " name="Otto Meier" name2="Augenoptik und Schmuck " street="Dorfstr. 8 " zip="74291" city="Oberbergen" isoCountryCode="DE" phone="07421-93 02 893" fax="07421-93 02 894 " email="[email protected]"/> <!-- Abweichende Rechnungsanschrift--> </Addresses> Formatbeschreibung_Order_Orderresponse_26_10_2005.doc Seite 4 von 10 2.3 Das Element OrderItems Jedes Element OrderItems kann aus einem oder mehreren Elementen OrderItem bestehen. Jedes OrderItem stellt eine Bestellposition dar. Zur Beschreibung stehen folgende Attribute zur Verfügung: Attribut articleID articleName adressID clientOrderItemID referenceName deliveryDate Beschreibung Artikelnummer beim Lieferant Artikelname ID der zugehörigen Adresse ID die (eindeutig) das OrderItem auf Senderseite bezeichnet. Kommission (Kunde/Auftragsnummer AO) gewünschter Liefertermin Beispiel 37549 Weflex spezial 12 Typ required required optional CL17549 Frau Müller 22.10.2005 required optional optional Beispiel-XML-Code: <OrderItems> <OrderItem articleID="VIS" articleName="CIBASOFT Visitint" clientOrderItemID="89R" referenceName="L' Adeur , Stefan" adressID="1"> <!-- Anzahl der Configuration -Blöcke ergibt sich aus Configlines im Katalog --> <!-- Ist die Seite relevant muss diese als Feature (EyeSide) in der Configuration angegeben werden --> <Configuration quantity="1"> <Feature templateID="EyeSide" selectedValue="right"/> <Feature templateID="Diameter" selectedValue="14.35"/> <Feature templateID="RadiusBasecurve" selectedValue="8.50"/> <Feature templateID="Sphere" selectedValue="19.25"/> </Configuration> </OrderItem> <OrderItem articleID="VIS" articleName="CIBASOFT Visitint" clientOrderItemID="89L" referenceName ="L' Adeur , Stefan" adressID="1"> <Configuration quantity="1"> <Feature templateID="EyeSide" selectedValue="left"/> <Feature templateID="Diameter" selectedValue="0.00"/> <Feature templateID="Sphere" selectedValue="0.00"/> </Configuration> </OrderItem> <OrderItem articleID="Fit55-toricUV" articleName="Fit 55-toric UV" clientOrderItemID="71R" referenceName="Herr Klaus" adressID="3"> <Configuration quantity="5"> <Feature templateID="EyeSide" selectedValue="right"/> <Feature templateID="Diameter" selectedValue="0.00"/> <Feature templateID="Sphere" selectedValue="0.00"/> </Configuration> </OrderItem> <OrderItem articleID="Fit55-toricUV" articleName="Fit 55-toric UV" clientOrderItemID="71R" referenceName="Herr Meier" adressID="2"> <Configuration quantity="1"> <Feature templateID="EyeSide" selectedValue="right"/> <Feature templateID="Diameter" selectedValue="8.00"/> <Feature templateID="Sphere" selectedValue="2.00"/> </Configuration> </OrderItem> </OrderItems> Formatbeschreibung_Order_Orderresponse_26_10_2005.doc Seite 5 von 10 2.3.1 Das Element Configuration Im Element Configuration wird die Konfiguration des Artikels beschrieben. Über das Attribut quantity wird die gewünschte Stückzahl dieser Konfiguration angegeben. Jede Konfiguration enthält eine Aufzählung der bestellrelevanten Produktmerkmale (Features). Die Gültigkeiten für den jeweiligen Artikel sind über den Katalog definiert. Beispiel-XML-Code: Configuration quantitiy=" 2"> <!--alle Produkt- Features im Catalog mit IncludeInOrder=true gekennzeichnet--> <Feature templateID=" Sphere" selectedValue ="2.25"/> <Feature templateID=" EyeSide" selectedValue ="right"/> <Feature templateID=" Material" selectedValue ="Bo- ES- UV"/> <Feature templateID=" Color" selectedValue=" 12"/> </Configuration> Formatbeschreibung_Order_Orderresponse_26_10_2005.doc Seite 6 von 10 3 Beispiel-XML-Code für eine komplette Bestellung <?xml version="1.0" encoding="utf-8"?> <Order catalogID="1.1" catalogName="Produktkatalog Wöhlk 2004/2005" supplierID="CIBA" clientOrderID ="00001-334455667788" generationDate ="06.10.2005 11:16" generatorInfo ="P&P EASY Version 1.242" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance " xsi:noNamespaceSchemaLocation ="http://www.cl-forum.de/Schema/Orders.xsd"> <Client clientID="334455667788" clientName="Brillen und Mehr Heitmann Optik "> <!-- Optional--> <Addresses> <Address clientType="Retailer" adressID="1" addressType="ShippingAddress" name="Otto Meier GmbH" name2="Augenoptik und Schmuck" street="Hauptstraße 456" zip="89643" city="Frankfurt" isoCountryCode="DE" phone="07421-93 02 893" fax="07421-93 02 894" email="[email protected]"/> <!-- Abweichende Lieferadresse / z.B. Filial -Adesse--> <Address clientType="Consumer" adressID="2" addressType="ShippingAddress" name="Herr Georg Müller" street="Kundenweg 56" zip="89643" city="Heimhausen " isoCountryCode="DE" phone="07421-93 02 893" fax="07421-93 02 894 "/> <!-- Abweichende Lieferadresse - Endverbraucher --> <Address adressID="3" addressType="BillingAddress " name="Otto Meier" name2="Augenoptik und Schmuck " street="Dorfstr. 8 " zip="74291" city="Oberbergen" isoCountryCode="DE" phone="07421-93 02 893" fax="07421-93 02 894 " email="[email protected]"/> <!-- Abweichende Rechnungsanschrift--> </Addresses> </Client> <OrderItems> <OrderItem articleID="VIS" articleName="CIBASOFT Visitint" clientOrderItemID="89R" referenceName ="L' Adeur , Stefan" adressID="1"> <!-- Anzahl der Configuration-Blöcke ergibt sich aus Configlines im Katalog --> <!-- Ist die Seite relevant muss diese als Feature (EyeSide) in der Configuration angegeben werden --> <Configuration quantity="1"> <Feature templateID="EyeSide" selectedValue="right"/> <Feature templateID="Diameter" selectedValue="14.35"/> <Feature templateID="RadiusBasecurve" selectedValue="8.50"/> <Feature templateID="RadiusBaseCurve2" selectedValue="8.40"/> <Feature templateID="Sphere" selectedValue="19.25"/> </Configuration> </OrderItem> <OrderItem articleID="VIS" articleName="CIBASOFT Visitint" clientOrderItemID="89L" referenceName ="L' Adeur , Stefan" adressID="1"> <Configuration quantity="1"> <Feature templateID="EyeSide" selectedValue="left"/> <Feature templateID="Diameter" selectedValue="0.00"/> <Feature templateID="Sphere" selectedValue="0.00"/> </Configuration> </OrderItem> <OrderItem articleID="Fit55-toricUV" articleName="Fit 55-toric UV" clientOrderItemID="71R" referenceName="Herr Klaus" adressID="3"> <Configuration quantity="5"> <Feature templateID="EyeSide" selectedValue="right"/> <Feature templateID="Diameter" selectedValue="0.00"/> <Feature templateID="Sphere" selectedValue="0.00"/> </Configuration> </OrderItem> <OrderItem articleID="Fit55-toricUV" articleName="Fit 55-toric UV" clientOrderItemID="71R" referenceName="Herr Meier" adressID="2"> <Configuration quantity="1"> <Feature templateID="EyeSide" selectedValue="right"/> <Feature templateID="Diameter" selectedValue="8.00"/> <Feature templateID="Sphere" selectedValue="2.00"/> </Configuration> </OrderItem> </OrderItems> </Order> Formatbeschreibung_Order_Orderresponse_26_10_2005.doc Seite 7 von 10 4 Aufbau des Formates für Austausch von Auftragsstati (OrderResponse) Auch das Format für den Statusaustausch basiert auf den beiden Formaten Catalog.xml und Order.xml. 4.1 Das Element OrderResponse Das Element Orderresponse besteht den Attributen clientID und clientName (optional)und dem Element OrderItems das aus einem oder mehreren Elementen OrderItem besteht. Das Element OrderResponse besitzt folgende Attribute: Attribut supplierID supplierName clientID clientName generationDate generatorInfo 4.2 Beschreibung Eindeutige ID des Lieferanten Name des Lieferanten ID des Kunden (Kundennummer beim Lieferanten) Name des Kunden Generierungsdatum Beschreibung der Generierungssoftware Beispiel CIBA CIBA Typ required optional 530457 Brillen Meier 28.10.2005 11:16 CIBA ERP required optional optional optional Beispiel 37549 Typ required 89R required 4 3 21.10.2005 Herr Müller 22.10.2005 24.10.2005 Post EAN13 DE20573898934 10 Durchmesser nicht lieferbar required required optional optional optional optional optional optional optional optional Das Element OrderItem Das Element OrderItem besitzt folgende Attribute: Attribut Beschreibung supplierOrderItemID ID der Bestellposition beim Lieferanten ID der Bestellposition beim Kunden (AOclientOrderItemID Software) orderStatus Mitzuteilender Auftragsstatus > siehe Werteliste deliveryQuantity Gelieferte Menge orderDate Generierungsdatum des Auftrags referenceName Kommision beim Kunden deliveryDate Lieferdatum shipment Date Versanddatum shipmentType Versandart itemCodeType Art des Artikel-Codes itemCodeValue Artikelcode (Wert) errorCode Definierter Fehlercode errorDescription Fehlermeldung als Text Formatbeschreibung_Order_Orderresponse_26_10_2005.doc optional Seite 8 von 10 4.2.1 Standardwerte für das Attribut orderStatus Wert 1 2 3 4 5 10 Beschreibung Transmitted (Bestellung wurde an Hersteller übermittelt MailReceived (Hersteller hat die Mail erhalten) In Progress (Auftrag beim Hersteller in Bearbeitung) DeliveryDate (Mitteilung des voraussichtlichen Liefertermins) Delivered (Bestellung wurde vom Hersteller versandt) Error (Fehler bei Auftragsbearbeitung - Definierte Fehlercodes zur aut. Auswertung und Fehlerbeschreibung als Text (Anzeige) 5 Beispiel-XML-Code für eine Statusaustauschdatei <?xml version="1.0" encoding="utf-8"?> <OrderResponse supplierID="UstID des Herstellers" supplierName="CIBA" clientID ="334455667788" clientName="Brillen und Mehr Heitmann Optik" generationDate="28.10.2005 11:16" generatorInfo="CIBA ERP " xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation ="http://www.cl-forum.de/Schema/OrderResponse.xsd"> <OrderItems> <OrderItem supplierOrderItemID="72974021" clientOrderItemID ="89R" orderStatus="2" orderDate="22.10.2005" referenceName="L' Adeur , Stefan"/> <!-- Empfangsbetätigung des Herstellers --> <OrderItem supplierOrderItemID="72974022" clientOrderItemID ="89L" orderStatus="2" orderDate="22.10.2005" referenceName="L' Adeur , Stefan"/> <!-- Empfangsbetätigung des Herstellers --> <OrderItem supplierOrderItemID="72974023" clientOrderItemID ="71R" orderStatus="3" referenceName ="La, Klaus"/> <!-- Meldung in Produktion--> <OrderItem supplierOrderItemID="72974024" clientOrderItemID ="96R" orderStatus="4" deliveryQuantity="1" deliveryDate="26.10.2005" referenceName="Frau Meier"/> <!-- Mitteilung voraussichtlicher Liefertermin--> <OrderItem supplierOrderItemID="72974027" clientOrderItemID ="96L" orderStatus="4" deliveryQuantity="1" deliveryDate="26.10.2005" referenceName="Frau Meier"/> <!-- Mitteilung voraussichtlicher Liefertermin--> <OrderItem supplierOrderItemID="72974028" clientOrderItemID ="63" orderStatus="5" deliveryQuantity="4" deliveryDate="27.10.2005" referenceName="Lager"/> <!-- Änderungsmitteilung voraussichtlicher Liefertermin (zweite, dritte,.. Mitteilung)--> <OrderItem supplierOrderItemID="72974045" clientOrderItemID ="68" orderStatus="6" deliveryQuantity="1" deliveryDate="26.10.2005" referenceName="Lager" shipmentDate="28.10.2005" shipmentType="Transmed"/> <!-- Versand-Mitteilung --> <OrderItem supplierOrderItemID="72974053" clientOrderItemID ="74" orderStatus="7" deliveryQuantity="2" deliveryDate="26.10.2005" referenceName="Lager" shipmentDate="28.10.2005" shipmentType="Post" itemCodeType="EAN13" itemCodeValue ="DE8363848"/> <!-- Versand-Mitteilung mit Barcode-Übermittlung--> <OrderItem supplierOrderItemID="72974021" clientOrderItemID ="89R" orderStatus="10" referenceName ="L' Adeur , Stefan" errorCode="44" errorDescription="leider nicht mehr lieferbar"/> <!-- Fehlermeldung mit Beschreibung--> </OrderItems> </OrderResponse> Formatbeschreibung_Order_Orderresponse_26_10_2005.doc Seite 9 von 10 5.1 HTML-Dokumentation zum Katalog-Schema 5.2 HTML-Dokumentation zum Templates-Schema 5.3 HTML-Dokumentation zum Orders-Schema 5.4 HTML-Dokumentation zum OrderResponce-Schema 5.5 Spezielle Anwendungsbeispiele Diese Unterlagen fi nden Sie Online unter www.cl-forum.de Formatbeschreibung_Order_Orderresponse_26_10_2005.doc Seite 10 von 10