v2.logistics.create_shipping_document

Use this api to create shipping document task for each order or package and this API is only available after retrieving the tracking number.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"order_list": [
		{
			"order_sn": "201118BCKPJQQ8",
			"package_number": "2485710696837122445",
			"tracking_number": "SPXID02742637123B",
			"shipping_document_type": "NORMAL_AIR_WAYBILL"
		}
	]
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://open.admin.shopee.io/api/v2/logistics/create_shipping_document?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"order_list\": [
      {
         \"order_sn\": \"201118BCKPJQQ8\",
         \"package_number\": \"2485710696837122445\",
         \"shipping_document_type\": \"NORMAL_AIR_WAYBILL\",
         \"tracking_number\": \"SPXID02742637123B\"
      }
   ]
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://open.admin.shopee.io/api/v2/logistics/create_shipping_document?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 => '{
    "order_list": [
        {
            "order_sn": "201118BCKPJQQ8",
            "package_number": "2485710696837122445",
            "shipping_document_type": "NORMAL_AIR_WAYBILL",
            "tracking_number": "SPXID02742637123B"
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request POST 'https://open.admin.shopee.io/api/v2/logistics/create_shipping_document?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "order_list": [
      {
         "order_sn": "201118BCKPJQQ8",
         "package_number": "2485710696837122445",
         "shipping_document_type": "NORMAL_AIR_WAYBILL",
         "tracking_number": "SPXID02742637123B"
      }
   ]
}'

Python

import requests
import json

url = "https://open.admin.shopee.io/api/v2/logistics/create_shipping_document?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "order_list": [
    {
      "order_sn": "201118BCKPJQQ8",
      "package_number": "2485710696837122445",
      "shipping_document_type": "NORMAL_AIR_WAYBILL",
      "tracking_number": "SPXID02742637123B"
    }
  ]
})
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":"",
    "response":{
        "result_list":[
            {
                "order_sn":"22112899JG5XGU"
            }
        ]
    },
    "warning":null,
    "request_id":"80e9644be9c077bec9f89a762e2ea120"
}

Error example

JSON

{
    "error":"common.batch_api_all_failed",
    "message":"Failed, please check result_list for more details.",
    "response":{
        "result_list":[
            {
                "order_sn":"2211289U7C0PUK",
                "fail_error":"logistics.package_can_not_print",
                "fail_message":"The package can not print now."
            }
        ]
    },
    "request_id":"3c8a0a3bcd9d767e929aca2fafe2a620"
}

Errors

Common errors

Update log