v2.logistics.download_shipping_document

Use this api to download shipping_document. You have to call v2.logistics.create_shipping_document to create a new shipping document task first and call v2.logistics.get_shipping_document_resut to get the task status second. If the task is READY, you can download this shipping document.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

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

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://open.admin.shopee.io/api/v2/logistics/download_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\"
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://open.admin.shopee.io/api/v2/logistics/download_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"
}',
  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/download_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"
}'

Python

import requests
import json

url = "https://open.admin.shopee.io/api/v2/logistics/download_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"
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

If Success, this api will return a waybill file.
If Fail, this api will return the error message as the example below.
{
    "error":"logistics.xxxxx",
    "message":"The package can not print now, please .......",
    "request_id":"814468c0f07157681b78f6f0b58030db"
}

Error example

JSON

{
    "error": "logistics.shipping_document_should_print_first",
    "message": "The package can not print now, please create shipping document first.Detail: these orders: 220725D58XURJS should print",
    "request_id": "774ffe1565034014799a7e221246d614"
}

Errors

Common errors

Update log