Cancel Barcode - cancelBarcode()

Barcode Cancellation

The cancelBarcode() method on Horoz Logistics Domestic Distribution Integration is used to cancel the goods acceptance record (ATF record / barcode label record) of a shipment order that was previously created with the createShipping() method, approved with createBarcode(), created a goods acceptance record and received a barcode label, if it meets the cancellation conditions.
If there is a shipment order record that has been previously approved with the createBarcode() method in the Horoz Logistics system, goods acceptance record (ATF record) has been created and operationally read, when the client tries to cancel the barcode label of the relevant shipment order with the cancelBarcode() method, it will receive an error over the integration.

Important information about the cancelBarcode() method and the things to be considered when canceling the barcode of the shipment order in the Horoz system are listed below for the information of the clients.

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

• When canceling a shipment order barcode that was previously sent to the Horoz system with the cancelBarcode() method, the atfId (the first 11 digits of the information in the barcode field returned in the response of the createBarcode method) and the order number must be passed to the body part of the method in JSON data type. The processKey of the client must be passed as a parameter type to the header of the method. The submission made with the cancelBarcode() method must be encoded as UTF-8 and transmitted to Horoz Logistics Domestic Distribution Integration Web service.

• The order for which barcode label cancellation request will be sent to Horoz Logistics system with cancelBarcode() method must have a delivery for which barcode label was created with createShipping() + createBarcode() methods. The barcode label of the goods acceptance record (ATF record) cannot be canceled for a delivery that has not received a barcode label in the Horoz Lojistik system.

• The order to be sent to the Horoz Logistics system with the cancelBarcode() method, for which the barcode label is requested to be canceled, must have been approved by Horoz Logistics, the goods acceptance record must have been made, but there must be no operational movement. Otherwise, an error will be returned to the client for the call made with the cancelBarcode() method.

• The cancelBarcode() method does barcode label canceling on order basis. It is not possible to cancel the barcode label on a part basis for any part of any product in an order for which a barcode label was previously created with the createBarcode() method and an acceptance record (ATF record) was created.

• When a barcode label cancellation request is sent to the Horoz Logistics system with the cancelBarcode() method and the goods acceptance record (ATF record / barcode label) is created, the canceled barcode labels must be removed from the products within the relevant order. If the goods acceptance record (ATF record / barcode label) is created for the related order again with createBarcode() method, the new barcode label should be pasted on the products within the related order.

• If the order for which a shipment order was previously sent to the Horoz Logistics system with createShipping and a goods acceptance record (ATF record / barcode label) was created with the createBarcode() method is not given to Horoz Logistics on the client side, the barcode label and the order must be canceled completely. The cancelBarcode() method must be called to cancel the barcode label and then the cancelShipping() method must be called to cancel the order completely.

---

POST cancelBarcode()

ENDPOINT

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

Parameter Descriptions & Rules

The following table lists the input and output parameters of the cancelBarcode() 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	The requestNumber details about the order that has been created by means of createShipping by the client	string	50	inBody Request	Mandatory
atfId	ATF entry / Barcode entry ID details	string	11	inBody Request	Mandatory

Example Request

  {
    "atfId": "15854236521",
    "requestNumber": "TEST123456"
  }s

Example Response

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

---

Servis Cevapları

Response Code	Response Message	Description
STA-100	Kayit islemi basarili	It refers to the fact that the barcode cancellation process is successful.
ERR-20001	HATALI IŞLEM ANAHTARI	Indicates that the entered processKey details are incorrect.
ERR-20020	SEVK KAYDI BULUNAMADI YADA GEÇERSİZ KAYIT	Indicates that the order, the barcode of which is being tried to be cancelled, does not exist in the system, or that it has been made invalidly.
ERR-20021	GECERSIZ SEVK KAYDI.	Indicates that the order, the barcode of which is tried to be cancelled, has been made invalidly.
ERR-20022	Kaydın ATF si oluşturulamadı.	Indicates that an ATF has not yet been created for the order, the barcode of which is tried to be canceled, and also that such order does not have a barcode.
ERR-20023	Kayıt onaylanmadı.	Indicates that the order, the barcode of which is being tried to be cancelled, has not been approved yet by the Customer Representative.
ERR-20052	HAREKET GÖRMÜŞ ATF GÜNCELLENEMEZ	Indicates that the order, the barcode of which is being tried to be cancelled, has already entered the logistics process, and also that such order may not be cancelled since it has been subject to movements.