Cancellation Process (cancel)

Cancellation Process

The cancel() method is used for canceling individual work orders transferred to the Horoz system. It supports single cancellation order submissions.

Before initiating the cancellation process with this method, the values of the opType and parameter fields must be communicated to Horoz Logistics.

• The maximum number of cancellations that can be submitted in each request is 1.
• This method is used for the cancellation of return, order, and receipt orders registered in the Horoz system. Cancellation orders cannot be sent for work orders not defined in the Horoz system.

POST cancel

Use

https://ewms.horoz.com.tr:9992/fullfillmentservice_test/v1/cancel https://ewms.horoz.com.tr:9992/fullfillmentservice_app/v1/cancel

Parameter Descriptions & Rules

The table below lists the input and output parameters of the cancel() operation, along with their types and formats.

Fields

Parameter	Mandatory	Description	Data Type
processKey	Yes	Information provided to you for processKey	string
opCode	Yes	Operation Code	string
opType	No	Operation Type. Specifies which work order the operation code belongs to. Example: 10 for Order, 20 for Receipt	string
dataTransferInfo	No	Data Transfer information	string
parameter01	No	User Defined Parameter 1	string
parameter02	No	User Defined Parameter 2	string
parameter03	No	User Defined Parameter 3	string
parameter04	No	User Defined Parameter 4	string
parameter05	No	User Defined Parameter 5	string

Example Service Request

  {
    "processKey": "A1389BF5246943ED8F40DEF725E0EE84",
    "opCode": "20230221256974-1",
    "opType": "20",
    "dataTransferInfo": "/kpsCEDOi0K9xaVX3iUAgA==",
    "parameter01": "string",
    "parameter02": "string",
    "parameter03": "string",
    "parameter04": "string",
    "parameter05": "string"
  }

Example Response

{
  "result": "0",
  "errorCode": "",
  "systemMessage": "Sipariş İptal Edildi. Sipariş Kodu: 20230221256974-1"
}

Services Response

result	errorCode	systemMessage	Description
0	101	BTA NOT FOUND!	The Expected Receipt sent to the Horoz system does not exist.
1	101	BTA CANCELLED SUCCESSFULLY!	The Expected Receipt has been successfully cancelled.
0	101	BTA STATUS NOT SUITABLE FOR CANCELLATION!	The Expected Receipt has already been completed or previously cancelled.
0	101	ORDER NOT FOUND!	The Order sent to the Horoz system does not exist.
1		ORDER CANCELLED SUCCESSFULLY!	The Order has been successfully cancelled.
0	101	ORDER STATUS NOT SUITABLE FOR CANCELLATION!	The Order is not eligible for cancellation.
0	101	ORDER SHIPPED CANNOT BE CANCELLED !!!	The Order has been shipped and cannot be cancelled.