Acme API Specification (en-us)

Acme API Specification Specification version 1.0

Updated 2010.03.17

Acme API Specification v 1.0

2

Table Of Contents 1 ChangeLog ....................................................................................................................................................................... 5

2 General information ....................................................................................................................................................... 7

2.1 Web Service Address .............................................................................................................................................. 7

2.2 LicenseKey ............................................................................................................................................................... 7

2.3 Additional Resources .............................................................................................................................................. 7

3 Web Service Methods ..................................................................................................................................................... 8

3.1 Summary ................................................................................................................................................................. 8

3.2 Products .................................................................................................................................................................. 9

3.2.1 GetProductList Method .................................................................................................................................. 9

3.2.1.1 Method Request ......................................................................................................................................... 9

3.2.1.2 Method Response ....................................................................................................................................... 9

3.2.1.3 Request/Response Examples .................................................................................................................... 10

3.2.2 GetProductClassification Method ................................................................................................................. 13

3.2.2.1 Method Request ....................................................................................................................................... 13

3.2.2.2 Method Response ..................................................................................................................................... 13

3.2.2.3 Request/Response examples .................................................................................................................... 13

3.2.3 GetProductBarcodeList Method ................................................................................................................... 17

3.2.3.1 Method Request ....................................................................................................................................... 17

3.2.3.2 Method Response ..................................................................................................................................... 17


3.2.4 GetProductResources Method ..................................................................................................................... 19

3.2.4.1 Method Request ....................................................................................................................................... 19

3.2.4.2 Method Response ..................................................................................................................................... 19


3.2.5 GetProductSpecification Method ................................................................................................................. 23

3.2.5.1 Method Request ....................................................................................................................................... 23

3.2.5.2 Method Response ..................................................................................................................................... 23


3.2.6 GetVendorList Method ................................................................................................................................. 26

3.2.6.1 Method Request ....................................................................................................................................... 26

3.2.6.2 Method Response ..................................................................................................................................... 26


3.2.7 GetProductRelationList method ................................................................................................................... 29

3.2.7.1 Method Request ....................................................................................................................................... 29

3.2.7.2 Method Response ..................................................................................................................................... 29


3


3.2.8 GetProductPresentList Method .................................................................................................................... 31

3.2.8.1 Method Request ....................................................................................................................................... 31

3.2.8.2 Method Response ..................................................................................................................................... 31


3.2.9 Get ProductBundleList Method .................................................................................................................... 34

3.2.9.1 Method Request ....................................................................................................................................... 34

3.2.9.2 Method Response ..................................................................................................................................... 34

3.2.9.3 Request/Response Examples ................................................................................................................... 34

3.2.10 GetTreeNodes method ................................................................................................................................. 37

3.2.10.1 Method request .................................................................................................................................... 37

3.2.10.2 Method response .................................................................................................................................. 37

3.2.10.3 Request/Response Examples ................................................................................................................ 37

3.2.11 GetTreeNodeProducts method .................................................................................................................... 40

Method returns positions of Products in ecommerce tree .......................................................................................... 40

3.2.11.1 Method request .................................................................................................................................... 40

3.2.11.2 Method response .................................................................................................................................. 40

3.2.11.3 Request/Response Examples ................................................................................................................ 40

3.3 Orders ................................................................................................................................................................... 43

3.3.1 GetAddressList Method ................................................................................................................................ 43

3.3.1.1 Method Request ....................................................................................................................................... 43

3.3.1.2 Method Response ..................................................................................................................................... 43


3.3.2 GetDeliveryTypeList Method ........................................................................................................................ 45

3.3.2.1 Method Request ....................................................................................................................................... 45

3.3.2.2 Method Response ..................................................................................................................................... 45


3.3.3 PurchaseProducts Method ........................................................................................................................... 48

3.3.3.1 Method Request ....................................................................................................................................... 48

3.3.3.2 Method Response ..................................................................................................................................... 49


3.3.4 GetOrderDetails Method .............................................................................................................................. 53

3.3.4.1 Method Request ....................................................................................................................................... 53

3.3.4.2 Method Response ..................................................................................................................................... 53


3.3.5 GetCustomerUserList Method ...................................................................................................................... 58


4

3.3.5.1 Method Request ....................................................................................................................................... 59

3.3.5.2 Method Response ..................................................................................................................................... 59


3.3.6 UpdateOrderLine Method ............................................................................................................................ 61

3.3.6.1 Method Request ....................................................................................................................................... 61

3.3.6.2 Method Response ..................................................................................................................................... 63


3.4 Invoices ................................................................................................................................................................. 66

3.4.1 GetInvoiceList Method.................................................................................................................................. 66

3.4.1.1 Method Request ....................................................................................................................................... 66

3.4.1.2 Method Response ..................................................................................................................................... 66


3.4.2 GetInvoiceDetails Method ............................................................................................................................ 69

3.4.2.1 Method Request ....................................................................................................................................... 69

3.4.2.2 Method Response ..................................................................................................................................... 69


3.4.3 GetInvoiceProductSerialList Method ............................................................................................................ 73

3.4.3.1 Method Request ....................................................................................................................................... 73

3.4.3.2 Method Response ..................................................................................................................................... 74


3.4.4 GetInvoiceShipments Method ...................................................................................................................... 76

3.4.4.1 Method Request ....................................................................................................................................... 76

3.4.4.2 Method Response ..................................................................................................................................... 76


4 Resources ...................................................................................................................................................................... 80

4.1 Development resources ........................................................................................................................................ 80

4.2 Product specification pages in supplier’s web site ............................................................................................... 80

4.2.1 for Acme Computer Components customers ............................................................................................... 80

4.2.2 for Avad Baltic Customers ............................................................................................................................. 80


5

1 ChangeLog

2010.03.17

1) Added new fields in GetOrderDetails and UpdateOrderLine methods

2010.03.01

1) Added new fields in PurchaseProducts method

2010.02.05

1) Added new methods: GetTreeNodes and GetTreeNodeProducts

2010.01.05

1) Added information about link to AVAD product page (4.2)

2009.10.16

1) Added new request filters for GetProductList method: SupplierCode, VendorId and PartNumber;

2) Updated information on product warranties in GetProductList method response

2009.07.21

1) Added new fields OrderRefId and OrderLineRefiId in PurchaseProducts, GetInvoiceDetails, GetOrderDetails and

UpdateOrderLine;

2) Added new filters for GetInvoiceDetails method;

3) Added new filter OrderRefId for GetOrderDetails method;

4) Updated GetInvoiceDetails method: added Note field in InvoiceLine.

2009.06.15

1) The link to the product page on acc.acme.eu has been changed (4.2).

2009.02.10

1) Addded new method GetProductBundleList method.

2009.01.30

1) Added new method GetDeliveryTypeList;

2) Removed tables with delivery types from this document;

3) Updated GetProductList method: added new field IsNewProduct;

4) Added new methods: GetProductRelationList, GetProductPresentList.

2008.12.10

1) Document renamed to Acme API Specification;

2) Added table of contents;

3) Web methods now are logically grouped;

4) Updated GetInvoiceDetails method now returns service charge if it available;

5) Updated GetProductList method: added new parameter in response RecommendedRetailPrice;

6) Added new filter UpdatedSince for GetProductSpecification method.

2008.10.21

1) Added possibility to supply custom addresses in PurchaseProducts and UpdateOrderLine methods.


6

2008.10.13

1) Added product ordering subsystem. New Methods: PurchaseProducts, GetAddressList, GetCustomerUserList,

UpdateOrderLine, GetOrderDetails, also added GetInvoiceShipments method;

2) Described possibility to supply multiple filters for GetProductSpecification, GetProductResources,

GetInvoiceDetails and GetProductBarcodeList methods.

2008.05.08

1) Updated GetProductList method: Added new GrossWeight parameter for Product element.

2008.04.02

1) Updated GetInvoiceList and GetInvoiceDetails methods;

2) Added new parameters to InvoiceHeader element (BranchId and DeliveryAddress).

2008.03.26

1) Added new methods GetProductSpecification and GetProductResources;

2) Added request filters in GetProductBarcodeList method.

2008.03.12

1) Added new methods GetInvoiceList, GetInvoiceProductSerialList, GetInvoiceDetails.

2008.01.31

1) Added new method GetProductBarcodeList.

2008.01.07

1) Version 1.0 released

2) Connection URL’s are changed from https://api.acme.lt/0.1/ */*… to https://api.acme.lt/1.0/ */*… accordingly

3) GetProductList method has required filter Currency. At the moment the response will be only in currency by

default assigned to user. When the request parameter provided differs from the default user one, request will

return an empty response. The default currency is displayed in e-commerce system, or user may ask local sales

representatives.

4) Filter UpdatedSince not realized yet, for feature reference.

5) Now all filter names and values are case insensitive.

2007.12.24

1) Demo version of web services


7

2 General information

2.1 Web Service Address

Web service address is: https://api.acme.lt/1.0/commerce.asmx

WSDL file address is: https://api.acme.lt/1.0/commerce.asmx?wsdl

2.2 LicenseKey

For user identification LicenseKey is required in every method call. You must to define LicenseKey in SOAP header

of Web Service method request.

For testing purposes you can use LicenseKey: 498ec72c-e8e7-48f2-b300-d95666aeb141. It is xml demo client

