Documentation::getOrdersList

Method returns list of saved orders from arbitrary date defined by current midnight - number of days.

The only input parameter is days (xsd:unsignedByte), which specifies the number of days from current midnight.

Output is 3D array (struct) of number (xsd:token), which carries the internal order number, number_ext (xsd:string), the client/external number, issued (xsd:dateTime), which carries the order issuance date and time in ISO 8601 localtime (see ISO 8601 standart for details), status (xsd:unsignedByte), the order status (usually a two-digit number).

Fault codes

Method returns SOAP fault (according to SOAP Version 1.2, section 2.3 Fault Scenarios) on failure or when no data found for client request. Database error may be returned with specific error prefix, when database is not ready or something unwanted happens.

Code Actor String Detail
0SERVICENo orders found for supplied date.client input
1CLIENTNumber of days out of bounds.client input
ORA-[0-9]{1-5}DATABASEDatabase subsystem error.database error message

Orders statuses

Status ID Description
1Order received
2Partially delivered
3Delivered
4Order cancelled
5Partially shipped
6Shipped

Processing examples

Type of order Description
Order cancelledOrder received (1) -> Order cancelled (4)
All products are on stockOrder received (1) -> Shipped (6) -> Delivered (3)
Some products are out of stockOrder received (1) -> Partially shipped (5) -> Delivered (3)
Some products are out of stockOrder received (1) -> Partially shipped (5) -> Partially delivered (2) -> Delivered (3)

Authentication

SOAP client must be capable of basic HTTP authentication to use this method.

Example request

POST /index.php HTTP/1.0
User-Agent:ClTest/1.0.0 (0.99)
Host:xchgdemo.techdata.cz
Content-Type:text/xml; charset=UTF-8
SOAPAction:"http://xchgdemo.techdata.cz/index.php/getOrdersList"
Content-Length:552

Example response

HTTP/1.1 200 OK
Date:Thu, 12 Jul 2007 06:59:13 GMT
Server:Apache
X-SOAP-Server:NuSOAP/0.6.8 (1.81)
Content-Length:25358
Connection:close
Content-Type:text/xml; charset=UTF-8

Example fault response

HTTP/1.1 500 Internal Server Error
Date:Thu, 12 Aug 2004 09:26:36 GMT
Server:Apache
Status:500 Internal Server Error
X-SOAP-Server:NuSOAP/0.6.8 (1.76)
Content-Length:656
Connection:close
Content-Type:text/xml; charset=UTF-8

Known bugs

SOAP fault is returned in ISO-8859-1 encoding, except of server header UTF-8 charset declaration.