快工助手跨境电商知识与商机助手
快工云仓服务介绍

v2.logistics.get_shipping_document_data_info

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存，可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.logistics.get_shipping_document_data_info

Use this api to fetch the logistics information of an order, these info can be used for self-design AWB printing. Besides, this api supports returning personal info as images.

#

§2 Overview

Overview

FieldValue
ModuleLogistics
API typeShop
HTTP methodPOST
Path/api/v2/logistics/get_shipping_document_data_info
Production URLhttps://partner.shopeemobile.com/api/v2/logistics/get_shipping_document_data_info
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/logistics/get_shipping_document_data_info
PermissionERP System; Seller In House System; Order Management; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
order_snstringYes201224EM1FMFG1Shopee's unique identifier for an order.
package_numberstringNo9087129345Shopee's unique identifier for the package under an order. You shouldn't fill the field with empty string when there isn't a package number.
recipient_address_infoobject[]Norecipient address to query as image
recipient_address_info.keystringYesnamefields to query in the recipient address, should be name, phone, full_address, town, district, city, state, region, zipcode.
recipient_address_info.styleobjectNoimage style
recipient_address_info.style.text_stylestring[]No["bold", "italic"]supports bold and italic
recipient_address_info.style.font_sizeint32No12supports 1 - 108
recipient_address_info.style.text_colorstringNo#39c5bbcolor string like "#AbCd12"
recipient_address_info.style.image_widthfloatNo3.0supports 0.1-30, in centimeters
recipient_address_info.style.h_alignstringNocentertext horizontal align, supports left, center and right.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
request_idstring862fc4d77de74edf9bf045c7650f1988The identifier for an API request for error tracking.
errorstringerror_authIndicate error type if hit error. Empty if no error happened.
messagestringInvalid access_token.Indicate error details if hit error. Empty if no error happened.
responseobjectDetail informations you are querying.; Note: For parcels that support pre-shipment printing, calling this API before shipment will only return the following fields: response; recipient_address_info; key; image; shipping_document_info; cod; cod_amount; order_weight; logistics_channel_id; shipping_carrier; pickup_code
response.recipient_address_infoobject
response.recipient_address_info.keystringnamequeried field in recipient address
response.recipient_address_info.imagestringdata:image/png;base64,/9j/4AAQSkZJRgABAgEASABIAAD/……base64 encoded png data string
response.shipping_document_infoobject
response.shipping_document_info.codbooleantrueThis value indicates whether the order was a COD (cash on delivery) order.
response.shipping_document_info.cod_amountstring185Use this field to indicate cod amount.
response.shipping_document_info.order_weightint32500Use this field to indicate order weight when calculate the shipping fee. The unit of weigh is gram.
response.shipping_document_info.logistics_channel_idint3228016The identity of logistic channel.
response.shipping_document_info.shipping_carrierstringStandard DeliveryThe logistics service provider that the buyer selected for the order to deliver items.
response.shipping_document_info.service_codestringSHPOnly work for cross-border order. This code is required at some sorting hub. Please ensure the service_code is INCLUDED on your shipping label, otherwise the parcel cannot be processed by the warehouse. If you didn't retrieve service_code after you first called this API, please try few more times within 30 minutes.
response.shipping_document_info.first_mile_namestringMYF3Only work for cross-border order.The name of the carrier ships cross country or region.
response.shipping_document_info.last_mile_namestringMYL1Only work for cross-border order.The name of the carrier delivers the parcels in local country or region.
response.shipping_document_info.goods_to_declarebooleantrueOnly work for cross-border order.This value indicates whether the order contains goods that are required to declare at customs. "T" means true and it will mark as "T" on the shipping label; "F" means false and it will mark as "P" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo.
response.shipping_document_info.lane_codestringS-MY03Only work for cross-border order. The string use for waybill printing. The format is "S - region_code and lane_number". For example, S-TH01, S-TH02
response.shipping_document_info.warehouse_addressstringChina Guangdong Shenzhen 1/F, Building 8,Tangtou industrial District ,Shiyan street ,baoan districtOnly work for cross-border order in some special shop. The address info of the warehouse.
response.shipping_document_info.warehouse_idstringTWS01Only work for cross-border order in some special shop. The ID of the warehouse.
response.shipping_document_info.recipient_sort_codeobjectThe sort_code of recipient.
response.shipping_document_info.recipient_sort_code.first_recipient_sort_codestringB-151-ATP-ATP-010The first-level sort_code of recipient.
response.shipping_document_info.recipient_sort_code.second_recipient_sort_codestringThe second-level sort_code of recipient.
response.shipping_document_info.recipient_sort_code.third_recipient_sort_codestringSAN ROQUE 009The third-level sort_code of recipient.
response.shipping_document_info.sender_sort_codeobjectThe sort_code of sender.
response.shipping_document_info.sender_sort_code.first_sender_sort_codestringThe first-level sort_code of sender.
response.shipping_document_info.sender_sort_code.second_sender_sort_codestringThe second-level sort_code of sender.
response.shipping_document_info.sender_sort_code.third_sender_sort_codestringThe third-level sort_code of sender.
response.shipping_document_info.return_sort_codeobjectThe sort code for 3PL doing RTS.
response.shipping_document_info.return_sort_code.return_first_sort_codestringRTS-FM-MANThe first-level sort code for 3PL doing RTS.
response.shipping_document_info.third_party_logistic_infoobjectOnly used for TW sellers.
response.shipping_document_info.third_party_logistic_info.service_descriptionstringUse this field to indicate the order category.
response.shipping_document_info.third_party_logistic_info.barcodestringThe manufacturer barcode.
response.shipping_document_info.third_party_logistic_info.purchase_timestringThe purchase_time of the store.
response.shipping_document_info.third_party_logistic_info.return_timestringThe return_time of the store.
response.shipping_document_info.third_party_logistic_info.manufacturers_namestringThe name of manufacturers.
response.shipping_document_info.third_party_logistic_info.manufacturers_websitestringThe website of manufacturers.
response.shipping_document_info.third_party_logistic_info.recipient_areastringThe identification of recipient area.
response.shipping_document_info.third_party_logistic_info.route_stepstringThe route code of the waybill.
response.shipping_document_info.third_party_logistic_info.suda5_codestringThe tally code of the waybill.
response.shipping_document_info.third_party_logistic_info.large_logistics_idstringThe code of large logistics.
response.shipping_document_info.third_party_logistic_info.parent_idstringThe parent code of the waybill.
response.shipping_document_info.third_party_logistic_info.return_cyclestringUse this field to indicate the return cycle.
response.shipping_document_info.third_party_logistic_info.return_modestringUse this field to indicate the return mode.
response.shipping_document_info.third_party_logistic_info.promptstringThe reminder of stork work.
response.shipping_document_info.third_party_logistic_info.order_snstringShopee's unique identifier for an order.
response.shipping_document_info.third_party_logistic_info.qrcodestringThe QR code of the waybill.
response.shipping_document_info.third_party_logistic_info.ec_supplier_namestringThe supplier name of channel.
response.shipping_document_info.third_party_logistic_info.ec_bar_code16stringUse this field to indicate the first barcode.
response.shipping_document_info.third_party_logistic_info.equipment_idstringThe device code.
response.shipping_document_info.third_party_logistic_info.eshop_idstringThe child code for B2C Family-mart.
response.shipping_document_info.third_party_logistic_info.ec_bar_code9stringUse this field to indicate the pick barcode.
response.shipping_document_info.third_party_logistic_info.pelican_tracking_nostringThe tracking number of Shopee Delivery.
response.shipping_document_info.third_party_logistic_info.print_datestringThe date of printing the wayBill.
response.shipping_document_info.third_party_logistic_info.pzipstringThe sort code of the order.
response.shipping_document_info.third_party_logistic_info.pzip_cstringThe barcode of the sort code.
response.shipping_document_info.third_party_logistic_info.deliver_area_txtstringThe code of the delivery area.
response.shipping_document_info.third_party_logistic_info.deliver_date_ymdstringExpected delivery date of the order.
response.shipping_document_info.third_party_logistic_info.sd_driver_codestringLorry driver code of the order.
response.shipping_document_info.third_party_logistic_info.md_driver_codestringMotorcycle driver code of the order.
response.shipping_document_info.third_party_logistic_info.putorder_stackzone_codestringStacking area of the order.
response.shipping_document_info.third_party_logistic_info.customer_codestringThe customer code of Shopee.
response.shipping_document_info.third_party_logistic_info.deliver_routerstringUse this field to indicate the delivery router.
response.shipping_document_info.third_party_logistic_info.store_typestringUse this field to indicate the store type.
response.shipping_document_info.third_party_logistic_info.pick_routerstringUse this field to indicate the pick router.
response.shipping_document_info.third_party_logistic_info.barcode_dcstringThe main logistic barcode of the waybill.
response.shipping_document_info.third_party_logistic_info.ec_order_numberstringUse this field to indicate the logistics order number.
response.shipping_document_info.third_party_logistic_info.barcode_prstringThe sorting barcode of the waybill.
response.shipping_document_info.third_party_logistic_info.first_pick_barcodestringThe first pick barcode of the waybill.
response.shipping_document_info.third_party_logistic_info.second_pick_barcodestringThe second pick barcode of the waybill.
response.shipping_document_info.third_party_logistic_info.is_cod_boolstringUse this field to indicate the service type.
response.shipping_document_info.third_party_logistic_info.receiver_namestringUse this field to indicate the receiver name.
response.shipping_document_info.third_party_logistic_info.rcv_store_namestringUse this field to indicate the receiver store name.
response.shipping_document_info.third_party_logistic_info.branch_codestringUse this field indicates destination service point code.
response.shipping_document_info.third_party_logistic_info.branch_namestringUse this field indicates destination service point name.
response.shipping_document_info.third_party_logistic_info.last_third_digits_recipient_phonestringUse this field indicates buyer phone number (last 3 digits).
response.shipping_document_info.third_party_logistic_info.last_third_digits_sender_phonestringUse this field indicates seller phone number (last 3 digits).
response.shipping_document_info.third_party_logistic_info.barcode_no1stringFirst barcode no. sacnned when seller drop off
response.shipping_document_info.third_party_logistic_info.barcode_no2stringSecond barcode no. sacnned when seller drop off
response.shipping_document_info.third_party_logistic_info.print_datetimestringAWB Print date and time
response.shipping_document_info.third_party_logistic_info.ok_mid_typestringMiddle type used in OK Mart SOC
response.shipping_document_info.third_party_logistic_info.ok_aisle_nostringAisle no. used in OK Mart SOC
response.shipping_document_info.third_party_logistic_info.ok_grid_nostringGrid no used in OK Mart SOC
response.shipping_document_info.third_party_logistic_info.ok_tracking_numberstringThe tracking number of OK Mart.
response.shipping_document_info.third_party_logistic_info.barcode_no3stringOK SOC received no.
response.shipping_document_info.third_party_logistic_info.ship_typestringShip type used by OK Mart
response.shipping_document_info.third_party_logistic_info.areastringThe area of the collect OK branch used for OK sorting
response.shipping_document_info.third_party_logistic_info.barcode_no4stringFirst barcode no. sacnned when buyer collect
response.shipping_document_info.third_party_logistic_info.barcode_no5stringSecond barcode no. sacnned when buyer collect
response.shipping_document_info.third_party_logistic_info.tw_last_three_digits_buyer_phonestring678[Only for local TW orders] Last 3 digits of buyer's phone number, apply for channel_id: 30005, 30006, 30007,30014,30015
response.shipping_document_info.third_party_logistic_info.tw_store_namestring聯合門市[Only for TW channel_id:30005 ] Store name for 7-ELEVEN orders.
response.shipping_document_info.third_party_logistic_info.tw_store_numberstring214559[Only for TW channel_id:30005 ]Store number for 7-ELEVEN orders.
response.shipping_document_info.third_party_logistic_info.buyer_prefer_delivery_timeobject[Only for TW channel:30017] The time buyer prefers to receive the packages.
response.shipping_document_info.third_party_logistic_info.buyer_prefer_delivery_time.slot_idstring4The slot which buyer choose
response.shipping_document_info.third_party_logistic_info.buyer_prefer_delivery_time.start_timestring10:00The start time of a day buyer prefer to receive the packages
response.shipping_document_info.third_party_logistic_info.buyer_prefer_delivery_time.end_timestring17:00The end time of a day buyer prefer to receive the packages.
response.shipping_document_info.third_party_logistic_info.buyer_prefer_delivery_time.descriptionstring住家：本人收货The detailed instructions of the package delivering.
response.shipping_document_info.tracking_numberstringMY200448706479ITThe tracking number assigned by the shipping carrier for item shipment.
response.shipping_document_info.shopee_tracking_numberstringMY200448706479ITFirst mile tracking NO. for CrossBoard BR seller can be used to self-design CB Brazil AWB.
response.shipping_document_info.last_mile_tracking_numberstringThe last-mile tracking number. Only for Cross Board BR seller.
response.shipping_document_info.pickup_hubstringThe name of pickup hub.
response.shipping_document_info.delivery_hubstringThe name of delivery hub.
response.shipping_document_info.deliver_areastringSAN ROQUE 009Zone name.
response.shipping_document_info.ec_order_nostringThe name of ec order.
response.shipping_document_info.create_date_ymd_slstring2022/12/05The date of create shipment order.
response.shipping_document_info.manufacturers_namestringThe name of manufacturer.
response.shipping_document_info.manufacturers_websitestringThe website of manufacturer.
response.shipping_document_info.is_lm_dg_boolint320Use this field to indicate order contains dangerous goods or not.; 0: Non-dangerous good; 1: Dangerous good; 2: Prohibited
response.shipping_document_info.preferred_delivery_optionint321Use this field to indicate delivery address is residential or office address.; 0: not configured; 1: office address; 2: residential address
response.shipping_document_info.spx_sub_districtstringThe sub-district of recipient's address.
response.shipping_document_info.spx_receive_stationobjectThe spx receive station.
response.shipping_document_info.spx_receive_station.spx_first_receive_stationstringThe first pickup station.
response.shipping_document_info.zonestringThe zone of this order.
response.shipping_document_info.zone_codestringDelivery Sub Zone.
response.shipping_document_info.destination_base_codestringDistribution Center Code.
response.shipping_document_info.last_third_digits_buyer_phonestringUse this field indicates buyer phone number (last 3 digits). For non-TW local sellers
response.shipping_document_info.parcel_sizestringcorresponding locker sizing for self-collection locker channels [only available for specific logistic channels: 148003 and 140006]
response.shipping_document_info.sodbooleanfalsethis value indicates whether the buyer select "scan on delivery" payment channel at checkout.
response.shipping_document_info.buyer_cpf_idstringBuyer's CPF number for taxation and invoice purposes. Only for Brazil order.
response.shipping_document_info.mutual_checkint321only apply for ID/VN shops.; mutual_check indicates whether the parcel is eligible for Return-on-the-Spot (RoS) co-check.; If mutual_check=1, then the parcel is RoS eligible, where drivers and buyers can co-check the parcel. Buyer can then choose to accept or reject the parcel on the spot.; If mutual_check=0, then the parcel is ineligible for RoS.
response.shipping_document_info.dely_fri_labelstringLProbability of Successful Friday Delivery.; The value of L(low), M(medium), H(high) represent the chances of successful delivery attempts on Friday.
response.shipping_document_info.dely_sat_labelstringMProbability of Successful Saturday Delivery; The value of L(low), M(medium), H(high) represent the chances of successful delivery attempts on Saturday.
response.shipping_document_info.dely_sun_labelstringHProbability of Successful Sunday Delivery.; The value of L(low), M(medium), H(high) represent the chances of successful delivery attempts on Sunday.
response.shipping_document_info.pickup_codestringFor drivers to quickly identify parcel to be picked up. Only returned for ID and TH local orders which use instant+sameday for delivery.
response.shipping_document_info.sorting_groupstring[Only for TW 30029 channel] This field indicate the sorting group value of the package. Available values: - North - South
response.shipping_document_info.unpackaged_sku_idstring[Only for TW 30029 channel] Please refer to this number instead of tracking number for this this channel. This field will be empty for other channels.
response.shipping_document_info.unpackaged_sku_id_qrcodestring[Only for TW 30029 channel] Please refer to this field to generate the QR code for the shipping document for this channel. This field will be empty for other channels.
response.shipping_document_info.high_valuebooleantrueThis value indicates whether the order is considered a “high value” item and requires special handling by the logistics provider. The threshold to be considered "high value" item differs by region, and is only applicable to SPX channels. For regions other than Malaysia and Thailand, this field will always return empty.
response.shipping_document_info.dg_specific_typeint321Currently only applicable for Brazil, Indonesia, Vietnam, Philippines.; For orders with Dangerous Goods, this value indicates the severity of the danger and requires special handling by the logistics provider.; 0 = Not classified / no DG sub-type; 1 = DG_A; 2 = DG_B; 3 = DG_C; 4 = DG_D
response.shipping_document_info.hotspot_idstringHS-BSC-01This ID is used by 3PL to determine parcel routing. For regions other than Malaysia and Thailand, this field will always return empty.
response.shipping_document_info.weekend1_delivery_success_labelstringHThis value indicates whether an order has a high / medium / low delivery success rate on each weekend (e.g. sat and sun respectively). For regions other than Malaysia, this field will always return empty.; High = H; Medium = M; Low = L
response.shipping_document_info.weekend2_delivery_success_labelstringMThis value indicates whether an order has a high / medium / low delivery success rate on each weekend (e.g. sat and sun respectively). For regions other than Malaysia, this field will always return empty.; High = H; Medium = M; Low = L
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2
#

