Allgemeine Hinweise zum Format

1. Basis des Dokuments sind die fünf Bereiche
   • header - Kopfdaten mit allgemeinen Daten wie Sender, Empfänger und Dokumentenbeschreibung
   • shipping - optionale Daten mit Versandinformationen (Paketnummern etc.)
   • templates - optionale Vorlagen für items, die bei vielen gleichartigen Artikeln genutzt werden können
   • items - Die im Dokument enthaltenen Artikel/Positionen
   • files - optional Dateien zum Dokument oder zu Artikeln
   Für Basisimplementierungen sind nur der header und die [items] relevant, alles übrige muss nicht verwendet werden.
2. Mit Hilfe des Elements templates ist ein einfaches Vorlagensystem enthalten, welches die Darstellung gleichartiger Artikel, die sich z.B. nur durch Ihre Seriennummern und NWR-IDs unterscheiden, kompakter darstellen zu können. Wichtig ist hier zu wissen, dass diess Vorlagensystem bewusst einfach gehalten ist: Man definiert ein Template (mit einer eindeutigen ID), welches alle gemeinsamen oder zum überwiegenden Teil gemeinsamen Merkmale des items enthält. Spätere items können mit einer referenz auf diese Template-ID erstellt werden, was dann bedeutet, dass die Daten des Items mit denen des Templates vorbefüllt sind, und die eigenen Datenfelder diese nur noch ergänzen oder überschreiben können. Ein Löschen von Feldern des Templates ist NICHT möglich.
3. Hinweis zur Vorlagennutzung: Die Nutzung von Vorlagen ist für Ersteller von Lieferscheinen (z.B. Hersteller oder Großhändler) optional, d.h. man KANN sie nutzen, muss es aber nicht. Außer einer kompakteren Schreibweise und damit Größenvorteilen bei der Übertragung gleichartiger items hat es keinerlei Vorteil. Dagegen ist die Implementierung für Empfänger von Lieferscheinen (Warenwirtschaft, Waffenbücher etc.) verpflichtend, d.h. sie MUSS implementiert sein, um alle gültigen Dokumente lesen zu können.
4. Hinweis zu Waffenteilen bei Vorlagen: Definiert eine Vorlage eine gewissen Anzahl von Waffenteilen, so muss diese Anzahl in den späteren Items identisch sein; entsprechend werden die Waffenteile in derselben Reihenfolge ergänzt/überschrieben. Dies ist natürlich das offensichtliche Verhalten, der Hinweis dient nur zur Klarstellung, dass man bei der Erstellung die Reihenfolge einhält.
5. Hinweis zu IDs und IDREFs: Diese Verweise werden für templates, shipping-Angaben und files-Verweise verwendet. Diese müssen laut Definition mit einem Buchstaben beginnen und dürfen keine Leerzeichen o.ä. enthalten, zudem müssen sie eindeutig im gesamten Dokument sein. Daher dürfen Templates/Shipments/Dateien nicht einfach nummeriert werden, sondern sollten z.B. Präfixe enthalten (ship1,t2,file9 o.ä.) oder willkürliche IDs sein.
6. Hinweis zu Preisangaben: Die Angabe von Preisen ist bei den Artikeln optional. Einige Warenwirtschaftssysteme erwarten allerdings, dass zumindest der EK-Preis mit angegeben wird. Dieser SOLLTE also vorhanden sein.
7. Hinweis zur Preisdefinition: Sowohl der Typ als auch die Währung sind Pflicht-Attribute, um Verwechslungen sicher auszuschließen.
8. Hinweis zu XWaffe-Daten: Auch wenn die XWaffe-Daten von Waffenteilen in einer Waffe zum überwiegenden Teil identisch sind, ist die Angabe auch in Waffenteilen verpflichtend. Dies dient der Sicherheit, dass eingetragene Daten immer komplett sind und denen im NWR entsprechen, ohne Interpretationsspielraum zu lassen.
9. Hinweis zu Blockierungs- und Beschussangaben: Diese (optionalen) Angaben werden für die Mehrzahl der normalen Waffenüberlassungen nicht benötigt, können aber für den Austausch von Gebrauchtwaffen oder Einzelteilen hilfreich sein. Standard für die Blockierung ist natürlich false=nein, für das Feld cipapproved (beschossen oder nicht) bei Waffen true=ja, bei Waffenteilen false=nein. Dies entspricht der normalen Praxis, dass Waffen in der Regel als solche beschossen in den Handel kommen, ein Einzelteil aber nicht. Lediglich bei modularen Waffenteilen kann auch das Waffenteil beschossen geliefert werden.
10. Dateiverweise im Dokument: Sowohl beim "fileref"-Attribut der Rechnungs/Lieferscheinnummer als auch bei den Items im Bereich "files" ist die Angabe von Dateien möglich. Referenzierte Dateien werden gemeinsam im Block files am Ende gesammelt aufgeführt, zusammen mit dem entsprechenden Typ (jpg, pdf etc.) und Ihrer Quelle. Diese kann auf drei Arten erfolgen:
    • Über eine vollständige URL zum Abruf über das Internet
    • direkt eingebettet in das Dokument (als Base64-codierter Dateiinhalt). Dies empfehlen wir nur für überschaubare Datenmengen, ist aber z.B. besonders interessant zum Einbinden von Lieferscheinen/Rechnungen im PDF-Format.
    • über ein externes Übertragungskonzept, das außerhalb dieser Spezifikation ist - hier werden nur Dateinamen notiert, die z.B. über andere Kanäle angesprochen werden können

