Acme Api Specification (en-us)

Acme API Specification Specification version 1.0 Updated 2010.03.17

Acme API Specification v 1.0 Table Of Contents 1 ChangeLog....................................................................................................................................................................... 5 2

3

General information ....................................................................................................................................................... 7 2.1

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

2.2

LicenseKey............................................................................................................................................................... 7

2.3

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

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.3.3

Request/Response Examples .................................................................................................................... 17

3.2.4

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

3.2.4.1

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

3.2.4.2

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

3.2.4.3

Request/Response examples .................................................................................................................... 20

3.2.5

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

3.2.5.1

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

3.2.5.2

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

3.2.5.3

Request/Response examples .................................................................................................................... 23

3.2.6

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

3.2.6.1

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

3.2.6.2

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

3.2.6.3

Request/Response examples .................................................................................................................... 27

3.2.7

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

3.2.7.1

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

3.2.7.2

Method Response ..................................................................................................................................... 29 2

Acme API Specification v 1.0 3.2.7.3 Request/Response Examples .................................................................................................................... 29 3.2.8

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

3.2.8.1

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

3.2.8.2

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

3.2.8.3

Request/Response Examples .................................................................................................................... 32

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.3

3.2.11.1

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

3.2.11.2

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

3.2.11.3

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

Orders ................................................................................................................................................................... 43

3.3.1

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

3.3.1.1

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

3.3.1.2

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

3.3.1.3

Request/Response examples .................................................................................................................... 43

3.3.2

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

3.3.2.1

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

3.3.2.2

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

3.3.2.3

Request/Response Examples .................................................................................................................... 45

3.3.3

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

3.3.3.1

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

3.3.3.2

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

3.3.3.3

Request/Response examples .................................................................................................................... 49

3.3.4

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

3.3.4.1

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

3.3.4.2

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

3.3.4.3

Request/Response examples .................................................................................................................... 54

3.3.5

GetCustomerUserList Method ...................................................................................................................... 58 3

Acme API Specification v 1.0 3.3.5.1 Method Request ....................................................................................................................................... 59 3.3.5.2

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

3.3.5.3

Request/Response examples .................................................................................................................... 59

3.3.6

3.4

3.3.6.1

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

3.3.6.2

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

3.3.6.3

Request/Response examples .................................................................................................................... 63

Invoices ................................................................................................................................................................. 66

3.4.1

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

3.4.1.1

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

3.4.1.2

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

3.4.1.3

Request/Response examples .................................................................................................................... 66

3.4.2

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

3.4.2.1

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

3.4.2.2

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

3.4.2.3

Request/Response examples .................................................................................................................... 70

3.4.3

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

3.4.3.1

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

3.4.3.2

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

3.4.3.3

Request/Response examples .................................................................................................................... 74

3.4.4

4

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

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

3.4.4.1

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

3.4.4.2

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

3.4.4.3

Request/Response examples .................................................................................................................... 76

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

4

Acme API Specification v 1.0

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. 5

Acme API Specification v 1.0 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

6

Acme API Specification v 1.0

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.

7

Acme API Specification v 1.0

3

Web Service Methods

3.1 Summary Table 1 Web Service method summary

Method Name Product Catalog GetProductList GetProductClassification GetProductBarcodeList GetProductSpecification GetProductResources GetVendorList GetProductPresentList GetProductRelationList GetProductBundleList GetTreeNodes GetTreeNodeProducts Orders PurchaseProducts UpdateOrderLine GetOrderDetails GetAddressList GetCustomerUserList Invoices GetInvoiceList GetInvoiceDetails GetInvoiceProductSerialList GetInvoiceShipments

Short Description Method returns products information Method returns product classification data Method returns barcodes (EAN) of products Method returns products descriptions Method returns products resources (links to images, pdf, etc.) Method returns vendors list Method returns information about product presents Method returns information about product relations Method returns list of product bundles Method returns nodes of ecommerce tree Method returs position of products in ecommerce tree Method is used for placing products in orders Method is used for order updates Method returns order details Method returns list of available addresses Method returns list of customer users Method returns list o available invoices Method returns invoice details Method returns serial number list related to specific invoice Method returns list of shipments for specific invoice

8

Acme API Specification v 1.0

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 Language Currency SegmentId GroupId ClassId SeriesId SupplierCode VendorId PartNumber

Occurs 1 1 0…n 0...n 0…n 0...n 0…n 0…n 0…n

Value Example lt-lt LTL 1 12 123 1234 003315 ca EEEPC

Description Product list language Price list currency Narrows result set to specific Segment of Product Classification Narrows result set to specific Group of Product Classification Narrows result set to specific Class of Product Classification Narrows result set to specific Series of Product Classification Narrows result set to specific Products with given SupplierCode Narrows result set to given Vendor’s products 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 ProductList Product Product SupplierCode SegmentId

Type

String String

1 1

GroupId

String

1

ClassId

String

1

SeriesId

String

1

VendorId Name PartNumber Warranty

String String String Integer

1 1 1 1

Price Quantity GrossWeight

Decimal Decimal Decimal

1 1 1

