v2.order.set_note

Use this api to set note for an order.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"order_sn": "201224EM1FMFG1",
	"note": "Thank you"
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/order/set_note?access_token=access_token&timestamp=timestamp&shop_id=shop_id&partner_id=partner_id&sign=sign")
.header("Content-Type","application/json")
.body("{
   \"note\": \"Thank you\",
   \"order_sn\": \"201224EM1FMFG1\"
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/order/set_note?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 => '{
    "note": "Thank you",
    "order_sn": "201224EM1FMFG1"
}',
  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/set_note?partner_id=partner_id&sign=sign&access_token=access_token&timestamp=timestamp&shop_id=shop_id' \
--header 'Content-Type: application/json' \
--data-raw '{
   "note": "Thank you",
   "order_sn": "201224EM1FMFG1"
}'

Python

import requests
import json

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

payload=json.dumps({
  "note": "Thank you",
  "order_sn": "201224EM1FMFG1"
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.request("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
    "error": "",
    "message": "",
    "request_id": "d66edb8e726d414eb874edda8fa43f4c"
}

Error example

JSON

{
    "error": "error_param",
    "message": "Wrong parameters, detail: note is a required field.",
    "request_id": "f56e55ef161768e219121420b8c4fa4b"
}

Errors

Common errors