The order format is based on the standard xml catalog format. In an order one order item (position) is exactly one possible configuration of the delivery ranges defined in the catalog.
The Webservice PlaceSkuOrder offers the possibility to easily transmit orders only with SKU ID. It’s an alternate possibility to order frames from customer systems using only the SKU ID (usually EAN Code) without order relevant features. The Webservice generates automatically the corresponding order.xml file and also checks are done in the same way as mentioned in the chapter PlaceOrder. All orders are transferred to the suppliers always in the same format.
Important for the correct mapping of the order are the parameters clientID
, clientOrderID
(unique order
number for the query of OrderResponse and ASN, that in the order e.g. can be defined from the optician software)
and clientOrderItemID
(item number of an article, that also can be defined from the optician software).
In addition, with the fields supplierID
and catalogID
in the order must be defined to which supplier and
catalog the order applies. The respective specifications are returned from the Webservice GetCatalogInfo.ashx.
The two IDs clientOrderID
and clientOrderItemID
will be mandatory. Whereby the
two IDs don’t have to be unique for themselves, but in combination.
So, split orders are supported also after partial acceptance and correction.
In the element SkuOrder
general information concerning the order are defined.
It is devided in the two parts Client
and SkuOrderItems
.
Validation is based on most recent schema version. It is available under the following URL:
http://templates.look4optics.com/v_2_0/skuorder.xsd
As an option you can quote address information of the orderer under Client
.
Following is the description of the different order items (positions). Only quantity (quantity
)
and SkuID
(usually EAN code) and the item number (clientOrderItemID
) must be specified here.
SkuOrder
¶The element SkuOrder
contains the elements Client
(information concerning
the orderer) and SkuOrderItems
(order positions).
The element SkuOrder
starts with the definition of general information for
the order.
The values schemaMajorVersionID
and schemaMinorVersionID
should be set
permanently in the ordering software, because they indicate which version of
the standard is used in the structure of the document.
Therefore other programs can adjust themselves when parsing the document. The
values can be increased in the transmitter software, if there is a new version
of the standard and the program compatibility has been tested.
For the description are the following attributes available:
Attribute | Type / Use | Description / Example |
---|---|---|
catalogID |
xs:string required |
Version of the catalog format on which the creation of the order is based (e.g. Schema_Catalog_1_6 ) |
clientOrderID |
xs:string required |
Order ID on the side of the sender (e.g. 00023-345785 ) |
generatorInfo |
xs:string required |
Information about the generation software (e.g. Look4 Webservices Test ) |
supplierID |
xs:string required |
Unique ID of the supplier (e.g. DE813058544 ) |
Client
¶The element Client
contains the attribute clientID
(client id at supplier).
Optionally you can define address data (e.g. deviating delivery address) if it is
not the same as the order address.
Attribute | Type / Use | Description / Example |
---|---|---|
clientID |
xs:string required |
Client number at supplier (e.g. 012345 ) |
Address
has following attributes:¶Multiple addresses can be given in the element Address
. This information is optional. If different delivery
addresses are necessary, the shipping address is given here and can be assigned to individual order items under
SkuOrderItems
. Thus, for example, the corporate headquarters can send orders for several stores in one order.
The address can also be used to pass the associated clientID
(customer number of the store at the supplier).
The handling for different delivery addresses differs at the suppliers and should therefore always be coordinated with LOOK4 or the relevant suppliers or tested extensively in the test phase.
Attribute | Type / Use | Description / Example |
---|---|---|
addressID |
xs:string required |
Unique ID for an address. This can be linked later to one or more orders. (e.g. 123456 ) |
addressType |
xs:NMTOKEN required |
Address type, standard values: MainAddress, ShippingAddress, BillingAddress (e.g. MainAddress ) |
city |
xs:string required |
City (e.g. London ) |
clientID |
xs:string optional |
Client ID (e.g. 123423 ) |
email |
xs:string optional |
E-mail (e.g. mail@optician-test-smith.co.uk ) |
isoCountryCode |
xs:language required |
ISO country code (e.g. GB ) |
name |
xs:string required |
Name (e.g. Smith Optics Ltd. ) |
street |
xs:string required |
Street (e.g. Main street 123 ) |
zip |
xs:string required |
Zip code (e.g. DN1 1NE ) |
Example XML code:
<Addresses> <Address clientType="Branch" addressID="1" addressType="MainAddress" name="Smith Optics Ltd." name2="Eye care and more" street="Main street 123" zip="DN1 1NE" city="London" isoCountryCode="GB" phone="+0044 1302 344 123" fax="+0044 1302 344 321" email="mail@optician-test-smith.co.uk" /> <!-- Address of branch --> <Address clientType="Retailer" addressID="2" addressType="BillingAddress" name="Smith Optics Ltd. Administration Office" street="Long street 347" zip="DN2 2NE" city="London" isoCountryCode="GB" phone="+0044 1302 344 123" fax="+0044 1302 344 321" email="central@optician-test-smith.co.uk" /> <!-- Address of administration center --> <Address clientType="Consumer" addressID="3" addressType="ShippingAddress" name="Henry Miller" street="Short street 1" zip="DN1 1NE" city="London" isoCountryCode="GB" phone="+0044 123456" email="mail@henrytest.miller.co.uk" /> <!-- Address of consumer --> </Addresses>
SkuOrderItems
¶Each element SkuOrderItems
can have one or more SkuOrderItem
elements.
Each OrderItem
describes one order position.
The referencing for the order response and assignment of individual order items takes
place via the attribute clientOrderItemID
. This field must always be filled when
the orders are sent via Web service.
For description the following attributes can be used:
Attribute | Type / Use | Description / Example |
---|---|---|
skuID |
xs:string required |
SKU-ID at supplier (e.g. A2780 ) |
skuIDType |
xs:NMTOKEN optional |
Item type: GTIN (Default), SupplierSKU-ID (e.g. standard ) |
quantity |
xs:positiveInteger required |
Desired quantity (e.g. 1 ) |
clientOrderItemID |
xs:string required |
ID that (definitely) defines the order item on side of the sender (e.g. LOOK4-WLK-01 ) |
addressID |
xs:string optional |
ID of the associated address (e.g. 123456 ) |
deliveryDate |
xs:dateTime optional |
Desired delivery date (e.g. 2011-02-12T09:00:00 ) |
referenceName |
xs:string optional |
Commission, client/order number (e.g. Stock ) |
Example XML code:
<SkuOrderItems> <SkuOrderItem skuID="5055022613306" quantity="2" clientOrderItemID="1"/> <SkuOrderItem skuID="5055022613269" quantity="1" clientOrderItemID="2"/> <SkuOrderItem skuID="5055022614150" quantity="3" clientOrderItemID="=3"/> </SkuOrderItems>
<SkuOrder catalogID="catalog_de_de.xml" clientOrderID="46789" generatorInfo="Test App" supplierID="DE812671943" schemaMajorVersionID="1" schemaMinorVersionID="13" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://templates.look4optics.com/v_2_0/SkuOrder.xsd"> <Client clientID="00011" clientName="Testclient 11" responseMail="info@look4.de"> <Addresses> <Address clientType="Branch" addressID="1" addressType="MainAddress" name="Smith Optics Ltd." name2="Eye care and more" street="Main street 123" zip="DN1 1NE" city="London" isoCountryCode="GB" phone="+0044 1302 344 123" fax="+0044 1302 344 321" email="mail@optician-test-smith.co.uk" /> <Address clientType="Retailer" addressID="2" addressType="BillingAddress" name="Smith Optics Ltd. Administration Office" street="Long street 347" zip="DN2 2NE" city="London" isoCountryCode="GB" phone="+0044 1302 344 123" fax="+0044 1302 344 321" email="central@optician-test-smith.co.uk" /> <Address clientType="Consumer" addressID="3" addressType="ShippingAddress" name="Henry Miller" street="Short street 1" zip="DN1 1NE" city="London" isoCountryCode="GB" phone="+0044 123456" email="mail@henrytest.miller.co.uk" /> </Addresses> </Client> <SkuOrderItems> <SkuOrderItem skuID="5055022613306" quantity="2" clientOrderItemID="1"/> <SkuOrderItem skuID="5055022613269" quantity="1" clientOrderItemID="2"/> <SkuOrderItem skuID="5055022614150" quantity="3" clientOrderItemID="=3"/> </SkuOrderItems> </SkuOrder>
The format is independent of the type of data transfer. The transfer takes place via Web service with an HTTP request (POST). The order via the Web services of LOOK4Optics is made to the following URL:
Productive: https://www.look4optics.de/OrderService/PlaceSkuOrder.ashx
For detailed information please contact the LOOK4 support or the supplier. The URLs for suppliers who run their own Web services can be found in the respective catalogs in the WebServices element.