account; price level 1, default currency LTL and stock display limit 1. All data returned using this key is for TESTING

purposes only. With demo LicenseKey You can’t make purchases (PurchaseProducts method) and edit order lines

(UpdateOrderLine method).

For new LicenseKey requests please ask you sales representative.

2.3 Additional Resources

Information about additional recourses (web service client examples, etc.) You can find in 4 chapter.


8

3 Web Service Methods

3.1 Summary

Table 1 Web Service method summary

Method Name Short Description Product Catalog GetProductList Method returns products information

GetProductClassification Method returns product classification data

GetProductBarcodeList Method returns barcodes (EAN) of products

GetProductSpecification Method returns products descriptions

GetProductResources Method returns products resources (links to images, pdf, etc.)

GetVendorList Method returns vendors list

GetProductPresentList Method returns information about product presents

GetProductRelationList Method returns information about product relations

GetProductBundleList Method returns list of product bundles

GetTreeNodes Method returns nodes of ecommerce tree

GetTreeNodeProducts Method returs position of products in ecommerce tree

Orders PurchaseProducts Method is used for placing products in orders

UpdateOrderLine Method is used for order updates

GetOrderDetails Method returns order details

GetAddressList Method returns list of available addresses

GetCustomerUserList Method returns list of customer users

Invoices GetInvoiceList Method returns list o available invoices

GetInvoiceDetails Method returns invoice details

GetInvoiceProductSerialList Method returns serial number list related to specific invoice

GetInvoiceShipments Method returns list of shipments for specific invoice


9

3.2 Products

This method group is used to get information about products.

3.2.1 GetProductList Method

Method returns information about Products.

3.2.1.1 Method Request

Table 2 available method request filters

Name Occurs Value Example Description

Language 1 lt-lt Product list language

Currency 1 LTL Price list currency

SegmentId 0…n 1 Narrows result set to specific Segment of Product Classification

GroupId 0...n 12 Narrows result set to specific Group of Product Classification

ClassId 0…n 123 Narrows result set to specific Class of Product Classification

SeriesId 0...n 1234 Narrows result set to specific Series of Product Classification

SupplierCode 0…n 003315 Narrows result set to specific Products with given SupplierCode

VendorId 0…n ca Narrows result set to given Vendor’s products

PartNumber 0…n EEEPC Narrows result set to product(s) with given part number

Notes:

At the moment the response will be only in currency by default assigned to user. When the request parameter

provided differs from the default user one, request will return an empty response. The default currency is

displayed in e-commerce system, or user may ask local sales representatives.

3.2.1.2 Method Response

Table 3 method response details

Name Type Occurs Description

ProductList

Product Product 0…n Products

Product

SupplierCode String 1 Product identification code assigned by supplier

SegmentId String 1 Top level product group identification, identifies the

product segment

GroupId String 1 Second level product group identification, identifies

the product group

ClassId String 1 Third level product group identification, identifies the

product class

SeriesId String 1 Forth level product group identification, identifies the

product series

VendorId String 1 Product

Name String 1 Product name

PartNumber String 1 Product part number assigned by vendor

Warranty Integer 1 Product warranty (in months)

If field value is -1 then product has limited lifetime

warranty

Price Decimal 1 Product price

Quantity Decimal 1 Available quantity of product in warehouse

GrossWeight Decimal 1 Product gross weight


10

3.2.1.3 Request/Response Examples

SOAP 1.1 example:

Request:

POST /1.0/commerce.asmx HTTP/1.1

Host: api.acme.lt

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://schemas.acme.eu/GetProductList"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Header>

<LicenseHeader xmlns="http://schemas.acme.eu/">

<LicenseKey>498ec72c-e8e7-48f2-b300-d95666aeb141</LicenseKey>

</LicenseHeader>

</soap:Header>

<soap:Body>

<GetProductList xmlns="http://schemas.acme.eu/">

<GetProductListRequest>

<Filters>

<Filter>

<Name>Language</Name>

<Value>lt-lt</Value>

</Filter>

<Filter>

<Name>Currency</Name>

<Value>LTL</Value>

</Filter>

</Filters>

</GetProductListRequest>

</GetProductList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK





xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<GetProductListResponse xmlns="http://schemas.acme.eu/">

DateExpected DateTime 1 Expected product arrival date (if value equal 1900-01-

01T00:00:00 then date is not defined )

RecommendedRetailPrice Decimal 1 Recommended retail price of product If value is 0

recommended retail price is not defined

IsNewProduct Boolean 1 Indicates new product in system


11

<GetProductListResult>

<ProductList>

<Product>

<SupplierCode>001982</SupplierCode>

<SegmentId>65000000</SegmentId>

<GroupId>65010000</GroupId>

<ClassId>65010200</ClassId>

<SeriesId>10001125</SeriesId>

<VendorId>AM</VendorId>

<PartNumber>ADA3000BIBOX</PartNumber>

<Name>AMD Athlon64 3000+ (1800MHz/L2 Cache 512KB) Socket 939, BOX</Name>

<Warranty>36</Warranty>

<Price>196.00000</Price>

<Quantity>0</Quantity>

<DateExpected>1999-01-01T00:00:00</DateExpected>

<IsNewProduct>true</IsNewProduct>

</Product>

<Product>







<PartNumber>ADA3000AXBOX</PartNumber>

<Name>AMD Athlon64 3000+ (2000MHz/1600MHz/L2 Cache 512KB) Socket 754, BOX</Name>




<GrossWeight>3.6000</GrossWeight>


<IsNewProduct>false</IsNewProduct>

</Product>

</ProductList>

</GetProductListResult>

</GetProductListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt

Content-Type: application/soap+xml; charset=utf-8



<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-

envelope">

<soap12:Header>



</LicenseHeader>


12

</soap12:Header>

<soap12:Body>

<GetProductList xmlns="http://schemas.acme.eu/">

<GetProductListRequest>

<Filters>

<Filter>



</Filter>

<Filter>

<Name>Currency</Name>

<Value>LTL</Value>

</Filter>

</Filters>

</GetProductListRequest>

</GetProductList>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK






envelope">

<soap12:Body>

<GetProductListResponse xmlns="http://schemas.acme.eu/">

<GetProductListResult>

<ProductList>

<Product>







<PartNumber>ADA3000BIBOX</PartNumber>

<Name>AMD Athlon64 3000+ (1800MHz/L2 Cache 512KB) Socket 939, BOX</Name>





<IsNewProduct>true</IsNewProduct>

</Product>

<Product>








13

<PartNumber>ADA3000AXBOX</PartNumber>

<Name>AMD Athlon64 3000+ (2000MHz/1600MHz/L2 Cache 512KB) Socket 754, BOX</Name>




<GrossWeight>3.6000</GrossWeight>


<IsNewProduct>false</IsNewProduct>

</Product>

</ProductList>

</GetProductListResult>

</GetProductListResponse>

</soap12:Body>

</soap12:Envelope>

3.2.2 GetProductClassification Method

GetProductClassification method returns information about classification of products


This method does not have any request parameters.


Table 4 product classification response


Segment

SegmentId String 1 Top level product group identification, identifies the product Segment

SegmentName String 1 Segment name

Group

GroupId String 1 Second level product group identification, identifies the product group

SegmentId String 1 Identification number of parent segment

GroupName String 1 Group name

Class

ClassId String 1 Third level product group identification, identifies the product class

GroupId String 1 Identification number of parent group

ClassName String 1 Class name

Series

SeriesId String 1 Forth level product group identification, identifies the product series

ClassId String 1 Identification number of parent Class

SeriesName String 1 Series name

3.2.2.3 Request/Response examples

SOAP 1.1 examples:

Request:


Host: api.acme.lt


Content-Length: 123


14

SOAPAction: "http://schemas.acme.eu/GetProductClassification"



xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetProductClassification xmlns="http://schemas.acme.eu/">

<GetProductClassificationRequest />

</GetProductClassification>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 566





<soap:Body>

<GetProductClassificationResponse xmlns="http://schemas.acme.eu/">

<GetProductClassificationResult>

<SegmentList>

<Segment>


<SegmentName>Music</SegmentName>

</Segment>

<Segment>


<SegmentName>Computing</SegmentName>

</Segment>

<Segment>


<SegmentName>Audio Visual/Photography</SegmentName>

</Segment>

</SegmentList>

<GroupList>

<Group>



<GroupName>Musical Instruments/Accessories</GroupName>

</Group>

<Group>



<GroupName>Photography/Optics</GroupName>


15

</Group>

</GroupList>

<ClassList>

<Class>



<ClassName>Musical Instruments (Non Powered)</ClassName>

</Class>

<Class>



<ClassName>Computer Accessories</ClassName>

</Class>

</ClassList>

<SeriesList>

<Series>



<SeriesName>Brasswind Musical Instruments (Non Powered)</SeriesName>

</Series>

<Series>



<SeriesName>Woodwind Musical Instruments (Non Powered)</SeriesName>

</Series>

</SeriesList>

</GetProductClassificationResult>

</GetProductClassificationResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt


Content-Length: 543




envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetProductClassification xmlns="http://schemas.acme.eu/">

<GetProductClassificationRequest />

</GetProductClassification>

</soap12:Body>

</soap12:Envelope>


16

Response:

HTTP/1.1 200 OK






envelope">

<soap12:Body>

<GetProductClassificationResponse xmlns="http://schemas.acme.eu/">

