The document InventoryReport is used for the transmission of an inventory list of the client (POS) to the head office of a chain or the manufacturer. The constant data exchange between points of sale (shops/stores) and the manufacturer guarantees that the manufacturer always has the exact quantity available and can be used for statistical purposes.
The format for the exchange of inventory data is based on the catalog format Catalog.xml
.
Only a small amount of information is required for a simple implementation of the inventory report. Additional information can be passed for the different use cases.
An inventory report always refers to a specific time, which must be specified in the document at inventorydate
.
The validation is performed on the basis of the most up-to-date schema version. This is available at the following URL:
The document InventoryReport consists of the three main elements InventoryReport
,
InventoryItem
and Client
.
InventoryReport
¶The element InventoryReport
at least consists of the attributes generationDate
, inventoryDate
,
inventoryReportID
, schemaMajorVersionID
, schemaMajorVersionID
and supplierID
as well as the
elements Client
and InventoryItems
.
The element InventoryItems
can consist of one or more elements InventoryItem
.
Generally, articles can be described in two ways. Either with an unique ID that defines exactly a variant (SKU) (e.g., EAN or UPC code) or with an article ID (model number at frames) and the features that are required to identify the variant (in the catalog as order relevant defined product features).
Example XML code:
<InventoryReport xsi:noNamespaceSchemaLocation= "http://templates.look4optics.com/v_2_0/InventoryReport.xsd" schemaMajorVersionID="1" schemaMinorVersionID="12" messageNumber="4314314321432" inventoryReportID="IR-2017-02-21-115" generationDate="2017-02-21T09:52:23.9305444+02:00" currency="EURO" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" corporateOfficeType="store" inventoryDate="2017-02-21T09:52:23.9305444+02:00" supplierID="233212312" > <Client clientID="31024" clientName="Eyewear Solutions LTD"> <Addresses> <Address addressID="1" addressType="MainAddress" name="Eyewear Solutions LTD" street="152 Chiswick High Road" zip="W4 1PR" city="London" isoCountryCode="UK" phone="+44 208 4517 123" fax="+44 208 4517 124" email="test@ew-solutions.co.uk" clientType="Retailer"/> </Addresses> </Client> <InventoryItems> <InventoryItem inventoryQuantity="2" articleID="L0505" articleName="Biomedics 55" recommendedRetailPrice="10" articleGroupCode="AGBC" articleGroupDescription="contact lenses" articleGroupCodeRetailer="123456" brand="Biomedics" purchasePrice="100" > <Configuration quantity="1"> <Feature templateID="Diameter" selectedValue="14.20"/> <Feature templateID="RadiusBasecurve" selectedValue="8.70"/> <Feature templateID="Sphere" selectedValue="-9.00"/> </Configuration> </InventoryItem> <InventoryItem inventoryQuantity="3" articleID="L0506" articleName="Consan Pflege 360 ml" brand="CooperVision" recommendedRetailPrice="20" articleGroupCode="AGBC" articleGroupDescription="care" articleGroupCodeRetailer="123457" purchasePrice="200" > <Configuration quantity="3"> <Feature templateID="Diameter" selectedValue="14.40"/> <Feature templateID="RadiusBasecurve" selectedValue="8.80"/> <Feature templateID="Sphere" selectedValue="-7.00"/> <Feature templateID="Cylinder" selectedValue="-1.25"/> <Feature templateID="AxisCylinder" selectedValue="70"/> </Configuration> </InventoryItem> <InventoryItem inventoryQuantity="4" articleID="02030" articleName="Aigner 02030-00001" brand="Aigner" recommendedRetailPrice="40" articleGroupCode="SGBC" articleGroupDescription="sunglasses" articleGroupCodeRetailer="123458" purchasePrice="300" > <Configuration quantity="1"> <Feature templateID="FrameColour" selectedValue="silver"/> <Feature templateID="LensColour" selectedValue="polar gray"/> <Feature templateID="FrameTempleLength" selectedValue="125"/> </Configuration> </InventoryItem> <InventoryItem inventoryQuantity="3" articleID="L7928" articleName="Trient 1256" brand="Koberg+Tente" recommendedRetailPrice="50" articleGroupCode="FGBC" articleGroupDescription="frames" articleGroupCodeRetailer="123459" purchasePrice="400" > <Configuration quantity="1"> <Feature templateID="EanCode" selectedValue="4026587082069"/> </Configuration> </InventoryItem> </InventoryItems> </InventoryReport>
Attribute | Type / Use | Description / Example |
---|---|---|
corporateOfficeType |
xs:NMTOKEN optional |
Corporate office type (e.g. headquarter ) |
currency |
xs:string |
Currency (e.g. EURO ) |
generationDate |
xs:dateTime required |
Date and time of generation (e.g. 2011-02-11T11:48:34 ) |
generatorInfo |
xs:string optional |
Information about the generation software (e.g. Look4 Webservices Test ) |
inventoryDate |
xs:dateTime required |
Date and time of inventory (e.g. 2011-02-11T11:48:34 ) |
inventoryReportID |
xs:string required |
ID for the inventory report document (e.g. IR-Branch-312-2011-01-03 ) |
inventoryReportName |
xs:string optional |
Describing name for the inventory report (e.g. Report-Branch-312-contact lense stock ) |
messageNumber |
xs:string optional |
Unique ID for this document file (e.g. IR-20110211105912-123 ) |
schemaMajorVersionID |
xs:integer required |
Major version number for the description of the current schema version (e.g. 1.x) (e.g. 1 ) |
schemaMinorVersionID |
xs:integer required |
Minor version number for the description of the current schema version (e.g. x.6) (e.g. 0 ) |
supplierID |
xs:string required |
Supplier ID (e.g. 012345 ) |
InventoryItem
¶The element InventoryItem
contains the status message for a particular article or a
specific product configuration.
The element InventoryItem
contains the following attributes:
Example XML code:
<InventoryItem inventoryQuantity="2" articleID="L0505" articleName="Biomedics 55" recommendedRetailPrice="10" articleGroupCode="AGBC" articleGroupDescription="contact lenses" articleGroupCodeRetailer="123456" brand="Biomedics" purchasePrice="100"> <Configuration quantity="1"> <Feature templateID="Diameter" selectedValue="14.20"/> <Feature templateID="RadiusBasecurve" selectedValue="8.70"/> <Feature templateID="Sphere" selectedValue="-9.00"/> </Configuration> </InventoryItem>
Attribute | Type / Use | Description / Example |
---|---|---|
articleGroupCode |
xs:string optional |
Article group code at supplier (e.g. B-451 ) |
articleGroupCodeRetailer |
xs:string optional |
Code for the article group at the retailer (e.g. CL-soft ) |
articleGroupDescription |
xs:string optional |
Description of the article group (e.g. C-2716 ) |
articleID |
xs:string required |
(e.g. A2780 ) |
articleName |
xs:string required |
Article name (e.g. Smith Optics Ltd. ) |
brand |
xs:string optional |
Brand of the product (e.g. Zeiss ) |
eanCode |
xs:string optional |
EAN-Code, 13-digit (e.g. 7234567891234 ) |
grossUnitPrice |
xs:decimal optional |
Gross price per unit (to be paid) (e.g. 12 ) |
inventoryQuantity |
xs:decimal required |
Quantity of items on stock (e.g. `` 12``) |
purchasePrice |
xs:decimal optional |
Purchase price (list price) (e.g. 10 ) |
recommendedRetailPrice |
xs:decimal optional |
Recommended retail price (e.g. 20,50 ) |
retailPrice |
xs:decimal optional |
Retail price (e.g. 19,50 ) |
transactionType |
xs:NMTOKEN optional |
TransactionType (sale, return,damage,..) (e.g. sale ) |
upcCode |
xs:string optional |
UPC-Code, 12-digit (e.g. 723456789123 ) |
Client
¶The element``Client`` includes all information on 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="31024" clientName="Eyewear Solutions LTD"> <Addresses> <Address addressID="1" addressType="MainAddress" name="Eyewear Solutions LTD" street="152 Chiswick High Road" zip="W4 1PR" city="London" isoCountryCode="UK" phone="+44 208 4517 123" fax="+44 208 4517 123" clientType="Retailer"/> </Addresses> </Client>
Client
¶Attribute | Type / Use | Description / Example |
---|---|---|
clientID |
xs:NMTOKEN required |
GLN or client no. (e.g. 012345 ) |
clientName |
xs:NMTOKEN 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 ) |