API Documentation
Table of Contents
| Authentication Keys |
In order the get your authKey please register
or login and check the
Authentication Keys. Please notice that all of API methods require a valid authKey! |
|---|
| Supported Protocols | |
|---|---|
| Supported protocols | SOAP HTTP -> XML HTTP -> JSON |
| SOAP | WSDL located here: /api/soap/api.wsdl
Please post all SOAP requests to /api/soap |
| HTTP+XML HTTP+JSON |
Default format: XML If you prefer HTTP over SOAP, you can use the HTTP request api. Simply constract a http request: /api/MethodName?params=myParams If you prefer to work with JSON add ?tg_format=json or a HTTP Accept: text/javascript header You can also POST the params instead of passing them in GET request. |
| Sandbox and URL Constractor | For your convenience you can use automated URL Constractor. |
|---|
| Method | Url | Params | Return | Description |
|---|---|---|---|---|
| getLocations | /api/getStocks | required string: authKey |
Locations Object | Returns available locations |
| getGroups | /api/getGroups | required string: authKey optional string: locationCode |
Groups Object | Returns available groups Example url: /api/getGroups?authKey=my_auth_Key&locationCode=UK |
| getStyles | /api/getStyles | required string: authKey optional string: locationCode |
Styles Object | Returns available locations Example url: /api/getStyles?authKey=my_auth_Key&locationCode=UK |
| getStocks | /api/getStocks | required string: authKey optional string: locationCode optional string: styleCode |
Stocks Object | Returns available Stocks Example url: /api/getStocks?authKey=my_auth_Key&locationCode=UK&styleCode=N02 |
| getStockOrders | /api/getStockOrders | required string: authKey optional string: locationCode optional string: styleCode optional string: itemCode |
StockOrders Object | Returns available stock orders |
| getStyleSizes | /api/getStyleSizes | required string: authKey optional string: locationCode optional string: styleCode |
Sizes Object | Returns available sizes for given style, if no style is
given, returns all sizes Example url: /api/getStyleSizes?authKey=my_auth_Key&locationCode=UK&styleCode=N02 |
| getStyleColors | /api/getStyleColors | required string: authKey optional string: locationCode optional string: colorCode |
Colors Object | Returns available colors, if color code is fiven, returns
singe color object Example url: /api/getStyleColors?authKey=my_auth_Key&locationCode=UK |
| Errors and Exceptions | In case of an error or exception in one of the methods an ApiError object will be returned instead of expected result. |
|---|
| Object | Description | Example |
|---|---|---|
| ApiError |
Param String: faultcode Param String: faultstring |
ApiError.xml |
| ApiImage |
Object Type: sequence Param String: url Param String: version |
|
| ApiStyles |
Object Type: sequence Param Sequence String: styleCode (ie. N02,N03 ) Param Sequence ApiImage: image Param String: locationCode (ie. UK, DE) Param String: name Param Sequence ApiImage: sizechart |
ApiStyles.xml |
| ApiStocks |
Object Type: sequence Param String: itemCode (ie. N02-BL1,N03-BL2 ) Param String: colorCode (ie. BL,AG ) Param Sequence String: groupCode (ie. A,B,C ) Param Sequence ApiImage: image Param String: locationCode (ie. UK, DE) Param String: name Param Int: size Param Int: stock Param String: styleCode (ie. N02,N03 ) |
ApiStocks.xml |
| ApiStockOrders |
Object Type: sequence Param Int: amount Param String: itemCode (ie. N02-BL1,N03-BL2 ) Param String: date (dd.mm.yyyy) Param String: locationCode (ie. UK, DE) |
ApiStockOrders.xml |
| ApiSizes |
Object Type: sequence Param String: sizeCode (ie. 1,2,3 ) Param String: locationCode (ie. UK, DE) Param String: size (size name S,M,L,XXL etc) Param String: styleCode (ie. N02,N03 ) |
ApiSizes.xml |
| ApiLocations |
Object Type: sequence Param String: address Param String: locationCode (ie. UK, DE) |
ApiLocations.xml |
| ApiGroups |
Object Type: sequence Param String: groupCode (ie. A,B,C ) Param String: locationCode (ie. UK, DE) Param String: name |
ApiGroups.xml |
| ApiColors |
Object Type: Sequence Param String: colorCode ( ie. BL,AG ) Param Sequence ApiImage: image Param String: locationCode (ie. UK, DE) Param String: name (of the color: Balck, White ) |
ApiColors.xml |