v2.order.cancel_order

Use this api to cancel an order. This action can only be performed before the order has been shipped.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"order_sn": "201020SQQ5K2EP",
	"cancel_reason": "OUT_OF_STOCK",
	"partial_cancel_item_list": [
		{
			"item_id": 1680783,
			"model_id": 327890123,
			"order_item_id": 0,
			"promotion_group_id": 0,
			"model_quantity": 2
		}
	]
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/order/cancel_order?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"cancel_reason\": \"OUT_OF_STOCK\",
   \"order_sn\": \"201020SQQ5K2EP\",
   \"partial_cancel_item_list\": [
      {
         \"item_id\": 1680783,
         \"model_id\": 327890123,
         \"model_quantity\": 2,
         \"order_item_id\": 0,
         \"promotion_group_id\": 0
      }
   ]
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/order/cancel_order?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "cancel_reason": "OUT_OF_STOCK",
    "order_sn": "201020SQQ5K2EP",
    "partial_cancel_item_list": [
        {
            "item_id": 1680783,
            "model_id": 327890123,
            "model_quantity": 2,
            "order_item_id": 0,
            "promotion_group_id": 0
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/order/cancel_order?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "cancel_reason": "OUT_OF_STOCK",
   "order_sn": "201020SQQ5K2EP",
   "partial_cancel_item_list": [
      {
         "item_id": 1680783,
         "model_id": 327890123,
         "model_quantity": 2,
         "order_item_id": 0,
         "promotion_group_id": 0
      }
   ]
}'

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/order/cancel_order?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "cancel_reason": "OUT_OF_STOCK",
  "order_sn": "201020SQQ5K2EP",
  "partial_cancel_item_list": [
    {
      "item_id": 1680783,
      "model_id": 327890123,
      "model_quantity": 2,
      "order_item_id": 0,
      "promotion_group_id": 0
    }
  ]
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
    "error": "",
    "message": "",
    "request_id": "2ead12d461c34e7c9275c42c2f70fa7d",
    "response": {
        "update_time": 1603184533
    } 
}

Error example

JSON

{
    "error":"error_param",
    "message":"Wrong parameters, detail: order_sn is a required field.",
    "request_id":"4d6a1cfcb68b2d1b0f0110e723614a22"
}

Errors

Common errors

Update log