v2.logistics.get_booking_shipping_document_data_info

Use this api to fetch the logistics information of a booking these info can be used for airwaybill printing. Dedicated for crossborder SLS order airwaybill. May not be applicable for local channel airwaybill. Besides, this api supports returning personal info as images.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"booking_sn": "201201E81SYYKE",
	"recipient_address_info": [
		{
			"key": "name",
			"style": {
				"text_style": [
					"bold",
					"italic"
				],
				"text_color": "#39c5bb",
				"image_width": 3,
				"h_align": "center"
			}
		}
	]
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://open.admin.uat.shopee.io/api/v2/logistics/get_booking_shipping_document_data_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"booking_sn\": \"201201E81SYYKE\",
   \"recipient_address_info\": [
      {
         \"key\": \"name\",
         \"style\": {
            \"h_align\": \"center\",
            \"image_width\": 3,
            \"text_color\": \"#39c5bb\",
            \"text_style\": [
               \"bold\",
               \"italic\"
            ]
         }
      }
   ]
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://open.admin.uat.shopee.io/api/v2/logistics/get_booking_shipping_document_data_info?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 => '{
    "booking_sn": "201201E81SYYKE",
    "recipient_address_info": [
        {
            "key": "name",
            "style": {
                "h_align": "center",
                "image_width": 3,
                "text_color": "#39c5bb",
                "text_style": [
                    "bold",
                    "italic"
                ]
            }
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request POST 'https://open.admin.uat.shopee.io/api/v2/logistics/get_booking_shipping_document_data_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "booking_sn": "201201E81SYYKE",
   "recipient_address_info": [
      {
         "key": "name",
         "style": {
            "h_align": "center",
            "image_width": 3,
            "text_color": "#39c5bb",
            "text_style": [
               "bold",
               "italic"
            ]
         }
      }
   ]
}'

Python

import requests
import json

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

payload=json.dumps({
  "booking_sn": "201201E81SYYKE",
  "recipient_address_info": [
    {
      "key": "name",
      "style": {
        "h_align": "center",
        "image_width": 3,
        "text_color": "#39c5bb",
        "text_style": [
          "bold",
          "italic"
        ]
      }
    }
  ]
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
	"request_id": "862fc4d77de74edf9bf045c7650f1988",
	"error": "error_auth",
	"message": "Invalid access_token.",
	"response": {
		"recipient_address_info": {
			"key": "name",
			"image": "data:image/png;base64,/9j/4AAQSkZJRgABAgEASABIAAD/……"
		},
		"shipping_document_info": {
			"booking_weight": 500,
			"logistics_channel_id": 28016,
			"shipping_carrier": "Standard Delivery",
			"recipient_sort_code": {
				"first_recipient_sort_code": "B-151-ATP-ATP-010",
				"second_recipient_sort_code": "-",
				"third_recipient_sort_code": "SAN ROQUE 009"
			},
			"sender_sort_code": {
				"first_sender_sort_code": "-",
				"second_sender_sort_code": "-",
				"third_sender_sort_code": "-"
			},
			"return_sort_code": {
				"return_first_sort_code": "RTS-FM-MAN"
			},
			"tracking_number": "MY200448706479IT",
			"pickup_hub": "-",
			"delivery_hub": "-",
			"deliver_area": "SAN ROQUE 009",
			"ec_booking_no": "-",
			"create_date_ymd_sl": "2022/12/05",
			"manufacturers_name": "-",
			"manufacturers_website": "-",
			"is_lm_dg_bool": 0,
			"spx_sub_district": "-",
			"spx_receive_station": {
				"spx_first_receive_station": "-"
			},
			"zone": "-",
			"zone_code": "-",
			"destination_base_code": "-",
			"dg_specific_type": 0
		}
	}
}

Error example

JSON

{
   "error": "common.unknown_error",
   "message": "Unknown error, detail: error_key:FULFILLMENT_BOOKING_LOGISTICS_LIMIT.",
   "request_id": "a4a509e7b7434d21b8f4278794b40e19"
}

Errors

Common errors

Update log