API Docs

Cancel Return Order

PATCH

/api/v1/public/return-orders/update-status/{{return_id}}

ReturnCancel

Cancel a return order based on the provided return_id.

Path Parameter:
return_id (string or number): ID of the return order to be canceled.

Note:

This API can only cancel return orders that are in a valid state (e.g., pending approval or unprocessed).

If the return order has already been processed, shipped, or completed, cancellation might not be allowed.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PATCH '/api/v1/public/return-orders/update-status/{{return_id}}' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": 1002
}'

Response Example

200 - Success

{
    "status_code": 200,
    "data": {
        "return_id": 375,
        "status": 1002
    },
    "error": false,
    "error_code": null,
    "log_id": null,
    "messages": "",
    "total": 1
}

Request

Header Params

Authorization

string

required

Default:

Body Params application/json

status

integer

required

status: 1002 → Represents that the return order is cancelled.

Examples

Responses

🟢200OK

application/json

Body

status_code

integer

optional

data

object

optional

return_id

integer

optional

status

integer

optional

error

boolean

optional

error_code

string

optional

log_id

integer

optional

messages

string

optional

total

integer

optional

🟠400Bad Request

Create return order

List courier service integrated