API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Order Return
  • Config
    • List Pickup Address
      GET
    • List Box Dimension
      GET
    • List vendor
      GET
    • List store
      GET
  • Online Product
    • Options
      • List category
      • List brand
    • Create Single Product
      POST
    • Create Product From Product Inventory
      POST
    • List product
      GET
    • Product detail
      GET
  • Product Inventory
    • Options
      • List Outbound Strategy
      • List Product Type
      • List Material
      • List Storage Method
    • List product inventory
      GET
    • Product inventory detail
      GET
    • Create single inventory product
      POST
  • Order
    • Shipping Service
      • Preview shipping prices
        • List shipping service
        • List available courier
      • List available courier from order
      • List shipping service of courier
    • Create order B2C
      POST
    • Create order B2B
      POST
    • List order
      GET
    • Order detail
      GET
    • Cancel order
      PATCH
  • Shipment
    • Create shipment auto
      POST
    • [Retail][Ship by self] Create shipment with item
      POST
    • Cancel shipment
      PATCH
    • List shipment
      GET
    • Shipment detail
      GET
    • List shipment of order
      GET
  • Shipment Inbound
    • Create shipment inbound
    • Cancel shipment inbound
    • List shipment inbound
    • Shipment inbound detail
    • Shipment inbound items
  • Order Return
    • List return order
      GET
    • Return order detail
      GET
    • Create return order
      POST
    • Cancel Return Order
      PATCH
  • Courier
    • List courier service integrated
    • List courier operate
    • List courier integrated
  • Address Directory
    • Province
    • District
    • Ward
  1. Order Return

Cancel Return Order

PATCH
/api/v1/public/return-orders/update-status/{{return_id}}
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

Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Body

🟠400Bad Request
Request 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 Response Example
200 - Success
{
    "status_code": 200,
    "data": {
        "return_id": 375,
        "status": 1002
    },
    "error": false,
    "error_code": null,
    "log_id": null,
    "messages": "",
    "total": 1
}
Previous
Create return order
Next
List courier service integrated
Built with