<GetProductClassificationResult>

<SegmentList>

<Segment>


<SegmentName>Music</SegmentName>

</Segment>

<Segment>


<SegmentName>Computing</SegmentName>

</Segment>

<Segment>


<SegmentName>Audio Visual/Photography</SegmentName>

</Segment>

</SegmentList>

<GroupList>

<Group>



<GroupName>Musical Instruments/Accessories</GroupName>

</Group>

<Group>



<GroupName>Photography/Optics</GroupName>

</Group>

</GroupList>

<ClassList>

<Class>



<ClassName>Musical Instruments (Non Powered)</ClassName>

</Class>

<Class>



<ClassName>Computer Accessories</ClassName>

</Class>

</ClassList>

<SeriesList>

<Series>




17

<SeriesName>Brasswind Musical Instruments (Non Powered)</SeriesName>

</Series>

<Series>



<SeriesName>Woodwind Musical Instruments (Non Powered)</SeriesName>

</Series>

</SeriesList>

</GetProductClassificationResult>

</GetProductClassificationResponse>

</soap12:Body>

</soap12:Envelope>

3.2.3 GetProductBarcodeList Method

This method returns Product EAN barcodes list.

Notice: Some products can have more than one barcode


Table 5 available request filters

Name Occurs Value example Description

SupplierCode 0…n 004587 Product identification code assigned by supplier

Notes on request filters:

1. If SupplierCode filter not defined, web service method will return barcodes of all producs.

2. It is possible to supply more than one SupplierCode filter in single method request



Name Type Description

ProductBarcode

SupplierCode String Product identification code assigned by supplier

Barcode String Product barcode


SOAP 1.1 example:

Request:


Host: api.acme.lt


Content-Length: 455

SOAPAction: "http://schemas.acme.eu/GetProductBarcodeList"






18

<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetProductBarcodeList xmlns="http://schemas.acme.eu/">

<GetProductBarcodeListRequest />

</GetProductBarcodeList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 564





<soap:Body>

<GetProductBarcodeListResponse xmlns="http://schemas.acme.eu/">

<GetProductBarcodeListResult>

<ProductBarcodeList>

<SupplierCode> 000068</SupplierCode>

<Barcode>2000000029740</Barcode>

</ProductBarcode>

<ProductBarcode>


<Barcode> 0858540651912</Barcode>

</ProductBarcode>

</ProductBarcodeList>

</GetProductBarcodeListResult>

</GetProductBarcodeListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt


Content-Length: 564




envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>


19

<soap12:Body>

<GetProductBarcodeList xmlns="http://schemas.acme.eu/">

<GetProductBarcodeListRequest />

</GetProductBarcodeList>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 533




envelope">

<soap12:Body>

<GetProductBarcodeListResponse xmlns="http://schemas.acme.eu/">

<GetProductBarcodeListResult>

<ProductBarcodeList>

<ProductBarcode>


<Barcode>2000000029740</Barcode>

</ProductBarcode>

<ProductBarcode>


<Barcode> 0858540651912</Barcode>

</ProductBarcode>

</ProductBarcodeList>

</GetProductBarcodeListResult>

</GetProductBarcodeListResponse>

</soap12:Body>

</soap12:Envelope>

3.2.4 GetProductResources Method

Method returns information about product resources.




Language 1 lt-lt Preferred language of method response





ProductResources



20

ProductResource ProductResource 0..n Product resource (see below)

ProductResource

ResourceType String 1 Resource Type (for available types see table below)

ResourceName String 1 Resource name

ResourceURL String 1 Resource URL

Table 9 resource types

Type Type Description

0 Small Image

1 Pdf Document

2 MS Word Document

3 XML file

4 Link

5 RTF file

6 TXT file

7 Medium Image

8 Large Image


SOAP 1.1 example:

Request:


Host: api.acme.lt


Content-Length: 334

SOAPAction: "http://schemas.acme.eu/GetProductResources"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetProductResources xmlns="http://schemas.acme.eu/">

<GetProductResourcesRequest>

<Filters>

<Filter>


<Value>en-us</Value>

</Filter>

<Filter>

<Name>SupplierCode</Name>

<Value>018395</Value>

</Filter>

</Filters>

</GetProductResourcesRequest>

</GetProductResources>


21

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK







<soap:Body>

<GetProductResourcesResponse xmlns="http://schemas.acme.eu/">

<GetProductResourcesResult>

<ProductResources>


<ProductResource>

<ResourceType>0</ResourceType>

<ResourceName>d</ResourceName>

<ResourceURL>http://s3.acme.lt/products/018395/photos /large/1.jpg</ResourceURL>

</ProductResource>

<ProductResource>


<ResourceName>m</ResourceName>

<ResourceURL>http://s3.acme.lt/products/018395/photos /small/1.png</ResourceURL>

</ProductResource>

<ProductResource>


<ResourceName>v</ResourceName>

<ResourceURL>http://s3.acme.lt/products/018395/photos /medium/1.jpg</ResourceURL>

</ProductResource>

</ProductResources>

</GetProductResourcesResult>

</GetProductResourcesResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt


Content-Length: 344




envelope">

<soap12:Header>




22

</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetProductResources xmlns="http://schemas.acme.eu/">

<GetProductResourcesRequest>

<Filters>

<Filter>



</Filter>

<Filter>



</Filter>

</Filters>

</GetProductResourcesRequest>

</GetProductResources>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 633




envelope">

<soap12:Body>

<GetProductResourcesResponse xmlns="http://schemas.acme.eu/">

<GetProductResourcesResult>

<ProductResources>


<ProductResource>


<ResourceName>d</ResourceName>

<ResourceURL>http://s3.acme.lt/products/018395/photos /large/1.jpg</ResourceURL>

</ProductResource>

<ProductResource>


<ResourceName>m</ResourceName>

<ResourceURL>http://s3.acme.lt/products/018395/photos /small/1.png</ResourceURL>

</ProductResource>

<ProductResource>


<ResourceName>v</ResourceName>

<ResourceURL>http://s3.acme.lt/products/018395/photos /medium/1.jpg</ResourceURL>

</ProductResource>

</ProductResources>

</GetProductResourcesResult>

</GetProductResourcesResponse>

</soap12:Body>

</soap12:Envelope>


23

3.2.5 GetProductSpecification Method

Method returns list of product specifications.




Language 1 lt-lt Preferred language of method response


UpdatedSince 1 2008.10.15 10:15:15 Narrows result to product specifications which were created

or modified since defined time




ProductSpecification


ProductProperty ProductProperty 0…n Product property

ProductProperty

PropertyCode String 1 Property identification code

PropertyName String 1 Property name

PropertyValue String 1 Property value


SOAP 1.1 example:

Request:


Host: api.acme.lt



SOAPAction: "http://schemas.acme.eu/GetProductSpecification"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetProductSpecification xmlns="http://schemas.acme.eu/">


24

<GetProductSpecificationRequest>

<Filters>

<Filter>



</Filter>

<Filter>



</Filter>

</Filters>

</GetProductSpecificationRequest>

</GetProductSpecification>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK







<soap:Body>

<GetProductSpecificationResponse xmlns="http://schemas.acme.eu/">

<GetProductSpecificationResult>

<ProductSpecification>


<ProductProperty>

<PropertyCode>95</PropertyCode>

<PropertyName>Video</PropertyName>

<PropertyValue>nVidia Ge Force 8400M G 256MB</PropertyValue>

</ProductProperty>

<ProductProperty>


<PropertyName>Type</PropertyName>

<PropertyValue>13.3 WXGA glare wide</PropertyValue>

</ProductProperty>

<ProductProperty>


<PropertyName>Keyboard</PropertyName>

<PropertyValue>US</PropertyValue>

</ProductProperty>

<ProductProperty>


<PropertyName>Optical storage</PropertyName>

<PropertyValue>Super Multi DL DVD+/-RW (CBB standard)</PropertyValue>

</ProductProperty>

<ProductProperty>


<PropertyName>AC adapter</PropertyName>

<PropertyValue>Output : 19V DC 3.42A 90W; Input : 100~240V AC 50/60Hz universal (CBB


25

standard)</PropertyValue>

</ProductProperty>

<ProductProperty>


<PropertyName>HDD</PropertyName>

<PropertyValue>SATA 120GB / 5400rpm (CBB standard)</PropertyValue>

</ProductProperty>

</ProductSpecification>

</GetProductSpecificationResult>

</GetProductSpecificationResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt






envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetProductSpecification xmlns="http://schemas.acme.eu/">

<GetProductSpecificationRequest>

<Filters>

<Filter>



</Filter>

<Filter>



</Filter>

</Filters>

</GetProductSpecificationRequest>

</GetProductSpecification>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK





26



envelope">

<soap12:Body>

<GetProductSpecificationResponse xmlns="http://schemas.acme.eu/">

<GetProductSpecificationResult>

<ProductSpecification>

<ProductProperty>


<PropertyName>Video</PropertyName>

<PropertyValue>nVidia Ge Force 8400M G 256MB</PropertyValue>

</ProductProperty>

<ProductProperty>


<PropertyName>Type</PropertyName>

<PropertyValue>13.3 WXGA glare wide</PropertyValue>

</ProductProperty>

<ProductProperty>


<PropertyName>Keyboard</PropertyName>

<PropertyValue>US</PropertyValue>