Product

Occurs 0…n

Description Products Product identification code assigned by supplier Top level product group identification, identifies the product segment Second level product group identification, identifies the product group Third level product group identification, identifies the product class Forth level product group identification, identifies the product series Product Product name Product part number assigned by vendor Product warranty (in months) If field value is -1 then product has limited lifetime warranty Product price Available quantity of product in warehouse Product gross weight 9

Acme API Specification v 1.0 DateExpected

DateTime

1

RecommendedRetailPrice

Decimal

1

IsNewProduct

Boolean

1

Expected product arrival date (if value equal 1900-0101T00:00:00 then date is not defined ) Recommended retail price of product If value is 0 recommended retail price is not defined Indicates new product in system

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" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> Language lt-lt Currency LTL Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <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:Body> 10

Acme API Specification v 1.0 <SupplierCode>001982 <SegmentId>65000000 65010000 65010200 <SeriesId>10001125 AM <PartNumber>ADA3000BIBOX AMD Athlon64 3000+ (1800MHz/L2 Cache 512KB) Socket 939, BOX <Warranty>36 196.00000 0 1999-01-01T00:00:00 true <SupplierCode>001512 <SegmentId>65000000 65010000 65010200 <SeriesId>10001125 AM <PartNumber>ADA3000AXBOX AMD Athlon64 3000+ (2000MHz/1600MHz/L2 Cache 512KB) Socket 754, BOX <Warranty>36 296.00000 0 3.6000 1999-01-01T00:00:00 false SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 11

Acme API Specification v 1.0 <soap12:Body> Language lt-lt Currency LTL Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Body> <SupplierCode>001982 <SegmentId>65000000 65010000 65010200 <SeriesId>10001125 AM <PartNumber>ADA3000BIBOX AMD Athlon64 3000+ (1800MHz/L2 Cache 512KB) Socket 939, BOX <Warranty>36 196.00000 0 1999-01-01T00:00:00 true <SupplierCode>001512 <SegmentId>65000000 65010000 65010200 <SeriesId>10001125 AM 12

Acme API Specification v 1.0 <PartNumber>ADA3000AXBOX AMD Athlon64 3000+ (2000MHz/1600MHz/L2 Cache 512KB) Socket 754, BOX <Warranty>36 296.00000 0 3.6000 1999-01-01T00:00:00 false

3.2.2

GetProductClassification Method GetProductClassification method returns information about classification of products

3.2.2.1 Method Request This method does not have any request parameters. 3.2.2.2 Method Response Table 4 product classification response

Name Segment SegmentId SegmentName Group GroupId SegmentId GroupName Class ClassId GroupId ClassName Series SeriesId ClassId SeriesName

Type

Occurs Description

String String

1 1

Top level product group identification, identifies the product Segment Segment name

String String String

1 1 1

Second level product group identification, identifies the product group Identification number of parent segment Group name

String String String

1 1 1

Third level product group identification, identifies the product class Identification number of parent group Class name

String String String

1 1 1

Forth level product group identification, identifies the product series Identification number of parent Class Series name

3.2.2.3 Request/Response examples SOAP 1.1 examples: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: text/xml; charset=utf-8 Content-Length: 123 13

Acme API Specification v 1.0 SOAPAction: "http://schemas.acme.eu/GetProductClassification" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: 566 <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:Body> <SegmentList> <Segment> <SegmentId>61000000 <SegmentName>Music <Segment> <SegmentId>65000000 <SegmentName>Computing <Segment> <SegmentId>68000000 <SegmentName>Audio Visual/Photography 61010000 <SegmentId>61000000 Musical Instruments/Accessories 68020000 <SegmentId>68000000 Photography/Optics 14

Acme API Specification v 1.0 61010200 61010000 Musical Instruments (Non Powered) 65010100 65010000 Computer Accessories <SeriesList> <Series> <SeriesId>10000933 61010200 <SeriesName>Brasswind Musical Instruments (Non Powered) <Series> <SeriesId>10000937 61010200 <SeriesName>Woodwind Musical Instruments (Non Powered) SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: 543 <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> 15

Acme API Specification v 1.0 Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Body> <SegmentList> <Segment> <SegmentId>61000000 <SegmentName>Music <Segment> <SegmentId>65000000 <SegmentName>Computing <Segment> <SegmentId>68000000 <SegmentName>Audio Visual/Photography 61010000 <SegmentId>61000000 Musical Instruments/Accessories 68020000 <SegmentId>68000000 Photography/Optics 61010200 61010000 Musical Instruments (Non Powered) 65010100 65010000 Computer Accessories <SeriesList> <Series> <SeriesId>10000933 61010200 16

Acme API Specification v 1.0 <SeriesName>Brasswind Musical Instruments (Non Powered) <Series> <SeriesId>10000937 61010200 <SeriesName>Woodwind Musical Instruments (Non Powered)

3.2.3

GetProductBarcodeList Method This method returns Product EAN barcodes list. Notice: Some products can have more than one barcode

3.2.3.1 Method Request Table 5 available request filters

Name SupplierCode

Occurs Value example Description 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

