Selection of Collection Points - selectCollectionPoints()

Selection of Collection Points

The selectCollectionPoints() method on the Horoz Logistics E-Export Integration is designed to determine the collection address where the product will be brought if the purchase type is Self-Brought in the orders sent to Horoz. The information contained in the order can be passed to the request field to determine which collection point the product will be brought to for the relevant order. Important information about the selectCollectionPoints() method and things to be considered are listed below for the information of the clients.

selectCollectionPoints() method is a RESFtul web service method that receives data in JSON format with POST method.
With the selectCollectionPoints() method, the information should be passed to the body part of the method in the JSON data type when determining the collection address where the product will be brought in case the collection type is Self-Brought in the Horoz Logistics system. The processKey of the client must be passed to the header of the method as a parameter type. The submission made with the selectCollectionPoints() method must be encoded as UTF-8 and transmitted to the Horoz Logistics E-Export Integration Web service.
The selectCollectionPoints() method returns to the client the information about the collection address where orders with reception type ItWillBring (receptionType: itWillBring) should be called by the client before order entry.
The selectCollectionPoints() method accepts the following parameters in JSON format via a POST request: recipientCountryName, paymentMethod, recepientType, and transportType.
In response, the method returns responseCode and responseMessage to indicate the success or failure of the operation. Additionally, it provides collectionPointId, address, country, city, county, postCode, officialPerson, phone, and email information to notify the client about the collection point that should be used when creating an order.
The selectCollectionPoints() method always returns information about a suitable collection point to the client based on the information provided in the request and the validity of that information.

POST selectCollectionPoints()

ENDPOINT

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

Parameter Descriptions & Rules

The following table shows the input and output parameters of the selectCollectionPoints() 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
`recipientCountryName`	Recipient country name	string	100	inBody Request	Mandatory
`paymentMethod`	Payment type (mandatory when transportType is “airWay”)	string	50	inBody Request	Mandatory
`recipientType`	Reception type (mandatory when transportType is “airWay”)	string	50	inBody Request	Mandatory
`transportType`	Transport type	string	50	inBody Request	Mandatory

  {
    "recipientCountryName": "ALMANYA",
    "paymentMethod": "economy",
    "recipientType": "B2C",
    "transportType": "airWay"
  }

  {
    "response": {
      "responseCode": "STA-100",
      "responseMessage": "ISLEM BASARILI",
      "selectCollectionPoints": {
        "collectionPoints": [
          {
            "collectionPointId": 3,
            "address": "İKİTELLİ CAD. NO:18-20A ATATÜRK MAHALLESİ 34307 KÜÇÜKÇEKMECE İSTANBUL / TÜRKİYE",
            "country": "TÜRKİYE",
            "city": "İSTANBUL",
            "county": "KÜÇÜKÇEKMECE",
            "postCode": "34290",
            "officialPerson": "AHMET MÜCAHİT KARDAŞ",
            "phone": "05300722706",
            "email": "mucahit@cargomda.com"
          }
        ]
      }
    }
  }

Any further information about the enum values expected in the selectCollectionPoints() method is provided as follows.

ENUM FIELD	FIELD NAME	DESCRIPTION
paymentMethod	Payment type	The payment type may be reported by entering the appropriate value for the selection from one of the values of economy and express. (economy : economy, express : express)
recipientType	Recipient type	The reception type may be reported by entering the appropriate value for the selection from one of the values of B2B and B2C.
transportType	Transport type	The transport type may be reported by entering the appropriate value for the selection from one of the values of road and airWay. (road : road, airWay : airway)

Service Responses

You can access the successful/unsuccessful service responses here.