</ProductProperty>

<ProductProperty>


<PropertyName>Optical storage</PropertyName>

<PropertyValue>Super Multi DL DVD+/-RW (CBB standard)</PropertyValue>

</ProductProperty>

<ProductProperty>


<PropertyName>AC adapter</PropertyName>

<PropertyValue>Output : 19V DC 3.42A 90W; Input : 100~240V AC 50/60Hz universal (CBB

standard)</PropertyValue>

</ProductProperty>

<ProductProperty>


<PropertyName>HDD</PropertyName>

<PropertyValue>SATA 120GB / 5400rpm (CBB standard)</PropertyValue>

</ProductProperty>

</ProductSpecification>

</GetProductSpecificationResult>

</GetProductSpecificationResponse>

</soap12:Body>

</soap12:Envelope>

3.2.6 GetVendorList Method

This method return list of products’ vendors





27



Vendor

VendorId String 1 Vendor’s identification code in Supplier System

VendorName String 1 Vendor Name


SOAP 1.1 example:

Request:


Host: api.acme.lt



SOAPAction: "http://schemas.acme.eu/GetVendorList"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetVendorList xmlns="http://schemas.acme.eu/">

<GetVendorListRequest />

</GetVendorList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK







<soap:Body>

<GetVendorListResponse xmlns="http://schemas.acme.eu/">

<GetVendorListResult>

<VendorList>

<Vendor>


<VendorName>AMD</VendorName>

</Vendor>

<Vendor>


28

<VendorId>V1</VendorId>

<VendorName>Vendor</VendorName>

</Vendor>

</VendorList>

</GetVendorListResult>

</GetVendorListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt






envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetVendorList xmlns="http://schemas.acme.eu/">

<GetVendorListRequest />

</GetVendorList>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK






envelope">

<soap12:Body>

<GetVendorListResponse xmlns="http://schemas.acme.eu/">

<GetVendorListResult>

<VendorList>

<Vendor>


<VendorName>AMD</VendorName>

</Vendor>

<Vendor>

<VendorId>V1</VendorId>

<VendorName>Vendor</VendorName>


29

</Vendor>

</VendorList>

</GetVendorListResult>

</GetVendorListResponse>

</soap12:Body>

</soap12:Envelope>

3.2.7 GetProductRelationList method

Methods returns information about related products


Table 13 method request details


SupplierCode 0…n 003315 Narrows result set to product with defined SupplierCode




ProductRelationList

ProductRelation ProductRelation 0…n List of product relations

ProductRelation


RelatedSupplierCode String 1 Code of releted product


SOAP 1.1 example:

Request:


Host: api.acme.lt


Content-Length: 436

SOAPAction: "http://schemas.acme.eu/GetProductRelationList"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetProductRelationList xmlns="http://schemas.acme.eu/">

<GetProductRelationListRequest>


30

<Filters>

</Filters>

</GetProductRelationListRequest>

</GetProductRelationList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 456





<soap:Body>

<GetProductRelationListResponse xmlns="http://schemas.acme.eu/">

<GetProductRelationListResult>

<ProductRelationList>

<ProductRelation>


<RelatedSupplierCode>015693</RelatedSupplierCode>

</ProductRelation>

<ProductRelation>



</ProductRelation>

</ProductRelationList>

</GetProductRelationListResult>

</GetProductRelationListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt


Content-Length: 632




envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetProductRelationList xmlns="http://schemas.acme.eu/">


31

<GetProductRelationListRequest>

</GetProductRelationListRequest>

</GetProductRelationList>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK






envelope">

<soap12:Body>

<GetProductRelationListResponse xmlns="http://schemas.acme.eu/">

<GetProductRelationListResult>

<ProductRelationList>

<ProductRelation>



</ProductRelation>

<ProductRelation>



</ProductRelation>

</ProductRelationList>

</GetProductRelationListResult>

</GetProductRelationListResponse>

</soap12:Body>

</soap12:Envelope>

3.2.8 GetProductPresentList Method

Method returns information about presents associated with products




Language 1 lt-lt Prefered language for present names

SupplierCode 0…n 003315 Narrows result set to product with defined SupplierCode




ProductPresentList

ProductPresent ProductPresent 0…n Array of product presents


32

ProductPresent


PresentName String 1 Present name


SOAP 1.1 example:


Host: api.acme.lt


Content-Length: 478

SOAPAction: "http://schemas.acme.eu/GetProductPresentList"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetProductPresentList xmlns="http://schemas.acme.eu/">

<GetProductPresentListRequest>

<Filters>

<Filter>



</Filter>

</Filters>

</GetProductPresentListRequest>

</GetProductPresentList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 658





<soap:Body>

<GetProductPresentListResponse xmlns="http://schemas.acme.eu/">

<GetProductPresentListResult>

<ProductPresentList>

<ProductPresent>


<PresentName>Present name</PresentName>


33

</ProductPresent>

<ProductPresent>



</ProductPresent>

</ProductPresentList>

</GetProductPresentListResult>

</GetProductPresentListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt






envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetProductPresentList xmlns="http://schemas.acme.eu/">

<GetProductPresentListRequest>

<Filters>

<Filter>



</Filter>

</Filters>

</GetProductPresentListRequest>

</GetProductPresentList>

</soap12:Body>

</soap12:Envelope>

Request:

HTTP/1.1 200 OK


Content-Length: 547




envelope">

<soap12:Body>

<GetProductPresentListResponse xmlns="http://schemas.acme.eu/">


34

<GetProductPresentListResult>

<ProductPresentList>

<ProductPresent>



</ProductPresent>

<ProductPresent>



</ProductPresent>

</ProductPresentList>

</GetProductPresentListResult>

</GetProductPresentListResponse>

</soap12:Body>

</soap12:Envelope>

3.2.9 Get ProductBundleList Method

Method returns list of available bundles. Bundle Id is reference to SupplierCode property in GetProducList

method response.


Method does not have any request parameters.



ProductBundleList

ProductBundle ProductBundle 0…n Array of Product bundle

ProductBundle

BundleId String 1 Bundle identification number (equal to SupplierCode in

ProductList)

BundledProduct BundledProduct 0…n Array of BundledProduct

BundledProduct


Quantity Decimal 1 Product quantity in bundle


SOAP 1.1 examples:

Request:


Host: api.acme.lt


Content-Length: 385


35

SOAPAction: "http://schemas.acme.eu/GetProductBundleList"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetProductBundleList xmlns="http://schemas.acme.eu/">

<GetProductBundleListRequest>

<Filters>

</Filters>

</GetProductBundleListRequest>

</GetProductBundleList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 674





<soap:Body>

<GetProductBundleListResponse xmlns="http://schemas.acme.eu/">

<GetProductBundleListResult>

<ProductBundleList>

<ProductBundle>

<BundleId>040955</BundleId>

<BundledProduct>



</BundledProduct>

<BundledProduct>



</BundledProduct>

</ProductBundle>

<ProductBundle>


<BundledProduct>



</BundledProduct>

<BundledProduct>




36

</BundledProduct>

</ProductBundle>

</ProductBundleList>

</GetProductBundleListResult>

</GetProductBundleListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 examples:

Request:


Host: api.acme.lt


Content-Length: 652




envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetProductBundleList xmlns="http://schemas.acme.eu/">

<GetProductBundleListRequest>

<Filters>

</Filters>

</GetProductBundleListRequest>

</GetProductBundleList>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 436




envelope">

<soap12:Body>

<GetProductBundleListResponse xmlns="http://schemas.acme.eu/">

<GetProductBundleListResult>

<ProductBundleList>

<ProductBundle>


<BundledProduct>



</BundledProduct>


37

<BundledProduct>



</BundledProduct>

</ProductBundle>

<ProductBundle>


<BundledProduct>



</BundledProduct>

<BundledProduct>



</BundledProduct>

</ProductBundle>

</ProductBundleList>

</GetProductBundleListResult>

</GetProductBundleListResponse>

</soap12:Body>

</soap12:Envelope>

3.2.10 GetTreeNodes method

Method returns list E-commerce tree nodes.

3.2.10.1 Method request

Table 17 Method request filters

Name Occurs Example Description

Language 1 en-us Prefered language for Node names

3.2.10.2 Method response

Table 18 Method response details


NodesList

TreeNode TreeNode 0...n Array of TreeNode

TreeNode

NodeId String 1 Tree Node identification number

ParrentNodeId String 1 Parent tree node Id

Name String 1 Node name

Left Integer 1 Left number for Modified Preorder Tree Traversal Algoritm

Right Integer 1 Right number for Modified Preorder Tree Traversal Algoritm



38

SOAP 1.1 examples:

Request:


Host: api.acme.lt


Content-Length: 452

SOAPAction: "http://schemas.acme.eu/GetTreeNodes"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetTreeNodes xmlns="http://schemas.acme.eu/">

<GetTreeNodesRequest>

<Filters>

<Filter>



</Filter>

</Filters>

</GetTreeNodesRequest>

</GetTreeNodes>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 642





<soap:Body>

<GetTreeNodesResponse xmlns="http://schemas.acme.eu/">

<GetTreeNodesResult>

<NodeList>

<TreeNode>

<NodeId>005564</NodeId>

<ParentNodeId>44455</ParentNodeId>

<Name>Scanners</Name>

<Left>102</Left>

<Right>102</Right>

