v2.logistics.get_shipping_document_result

Use this api to retrieve the status of the shipping document task. Document will be available for download only after the status change to 'READY'.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
  "order_list": [
    {
      "order_sn": "210129H5A7WVSE",
      "package_number": "2537708677189632625"
    },
    {
      "order_sn": "210129H5A7WVSE",
      "package_number": "2537708677189633625"
    },
    {
      "order_sn": "210129H577K4AM",
      "package_number": "2537712267513857625"
    }
  ]
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/logistics/get_shipping_document_result?sign=sign&access_token=access_token&timestamp=timestamp&shop_id=shop_id&partner_id=partner_id")
.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://partner.shopeemobile.com/api/v2/logistics/get_shipping_document_result?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://partner.shopeemobile.com/api/v2/logistics/get_shipping_document_result?access_token=access_token&timestamp=timestamp&shop_id=shop_id&partner_id=partner_id&sign=sign' \
--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://partner.shopeemobile.com/api/v2/logistics/get_shipping_document_result?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.request("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
  "message": "",
  "warning": [
    {
      "order_sn": "210129H577K4AM",
      "package_number": "2537712267513857625"
    }
  ],
  "request_id": "2028925e9f1440a3b8f9c3f8f21dee8d",
  "response": {
    "result_list": [
      {
        "status": "READY",
        "order_sn": "210129H5A7WVSE",
        "package_number": "2537708677189632625"
      },
      {
        "status": "READY",
        "order_sn": "210129H5A7WVSE",
        "package_number": "2537708677189633625"
      },
      {
        "fail_message": "The package can not print now, please create shipping document first.Detail: order_sn",
        "order_sn": "210129H577K4AM",
        "fail_error": "logistics.shipping_document_should_print_first",
        "package_number": "2537712267513857625"
      }
    ]
  },
  "error": ""
}

Error example

JSON

{
    "error": "common.batch_api_all_failed",
    "message": "Failed, please check result_list for more details.",
    "response": {
        "result_list": [
            {
                "order_sn": "220725D58XURJS3",
                "fail_error": "logistics.order_not_exist",
                "fail_message": "The order_sn 220725D58XURJS3 is not exist."
            }
        ]
    },
    "request_id": "550d98e83b6434346337dffc11e6f4e5"
}

Errors

Common errors

Update log