Catalogue export method.
Input is a multidimensional array (struct) of tns:productsFlatRequest, which is a complex structure best described in WSDL. There are many (to be honest, almost the whole request) optional fields in this structure, so read the WSDL comments carefully.
Output is a flat multidimensional array (struct) of tns:productsFlat, which contains unsorted product part numbers and other product attributes such as name, group id, vendor token and so.
| element | description | default |
|---|---|---|
| groups | array of group (not parent/root) identification xsd:nonNegativeIntegers, which narrows the request | all |
| vendors | array of vendor identification xsd:tokens, which narrows the request | all |
| keywords | array of keyword identification xsd:nonNegativeIntegers, which narrows the request | all |
| _groups | flag activating group identification xsd:nonNegativeIntegers export for each product | false |
| _kws | flag activating keyword identification xsd:nonNegativeIntegers export for each product (if available, because not all product must have a linked keyword) | false |
| _vendors | flag activating vendor identification xsd:tokens export for each product | false |
| _names | flag activating product names export | false |
| _prices | flag activating prices export with each product (if it's too slow, client should use getWarehouseStatus instead of using this flag) | false |
| _vats | flag activating export of value added tax percentages with each product | false |
| _texts | flag activating export of additional texts with each product (if available) | false |
| _imgs | flag activating export of additional image URIs (or filenames) with each product (if available) | false |
| _pids | flag activating export of product id | false |
| _warranties | flag activating export of warranty identification xsd:nonNegativeIntegers with each product (if available) | false |
| lang | language of output (see ISO 639 for details) | cs |
Client should request at worst 5 000 products (eg. one vendor or one group).
Client may submit only limited number of identical requests in a timeframe given by a contract.
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 |
|---|---|---|---|
| any negative | SERVER | Unhandled exception. | possibly anything |
| 1 | SERVICE | Requested vendor not found. | selected vendor |
| 2 | SERVICE | Empty response, no data to feed back. | query CRC |
| 3 | SERVICE | Response dataset too large, stopped. | query CRC |
| 1 | CLIENT | Malformed request, language not available. | selected language |
| 2 | CLIENT | Malformed request, invalid group identification. | selected group |
| 3 | CLIENT | Malformed request, invalid keyword identification. | selected keyword |
| 4 | CLIENT | Malformed request, invalid vendor identification token. | selected vendor |
| 5 | CLIENT | Malformed request. | |
| ORA-[0-9]{1-5} | DATABASE | Database subsystem error. | database error message |
SOAP client must be capable of basic HTTP authentication to use this method.
| 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/getProductsFlat" |
| Content-Length: | 1264 |
| HTTP/1.1 200 OK | |
|---|---|
| Date: | Thu, 12 Jul 2007 06:59:13 GMT |
| Server: | Apache |
| X-SOAP-Server: | NuSOAP/0.6.8 (1.76) |
| Content-Length: | 300909 |
| Connection: | close |
| Content-Type: | text/xml; charset=UTF-8 |
SOAP fault is returned in ISO-8859-1 encoding, except of server header UTF-8 charset declaration.