</TreeNode>

<TreeNode>


39



<Name>Printers</Name>

<Left>89</Left>

<Right>89</Right>

</TreeNode>

</NodeList>

</GetTreeNodesResult>

</GetTreeNodesResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 examples:

Request:


Host: api.acme.lt


Content-Length: 652




envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetTreeNodes xmlns="http://schemas.acme.eu/">

<GetTreeNodesRequest>

<Filters>

<Filter>



</Filter>

</Filters>

</GetTreeNodesRequest>

</GetTreeNodes>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 652




envelope">

<soap12:Body>

<GetTreeNodesResponse xmlns="http://schemas.acme.eu/">


40

<GetTreeNodesResult>

<NodeList>

<TreeNode>



<Name>Scanners</Name>

<Left>102</Left>

<Right>102</Right>

</TreeNode>

<TreeNode>



<Name>Printers</Name>

<Left>89</Left>

<Right>89</Right>

</TreeNode>

</NodeList>

</GetTreeNodesResult>

</GetTreeNodesResponse>

</soap12:Body>

</soap12:Envelope>

3.2.11 GetTreeNodeProducts method

Method returns positions of Products in ecommerce tree

3.2.11.1 Method request

Method does not have any request parameters

3.2.11.2 Method response

Table 19 Method response details


NodeProductList

NodeProduct NodeProduct 0…n Array of NodeProduct

NodeProduct

NodeId String 1 Tree node Id

SupplierCode String 1 Product identification number


SOAP 1.1 examples:

Request:


Host: api.acme.lt


Content-Length: 652

SOAPAction: "http://schemas.acme.eu/GetTreeNodeProducts"


41





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetTreeNodeProducts xmlns="http://schemas.acme.eu/">

<GetTreeNodeProductsRequest>

<Filters>

</Filters>

</GetTreeNodeProductsRequest>

</GetTreeNodeProducts>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 535





<soap:Body>

<GetTreeNodeProductsResponse xmlns="http://schemas.acme.eu/">

<GetTreeNodeProductsResult>

<NodeProductList>

<NodeProduct>



</NodeProduct>

<NodeProduct>



</NodeProduct>

</NodeProductList>

</GetTreeNodeProductsResult>

</GetTreeNodeProductsResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 examples:

Request:


Host: api.acme.lt


Content-Length: 356


42




envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetTreeNodeProducts xmlns="http://schemas.acme.eu/">

<GetTreeNodeProductsRequest>

<Filters>

</Filters>

</GetTreeNodeProductsRequest>

</GetTreeNodeProducts>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 632




envelope">

<soap12:Body>

<GetTreeNodeProductsResponse xmlns="http://schemas.acme.eu/">

<GetTreeNodeProductsResult>

<NodeProductList>

<NodeProduct>



</NodeProduct>

<NodeProduct>



</NodeProduct>

</NodeProductList>

</GetTreeNodeProductsResult>

</GetTreeNodeProductsResponse>

</soap12:Body>

</soap12:Envelope>


43

3.3 Orders

3.3.1 GetAddressList Method

Method returns list of available user addresses.






AddressList

Address Address 0..n Array of addresses

Address

AddressId String 1 Address identification code assigned by supplier

Street String 1 Street

City String 1 City

PostalCode String 1 Postal code

CountryCode String 1 Country code


SOAP 1.1 example:

Request:


Host: api.acme.lt


Content-Length: 457

SOAPAction: "http://schemas.acme.eu/GetAddressList"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetAddressList xmlns="http://schemas.acme.eu/">

<GetAddressListRequest>

</GetAddressListRequest>

</GetAddressList>

</soap:Body>

</soap:Envelope>


44

Response:

HTTP/1.1 200 OK


Content-Length:527





<soap:Body>

<GetAddressListResponse xmlns="http://schemas.acme.eu/">

<GetAddressListResult>

<AddressList>

<Address>

<AddressId>0001</AddressId>

<Street>Demo Street</Street>

<City>Kaunas</City>

<PostalCode>4444</PostalCode>

<CountryCode>LT</CountryCode>

</Address>

</AddressList>

</GetAddressListResult>

</GetAddressListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt






envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetAddressList xmlns="http://schemas.acme.eu/">



</GetAddressList>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK



45





envelope">

<soap12:Body>

<GetAddressListResponse xmlns="http://schemas.acme.eu/">

<GetAddressListResult>

<AddressList>

<Address>

<AddressId>0001</AddressId>

<Street>Demo Street</Street>

<City>Kaunas</City>

<PostalCode>4444</PostalCode>

<CountryCode>LT</CountryCode>

</Address>

</AddressList>

</GetAddressListResult>

</GetAddressListResponse>

</soap12:Body>

</soap12:Envelope>

3.3.2 GetDeliveryTypeList Method

Returns Available delivery types


Table 21 Method request parameters


Language 1 lt-lt Prefered language of delivery type name


Table 22 delivery type details


DeliveryTypeList

DeliveryType DeilveryType 0..n Delivery types list

DeliveryType

DeliveryTypeId Integer 1 Delivery type id

Name String 1 Delivery type name


SOAP 1.1 example:

Request:



46

Host: api.amce.lt


Content-Length: 653

SOAPAction: "http://schemas.acme.eu/GetDeliveryTypeList"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetDeliveryTypeList xmlns="http://schemas.acme.eu/">


<Filters>

</Filters>


</GetDeliveryTypeList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 745





<soap:Body>

<GetDeliveryTypeListResponse xmlns="http://schemas.acme.eu/">

<GetDeliveryTypeListResult>

<DeliveryTypeList>

<DeliveryType>

<DeliveryTypeId>1</DeliveryTypeId>

<Name>Carrier Delivery</Name>

</DeliveryType>

<DeliveryType>


<Name>Express Delivery</Name>

</DeliveryType>

</DeliveryTypeList>

</GetDeliveryTypeListResult>

</GetDeliveryTypeListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


47


Host: api.amce.lt






envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetDeliveryTypeList xmlns="http://schemas.acme.eu/">


<Filters>

</Filters>


</GetDeliveryTypeList>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK






envelope">

<soap12:Body>

<GetDeliveryTypeListResponse xmlns="http://schemas.acme.eu/">

<GetDeliveryTypeListResult>

<DeliveryTypeList>

<DeliveryType>


<Name>Carrier Delivery</Name>

</DeliveryType>

<DeliveryType>


<Name>Express Delivery</Name>

</DeliveryType>

</DeliveryTypeList>

</GetDeliveryTypeListResult>

</GetDeliveryTypeListResponse>

</soap12:Body>

</soap12:Envelope>


48

3.3.3 PurchaseProducts Method

Creates products orders




PurchaseLines

ProductPurchaseLine ProductPurchaseLine 0…n Product purchase line

ProductPurchaseLine

ProductPurchaseLineId String 1 ProductPurchaseLine identification number

assigned by customer party

OrderingBranchAddressId String 0..1 Customer’s branch AddressId used to identify

ordering branch values available from

GetAddressList method

OrderRefId String 0..1 User’s order reference id (20 characters max)

OrderLineRefId String 0..1 User’s order line reference id (20 characters max)


Quantity Integer 1 Quantity


DeliveryContact Contact 1 Delivery Contact information

DeliveryAddress Address 1 Delivery Address

Note String 0..1 Note for sales manager

CarrierNote String 0..1 Note for Carrier

CashOnDelivery Boolean 1 Cash On Delivery Option valid only for delivery to

customers addresses available in GetAddressList

method

Address

AddressId String 1 Address identification code assigned by supplier

Street String 1 Street

City String 1 City

PostalCode String 1 Postal code

CountryCode String 1 Country code (2 letters)

Contact

FirstName String 1 First Name

LastName String 1 Last Name

Email String 0..1 Email

Phone String 0..1 Phone

Notes:

List of available addresses you can get with GetAddressList method. You have to supply AddressId only other

fields (Street, City, PostalCode, Country) will be ignored in this method If AddressId left blank and all other fields

(Street, PostalCode, City, CountryCode) are filled it will be treated as custom address.

CountryCode must be provided as ISO 3166 code. (2 letters country code)

ProductPurchaseLineId is used to track relation between ProductPurchaseLine in request and

ProductPurchaseStatus in response.


49



Name Type Occurs Descriptions

StatusList

ProductPurchaseStatus ProductPurchaseStatus 0…n Product purchase status

ProductPurchaseStatus

ProductPurchaseLineId String 1 ProductPurchaseLine identification number

assigned by customer party

Status String 1 OK - product purchase line processed successfully

FAILED – failed to process product purchase line

Note String 1 Note

OrderReferenceId String 1 Order Reference identification number

All purchases are processed with delay and it is impossible to return real OrderId in method response.

OrderReferenceId links to real OrderId. Product purchases from one PurchaseProducts method call may be

placed in different orders.


SOAP 1.1 example:

Request:


Host: api.acme.lt



SOAPAction: "http://schemas.acme.eu/PurchaseProducts"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<PurchaseProducts xmlns="http://schemas.acme.eu/">

<PurchaseProductsRequest>

<PurchaseLines>

<ProductPurchaseLine>

<ProductPurchaseLineId>001</ProductPurchaseLineId>

<OrderingBranchAddressId>001</ OrderingBranchAddressId >

<OrderRefId>001</OrderRefId>

<OrderLineRefId>001</OrderLineRefId>