3.2.3.2 Method Response Table 6 method response details

Name ProductBarcode SupplierCode Barcode

Type

Description

String String

Product identification code assigned by supplier Product barcode

3.2.3.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: 455 SOAPAction: "http://schemas.acme.eu/GetProductBarcodeList" <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/"> 17

Acme API Specification v 1.0 <soap:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: 564 <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:Body> <SupplierCode> 000068 2000000029740 <SupplierCode> 000242 0858540651912 SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: 564 <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 18

Acme API Specification v 1.0 <soap12:Body>

Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: 533 <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/soapenvelope"> <soap12:Body> <SupplierCode> 000068 2000000029740 <SupplierCode> 000242 0858540651912

3.2.4

GetProductResources Method Method returns information about product resources.

3.2.4.1 Method Request Table 7 available request filters

Name Language SupplierCode

Occurs Value Example 1 lt-lt 0…n 024578

Description Preferred language of method response Product identification code assigned by supplier

3.2.4.2 Method Response Table 8 method response details

Name ProductResources SupplierCode

Type

Occurs

String

1

Description Product identification code assigned by supplier 19

Acme API Specification v 1.0 ProductResource ProductResource ResourceType ResourceName ResourceURL

ProductResource String String String

0..n 1 1 1

Product resource (see below) Resource Type (for available types see table below) Resource name Resource URL

Table 9 resource types

Type 0 1 2 3 4 5 6 7 8

Type Description Small Image Pdf Document MS Word Document XML file Link RTF file TXT file Medium Image Large Image

3.2.4.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: 334 SOAPAction: "http://schemas.acme.eu/GetProductResources" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> Language en-us SupplierCode 018395 20

Acme API Specification v 1.0

Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <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:Body> <SupplierCode>018395 0 d http://s3.acme.lt/products/018395/photos /large/1.jpg 0 m http://s3.acme.lt/products/018395/photos /small/1.png 0 v http://s3.acme.lt/products/018395/photos /medium/1.jpg SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: 344 <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 21

Acme API Specification v 1.0 <soap12:Body> Language en-us SupplierCode 018395 Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: 633 <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/soapenvelope"> <soap12:Body> <SupplierCode>018395 0 d http://s3.acme.lt/products/018395/photos /large/1.jpg 0 m http://s3.acme.lt/products/018395/photos /small/1.png 0 v http://s3.acme.lt/products/018395/photos /medium/1.jpg 22

Acme API Specification v 1.0

3.2.5

GetProductSpecification Method Method returns list of product specifications.

3.2.5.1 Method Request Table 10 available request filters

Name Occurs Language 1 SupplierCode 0…n UpdatedSince 1

Value Example lt-lt 004587 2008.10.15 10:15:15

Description Preferred language of method response Product identification code assigned by supplier Narrows result to product specifications which were created or modified since defined time

3.2.5.2 Method Response Table 11 method response details

Name ProductSpecification SupplierCode ProductProperty ProductProperty PropertyCode PropertyName PropertyValue

Type

Occurs

String ProductProperty

1 0…n

String String String

1 1 1

Description Product identification code assigned by supplier Product property Property identification code Property name Property value

3.2.5.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/GetProductSpecification" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> 23

Acme API Specification v 1.0 Language en-us SupplierCode 018704 Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <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:Body> <SupplierCode>018704 95 Video nVidia Ge Force 8400M G 256MB 13 Type 13.3 WXGA glare wide 110 Keyboard US 64 Optical storage Super Multi DL DVD+/-RW (CBB standard) 101 AC adapter Output : 19V DC 3.42A 90W; Input : 100~240V AC 50/60Hz universal (CBB 24

Acme API Specification v 1.0 standard) 96 HDD SATA 120GB / 5400rpm (CBB standard) SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> Language en-us SupplierCode 018704 Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length 25

Acme API Specification v 1.0 <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/soapenvelope"> <soap12:Body> 95 Video nVidia Ge Force 8400M G 256MB 13 Type 13.3 WXGA glare wide 110 Keyboard US 64 Optical storage Super Multi DL DVD+/-RW (CBB standard) 101 AC adapter Output : 19V DC 3.42A 90W; Input : 100~240V AC 50/60Hz universal (CBB standard) 96 HDD SATA 120GB / 5400rpm (CBB standard)

3.2.6

GetVendorList Method This method return list of products’ vendors

3.2.6.1 Method Request This method does not have any request parameters. 3.2.6.2 Method Response 26

Acme API Specification v 1.0 Table 12 method response details

Name Type Occurs Description Vendor VendorId String 1 Vendor’s identification code in Supplier System VendorName String 1 Vendor Name

3.2.6.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/GetVendorList" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body>

Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <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:Body> AM AMD 27

Acme API Specification v 1.0 V1 Vendor

SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Body> AM AMD V1 Vendor 28

Acme API Specification v 1.0

3.2.7

GetProductRelationList method Methods returns information about related products

3.2.7.1 Method Request Table 13 method request details

Name SupplierCode

Occurs 0…n

Value Example 003315

Description Narrows result set to product with defined SupplierCode

3.2.7.2 Method Response

