Cancelling a Supplier Order – cancelPaysSupplierShipping()

Supplier Order Cancellation

cancelPaysSupplierShipping() method, available on the Horoz Logistics Domestic Distribution Integration, is used to cancel a supplier-pays type shipping order that has been created previously by means of the createPaysSupplierShipping() method if such shipping order is in compliance with the cancellation conditions. If the shipping order entry that has been sent previously to the Horoz Logistics system by means of the createPaysSupplierShipping() method was approved by the Horoz Logistics operations and the operational life cycle has already started upon the accepance of the goods, the client will receive an error through the integration when it tries to cancel the shipping order by means of the cancelPaysSupplierShipping() method. Important information about the cancelPaysSupplierShipping() method and the points to be considered when canceling a shipping order in the Horoz system are listed below for the information of the clients.

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

• When canceling a shipping order that has been sent previously to the Horoz system by making use of the cancelPaysSupplierShipping() 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 a cancellation request will be sent to the Horoz Logistics system by making use of the createPaysSupplierShipping() method must have been previously created in the Horoz Logistics system via the Horoz Logistics Domestic Distribution Integration Webservice by means of the createPaysSupplierShipping() method. Any order that does not exist in the Horoz Logistics system may not be cancelled.

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

• cancelPaysSupplierShipping() method performs the cancellation process on order basis. A part-based cancellation may not be made for any part of any product within an order that has been created previously by means of the createPaysSupplierShipping() method.

• • When sending a cancellation request to the Horoz Logistics system by means of the cancelPaysSupplierShipping() method; in addition to the requestNumber field, the senderCode details which have been entered previously while creating the supplier-pays order by means of the createPaysSupplieerShipping() method is also expected to be entered in the marketPlaceMerchantCode field within the request.

---

POST cancelPaysSupplierShipping()

ENDPOINT

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

Parameter Descriptions & Rules

The following table lists the input and output parameters of the cancelPaysSupplierShipping() process, and 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	Order number	string	50	inBody Request	Mandatory
marketPlaceMerchantCode	Marketplace Merchant Code	string	100	inBody Request	Mandatory

Example Request

{
  "requestNumber": "TEST-17052023-1",
  "marketPlaceMerchantCode": "801411"
}  

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-20003	BU TALEP NUMARASI DAHA ÖNCE İPTAL EDİLMİŞ - Key: XXX TalepNo: XXX	Indicates that the order with the entered requestNumber details has been cancelled previously.
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-20010	TALEP ONAYLANDIĞINDAN İPTAL EDİLEMEZ	It refers to the fact that the respective shipment may not be cancelled because it has already entered the logistics process.
ERR-20036	marketPlaceMerchantCode BİLGİSİ BOŞ GEÇİLEMEZ.	Indicates that the marketPlaceMerchantCode details have been been entered incompletely.
ERR-20036	requestNumber BİLGİSİ BOŞ GEÇİLEMEZ.	Indicates that the requestNumber details have been entered incompletely.