50


<DeliveryContact>

<FirstName>First Name</FirstName>

<LastName>Last Name</LastName>

<Email>[email protected]</Email>

<Phone>2254444</Phone>

</DeliveryContact>

<DeliveryAddress>

<AddressId>adr1</AddressId>

<Street></Street>

<City></City>

<PostalCode></PostalCode>

<CountryCode></CountryCode>

</DeliveryAddress>

<Note>Note for manager</Note>

<CarrierNote>string</CarrierNote>

<CashOnDelivery>false</CashOnDelivery>

</ProductPurchaseLine>









<DeliveryContact>





</DeliveryContact>

<DeliveryAddress>


<Street></Street>

<City></City>



</DeliveryAddress>

<Note>Note for managers</Note>

<CarrierNote>note</CarrierNote>



</PurchaseLines>

</PurchaseProductsRequest>

</PurchaseProducts>

</soap:Body>

</soap:Envelope>

Response

HTTP/1.1 200 OK





51




<soap:Body>

<PurchaseProductsResponse xmlns="http://schemas.acme.eu/">

<PurchaseProductsResult>

<StatusList>

<ProductPurchaseStatus>


<Status>OK</Status>

<Note></Note>

<OrderReferenceId>15</OrderReferenceId>

</ProductPurchaseStatus>



<Status>OK</Status>

<Note></Note>



</StatusList>

</PurchaseProductsResult>

</PurchaseProductsResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt






envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<PurchaseProducts xmlns="http://schemas.acme.eu/">

<PurchaseProductsRequest>

<PurchaseLines>









<DeliveryContact>



52




</DeliveryContact>

<DeliveryAddress>


<Street></Street>

<City></City>



</DeliveryAddress>

<Note>string</Note>












<DeliveryContact>





</DeliveryContact>

<DeliveryAddress>


<Street></Street>

<City></City>



</DeliveryAddress>

<Note>note</Note>




</PurchaseLines>

</PurchaseProductsRequest>

</PurchaseProducts>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK






envelope">


53

<soap12:Body>

<PurchaseProductsResponse xmlns="http://schemas.acme.eu/">

<PurchaseProductsResult>

<StatusList>



<Status>OK</Status>

<Note></Note>





<Status>OK</Status>

<Note></Note>



</StatusList>

</PurchaseProductsResult>

</PurchaseProductsResponse>

</soap12:Body>

</soap12:Envelope>

3.3.4 GetOrderDetails Method

Method returns Order List


Table 25 available request parameters


OrderId 0…n SU000001 Order Id

OrderReferenceId 0...n 00244444 Order reference id from PurchaseProducts method

OrderRefId 0…n refid Order reference id defined by user.

Notes on request filters:

1. If no filters supplied all orders will be returned.

2. If filters OrderId or OrderReferenceId are supplied only matching order will be returned.

3. It is possible to supply more than one OrderId or OrderReferenceId filter in request




OrderList

Order Order 0…n Order

Order

OrderHeader OrderHeader 1 Order header

OrderLine OrderLine 1..n Order line

OrderHeader

OrderId String 1 Order id

OrderLine



54

OrderLineId String 1 Order line identification number

OrderRefId String 1 User’s order reference id

OrderLineRefId String 1 User’s order line reference id

UserId String 1 User identification number assigned by supplier

CurrencyCode String 1 Currency code

SalesPrice Decimal 1 Sales price

Quantity Decimal 1 Quantity

TypeId Integer 1 OrderLine type identification number

LineAmount Decimal 1 Line amount without VAT

IsEditable Boolean 1 True – line is editable

False – line is not editable

LineNote String 1 Line note

DeliveryStreet String 1 Delivery street

DeliveryCity String 1 Delivery city

DeliveryPostalCode String 1 Delivery postal code

DeliveryCountry String 1 Delivery country


DeliveryContact Contact 1 Delivery Contact

CarrierNote String 1 Carrier note

DeliveryName String 1 Delivery name

CashOnDelivery Boolean 1 Cash on delivery

OrderingBranchAddressId String 1 Customer’s branch AddressId used to identify ordering

branch

Contact

FirstName String 1 First name

LastName String 1 Last Name

Email String 1 Email

Phone String 1 Phone

Table 27 OrderLine types

TypeId Description

0 Products are placed on order

1 Products are physically reserved


SOAP 1.1 example:

Request:


Host: api.acme.lt


Content-Length: 423

SOAPAction: "http://schemas.acme.eu/GetOrderDetails"





<soap:Header>


55



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetOrderDetails xmlns="http://schemas.acme.eu/">

<GetOrderDetailsRequest>

<Filters>

<Filter>

<Name>OrderId</Name>

<Value>SU001</Value>

</Filter>

</Filters>

</GetOrderDetailsRequest>

</GetOrderDetails>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 632





<soap:Body>

<GetOrderDetailsResponse xmlns="http://schemas.acme.eu/">

<GetOrderDetailsResult>

<OrderList>

<Order>

<OrderHeader>

<OrderId>SU001</OrderId>

</OrderHeader>

<OrderLine>


<OrderLineId>5637555135</OrderLineId>



<UserId>U001</UserId>

<CurrencyCode>LTL</CurrencyCode>

<SalesPrice>605.0000</SalesPrice>

<Quantity>1.0000</Quantity>

<TypeId>1</TypeId>

<LineAmount>605.0000</LineAmount>

<IsEditable>true</IsEditable>

<LineNote>note</LineNote>

<DeliveryStreet>Kalvarijų g. 98</DeliveryStreet>

<DeliveryCity>Vilnius</DeliveryCity>

<DeliveryPostalCode>08211</DeliveryPostalCode>

<DeliveryCountry>lt</DeliveryCountry>


<DeliveryName>Delivery Name</DeliveryName>


56

<DeliveryContact>





</DeliveryContact>




</OrderLine>

<OrderLine>









<TypeId>1</TypeId>



<LineNote/>

<DeliveryStreet>Street 1</DeliveryStreet>






<DeliveryContact>





</DeliveryContact>




</OrderLine>

</Order>

</OrderList>

</GetOrderDetailsResult>

</GetOrderDetailsResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt


Content-Length: 475


57




envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetOrderDetails xmlns="http://schemas.acme.eu/">

<GetOrderDetailsRequest>

<Filters>

<Filter>

<Name>OrderId</Name>

<Value>SU001</Value>

</Filter>

</Filters>

</GetOrderDetailsRequest>

</GetOrderDetails>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 548




envelope">

<soap12:Body>

<GetOrderDetailsResponse xmlns="http://schemas.acme.eu/">

<GetOrderDetailsResult>

<OrderList>

<Order>

<OrderHeader>

<OrderId>SU001</OrderId>

</OrderHeader>

<OrderLine>









<TypeId>1</TypeId>



<LineNote/>

<DeliveryStreet>Kalvarijų g. 98</DeliveryStreet>


58






<DeliveryContact>





</DeliveryContact>




</OrderLine>

<OrderLine>









<TypeId>1</TypeId>



<LineNote/>

<DeliveryStreet>Street 1</DeliveryStreet>






<DeliveryContact>





</DeliveryContact>




</OrderLine>

</Order>

</OrderList>

</GetOrderDetailsResult>

</GetOrderDetailsResponse>

</soap12:Body>

</soap12:Envelope>

3.3.5 GetCustomerUserList Method

Returns Customer’s user list.


59






UserList

User User 0…n Users

User

UserId String 1 User identification number assigned by supplier


LastName String 1 Last name


SOAP 1.1 example:

Request:


Host: api.acme.lt



SOAPAction: "http://schemas.acme.eu/GetCustomerUserList"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetCustomerUserList xmlns="http://schemas.acme.eu/">

<GetCustomerUserListRequest>

</GetCustomerUserListRequest>

</GetCustomerUserList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK







60


<soap:Body>

<GetCustomerUserListResponse xmlns="http://schemas.acme.eu/">

<GetCustomerUserListResult>

<UserList>

<User>


<FirstName>John</FirstName>

<LastName>Doe</LastName>

</User>

<User>


<FirstName>Mark</FirstName>

<LastName>Thomas</LastName>

</User>

</UserList>

</GetCustomerUserListResult>

</GetCustomerUserListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt



SOAPAction: "http://schemas.acme.eu/GetCustomerUserList"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetCustomerUserList xmlns="http://schemas.acme.eu/">

<GetCustomerUserListRequest>

</GetCustomerUserListRequest>

</GetCustomerUserList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK








61

<soap:Body>

<GetCustomerUserListResponse xmlns="http://schemas.acme.eu/">

<GetCustomerUserListResult>

<UserList>

<User>


<FirstName>John</FirstName>

<LastName>Doe</LastName>

</User>

<User>


<FirstName>Mark</FirstName>

<LastName>Thomas</LastName>

</User>

</UserList>

</GetCustomerUserListResult>

</GetCustomerUserListResponse>

</soap:Body>

</soap:Envelope>

3.3.6 UpdateOrderLine Method

This method is used for OrderLine modification. There are 3 available actions for OrderLine updates:

1. delete – this action is used to delete selected OrderLine

2. update – this action is used to update OrderLine

3. split – this action is used to split one OrderLine in two separate OrderLine.

Request

Required request fields for all actions are OrderLineId, TypeId and Action Combination of OrderLineId and