Table 14 method response details

Name ProductRelationList ProductRelation ProductRelation SupplierCode RelatedSupplierCode

Type ProductRelation String String

Occurs 0…n 1 1

Description List of product relations Product identification code assigned by supplier Code of releted product

3.2.7.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: 436 SOAPAction: "http://schemas.acme.eu/GetProductRelationList" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> 29

Acme API Specification v 1.0 Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: 456 <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:Body> <SupplierCode>007589 015693 <SupplierCode>007589 019643

SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: 632 <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> 30

Acme API Specification v 1.0 Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Body> <SupplierCode>007589 015693 <SupplierCode>007589 019643

3.2.8

GetProductPresentList Method Method returns information about presents associated with products

3.2.8.1 Method Request

Table 15 method request details

Name Language SupplierCode

Occurs Value Example 1 lt-lt 0…n 003315

Description Prefered language for present names Narrows result set to product with defined SupplierCode

3.2.8.2 Method Response

Table 16 method response details

Name Type ProductPresentList ProductPresent ProductPresent

Occurs 0…n

Description Array of product presents 31

Acme API Specification v 1.0 ProductPresent SupplierCode PresentName

String String

1 1

Product identification code assigned by supplier Present name

3.2.8.3 Request/Response Examples

SOAP 1.1 example: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: text/xml; charset=utf-8 Content-Length: 478 SOAPAction: "http://schemas.acme.eu/GetProductPresentList" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> Language lt-lt Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: 658 <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:Body> <SupplierCode>003314 Present name 32

Acme API Specification v 1.0 <SupplierCode>008791 Present name

SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> Language lt-lt Request: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: 547 <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/soapenvelope"> <soap12:Body> 33

Acme API Specification v 1.0 <SupplierCode>003314 Present name <SupplierCode>008791 Present name

3.2.9

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

3.2.9.1 Method Request Method does not have any request parameters. 3.2.9.2 Method Response

Name ProductBundleList ProductBundle ProductBundle BundleId

Type

BundledProduct BundledProduct SupplierCode Quantity

BundledProduct

ProductBundle String

String Decimal

Occurs 0…n 1 0…n 1 1

Description Array of Product bundle Bundle identification number (equal to SupplierCode in ProductList) Array of BundledProduct Product identification code assigned by supplier Product quantity in bundle

3.2.9.3 Request/Response Examples SOAP 1.1 examples: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: text/xml; charset=utf-8 Content-Length: 385 34

Acme API Specification v 1.0 SOAPAction: "http://schemas.acme.eu/GetProductBundleList" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: 674 <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:Body> <BundleId>040955 <BundledProduct> <SupplierCode>011860 1 <BundledProduct> <SupplierCode>016348 1 <BundleId>030955 <BundledProduct> <SupplierCode>018860 1 <BundledProduct> <SupplierCode>016348 1 35

Acme API Specification v 1.0 SOAP 1.2 examples: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: 652 <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: 436 <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/soapenvelope"> <soap12:Body> <BundleId>040955 <BundledProduct> <SupplierCode>011860 1 36

Acme API Specification v 1.0 <BundledProduct> <SupplierCode>016348 1 <BundleId>030955 <BundledProduct> <SupplierCode>018860 1 <BundledProduct> <SupplierCode>016348 1

3.2.10 GetTreeNodes method Method returns list E-commerce tree nodes. 3.2.10.1 Method request

Table 17 Method request filters

Name Language

Occurs 1

Example en-us

Description Prefered language for Node names

3.2.10.2 Method response

Table 18 Method response details

Name NodesList TreeNode TreeNode NodeId ParrentNodeId Name Left Right

Type

Occurs Description

TreeNode 0...n

Array of TreeNode

String String String Integer Integer

Tree Node identification number Parent tree node Id Node name Left number for Modified Preorder Tree Traversal Algoritm Right number for Modified Preorder Tree Traversal Algoritm

1 1 1 1 1

3.2.10.3 Request/Response Examples 37

Acme API Specification v 1.0

SOAP 1.1 examples: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: text/xml; charset=utf-8 Content-Length: 452 SOAPAction: "http://schemas.acme.eu/GetTreeNodes" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> Language en-us Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: 642 <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:Body> 005564 <ParentNodeId>44455 Scanners 102 102 38

Acme API Specification v 1.0 003456 <ParentNodeId>004224 Printers 89 89 SOAP 1.2 examples: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: 652 <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> Language en-us Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: 652 <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/soapenvelope"> <soap12:Body> 39

Acme API Specification v 1.0 005564 <ParentNodeId>44455 Scanners 102 102 003456 <ParentNodeId>004224 Printers 89 89

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

Name NodeProductList NodeProduct NodeProduct NodeId SupplierCode

Type

Occurs

Description

NodeProduct

0…n

Array of NodeProduct

String String

1 1

Tree node Id Product identification number

3.2.11.3 Request/Response Examples SOAP 1.1 examples: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: text/xml; charset=utf-8 Content-Length: 652 SOAPAction: "http://schemas.acme.eu/GetTreeNodeProducts" 40

