Order Recall - reCall()

Order Recalling

The reCall() method, available on the Horoz Logistics Domestic Distribution Integration, is used to withdraw the delivery, the order data of which has been transmitted by the client via the Horoz Logistics Domestic Distribution Integration Webservice by making use of the createShipping or the createPaysSupplierShipping method and which is received from the merchant by the Horoz Logistics Domestic Distribution Operations unit, before it is received by the respective recipient. Important information about the reCall() method and the points to be considered when recalling a shipping order in the Horoz system are listed below for the information of the clients.

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

• When recalling a shipping order that has been sent previously to the Horoz system by making use of the reCall() method, the order number must be entered into the body of the method in JSON data type. The client's processKey details must be entered into the header of the method as a parameter type. The shipment made by means of the cancelPaysSupplierShipping() method must be encoded as UTF-8 and transmitted to the Horoz Logistics Domestic Distribution Integration Web service.

• The order, for which an order recall request will be sent to the Horoz Logistics system by making use of the reCall() method must have been previously created in the Horoz Logistics system via the Horoz Logistics Domestic Distribution Integration Webservice by means of the createShipping() or the createPaysSupplierShipping() method, depending on the type of the operation. Any order that does not exist in the Horoz Logistics system may not be cancelled.

• The order, for which an automatic order recall request will be sent to the Horoz Logistics system by means of the reCall() method, must have been approved by Horoz Logistics side, and the goods acceptance entry must have been made. Otherwise, an error will be returned to the client for the call made by means of the reCall() method.

• reCall() method performs automatic order recall on an order basis. Part-based automatic order recall may not be performed for any part of any product within an order that has been created previously by means of the createShipping() or the createPaysSupplierShipping() method and approved in the Horoz Logistics system and for which a goods acceptance entry (ATF entry/barcode label) has been created.

• When sending an automatic order recall request to the Horoz Logistics system by means of the reCall() method, the requestNumber details used to qualify the order number in the createShipping() and the createPaysSupplierShipping() methods, which were previously used while sending a shipping order to the Horoz Logistics system, is expected to be entered into the request.

• In order for the automatic order recall request made via the Horoz Logistics Domestic Distribution Integration Web service by means of the reCall() method to be successfully realized, it is expected that one of the types, namely ShippingReuqest, BranchSales or PaysSupplier is entered into the shippingType field of the order data which has been sent previously through the integration by means of the createShipping() or the createPaysSupplierShipping() method, and the ATF of such shipping order has been caused to be read.

• In order for the automatic order recall request made via the Horoz Logistics Domestic Distribution Integration Web service by making use of the reCall() method to be realized successfully, the delivery departure movement of the respective order from the transfer center to the final recipient must not have been read. Otherwise, the client calling the reCall() method will receive an error.

---

POST reCall()

ENDPOINT

http://b2btest.horoz.com.tr:7801/horozshipping_test/v1/reCall

Parameter Descriptions & Rules

The following table lists the input and output parameters of the reCall() process, as well as the types and formats of such parameters.

Fields

Fields	Description	Data Type	Length	Field Location	Requirement
processKey	The processKey details identified for the client	string	100	Header	Mandatory
requestNumber	The requestNumber details about the order that has been created by means of createShipping/createPaySupplierShipping by the client	string	50	inBody Request	Mandatory

Example Reuqest

  {
    "requestNumber": "TEST123456"
  }

Example Response

  {
        "response": {
            "responseCode": "STA-100",
            "responseMessage": "Kayit islemi basarili"
        }
    }

---

Service Responses

Response Code	Response Message	Description
STA-100	Kayit islemi basarili	It refers to the fact that the shipment cancellation process is successful.
ERR-20001	HATALI IŞLEM ANAHTARI	Indicates that the entered processKey details are incorrect.
ERR-20002	EKSİK PARAMETRE: TALEP NUMARASI	Indicates that the requestNumber information has been entered incompletely.
ERR-20004	TALEP NUMARASI BULUNAMADI - Key: XXX TalepNo: XXX	Indicates that a shipment has not been created previously with the requestNumber entered in the request.
ERR-20025	ATF bulunamadı!	It refers to the fact that that there is no ATF for the respective shipment.
ERR-20026	Gönderi Dağıtımda olduğu için geri çekme yapılamaz!	It refers to the fact that no recall() may be performed because the respective shipment has already entered the distribution process.
ERR-20027	Gönderi İADE durumunda olduğu için geri çekme yapılamaz!	It refers to the fact that no recall() may be performed because the respective shipment is in the return process.
ERR-20028	Gönderi hareket görmediği için geri çekme yapılamaz!	It refers to the fact that no recall() may be performed because the respective shipment has not been subject to any movement yet.
ERR-20029	Gönderi TESLİM edildiği için geri çekme yapılamaz!	It refers to the fact that no recall() may be performed because the logistics process for the respective shipment has been completed and the shipment has already been DELIVERED.
ERR-20030	Gönderi RECALL durumunda olduğu için geri çekme yapılamaz!	It refers to the fact that a recall() may not be performed again since the respective shipment has already been recalled.
ERR-20031	Sistem hatası oluştu, ilgili birim bilgilendirildi!	This response will be returned in case of an unexpected error with respect to the service. In case of receipt of such error, a notification will be sent to the IT unit, and you will be contacted with respect to such error.