TypeId fields used to identify order lines in Web Services. Other fields may be not required depending on

action. It is possible to supply more than one OrderLineUpdate in one request.


delete action:

Table 29 delete action request parameters


OrderLineUpdate


TypeId Integer 1 Order line type identification number

Action String 1 Action code

DeliveryTypeId Integer 0 Delivery type identification number

DeliveryAddress Address 0 Delivery address (see GetAddressList for details)


Note String 0 Note

update action:


62

Table 30 update action request parameters


OrderLineUpdate


OrderRefId String 1 User’s order reference id (20 characters max)

OrderLineRefId String 1 User’s order line reference id (20 characters max)






Note String 1 Note sales managers

CarrierNote String 1 Note for carrier

DeliveryContact Contact 1 Delivery contact

OrderingBranchAddr

essId

String 1 Customer’s branch AddressId used to identify ordering branch

values available from GetAddressList method

CashOnDelivery Boolean 1 Cash on delivery. Option valid only for delivery to customers

addresses available in GetAddressList method


Contact





Notes on update requests:

DeliveryAddress: if DeliveryAddress not provided or provided with empty strings in all fields address will be taken

from order line. If AddressId supplied it must be taken from GetAddressList response. If AddressId left blank and

all other fields are filled it will be treated as custom address


Quantity, DeliveryTypeId, Note: use values from updatable order line if you don’t want update these fields

Table 31 OrderLine types

TypeId Description

0 Products are placed on order

1 Products are physically reserved

split action:

Table 32 split action request parameters


OrderLineUpdate


OrderRefId String 1 User’s order reference id (20 characters max)

OrderLineRefId String 1 User’s order line reference id (20 characters max)







63

Note String 1 Note

CarrierNote String 1 Note for carrier

DeliveryContact Contact 1 Delivery contact

OrderingBranchAddr

essId

String 1 Customer’s branch AddressId used to identify ordering branch

values available from GetAddressList method

CashOnDelivery Boolean 1 Cash on delivery. Option valid only for delivery to customers

addresses available in GetAddressList method


Contact





Notes on split requests

DeliveryAddress: If AddressId supplied it must be taken from GetAddressList response. If AddressId left blank and

all other fields are filled it will be treated as custom address





UpdateLog

OrderLineUpdateStatus OrderLineUpdateStatus 0…n OrderLineUpdateStatus

OrderLineUpdateStatus


TypeId String 1 OrderLine type identification number

Status String 1 Update status

Note String 1 Additional information about error


SOAP 1.1 example:

Request:


Host: api.acme.lt



SOAPAction: "http://schemas.acme.eu/UpdateOrderLine"





<soap:Header>



</LicenseHeader>

</soap:Header>


64

<soap:Body>

<UpdateOrderLine xmlns="http://schemas.acme.eu/">

<UpdateOrderLineRequest>

<Updates>

<OrderLineUpdate>


<TypeId>1</TypeId>

<Action>delete</Action>

</OrderLineUpdate>

</Updates>

</UpdateOrderLineRequest>

</UpdateOrderLine>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK







<soap:Body>

<UpdateOrderLineResponse xmlns="http://schemas.acme.eu/">

<UpdateOrderLineResult>

<UpdateLog>

<OrderLineUpdateStatus>


<Status>OK</Status>

<TypeId>1</TypeId>

<Note></Note>

</OrderLineUpdateStatus>

</UpdateLog>

</UpdateOrderLineResult>

</UpdateOrderLineResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt


Content-Length: 487




envelope">

<soap12:Header>




65

</LicenseHeader>

</soap12:Header>

<soap12:Body>

<UpdateOrderLine xmlns="http://schemas.acme.eu/">

<UpdateOrderLineRequest>

<Updates>

<OrderLineUpdate>


<TypeId>1</TypeId>

<Action>delete</Action>

</OrderLineUpdate>

</Updates>

</UpdateOrderLineRequest>

</UpdateOrderLine>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 365




envelope">

<soap12:Body>

<UpdateOrderLineResponse xmlns="http://schemas.acme.eu/">

<UpdateOrderLineResult>

<UpdateLog>

<OrderLineUpdateStatus>


<Status>OK</Status>

<TypeId>1</TypeId>

<Note></Note>

</OrderLineUpdateStatus>

</UpdateLog>

</UpdateOrderLineResult>

</UpdateOrderLineResponse>

</soap12:Body>

</soap12:Envelope>


66

3.4 Invoices

3.4.1 GetInvoiceList Method

Method returns list of invoice headers.




InvoiceDateFrom 0…1 2008.01.01 Invoice date from

InvoiceDateTo 0…1 2008.01.30 Invoice date to

DueDateFrom 0…1 2008.02.01 Invoice due date from

DueDateTo 0…1 2008.02.14 Invoice due date to




InvoiceHeaderList

InvoiceHeader InvoiceHeader 0…n

InvoiceHeader

InvoiceNumber String 1 Invoice number

InvoiceDate DateTime 1 Invoice date

DueDate DateTime 1 Due date

InvoiceAmount Decimal 1 Invoice amount without VAT

InvoiceAmountWithTaxes Decimal 1 Invoice amount with VAT

PaidSum Decimal 1 Paid sum


BranchId String 1 Customer’s branch id

DeliveryAddress String 1 Delivery address


SOAP 1.1 example:

Request:


Host: api.acme.lt



SOAPAction: "http://schemas.acme.eu/GetInvoiceList"





<soap:Header>



</LicenseHeader>

</soap:Header>


67

<soap:Body>

<GetInvoiceList xmlns="http://schemas.acme.eu/">

<GetInvoiceListRequest>

<Filters>

<Filter>

<Name>InvoiceDateFrom</Name>

<Value>2008.02.02</Value>

</Filter>

<Filter>

<Name>InvoiceDateTo</Name>


</Filter>

</Filters>

</GetInvoiceListRequest>

</GetInvoiceList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK


Content-Length: 475





<soap:Body>

<GetInvoiceListResponse xmlns="http://schemas.acme.eu/">

<GetInvoiceListResult>

<InvoiceHeaderList>

<InvoiceHeader>

<InvoiceNumber>INV-00000001</InvoiceNumber>

<InvoiceDate>2008.02.25</InvoiceDate>

<DueDate>2008.03.25</DueDate>

<InvoiceAmount>100,00</InvoiceAmount>

<InvoiceAmountWithTaxes>118,00</InvoiceAmountWithTaxes>

<PaidSum>25,00</PaidSum>


<BranchId>111</BranchId>

<DeliveryAddress>Delivery Address</DeliveryAddress>

</InvoiceHeader>

<InvoiceHeader>










</InvoiceHeader>

</InvoiceHeaderList>


68

</GetInvoiceListResult>

</GetInvoiceListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt






envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetInvoiceList xmlns="http://schemas.acme.eu/">

<GetInvoiceListRequest>

<Filters>

<Filter>

<Name>InvoiceDateFrom</Name>


</Filter>

<Filter>

<Name>InvoiceDateTo</Name>


</Filter>

</Filters>

</GetInvoiceListRequest>

</GetInvoiceList>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK






envelope">

<soap12:Body>

<GetInvoiceListResponse xmlns="http://schemas.acme.eu/">

<GetInvoiceListResult>

<InvoiceHeaderList>

<InvoiceHeader>


69










</InvoiceHeader>

<InvoiceHeader>










</InvoiceHeader>

</InvoiceHeaderList>

</GetInvoiceListResult>

</GetInvoiceListResponse>

</soap12:Body>

</soap12:Envelope>

3.4.2 GetInvoiceDetails Method

Method returns details of specified Invoice.




InvoiceNumber 0…n INV-44544444 Invoice number

InvoiceDateFrom 0…1 2008.01.01 Invoice date from

InvoiceDateTo 0…1 2008.01.30 Invoice date to

DueDateFrom 0…1 2008.02.01 Invoice due date from

DueDateTo 0…1 2008.02.14 Invoice due date to




Invoice

InvoiceHeader InvoiceHeader 1 Invoice header

InvoiceLine InvoiceLine 0…n Invoice lines

MiscellaneousCharges MiscellaneousCharges 0…n Miscellaneous charges

InvoiceHeader

InvoiceNumber String 1 Invoice number


70

InvoiceDate DateTime 1 Invoice date

DueDate DateTime 1 Invoice due date

InvoiceAmount Decimal 1 Invoice amount without VAT

InvoiceAmountWithTaxes Decimal 1 Invoice amount with VAT

PaidSum Decimal 1 Paid sum


BranchId String 1 Customer’s branch id

DeliveryAddress String 1 Delivery address

InvoiceLine


OrderRefId String 1 User’s order reference id

OrderLineRefId String 1 User’s ordr line reference id

ShortName String 1 Short product name

SalesPrice Decimal 1 Sales price


LineAmount Decimal 1 Line amount

OrderNumber String 1 Order number

Note String 1 Note from order line

MiscellaneousCharges

ChargeCode String 1 Charge code

ChargeAmount Decimal 1 Charge amount

Table 38 available charge types

Code Name

transport Transport charge

service Service Charge


SOAP 1.1 example:

Request:


Host: api.acme.lt



SOAPAction: "http://schemas.acme.eu/GetInvoiceDetails"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetInvoiceDetails xmlns="http://schemas.acme.eu/">

<GetInvoiceDetailsRequest>

<Filters>