Acme API Specification v 1.0 <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: 535 <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:Body> 004533 <SupplierCode>003315 003344 <SupplierCode>004583 SOAP 1.2 examples: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: 356 41

Acme API Specification v 1.0 <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: 632 <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/soapenvelope"> <soap12:Body> 004533 <SupplierCode>003315 003344 <SupplierCode>004583

42

Acme API Specification v 1.0

3.3 Orders 3.3.1

GetAddressList Method Method returns list of available user addresses.

3.3.1.1 Method Request This method does not have any request parameters. 3.3.1.2 Method Response Table 20 method response details

Name AddressList Address Address AddressId Street City PostalCode CountryCode

Type

Occurs

Address

0..n

String String String String String

1 1 1 1 1

Description Array of addresses Address identification code assigned by supplier Street City Postal code Country code

3.3.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: 457 SOAPAction: "http://schemas.acme.eu/GetAddressList" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> 43

Acme API Specification v 1.0 Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length:527 <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:Body>

0001 <Street>Demo Street Kaunas 4444 LT

SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 44

Acme API Specification v 1.0 Content-Length: length <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/soapenvelope"> <soap12:Body>

0001 <Street>Demo Street Kaunas 4444 LT

3.3.2

GetDeliveryTypeList Method Returns Available delivery types

3.3.2.1

Method Request

Table 21 Method request parameters

Name Language

Occurs Value Example 1 lt-lt

Description Prefered language of delivery type name

3.3.2.2 Method Response Table 22 delivery type details

Name DeliveryTypeList DeliveryType DeliveryType DeliveryTypeId Name

Type

Occurs

DeilveryType

0..n

Integer String

1 1

Description Delivery types list Delivery type id Delivery type name

3.3.2.3 Request/Response Examples

SOAP 1.1 example: Request: POST /1.0/commerce.asmx HTTP/1.1 45

Acme API Specification v 1.0 Host: api.amce.lt Content-Type: text/xml; charset=utf-8 Content-Length: 653 SOAPAction: "http://schemas.acme.eu/GetDeliveryTypeList" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: 745 <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:Body> 1 Carrier Delivery 2 Express Delivery

SOAP 1.2 example: Request: 46

Acme API Specification v 1.0 POST /1.0/commerce.asmx HTTP/1.1 Host: api.amce.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Body> 1 Carrier Delivery 2 Express Delivery

47

Acme API Specification v 1.0 3.3.3 PurchaseProducts Method Creates products orders 3.3.3.1 Method Request Table 23 method request details

Name PurchaseLines ProductPurchaseLine ProductPurchaseLine ProductPurchaseLineId

Type ProductPurchaseLine

Occurs 0…n

String

1

OrderingBranchAddressId String

0..1

OrderRefId OrderLineRefId SupplierCode Quantity DeliveryTypeId DeliveryContact DeliveryAddress Note CarrierNote CashOnDelivery

0..1 0..1 1 1 1 1 1 0..1 0..1 1

Address AddressId Street City PostalCode CountryCode Contact FirstName LastName Email Phone

String String String Integer Integer Contact Address String String Boolean

String String String String String

1 1 1 1 1

String String String String

1 1 0..1 0..1

Description Product purchase line ProductPurchaseLine identification number assigned by customer party Customer’s branch AddressId used to identify ordering branch values available from GetAddressList method User’s order reference id (20 characters max) User’s order line reference id (20 characters max) Product identification code assigned by supplier Quantity Delivery type id Delivery Contact information Delivery Address Note for sales manager Note for Carrier Cash On Delivery Option valid only for delivery to customers addresses available in GetAddressList method Address identification code assigned by supplier Street City Postal code Country code (2 letters) First Name Last Name Email 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.

48

Acme API Specification v 1.0

3.3.3.2 Method Response

Table 24 method response details

Name Type Occurs StatusList ProductPurchaseStatus ProductPurchaseStatus 0…n ProductPurchaseStatus ProductPurchaseLineId String 1 Status

String

1

Note OrderReferenceId

String String

1 1

Descriptions Product purchase status ProductPurchaseLine identification number assigned by customer party OK - product purchase line processed successfully FAILED – failed to process product purchase line Note 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. 3.3.3.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/PurchaseProducts" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> 001 001 001 001 <SupplierCode>012568 1 49

Acme API Specification v 1.0 0 First Name Last Name <Email>[email protected] 2254444 adr1 <Street> Note for manager string false 002 001 001 002 <SupplierCode>012547 1 2 First Name Last Name <Email>[email protected] 2254444 adr2 <Street> Note for managers note false Response HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length 50

Acme API Specification v 1.0 <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:Body> <StatusList> 001 <Status>OK 15 002 <Status>OK 17 SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> 001 001 001 001 <SupplierCode>012568 1 0 First Name 51

Acme API Specification v 1.0 Last Name <Email>[email protected] 2254444 adr1 <Street> string note false 002 001 001 002 <SupplierCode>012547 1 2 First Name Last Name <Email>[email protected] 2254444 adr2 <Street> note note false Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> 52

