openTRANS 2.0

Einführung

Für die Übergabe von Warenkörben/Bestellungen an externe Systeme (z.B. Warenwirtschaften) verwenden wir das Format openTRANS in den Versionen 1.0 und 2.0. Die vollständige Beschreibung des openTRANS-Standards finden Sie auf der openTRANS Website, diese Dokumentation beschreibt daher nur Besonderheiten unserer Implementierung sowie die verwendeten Felder.

openTRANS ist ein offener Standard zur Unterstützung des elektronischen Datenaustauschs (EDI) bei Geschäftstransaktionen zwischen Handelsunternehmen. Der Standard begründete sich in einer Initiative von Industrie- und Handelsunternehmen unter der Leitung von Fraunhofer IAO in Kooperation mit der Universität Duisburg-Essen BLI mit dem Ziel einer Standardisierung von Geschäftsprozessdokumenten (z. B. Lieferavis, Rechnung) als Grundlage für eine elektronische System-zu-System-Kommunikation.

Quelle: wikipedia (https://de.wikipedia.org/wiki/OpenTRANS)

Überblick

openTRANS 2.0 ist die von uns aktuell unterstützte Version. Verwenden Sie eine der Implementierungen für neue Schnittstellen. Anpassungen sind bei begründetem Bedarf möglich und werden als eine eigene Schnittstellenversion geführt. Bitte wenden Sie sich bei Bedarf per Mail an support@cobai.com und beschreiben Sie Ihren Anwendungsfall.

Für Version 2.0 der openTRANS-Schnittstelle existieren die folgenden Implementierungen:

Standard
Unsere Standardimplementierung. Bei Bedarf werden Erweiterungen implementiert, der vorhandene Funktionsumfang bleibt aber garantiert erhalten. Sollten Erweiterungen die Abwärtskompatibilität beeinträchtigen erzeugen wir eine neue Variante der Schnittstelle
Gega-IT
Eine angepasste Version für Nutzer des Warenwirtschaftssystems der Firma Gega-IT. Sie können dieses Format auch für andere Anbindungen verwenden, wir garantieren allerdings nicht das der implementierte Umfang erhalten bleibt.

openTRANS 2.0 - Standardformat

Beispielbestellung

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ORDER version="2.0" type="standard">
    <ORDER_HEADER>
        <CONTROL_INFO>
            <GENERATOR_INFO>cobai.com openTRANS 2.0 generator</GENERATOR_INFO>
            <GENERATION_DATE>2017-02-16T19:06:01+01:00</GENERATION_DATE>
        </CONTROL_INFO>
        <ORDER_INFO>
            <ORDER_ID>56c00770-d81f-11e6-8169-02c01b511db7</ORDER_ID>
            <ORDER_DATE>2017-01-11T18:01:33.967+01:00</ORDER_DATE>
            <PARTIES>
                <PARTY>
                    <PARTY_ID type="supplier_specific">5</PARTY_ID>
                    <PARTY_ROLE>buyer</PARTY_ROLE>
                    <ADDRESS>
                        <NAME>Roadshow-Kunde</NAME>
                        <NAME2>Name 2 des Kunden</NAME2>
                        <STREET>Lange Straße 1</STREET>
                        <ZIP>12345</ZIP>
                        <CITY>Weitweitweg</CITY>
                        <EMAIL>dirk.lachowski@lacho.net</EMAIL>
                    </ADDRESS>
                </PARTY>
                <PARTY>
                    <PARTY_ID type="gln">4044581000000</PARTY_ID>
                    <PARTY_ROLE>intermediary</PARTY_ROLE>
                </PARTY>
                <PARTY>
                    <PARTY_ID type="buyer_specific">5</PARTY_ID>
                    <PARTY_ROLE>delivery</PARTY_ROLE>
                    <ADDRESS>
                        <NAME>Roadshow-Kunde</NAME>
                        <NAME2>Name 2 des Kunden</NAME2>
                        <CONTACT_DETAILS>
                            <CONTACT_ID>t</CONTACT_ID>
                            <CONTACT_NAME>Test</CONTACT_NAME>
                            <FIRST_NAME>Thomas</FIRST_NAME>
                            <PHONE>05132-86460</PHONE>
                            <FAX></FAX>
                            <EMAILS>
<EMAIL>dirk.lachowski@lacho.net</EMAIL>
                            </EMAILS>
                        </CONTACT_DETAILS>
                        <STREET>Lange Straße 1</STREET>
                        <ZIP>12345</ZIP>
                        <CITY>Weitweitweg</CITY>
                        <EMAIL>dirk.lachowski@lacho.net</EMAIL>
                    </ADDRESS>
                </PARTY>
            </PARTIES>
            <ORDER_PARTIES_REFERENCE>
                <BUYER_IDREF type="party_specific">5</BUYER_IDREF>
                <SUPPLIER_IDREF type="iln">4044581000000</SUPPLIER_IDREF>
            </ORDER_PARTIES_REFERENCE>
            <CUSTOMER_ORDER_REFERENCE></CUSTOMER_ORDER_REFERENCE>
            <CURRENCY>EUR</CURRENCY>
        </ORDER_INFO>
    </ORDER_HEADER>
    <ORDER_ITEM_LIST>
        <ORDER_ITEM>
            <LINE_ITEM_ID>1</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>220164001</SUPPLIER_PID>
                <DESCRIPTION_SHORT>Stuhlkarren 1335 L</DESCRIPTION_SHORT>
            </PRODUCT_ID>
            <QUANTITY>1.0</QUANTITY>
            <ORDER_UNIT>C62</ORDER_UNIT>
            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>99.00</PRICE_AMOUNT>
            </PRODUCT_PRICE_FIX>
            <PRICE_LINE_AMOUNT>99.00</PRICE_LINE_AMOUNT>
        </ORDER_ITEM>
        <ORDER_ITEM>
            <LINE_ITEM_ID>2</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>853136</SUPPLIER_PID>
                <DESCRIPTION_SHORT>Universalschere links 21 cm</DESCRIPTION_SHORT>
            </PRODUCT_ID>
            <QUANTITY>1.0</QUANTITY>
            <ORDER_UNIT>C62</ORDER_UNIT>
            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>0.00</PRICE_AMOUNT>
            </PRODUCT_PRICE_FIX>
            <PRICE_LINE_AMOUNT>0.00</PRICE_LINE_AMOUNT>
        </ORDER_ITEM>
        <ORDER_ITEM>
            <LINE_ITEM_ID>3</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>903522</SUPPLIER_PID>
                <DESCRIPTION_SHORT>colour laser - A3, 160 g/qm, weiß, 250 Blatt</DESCRIPTION_SHORT>
            </PRODUCT_ID>
            <QUANTITY>1.0</QUANTITY>
            <ORDER_UNIT>C62</ORDER_UNIT>
            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>0.00</PRICE_AMOUNT>
            </PRODUCT_PRICE_FIX>
            <PRICE_LINE_AMOUNT>0.00</PRICE_LINE_AMOUNT>
        </ORDER_ITEM>
        <ORDER_ITEM>
            <LINE_ITEM_ID>4</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>902358</SUPPLIER_PID>
                <DESCRIPTION_SHORT>Leibniz Minis Choco Cookie Cup</DESCRIPTION_SHORT>
            </PRODUCT_ID>
            <QUANTITY>1.0</QUANTITY>
            <ORDER_UNIT>C62</ORDER_UNIT>
            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>0.00</PRICE_AMOUNT>
            </PRODUCT_PRICE_FIX>
            <PRICE_LINE_AMOUNT>0.00</PRICE_LINE_AMOUNT>
        </ORDER_ITEM>
        <ORDER_ITEM>
            <LINE_ITEM_ID>5</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>903525</SUPPLIER_PID>
                <DESCRIPTION_SHORT>colour laser - A4, 190 g/qm, weiß, 250 Blatt</DESCRIPTION_SHORT>
            </PRODUCT_ID>
            <QUANTITY>1.0</QUANTITY>
            <ORDER_UNIT>C62</ORDER_UNIT>
            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>0.00</PRICE_AMOUNT>
            </PRODUCT_PRICE_FIX>
            <PRICE_LINE_AMOUNT>0.00</PRICE_LINE_AMOUNT>
        </ORDER_ITEM>
    </ORDER_ITEM_LIST>
    <ORDER_SUMMARY>
        <TOTAL_ITEM_NUM>5</TOTAL_ITEM_NUM>
        <TOTAL_AMOUNT>119.13</TOTAL_AMOUNT>
    </ORDER_SUMMARY>
</ORDER>

Felder

Felder die nicht in dieser Liste enthalten sind sollten selbsterklärend sein. Sie finden ihre Bedeutung in der offiziellen openTRANS-Dokumentation.

ORDER_HEADER/ORDER_INFO/ORDER_ID
Eine eindeutige Id für die Bestellung. Die Id ist garantiert eindeutig innerhalb eines Shops und innerhalb aller von uns gehosteten Shops.
ORDER_HEADER/ORDER_INFO/PARTIES/PARTY[PARTY_ROLE='delivery']
Abhängig vom Inhalte der Felder "Kundennummer (extern)" und "WE-Nummer" werden in den Kindelementen dieses Knotens unterschiedliche Informationen übergeben:
  • Ist das Feld "WE-Nummer" gefüllt wird eine PARTY_ID mit type="supplier_specific" übergeben. Wert ist der Inhalt aus dem Feld "WE-Nummer".
  • Ist das Feld "WE-Nummer" nicht gefüllt wird eine PARTY_ID mit type="buyer_specific" übergeben. Wert ist der Inhalt aus dem Feld "Kundennummer (extern)". Bitte beachten Sie, dass dadurch auch eine leere PARTY_ID übergeben werden kann.
  • Ist dem Auftrag kein Kunde zugeordnet (z.B. wenn er direkt im opCenter ohne Kunde erzeugt wurde) wird ebenfalls eine PARTY_ID mit type="supplier_specific" übergeben. Wert ist in diesem Fall die dem Shop zugeordnete Kundennummer des Shopbetreibers.
ORDER_HEADER/ORDER_INFO/PARTIES/PARTY[PARTY_ROLE='delivery']/ADDRESS/CONTACT_DETAIL
Dieser Knoten wird nur übergeben wenn der Bestellung ein Kunde zugeordnet ist. Der Unterknoten EMAILS/EMAIL enthält die Mailadresse des bestellenden Nutzers.
ORDER_ITEM_LIST/ORDER_ITEM/QUANTITY
Stückzahl einer Position. Ist für den Artikel der aktuellen Position eine Preiseinheit ungleich Eins definiert wird
  • der Einzelpreis durch die Preiseinheit dividiert
  • die Stückzahl mit der Preiseinheit multipliziert

Siehe auch ORDER_ITEM_LIST/ORDER_ITEM/PRODUCT_PRICE_FIX/PRICE_AMOUNT

ORDER_ITEM_LIST/ORDER_ITEM/PRODUCT_PRICE_FIX/PRICE_AMOUNT
Einzelpreis einer Position. Ist für den Artikel der aktuellen Position eine Preiseinheit ungleich Eins definiert wird
  • der Einzelpreis durch die Preiseinheit dividiert
  • die Stückzahl mit der Preiseinheit multipliziert

Siehe auch ORDER_ITEM_LIST/ORDER_ITEM/QUANTITY

openTRANS 2.0 - Gega-IT Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ORDER version="2.0" type="standard">
    <ORDER_HEADER>
        <CONTROL_INFO>
            <GENERATOR_INFO>cobai.com openTRANS 2.0 generator (version for GEGA IT-Solutions)</GENERATOR_INFO>
            <GENERATION_DATE>2016-07-07T15:48:28+02:00</GENERATION_DATE>
        </CONTROL_INFO>
        <ORDER_INFO>
            <ORDER_ID>490478b0-4449-11e6-b598-02c01b511db7</ORDER_ID>
            <ORDER_DATE>2016-07-07T15:47:56.271+02:00</ORDER_DATE>
            <PARTIES>
                <PARTY>
                    <PARTY_ID type="supplier_specific">5</PARTY_ID>
                    <PARTY_ID type="cobai-customer-id">c0bc3796-6d99-4693-826c-47fd5bfbaedb</PARTY_ID>
                    <PARTY_ROLE>buyer</PARTY_ROLE>
                    <ADDRESS>
                        <NAME>Roadshow-Kunde</NAME>
                        <NAME2>Name 2 des Kunden</NAME2>
                        <STREET>Lange Straße 1</STREET>
                        <ZIP>12345</ZIP>
                        <CITY>Weitweitweg</CITY>
                        <EMAIL>dirk@lacho.net</EMAIL>
                    </ADDRESS>
                </PARTY>
                <PARTY>
                    <PARTY_ID type="gln">4044581000000</PARTY_ID>
                    <PARTY_ROLE>intermediary</PARTY_ROLE>
                </PARTY>
                <PARTY>
                    <PARTY_ID type="buyer_specific">5</PARTY_ID>
                    <PARTY_ID type="cobai-customer-id">c0bc3796-6d99-4693-826c-47fd5bfbaedb</PARTY_ID>
                    <PARTY_ROLE>delivery</PARTY_ROLE>
                    <ADDRESS>
                        <NAME>Roadshow-Kunde</NAME>
                        <NAME2>Name 2 des Kunden</NAME2>
                        <CONTACT_DETAILS>
                            <CONTACT_ID>kv</CONTACT_ID>
                            <CONTACT_NAME>Kostenstellenverwalter</CONTACT_NAME>
                            <FIRST_NAME>Klaus</FIRST_NAME>
                            <PHONE>05132-86460</PHONE>
                            <FAX></FAX>
                            <EMAILS>
<EMAIL>dirk@lacho.net</EMAIL>
                            </EMAILS>
                        </CONTACT_DETAILS>
                        <STREET>Lange Straße 1</STREET>
                        <ZIP>12345</ZIP>
                        <CITY>Weitweitweg</CITY>
                        <EMAIL>dirk@lacho.net</EMAIL>
                    </ADDRESS>
                </PARTY>
            </PARTIES>
            <ORDER_PARTIES_REFERENCE>
                <BUYER_IDREF type="party_specific">5</BUYER_IDREF>
                <SUPPLIER_IDREF type="iln">4044581000000</SUPPLIER_IDREF>
            </ORDER_PARTIES_REFERENCE>
            <CUSTOMER_ORDER_REFERENCE></CUSTOMER_ORDER_REFERENCE>
            <CURRENCY>EUR</CURRENCY>
            <HEADER_UDX>
                <UDX.COBAI.SHIPPING></UDX.COBAI.SHIPPING>
                <UDX.COBAI.COST_CATEGORY_ID></UDX.COBAI.COST_CATEGORY_ID>
                <UDX.COBAI.PAYMENT_SYSTEM_NAME>net.lacho.payment.methods.PaymentMethodPrepayed</UDX.COBAI.PAYMENT_SYSTEM_NAME>
            </HEADER_UDX>
        </ORDER_INFO>
    </ORDER_HEADER>
    <ORDER_ITEM_LIST>
        <ORDER_ITEM>
            <LINE_ITEM_ID>1</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>850350020</SUPPLIER_PID>
                <DESCRIPTION_SHORT>Flipchart-Block, 68 x 99 cm, kariert/blanko, 20 Blatt</DESCRIPTION_SHORT>
            </PRODUCT_ID>
            <QUANTITY>5.0</QUANTITY>
            <ORDER_UNIT>C62</ORDER_UNIT>
            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>3.95</PRICE_AMOUNT>
                <TAX_DETAILS_FIX>
                    <TAX_TYPE>VAT</TAX_TYPE>
                    <TAX>0.19</TAX>
                </TAX_DETAILS_FIX>
                <ALLOW_OR_CHARGES_FIX>
                    <ALLOW_OR_CHARGE type="surcharge">
                        <ALLOW_OR_CHARGE_NAME>EMIZ</ALLOW_OR_CHARGE_NAME>
                        <ALLOW_OR_CHARGE_DESCR>Versand</ALLOW_OR_CHARGE_DESCR>
                        <ALLOW_OR_CHARGE_VALUE>
                            <AOC_MONETARY_AMOUNT>3.63</AOC_MONETARY_AMOUNT>
                        </ALLOW_OR_CHARGE_VALUE>
                    </ALLOW_OR_CHARGE>
                </ALLOW_OR_CHARGES_FIX>
            </PRODUCT_PRICE_FIX>
            <PRICE_LINE_AMOUNT>19.75</PRICE_LINE_AMOUNT>
        </ORDER_ITEM>
        <ORDER_ITEM>
            <LINE_ITEM_ID>2</LINE_ITEM_ID>
            <PRODUCT_ID>
                <SUPPLIER_PID>713212</SUPPLIER_PID>
                <DESCRIPTION_SHORT>Sammelhülle - A4, 2-tlg., Pack 100 Stück</DESCRIPTION_SHORT>
            </PRODUCT_ID>
            <QUANTITY>100.0</QUANTITY>
            <ORDER_UNIT>C62</ORDER_UNIT>
            <PRODUCT_PRICE_FIX>
                <PRICE_AMOUNT>0.23</PRICE_AMOUNT>
                <TAX_DETAILS_FIX>
                    <TAX_TYPE>VAT</TAX_TYPE>
                    <TAX>0.19</TAX>
                </TAX_DETAILS_FIX>
                <ALLOW_OR_CHARGES_FIX>
                    <ALLOW_OR_CHARGE type="surcharge">
                        <ALLOW_OR_CHARGE_NAME>EMIZ</ALLOW_OR_CHARGE_NAME>
                        <ALLOW_OR_CHARGE_DESCR>Versand</ALLOW_OR_CHARGE_DESCR>
                        <ALLOW_OR_CHARGE_VALUE>
                            <AOC_MONETARY_AMOUNT>4.21</AOC_MONETARY_AMOUNT>
                        </ALLOW_OR_CHARGE_VALUE>
                    </ALLOW_OR_CHARGE>
                </ALLOW_OR_CHARGES_FIX>
            </PRODUCT_PRICE_FIX>
            <PRICE_LINE_AMOUNT>23.00</PRICE_LINE_AMOUNT>
        </ORDER_ITEM>
    </ORDER_ITEM_LIST>
    <ORDER_SUMMARY>
        <TOTAL_ITEM_NUM>2</TOTAL_ITEM_NUM>
        <TOTAL_AMOUNT>60.2</TOTAL_AMOUNT>
    </ORDER_SUMMARY>
</ORDER>