Product Groups Listing - listProductGroups()

Product Groups Listing

This method has been prepared by HOROZ in order to express the list of product groups, which will be used in the export project, and the group information, in which the product is included in the product registration phase.

Product group information will be needed by the client when defining a product to the Horoz Logistics system. Product group information for the products in the product tree of a client is actually defined manually for each seller at the beginning of the integration process for the relevant client to the Horoz system via the Horoz Web Portal. If the seller needs new product group information other than the product groups in the existing list defined at the beginning, the seller can contact the customer representative of the relevant department and request to add the required product group to the system. The product group defined to the system by the Horoz Logistics export customer representative will be returned to the client simultaneously in the returns of the listProductGroups() method. Important information about the listProductGroups()method and the things to be considered when listing product groups in the Horoz system are listed below for the information of the clients.

• listProductGroups() method is a RESFtul web service method that receives data in JSON format with POST method.

• When querying the product group from the Horoz Logistics system with the listProductGroups() method, the information about the product group must be passed to the body part of the method in the JSON data type. The processKey information of the client must be passed to the header part of the method in parameter type. The submission made with the listProductGroups() method must be encoded as UTF-8 and transmitted to Horoz Logistics E-Export Integration Web service.

• The listProductGroups() method receives productGroupCode and productGroupName as parameters in JSON format as a POST method.The method returns productGroupCode, productGroupNameTr, productGroupNameEn, productGroupNameEn, productPartnerNameTr, productPartnerNameEn, montageStatus to the client in response to the received request parameters.There are Turkish and English equivalents of product group name, product partner name information in the returned response.

• When querying product groups with listProductGroups() method, querying can be done on the basis of product group code or product group name, or only on the basis of product group code or product group name.In addition, when the product group code and product group name information is empty and/or null, the information of all product groups defined and valid in the Horoz system for the relevant company is returned to the client.

---

POST listProductGroups()

EndPOINT

http://b2btest.horoz.com.tr:7801/eexport_test/v1/listProductGroups

Parameter Descriptions & Rules

The following table shows the input and output parameters of the listProductGroups() operation and their The types and formats of the parameters are listed.

Fields

FIELDS	DESCRIPTION	DATA TYPE	LENGTH	FIELD LOCATION	REQUIRMENT
processKey	processKey information defined for the client	string	100	Header	Mandatory
productGroupCode	Unique product group code information	string	10	inBody Request	Optional
productGroupName	Unique product group name information	string	100	inBody Request	Optional

Example Request

{ 
  "productGroupCode": "", 
  "productGroupName": "" 
}   

Example Response

{
  "response": {
    "responseCode": "STA-100",
    "responseMessage": "ISLEM BASARILI",
    "listProductGroups": {
      "productGroups": [
        {
          "productGroupCode": "98",
          "productGroupNameTr": "MOBİLYA",
          "productGroupNameEn": "FURNITURE",
          "productPartnerNameTr": "MOBİLYA",
          "productPartnerNameEn": "FURNITURE",
          "montageStatus": "NO"
        },
        {
          "productGroupCode": "99",
          "productGroupNameTr": "AYDINLATMA",
          "productGroupNameEn": "LIGHTING",
          "productPartnerNameTr": "AYDINLATMA",
          "productPartnerNameEn": "LIGHTING",
          "montageStatus": "NO"
        },
        :
      ]
    }
  }
}

---

Service Responses

You can access the successful/unsuccessful service responses here.