Acme API Specification v 1.0 <soap12:Body> <StatusList> 001 <Status>OK 15 002 <Status>OK 17

3.3.4

GetOrderDetails Method Method returns Order List

3.3.4.1 Method Request Table 25 available request parameters

Name OrderId OrderReferenceId OrderRefId

Occurs 0…n 0...n 0…n

Value example SU000001 00244444 refid

Description Order Id Order reference id from PurchaseProducts method 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

3.3.4.2 Method Response Table 26 method response details

Name OrderList Order Order OrderHeader OrderLine OrderHeader OrderId OrderLine SupplierCode

Type

Occurs

Description

Order

0…n

Order

OrderHeader OrderLine

1 1..n

Order header Order line

String

1

Order id

String

1

Product identification code assigned by supplier 53

Acme API Specification v 1.0 OrderLineId OrderRefId OrderLineRefId UserId CurrencyCode SalesPrice Quantity TypeId LineAmount IsEditable

String String String String String Decimal Decimal Integer Decimal Boolean

1 1 1 1 1 1 1 1 1 1

LineNote DeliveryStreet DeliveryCity DeliveryPostalCode DeliveryCountry DeliveryTypeId DeliveryContact CarrierNote DeliveryName CashOnDelivery OrderingBranchAddressId

String String String String String Integer Contact String String Boolean String

1 1 1 1 1 1 1 1 1 1 1

Contact FirstName LastName Email Phone

String String String String

1 1 1 1

Order line identification number User’s order reference id User’s order line reference id User identification number assigned by supplier Currency code Sales price Quantity OrderLine type identification number Line amount without VAT True – line is editable False – line is not editable Line note Delivery street Delivery city Delivery postal code Delivery country Delivery type id Delivery Contact Carrier note Delivery name Cash on delivery Customer’s branch AddressId used to identify ordering branch First name Last Name Email Phone

Table 27 OrderLine types

TypeId Description 0 Products are placed on order 1 Products are physically reserved

3.3.4.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: 423 SOAPAction: "http://schemas.acme.eu/GetOrderDetails" <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> 54

Acme API Specification v 1.0 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> OrderId SU001 Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: 632 <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:Body> SU001 <SupplierCode>015698 5637555135 001 001 <UserId>U001 LTL <SalesPrice>605.0000 1.0000 1 605.0000 true note Kalvarijų g. 98 Vilnius 08211 lt 1 Delivery Name 55

Acme API Specification v 1.0 First Name Last Name <Email>[email protected] 2254444 note false 001 <SupplierCode>019096 5637555137 001 002 <UserId>U001 LTL <SalesPrice>143.0000 10.0000 1 1430.0000 true Street 1 Vilnius 08211 lt 1 Delivery Name First Name Last Name <Email>[email protected] 2254444 note false 001

SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: 475 56

Acme API Specification v 1.0 <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> OrderId SU001 Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: 548 <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/soapenvelope"> <soap12:Body> SU001 <SupplierCode>015698 5637555135 001 002 <UserId>U001 LTL <SalesPrice>605.0000 1.0000 1 605.0000 true Kalvarijų g. 98 57

Acme API Specification v 1.0 Vilnius 08211 lt 1 Delivery Name First Name Last Name <Email>[email protected] 2254444 note false 001 <SupplierCode>019096 5637555137 001 001 <UserId>U001 LTL <SalesPrice>143.0000 10.0000 1 1425.0000 true Street 1 Vilnius 08211 lt 1 Delivery Name First Name Last Name <Email>[email protected] 2254444 note false 001

3.3.5

GetCustomerUserList Method Returns Customer’s user list. 58

Acme API Specification v 1.0 3.3.5.1 Method Request This method does not have any request parameters.

3.3.5.2 Method Response Table 28 method request details

Name UserList User User UserId FirstName LastName

Type

Occurs

User

0…n

String String String

1 1 1

Description Users User identification number assigned by supplier First name Last name

3.3.5.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/GetCustomerUserList" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body>

Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 59

Acme API Specification v 1.0 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <UserList> <User> <UserId>U001 John Doe <User> <UserId>U002 Mark Thomas SOAP 1.2 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/GetCustomerUserList" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <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/"> 60

Acme API Specification v 1.0 <soap:Body> <UserList> <User> <UserId>U001 John Doe <User> <UserId>U002 Mark Thomas

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.

3.3.6.1 Method Request delete action: Table 29 delete action request parameters

Name OrderLineUpdate OrderLineId TypeId Action DeliveryTypeId DeliveryAddress Quantity Note

Type String Integer String Integer Address Decimal String

Occurs 1 1 1 0 0 0 0

Description Order line identification number Order line type identification number Action code Delivery type identification number Delivery address (see GetAddressList for details) Quantity Note

update action: 61

Acme API Specification v 1.0 Table 30 update action request parameters

Name OrderLineUpdate OrderLineId OrderRefId OrderLineRefId TypeId Action DeliveryTypeId DeliveryAddress Quantity Note CarrierNote DeliveryContact OrderingBranchAddr essId CashOnDelivery

Type

DeliveryName Contact FirstName LastName Email Phone

Occurs

Description