Unser Tipp

Wir stehen Ihnen bei allen Unklarheiten, Verbesserungsvorschlägen, Fragen zur Implementierung oder für Testmöglichkeiten zur Seite: Kontaktieren Sie uns einfach unter info@oewi-standard.org und abonnieren Sie unseren Newsletter, damit Sie bei Änderungen, Neuigkeiten oder anderen Informationen rund um den Standard auf dem Laufenden bleiben!

Versionsänderungen

1.03: Ergänzung des Feldes pin bei receiver, um in speziellen Szenarien eine zusätzliche Absicherung ermöglichen zu können

1.02: Ergänzung des Feldes additionalinfo bei items für artikelbezogene, technische Informationen

1.01: Ergänzung der Felder gunblocking (Blockierungsinformationen, cipapproved (Beschuss) und deliverynotedate (Lieferscheindatum) sowie model bei Waffenteilen

1.00: Erste Veröffentlichung

Interaktive Formatbeschreibung

• Formatbeschreibung
• Beispiel Datei
• Beispiel-Lieferschein incl. NWR-Waffendaten

[-]   <oewidocument type="deliverynote" version="1.03" creator="..." xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://docs.oewi-standard.org/xsd/deliverynote/1.03.xsd">
[-]      <header>
         <messageid>...</messageid>
         <messagetime>...</messagetime>
         <deliverynoteid fileref="...">...</deliverynoteid>
         <invoiceid fileref="...">...</invoiceid>
         <receiverorderid source="...">...</receiverorderid>
         <senderorderid source="...">...</senderorderid>
         <deliverynotedate>...</deliverynotedate>
[-]         <sender addresscode="...">
            <nwrid>...</nwrid>
            <name>...</name>
            <name2>...</name2>
            <address1>...</address1>
            <address2>...</address2>
            <address3>...</address3>
            <zipcode>...</zipcode>
            <city>...</city>
            <country>...</country>
         </sender>
[-]         <receiver addresscode="..." pin="...">
            <nwrid>...</nwrid>
            <name>...</name>
            <name2>...</name2>
            <address1>...</address1>
            <address2>...</address2>
            <address3>...</address3>
            <zipcode>...</zipcode>
            <city>...</city>
            <country>...</country>
         </receiver>
         <notes>...</notes>
      </header>
[-]      <shipping>
[-]         <package shippingid="...">
            <serviceprovider>...</serviceprovider>
            <shippingnumber>...</shippingnumber>
            <trackinglink>...</trackinglink>
            <weight unit="KGM">...</weight>
         </package>
      </shipping>
[-]      <templates>
[-]         <item templateid="..." bundleid="..." bundleref="...">
            <amount unit="PCE">...</amount>
            <manufacturer>...</manufacturer>
            <productname>...</productname>
            <articlenumber type="...">...</articlenumber>
            <description>...</description>
            <additionalinfo>...</additionalinfo>
[-]            <prices>
               <price type="..." currency="..." vat="...">...</price>
            </prices>
[-]            <attributes>
               <attribute type="..." unit="..." customname="..." customunit="...">...</attribute>
            </attributes>
[-]            <files>
               <file fileref="..." comment="...">...</file>
            </files>
[-]            <weapondata xwaffeversion="...">
[-]               <weapon>
                  <manufacturer xwaffecode="...">...</manufacturer>
                  <serialno>...</serialno>
                  <nwrid>...</nwrid>
                  <model>...</model>
                  <caliber xwaffecode="...">...</caliber>
                  <productionyearordate>...</productionyearordate>
                  <importyearordate>...</importyearordate>
                  <weapontechnicalimplementation xwaffecode="...">...</weapontechnicalimplementation>
                  <weapontypefinestructure xwaffecode="...">...</weapontypefinestructure>
                  <weapontypeattachment1 xwaffecode="...">...</weapontypeattachment1>
                  <weaponcategory xwaffecode="...">...</weaponcategory>
                  <gunblocking type="..." serialno="...">...</gunblocking>
                  <cipapproved>...</cipapproved>
               </weapon>
[-]               <weaponpart>
                  <manufacturer xwaffecode="...">...</manufacturer>
                  <serialno>...</serialno>
                  <nwrid>...</nwrid>
                  <model>...</model>
                  <weaponpartname xwaffecode="...">...</weaponpartname>
                  <caliber xwaffecode="...">...</caliber>
                  <productionyearordate>...</productionyearordate>
                  <importyearordate>...</importyearordate>
                  <weapontechnicalimplementation xwaffecode="...">...</weapontechnicalimplementation>
                  <weapontypefinestructure xwaffecode="...">...</weapontypefinestructure>
                  <weapontypeattachment1 xwaffecode="...">...</weapontypeattachment1>
                  <weaponcategory xwaffecode="...">...</weaponcategory>
                  <gunblocking type="..." serialno="...">...</gunblocking>
                  <cipapproved>...</cipapproved>
               </weaponpart>
            </weapondata>
         </item>
      </templates>
[-]      <items>
         <item pos="..." templateref="..." shippingref="..." bundleid="..." bundleref="...">...</item>
      </items>
[-]      <files>
         <file fileid="..." filetype="..." filename="..." source="..." url="..." contenttype="..." contentlang="..." description="...">...</file>
      </files>
   </oewidocument>

oewidocument

type

version

creator

xmlns:xsi

xsi:noNamespaceSchemaLocation

header

messageid

messagetime

deliverynoteid

fileref

invoiceid

fileref

receiverorderid

source

senderorderid

source

deliverynotedate

sender

addresscode

nwrid

country

receiver

addresscode

pin

nwrid

shipping

package

shippingid

serviceprovider

shippingnumber

trackinglink

weight

unit

templates

item

templateid

bundleid

bundleref

amount

manufacturer

productname

articlenumber

description

additionalinfo

prices

price

type

currency

vat

attributes

attribute

type

unit

customname

customunit

files

file

fileref

comment

weapondata

weapon

manufacturer

xwaffecode

serialno

nwrid

model

caliber

xwaffecode

productionyearordate

importyearordate

weapontechnicalimplementation

xwaffecode

weapontypefinestructure

xwaffecode

weapontypeattachment1

xwaffecode

weaponcategory

xwaffecode

gunblocking

type

serialno

cipapproved

weaponpart

manufacturer

xwaffecode

serialno

nwrid

model

weaponpartname

xwaffecode

caliber

xwaffecode

productionyearordate

importyearordate

weapontechnicalimplementation

xwaffecode

weapontypefinestructure

xwaffecode

weapontypeattachment1

xwaffecode

weaponcategory

xwaffecode

gunblocking

type

serialno

cipapproved

items

item

pos

templateref

shippingref

bundleid

bundleref

files

file

fileid

filetype

filename

source

url

contenttype

contentlang

description