Product Listing - listProducts()
Product Listing
The listProducts method on the Horoz Logistics E-Export Integration can be used to list the products that will be used in the order creation step in the Horoz system from the Horoz Logistics system. Important information about the listProducts() method and the things to be considered when listing products in the Horoz Logistics system are listed below for the information of the clients.
-
The
listProducts()method is aRESFtulweb service method that receives data inJSONformat with thePOSTmethod. -
When sending a request for product listing to the Horoz system with the
listProducts()method, information about the product definition must be passed to the body part of the method in theJSONdata type. The processKey information of the client must be passed to the header part of the method in parameter type. The submission made with thelistProducts()method must be encoded as UTF-8 and transmitted to Horoz Logistics E-Export Integration Web service. -
The
listProducts()method can be used as a list to be displayed for selection on the product definition screen or order entry screen of the products registered in the Horoz Lojistik system with thereateProduct()method.Especially on the order entry screen, it is necessary to create a list that will enable the seller to easily select the products defined in the system according to the container definition types in the product definition structure.For this reason, the list has been created as master and detail. -
For the component product, information such as total desi and total kg, stacking status of the wardrobe will be included in the master section, and the sub-parts representing the product components will be included in the detail section.It should be used in the light of this information according to the design to be made.
-
It must be ensured that the number of containers to be placed on the ETGB is in compliance with the sales quantity within the order and with the container definition type. For example, for a wardrobe, considering that 2 units are sold and that there are 5 components, the sales quantity required to arrive within the order is expected to be 2 and the container quantity is expected to be 10.
-
The listProducts method is the function that returns the list of products, which is defined into the Horoz system, to the client. The listProducts method available within the E-Export integration web service, takes the productCode and productName values as the parameters as a
POSTmethod in JSON format. The relevant method returns the information about the productCode, productNameTr, productGroupCode, productGroupName, width, length, height, gross, netKg, desi, ean, logCode, packageType, stackStatus, containerDefination, isMasterProductRecord, masterProductRecordId to the client in response to the request parameters received. -
While querying the products by means of the
listProducts()method, the query may be performed on the basis of product code or product name, or only on the basis of product code or only on the basis of product name. In addition, when the product code and product name information is empty and/or null, the information about all valid product groups, which are defined in the Horoz system for the relevant company, is returned to the client. While querying a product, productCode information is expected to be entered as the master product code for component products.
POST listProducts()
Parameter Descriptions & Rules
The following table shows the input and output parameters of the listProducts() operation and their
The types and formats of the parameters are listed.
- Fields
- Example Request
- Example Response
| PARAMETER | DESCRIPTION | DATA TYPE | LENGTH | FIELD LOCATION | REQUIRMENT |
|---|---|---|---|---|---|
processKey | processKey information defined for the client | string | 100 | Header | Mandatory |
productCode | Unique product code information | string | 100 | inBody Request | Mandatory |
productName | Unique product name information | string | 500 | inBody Request | Mandatory |
{
"productCode": null,
"productName": null
}
{
"response": {
"responseCode": "STA-100",
"responseMessage": "ISLEM BASARILI",
"listProducts": {
"products": [
{
"productId" : 1055,
"productCode": "AKS10010",
"productNameTr": "AKSESUAR",
"productGroupCode": "99",
"productGroupName": "AYDINLATMA",
"ean": null,
"logCode": null,
"packageType": "KOLİ",
"stackStatus": "false",
"containerDefination": "TOPLU ÜRÜN",
"masterWidth": 50.000,
"masterLength": 50.000,
"masterHeight": 50.000,
"masterGross": 40.000,
"masterNetKg": 40.000,
"masterDesi": 41.667
},
{
"productId" : 1056,
"productCode": "KGN5618",
"productNameTr": "BEYAZ GARDIROP",
"productGroupCode": "98",
"productGroupName": "MOBİLYA",
"ean": null,
"logCode": null,
"packageType": "KOLİ",
"stackStatus": "true",
"containerDefination": "BİLEŞENLİ ÜRÜN",
"masterWidth": 90.000,
"masterLength": 160.000,
"masterHeight": 280.000,
"masterGross": 25.000,
"masterNetKg": 25.000,
"masterDesi": 333.333,
"productDetail": [
{
"productCode": "KGN5618-1",
"productName": "BEYAZ GARDIROP-1",
"width": 40.000,
"length": 80.000,
"height": 150.000,
"gross": 10.000,
"netKg": 10.000,
"desi": 160.000
},
{
"productCode": "KGN5618-2",
"productName": "BEYAZ GARDIROP-2",
"width": 50.000,
"length": 80.000,
"height": 130.000,
"gross": 15.000,
"netKg": 15.000,
"desi": 173.333
}
]
},
{
"productId" : 1057,
"productCode": "TV10010",
"productNameTr": "TELEVİZYON",
"productGroupCode": "98",
"productGroupName": "MOBİLYA",
"ean": null,
"logCode": null,
"packageType": "KOLİ",
"stackStatus": "false",
"containerDefination": "NORMAL ÜRÜN",
"masterWidth": 20.000,
"masterLength": 100.000,
"masterHeight": 60.000,
"masterGross": 20.000,
"masterNetKg": 20.000,
"masterDesi": 40.000
}]}}}
Service Responses
You can access the successful/unsuccessful service responses here.