String String String Integer String Integer Address Decimal String String Contact String

1 1 1 1 1 1 1 1 1 1 1 1

Boolean

1

String

1

Order line identification number User’s order reference id (20 characters max) User’s order line reference id (20 characters max) Order line type identification number Action code Delivery type identification number Delivery address (see GetAddressList for details) Quantity Note sales managers Note for carrier Delivery contact Customer’s branch AddressId used to identify ordering branch values available from GetAddressList method Cash on delivery. Option valid only for delivery to customers addresses available in GetAddressList method Delivery name

String String String String

1 1 1 1

First name Last name Email Phone

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 CountryCode must be provided as ISO 3166 code. (2 letters country code) 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

Name OrderLineUpdate OrderLineId OrderRefId OrderLineRefId TypeId Action DeliveryTypeId DeliveryAddress Quantity

Type String String String Integer String Integer Address Decimal

Occurs 1 1 1 1 1 1 1 1

Description Order line identification number User’s order reference id (20 characters max) User’s order line reference id (20 characters max) Order line type identification number Action code Delivery type identification number Delivery address (see GetAddressList for details) Quantity 62

Acme API Specification v 1.0 Note CarrierNote DeliveryContact OrderingBranchAddr essId CashOnDelivery DeliveryName Contact FirstName LastName Email Phone

String String Contact String

1 1 1 1

Boolean

1

String

1

Note Note for carrier Delivery contact Customer’s branch AddressId used to identify ordering branch values available from GetAddressList method Cash on delivery. Option valid only for delivery to customers addresses available in GetAddressList method Delivery name

String String String String

1 1 1 1

First name Last name Email Phone

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 CountryCode must be provided as ISO 3166 code. (2 letters country code)

3.3.6.2 Method Response Table 33 method response details

Name UpdateLog OrderLineUpdateStatus OrderLineUpdateStatus OrderLineId TypeId Status Note

Type

Occurs

OrderLineUpdateStatus

0…n

String String String String

1 1 1 1

Description OrderLineUpdateStatus Order line identification number OrderLine type identification number Update status Additional information about error

3.3.6.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/UpdateOrderLine" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 63

Acme API Specification v 1.0 <soap:Body> 11111111 1 delete Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <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:Body> 11111111 <Status>OK 1 SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: 487 <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 64

Acme API Specification v 1.0 <soap12:Body> 11111111 1 delete Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: 365 <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/soapenvelope"> <soap12:Body> 11111111 <Status>OK 1

65

Acme API Specification v 1.0

3.4 Invoices 3.4.1

GetInvoiceList Method Method returns list of invoice headers.

3.4.1.1 Method Request Table 34 available request filters

Name InvoiceDateFrom InvoiceDateTo DueDateFrom DueDateTo

Occurs 0…1 0…1 0…1 0…1

Value Example 2008.01.01 2008.01.30 2008.02.01 2008.02.14

Description Invoice date from Invoice date to Invoice due date from Invoice due date to

3.4.1.2 Method Response Table 35 method response details

Name InvoiceHeaderList InvoiceHeader InvoiceHeader InvoiceNumber InvoiceDate DueDate InvoiceAmount InvoiceAmountWithTaxes PaidSum CurrencyCode BranchId DeliveryAddress

Type InvoiceHeader String DateTime DateTime Decimal Decimal Decimal String String String

Occurs Description 0…n 1 1 1 1 1 1 1 1 1

Invoice number Invoice date Due date Invoice amount without VAT Invoice amount with VAT Paid sum Currency code Customer’s branch id Delivery address

3.4.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/GetInvoiceList" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 66

Acme API Specification v 1.0 <soap:Body> InvoiceDateFrom 2008.02.02 InvoiceDateTo 2008.03.03 Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: 475 <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:Body> INV-00000001 2008.02.25 2008.03.25 100,00 118,00 <PaidSum>25,00 LTL 111 Delivery Address INV-00000002 2008.02.26 2008.03.25 1000,00 1180,00 <PaidSum>100,00 LTL 111 Delivery Address 67

Acme API Specification v 1.0 SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> InvoiceDateFrom 2008.02.02 InvoiceDateTo 2008.03.03 Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Body> 68

Acme API Specification v 1.0 INV-00000001 2008.02.25 2008.03.25 100,00 118,00 <PaidSum>25,00 LTL 111 Delivery Address INV-00000002 2008.02.26 2008.03.25 1000,00 1180,00 <PaidSum>100,00 LTL 111 Delivery Address

3.4.2

GetInvoiceDetails Method Method returns details of specified Invoice.

3.4.2.1 Method Request Table 36 available request filters

Name Occurs InvoiceNumber 0…n InvoiceDateFrom 0…1 InvoiceDateTo 0…1 DueDateFrom 0…1 DueDateTo 0…1

Value example INV-44544444 2008.01.01 2008.01.30 2008.02.01 2008.02.14

Description Invoice number Invoice date from Invoice date to Invoice due date from Invoice due date to

3.4.2.2 Method Response Table 37 method response details

Name Invoice InvoiceHeader InvoiceLine MiscellaneousCharges InvoiceHeader InvoiceNumber