71

<Filter>

<Name>InvoiceNumber</Name>

<Value>INV-00000001</Value>

</Filter>

</Filters>

</GetInvoiceDetailsRequest>

</GetInvoiceDetails>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK







<soap:Body>

<GetInvoiceDetailsResponse xmlns="http://schemas.acme.eu/">

<GetInvoiceDetailsResult>

<InvoiceList>

<Invoice>

<InvoiceHeader>


<InvoiceDate>2008-02-26T00:00:00</InvoiceDate>

<DueDate>2008-03-25T00:00:00</DueDate>

<InvoiceAmount>1000.0000</InvoiceAmount>

<InvoiceAmountWithTaxes>1180.0000</InvoiceAmountWithTaxes>

<PaidSum>100.0000</PaidSum>




</InvoiceHeader>

<InvoiceLine>




<ShortName>Mustek ScanEx. A3 USB /USB/300x600/48bit/CIS</ShortName>




<OrderNumber>SU00014724</OrderNumber>

<Note>Note text goes here</Note>

</InvoiceLine>

<InvoiceLine>




<ShortName>A-DATA 2GB PD9 USB2.0 Flash Drive</ShortName>






72


</InvoiceLine>

<MiscellaneousCharges>

<ChargeCode>transport</ChargeCode>

<ChargeAmount>20.00000</ChargeAmount>

</MiscellaneousCharges>

</Invoice>

</InvoiceList>

</GetInvoiceDetailsResult>

</GetInvoiceDetailsResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt






envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetInvoiceDetails xmlns="http://schemas.acme.eu/">

<GetInvoiceDetailsRequest>

<Filters>

<Filter>



</Filter>

</Filters>

</GetInvoiceDetailsRequest>

</GetInvoiceDetails>

</soap12:Body>

</soap12:Envelope>

HTTP/1.1 200 OK






envelope">

<soap12:Body>

<GetInvoiceDetailsResponse xmlns="http://schemas.acme.eu/">

<GetInvoiceDetailsResult>


73

<InvoiceList>

<Invoice>

<InvoiceHeader>


<InvoiceDate>2008-02-26T00:00:00</InvoiceDate>

<DueDate>2008-03-25T00:00:00</DueDate>

<InvoiceAmount>1000.0000</InvoiceAmount>

<InvoiceAmountWithTaxes>1180.0000</InvoiceAmountWithTaxes>

<PaidSum>100.0000</PaidSum>




</InvoiceHeader>

<InvoiceLine>




<ShortName>Mustek ScanEx. A3 USB /USB/300x600/48bit/CIS</ShortName>






</InvoiceLine>

<InvoiceLine>




<ShortName>A-DATA 2GB PD9 USB2.0 Flash Drive</ShortName>






</InvoiceLine>

<MiscellaneousCharges>

<ChargeCode>transport</ChargeCode>

<ChargeAmount>20.00000</ChargeAmount>

</MiscellaneousCharges>

</Invoice>

</InvoiceList>

</GetInvoiceDetailsResult>

</GetInvoiceDetailsResponse>

</soap12:Body>

</soap12:Envelope>

3.4.3 GetInvoiceProductSerialList Method

Method returns list of product serial numbers related to specified invoice.



74



InvoiceNumber 1 INV-001447555 Invoice number




SOAP 1.1 example:

Request:


Host: api.acme.lt



SOAPAction: "http://schemas.acme.eu/GetInvoiceProductSerialList"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetInvoiceProductSerialList xmlns="http://schemas.acme.eu/">

<GetInvoiceProductSerialListRequest>

<Filters>

<Filter>



</Filter>

</Filters>

</GetInvoiceProductSerialListRequest>

</GetInvoiceProductSerialList>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK






ProductSerial


SerialNumber String 1 Product serial number


75



<soap:Body>

<GetInvoiceProductSerialListResponse xmlns="http://schemas.acme.eu/">

<GetInvoiceProductSerialListResult>

<ProductSerialList>

<ProductSerial>


<SerialNumber>ASW123213DFAFS</SerialNumber>

</ProductSerial>

<ProductSerial>


<SerialNumber>ASW123213DFAFA</SerialNumber>

</ProductSerial>

</ProductSerialList>

</GetInvoiceProductSerialListResult>

</GetInvoiceProductSerialListResponse>

</soap:Body>

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt






envelope">

<soap12:Header>



</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetInvoiceProductSerialList xmlns="http://schemas.acme.eu/">

<GetInvoiceProductSerialListRequest>

<Filters>

<Filter>



</Filter>

</Filters>

</GetInvoiceProductSerialListRequest>

</GetInvoiceProductSerialList>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK




76




envelope">

<soap12:Body>

<GetInvoiceProductSerialListResponse xmlns="http://schemas.acme.eu/">

<GetInvoiceProductSerialListResult>

<ProductSerialList>

<ProductSerial>


<SerialNumber>ASW123213DFAFS</SerialNumber>

</ProductSerial>

<ProductSerial>


<SerialNumber>ASW123213DFAFA</SerialNumber>

</ProductSerial>

</ProductSerialList>

</GetInvoiceProductSerialListResult>

</GetInvoiceProductSerialListResponse>

</soap12:Body>

</soap12:Envelope>

3.4.4 GetInvoiceShipments Method

Method returns list of shipments related with this invoice.




InvoiceNumber 1 INV-14557444 Invoice number




Shipment

CarrierId String 1 Carrier identification number (for available id see table below)

Number String 1 Shipment number

Table 43 carriers list

CarrierId Carrier Name

2 DPD Lietuva

3 Venipak


SOAP 1.1 example:


77

Request:


Host: api.acme.lt



SOAPAction: "http://schemas.acme.eu/GetInvoiceShipments"





<soap:Header>



</LicenseHeader>

</soap:Header>

<soap:Body>

<GetInvoiceShipments xmlns="http://schemas.acme.eu/">

<GetInvoiceShipmentsRequest>

<Filters>

<Filter>


<Value>USR-7</Value>

</Filter>

</Filters>

</GetInvoiceShipmentsRequest>

</GetInvoiceShipments>

</soap:Body>

</soap:Envelope>

Response:

HTTP/1.1 200 OK







<soap:Body>

<GetInvoiceShipmentsResponse xmlns="http://schemas.acme.eu/">

<GetInvoiceShipmentsResult>

<ShipmentList>

<Shipment>

<CarrierId>2</CarrierId>

<Number>45774444444</Number>

</Shipment>

<Shipment>



</Shipment>

</ShipmentList>

</GetInvoiceShipmentsResult>

</GetInvoiceShipmentsResponse>

</soap:Body>


78

</soap:Envelope>

SOAP 1.2 example:

Request:


Host: api.acme.lt






envelope">

<soap12:Header>


<LicenseKey>498ec72c-e8e7-48f2-b300-d95666aeb141 </LicenseKey>

</LicenseHeader>

</soap12:Header>

<soap12:Body>

<GetInvoiceShipments xmlns="http://schemas.acme.eu/">

<GetInvoiceShipmentsRequest>

<Filters>

<Filter>


<Value>USR-7</Value>

</Filter>

</Filters>

</GetInvoiceShipmentsRequest>

</GetInvoiceShipments>

</soap12:Body>

</soap12:Envelope>

Response:

HTTP/1.1 200 OK






envelope">

<soap12:Body>

<GetInvoiceShipmentsResponse xmlns="http://schemas.acme.eu/">

<GetInvoiceShipmentsResult>

<ShipmentList>

<Shipment>



</Shipment>

<Shipment>



</Shipment>

</ShipmentList>

</GetInvoiceShipmentsResult>


79

</GetInvoiceShipmentsResponse>

</soap12:Body>

</soap12:Envelope>


80

4 Resources

4.1 Development resources

1. Acme API client sample (PHP source):

http://s4.acme.eu/shop/glo/downloads/api/client/source/php.client.src.zip

2. Acme API TestClient (.zip .NET 3.5 framework required)

http://s4.acme.eu/shop/glo/downloads/api/client/client.zip

3. Acme API TestClient (C# source, .NET 3.5 framework required)

http://s4.acme.eu/shop/glo/downloads/api/client/source/net.client.src.zip

4. Acme API TestClient (online, .NET 3.5 framework required)

http://s4.acme.eu/shop/glo/downloads/api/client/client.application

4.2 Product specification pages in supplier’s web site

4.2.1 for Acme Computer Components customers

There is a possibility to access product specification web pages using specific URL.

URL template:

http://acc.acme.eu/{company}/{locale}/product,{SupplierCode}/view.html

1. {company} –Customer’s supplier identification code:

a) acc – Acme computer components;

b) acp - Acme Plus.

2. {SupplierCode} - Product identification number (6 numbers).

3. {locale} – Product specification page language.

Example:

http://acc.acme.eu/acc/lt-lt/product,show/011035/view.html

4.2.2 for Avad Baltic Customers

There is a possibility to access Avad product specification web pages using specific URL.

URL template:

http://www.avadbaltic.com/{company}/{locale}/product,{SupplierCode}/view.html

4. {company} –Customer’s supplier identification code:

a) avd – Avad Baltic;

5. {SupplierCode} - Product identification number (6 numbers).

6. {locale} – Product specification page language.

Example:

http://www.avadbaltic.com/avd/en-us/product,show/011035/view.html

Documents

Acme API Specification (en-us)