§6 Request samples

Request samples

#

§7 Payload

Payload

{
    "order_sn":"231112E8YGWPXJ",
    "package_number":"OFG153490685206408",
    "recipient_address_info":[
        {
            "key":"name",
            "style":{
                "h_align":"left",
                "text_style":[
                    "bold",
                    "italic"
                ],
                "font_size":12,
                "text_color":"#000000",
                "image_width":6
            }
        },
        {
            "key":"phone",
            "style":{
                "h_align":"left",
                "text_style":[
                    "bold",
                    "italic"
                ],
                "font_size":12,
                "text_color":"#000000",
                "image_width":6
            }
        },
        {
            "key":"full_address",
            "style":{
                "h_align":"left",
                "text_style":[
                    "bold",
                    "italic"
                ],
                "font_size":12,
                "text_color":"#000000",
                "image_width":6
            }
        },
        {
            "key":"town",
            "style":{
                "h_align":"left",
                "text_style":[
                    "bold",
                    "italic"
                ],
                "font_size":12,
                "text_color":"#000000",
                "image_width":6
            }
        },
        {
            "key":"district",
            "style":{
                "h_align":"left",
                "text_style":[
                    "bold",
                    "italic"
                ],
                "font_size":12,
                "text_color":"#000000",
                "image_width":6
            }
        },
        {
            "key":"city",
            "style":{
                "h_align":"left",
                "text_style":[
                    "bold",
                    "italic"
                ],
                "font_size":12,
                "text_color":"#000000",
                "image_width":6
            }
        },
        {
            "key":"state",
            "style":{
                "h_align":"left",
                "text_style":[
                    "bold",
                    "italic"
                ],
                "font_size":12,
                "text_color":"#000000",
                "image_width":6
            }
        },
        {
            "key":"region",
            "style":{
                "h_align":"left",
                "text_style":[
                    "bold",
                    "italic"
                ],
                "font_size":12,
                "text_color":"#000000",
                "image_width":6
            }
        },
        {
            "key":"zipcode",
            "style":{
                "h_align":"left",
                "text_style":[
                    "bold",
                    "italic"
                ],
                "font_size":12,
                "text_color":"#000000",
                "image_width":6
            }
        }
    ]
}
#

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/logistics/get_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("{
   \"order_sn\": \"201224EM1FMFG1\",
   \"package_number\": \"9087129345\",
   \"recipient_address_info\": [
      {
         \"key\": \"name\",
         \"style\": {
            \"font_size\": 12,
            \"h_align\": \"center\",
            \"image_width\": 3,
            \"text_color\": \"#39c5bb\",
            \"text_style\": [
               \"bold\",
               \"italic\"
            ]
         }
      }
   ]
}")
.asString();
#

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/logistics/get_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 => '{
    "order_sn": "201224EM1FMFG1",
    "package_number": "9087129345",
    "recipient_address_info": [
        {
            "key": "name",
            "style": {
                "font_size": 12,
                "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;
#

§10 cURL

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/logistics/get_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 '{
   "order_sn": "201224EM1FMFG1",
   "package_number": "9087129345",
   "recipient_address_info": [
      {
         "key": "name",
         "style": {
            "font_size": 12,
            "h_align": "center",
            "image_width": 3,
            "text_color": "#39c5bb",
            "text_style": [
               "bold",
               "italic"
            ]
         }
      }
   ]
}'
#

§11 Python

Python

import requests
import json

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

payload=json.dumps({
  "order_sn": "201224EM1FMFG1",
  "package_number": "9087129345",
  "recipient_address_info": [
    {
      "key": "name",
      "style": {
        "font_size": 12,
        "h_align": "center",
        "image_width": 3,
        "text_color": "#39c5bb",
        "text_style": [
          "bold",
          "italic"
        ]
      }
    }
  ]
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.request("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§12 Response sample

Response sample

#

§13 JSON

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": {
			"cod": true,
			"cod_amount": "185",
			"order_weight": 500,
			"logistics_channel_id": 28016,
			"shipping_carrier": "Standard Delivery",
			"service_code": "SHP",
			"first_mile_name": "MYF3",
			"last_mile_name": "MYL1",
			"goods_to_declare": true,
			"lane_code": "S-MY03",
			"warehouse_address": "China Guangdong Shenzhen 1/F, Building 8,Tangtou industrial District ,Shiyan street ,baoan district",
			"warehouse_id": "TWS01",
			"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"
			},
			"third_party_logistic_info": {
				"service_description": "-",
				"barcode": "-",
				"purchase_time": "-",
				"return_time": "-",
				"manufacturers_name": "-",
				"manufacturers_website": "-",
				"recipient_area": "-",
				"route_step": "-",
				"suda5_code": "-",
				"large_logistics_id": "-",
				"parent_id": "-",
				"return_cycle": "-",
				"return_mode": "-",
				"prompt": "-",
				"order_sn": "-",
				"qrcode": "-",
				"ec_supplier_name": "-",
				"ec_bar_code16": "-",
				"equipment_id": "-",
				"eshop_id": "-",
				"ec_bar_code9": "-",
				"pelican_tracking_no": "-",
				"print_date": "-",
				"pzip": "-",
				"pzip_c": "-",
				"deliver_area_txt": "-",
				"deliver_date_ymd": "-",
				"sd_driver_code": "-",
				"md_driver_code": "-",
				"putorder_stackzone_code": "-",
				"customer_code": "-",
				"deliver_router": "-",
				"store_type": "-",
				"pick_router": "-",
				"barcode_dc": "-",
				"ec_order_number": "-",
				"barcode_pr": "-",
				"first_pick_barcode": "-",
				"second_pick_barcode": "-",
				"is_cod_bool": "-",
				"receiver_name": "-",
				"rcv_store_name": "-",
				"branch_code": "-",
				"branch_name": "-",
				"last_third_digits_recipient_phone": "-",
				"last_third_digits_sender_phone": "-",
				"barcode_no1": "-",
				"barcode_no2": "-",
				"print_datetime": "-",
				"ok_mid_type": "-",
				"ok_aisle_no": "-",
				"ok_grid_no": "-",
				"ok_tracking_number": "-",
				"barcode_no3": "-",
				"ship_type": "-",
				"area": "-",
				"barcode_no4": "-",
				"barcode_no5": "-",
				"tw_last_three_digits_buyer_phone": "678",
				"tw_store_name": "聯合門市",
				"tw_store_number": "214559",
				"buyer_prefer_delivery_time": {
					"slot_id": "4",
					"start_time": "10:00",
					"end_time": "17:00",
					"description": "住家：本人收货"
				}
			},
			"tracking_number": "MY200448706479IT",
			"shopee_tracking_number": "MY200448706479IT",
			"last_mile_tracking_number": "-",
			"pickup_hub": "-",
			"delivery_hub": "-",
			"deliver_area": "SAN ROQUE 009",
			"ec_order_no": "-",
			"create_date_ymd_sl": "2022/12/05",
			"manufacturers_name": "-",
			"manufacturers_website": "-",
			"is_lm_dg_bool": 0,
			"preferred_delivery_option": 1,
			"spx_sub_district": "-",
			"spx_receive_station": {
				"spx_first_receive_station": "-"
			},
			"zone": "-",
			"zone_code": "-",
			"destination_base_code": "-",
			"last_third_digits_buyer_phone": "-",
			"parcel_size": "-",
			"sod": false,
			"buyer_cpf_id": "-",
			"mutual_check": 1,
			"dely_fri_label": "L",
			"dely_sat_label": "M",
			"dely_sun_label": "H",
			"pickup_code": "-",
			"sorting_group": "-",
			"unpackaged_sku_id": "-",
			"unpackaged_sku_id_qrcode": "-",
			"high_value": true,
			"dg_specific_type": 1,
			"hotspot_id": "HS-BSC-01",
			"weekend1_delivery_success_label": "H",
			"weekend2_delivery_success_label": "M"
		}
	}
}
#

§14 Error example

Error example

#

§15 JSON

JSON

{
    "error": "error_not_found",
    "message": "Wrong parameters, detail: the order is not found.",
    "request_id": "f93c90c2b6945787e974dc091a2c78c4"
}
#

§16 Errors

Errors

ErrorDescriptionSolution
error_statusStatus verification failed, shipping documents of this package cannot be printed now.
logistics.error_paramThe order is being allocated, please wait until the allocate is completed.
error_not_foundWrong parameters, detail: {msg}.
error_paramWrong parameters, detail: {msg}.
error_permissionSorry you don't have the permission, detail: {msg}.
error_serverGot an error when trying to generate image, please try again
logistics.error_limitYou don’t ship order yet.
logistics.error_booking_orderThis order is matched order with booking, don't need arrange shipment through seller side.
logistics.error_paramYou can not get order logistics of warehouse order.
logistics.error_status_limitThe order status is invalid. Please check the order status.
logistics.package_not_existThe package is not exist.
error_channel_unsupportThis logistic channel/logistic type doesn’t support retrieving info from Open API. Please use v2.logistics.download_shipping_document API instead.
error_paramNot allowed to self design AWB
logistics.package_number_not_existPlease request with package_number for this split order.
logistics.invalid_address_versionSome addresses are no longer supported per new regulation, please update to avoid wrong fulfilment
logistics.can_not_print_combine_orderThis order is part of a combined parcel, please use Seller Center instead.
logistics.can_not_print_jit_orderThis shipping channel only supports document printing in Shopee seller center
error_networkInner http call failed
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_shopshopid is invalid
error_paramrequest not from gateway
error_paramThis order logistics is not allowed to get.
#

§17 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspendedThe API is offline. Please call v2 API instead.
error_limitThe total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§18 Update log

Update log

DateChange
2026-07-15Add response fields " high_value", "dg_specific_type", "hotspot_id", "weekend1_delivery_success_label", "weekend2_delivery_success_label"
2025-08-14Support for pre-shipment printing of self-designed AWBs for certain logistics channels
2025-07-07Add new response fields "sorting_group", "unpackaged_sku_id", "unpackaged_sku_id_qrcode"
2024-04-15add new response fields "dely_fri_label", "dely_sat_label", "dely_sun_label"
2023-05-12add is_mutual_check field for VN/ID shops
#