Type

Occurs

InvoiceHeader InvoiceLine MiscellaneousCharges

1 0…n 0…n

String

1 69

Description Invoice header Invoice lines Miscellaneous charges Invoice number

Acme API Specification v 1.0 InvoiceDate DueDate InvoiceAmount InvoiceAmountWithTaxes PaidSum CurrencyCode BranchId DeliveryAddress InvoiceLine SupplierCode OrderRefId OrderLineRefId ShortName SalesPrice Quantity LineAmount OrderNumber Note MiscellaneousCharges ChargeCode ChargeAmount

DateTime DateTime Decimal Decimal Decimal String String String

1 1 1 1 1 1 1 1

Invoice date Invoice due date Invoice amount without VAT Invoice amount with VAT Paid sum Currency code Customer’s branch id Delivery address

String String String String Decimal Decimal Decimal String String

1 1 1 1 1 1 1 1 1

Product identification code assigned by supplier User’s order reference id User’s ordr line reference id Short product name Sales price Quantity Line amount Order number Note from order line

String Decimal

1 1

Charge code Charge amount

Table 38 available charge types

Code Name transport Transport charge service Service Charge

3.4.2.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/GetInvoiceDetails" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> 70

Acme API Specification v 1.0 InvoiceNumber INV-00000001 Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <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:Body> INV-00000002 2008-02-26T00:00:00 2008-03-25T00:00:00 1000.0000 1180.0000 <PaidSum>100.0000 LTL 111 Delivery Address <SupplierCode>000333 001 002 <ShortName>Mustek ScanEx. A3 USB /USB/300x600/48bit/CIS <SalesPrice>300.0000 3.0000 900.0000 SU00014724 Note text goes here <SupplierCode>009771 001 001 <ShortName>A-DATA 2GB PD9 USB2.0 Flash Drive <SalesPrice>100.5000 1.0000 60.0000 SU00014641 71

Acme API Specification v 1.0 Note text goes here <MiscellaneousCharges> transport 20.00000 SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> InvoiceNumber INV-00000001

HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Body> 72

Acme API Specification v 1.0 INV-00000001 2008-02-26T00:00:00 2008-03-25T00:00:00 1000.0000 1180.0000 <PaidSum>100.0000 LTL 111 Delivery Address <SupplierCode>000333 001 001 <ShortName>Mustek ScanEx. A3 USB /USB/300x600/48bit/CIS <SalesPrice>300.0000 3.0000 900.0000 SU00014724 Note text goes here <SupplierCode>009771 001 001 <ShortName>A-DATA 2GB PD9 USB2.0 Flash Drive <SalesPrice>100.5000 1.0000 60.0000 SU00014641 Note text goes here <MiscellaneousCharges> transport 20.00000

3.4.3

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

3.4.3.1 Method Request

73

Acme API Specification v 1.0 Table 39 available request filters

Name Occurs InvoiceNumber 1

Value Example INV-001447555

Description Invoice number

3.4.3.2 Method Response Table 40 method response details

Name ProductSerial SupplierCode SerialNumber

Type

Occurs

String String

1 1

Description Product identification code assigned by supplier Product serial number

3.4.3.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/GetInvoiceProductSerialList" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> InvoiceNumber INV-00000001 Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 74

Acme API Specification v 1.0 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <SupplierCode>255585 <SerialNumber>ASW123213DFAFS <SupplierCode>255585 <SerialNumber>ASW123213DFAFA SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> InvoiceNumber INV-00000001

Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length 75

Acme API Specification v 1.0 <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/soapenvelope"> <soap12:Body> <SupplierCode>255585 <SerialNumber>ASW123213DFAFS <SupplierCode>255585 <SerialNumber>ASW123213DFAFA

3.4.4

GetInvoiceShipments Method Method returns list of shipments related with this invoice.

3.4.4.1 Method Request Table 41 available request filters

Name Occurs InvoiceNumber 1

Value example INV-14557444

Description Invoice number

3.4.4.2 Method Response Table 42 method response details

Name Shipment CarrierId Number

Type

Occurs

String String

1 1

Description Carrier identification number (for available id see table below) Shipment number

Table 43 carriers list

CarrierId Carrier Name 2 DPD Lietuva 3 Venipak

3.4.4.3 Request/Response examples SOAP 1.1 example: 76

Acme API Specification v 1.0 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/GetInvoiceShipments" <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> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap:Body> InvoiceNumber USR-7 Response: HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <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:Body> <ShipmentList> <Shipment> 2 45774444444 <Shipment> 2 5466878878 77

Acme API Specification v 1.0 SOAP 1.2 example: Request: POST /1.0/commerce.asmx HTTP/1.1 Host: api.acme.lt Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Header> 498ec72c-e8e7-48f2-b300-d95666aeb141 <soap12:Body> InvoiceNumber USR-7 Response: HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <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/soapenvelope"> <soap12:Body> <ShipmentList> <Shipment> 2 45774444444 <Shipment> 2 5466878878 78

Acme API Specification v 1.0

79

Acme API Specification v 1.0

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

80