SetStatusToCanceled

Definition

Use this call to cancel a single item.

Request URI: https://api.sellercenter.lazada.sg?Action=SetStatusToCanceled

Parameters

Field	Type	Description
Action	string	SetStatusToCanceled Name of the API that is to be called. Mandatory.
Format	string	The response format, with XML as the default. Can be XML or JSON. Optional.
Timestamp	datetime	The current time in ISO8601 format (e.g., Timestamp=2016-04-01T10:00:00+02:00 for Berlin). Mandatory.
UserID	string	The ID of the user making the call. Mandatory.
Version	string	The API version against which this call is to be executed. The current version is "1.0". Mandatory.
Signature	string	The cryptographic signature, authenticating the request. You must create this value by computing the SHA256 hash of the request, using the API key of the user specified in the UserID parameter. Mandatory.
OrderItemId	long	Order item ID. Mandatory.
ReasonId	long	ID of the cancel reason, which is returned by the GetFailureReasons API. Mandatory.
ReasonDetail	string	Reason detail. Optional.

Code sample

# SetStatusToCanceled cURL example
# to run, update Timestamp and recompute Signature
#
url = "https://api.sg.ali-lazada.com/"
get
data-urlencode Action=SetStatusToCanceled
data-urlencode OrderItemId=1
data-urlencode ReasonID=15
data-urlencode ReasonDetail=My hobbies are ordering and returning.
data-urlencode Timestamp=2015-07-01T11:11+0000
data-urlencode [email protected]
data-urlencode Version=1.0
data-urlencode Signature=d4ff93cccb165295ed8357fe42082208b781a3b576bbb7d3fe7a624270b047b9

//init request with OrderItemId, reason, detailed reason
SetStatusToCanceled request = new SetStatusToCanceled(10937342L, "Invalid - Customer unreachable", "detailreason");
//fire request and check result
try {
  UpdateResponse response = request.execute();
  System.out.println("Set status succeed?" + response.getBody());
} catch (LazadaException e) {
  System.out.println(e.getResponseStr());
}

Result sample

Success and failure result samples are as follows.

<?xml version="1.0" encoding="UTF-8"?>
<SuccessResponse>
  <Head>
    <RequestId></RequestId>
    <RequestAction>SetStatusToCanceled</RequestAction>
    <ResponseType></ResponseType>
    <Timestamp>2013-08-27T14:44:13+0000</Timestamp>
  </Head>
  <Body />
</SuccessResponse>

<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse>
  <Head>
    <RequestAction>SetStatusToCanceled</RequestAction>
    <ErrorType>Sender</ErrorType>
    <ErrorCode>1000</ErrorCode>
    <ErrorMessage>Invalid cancelation reason</ErrorMessage>
  </Head>
  <Body/>
</ErrorResponse>

Error messages

Error code	Message
20	E020: "%s" Invalid Order Item ID
21	E021: OMS Api Error Occurred
22	E022: "%s" Invalid Reason
28	E028: It is not possible to set the order to the status "%s"