v2.logistics.get_shipping_document_parameter

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

来自 Shopee 官方资料快照 · 2026-09-06 12:13:01

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / 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_parameter

Use this api to get the selectable shipping_document_type and suggested shipping_document_type.

§2 Overview

Overview

Field	Value
Module	Logistics
API type	Shop
HTTP method	POST
Path	/api/v2/logistics/get_shipping_document_parameter
Production URL	https://partner.shopeemobile.com/api/v2/logistics/get_shipping_document_parameter
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/logistics/get_shipping_document_parameter
Rate limit	[0, 0, 0]
Permission	ERP System; Seller In House System; Order Management; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
order_list	object[]	Yes		The list of orders you want to get. limit [1,50]
order_list.order_sn	string	Yes	201201E81SYYKE	Shopee's unique identifier for an order.
order_list.package_number	string	No	60489687088750	Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
request_id	string	8412939d0fbd48c9a548fba4b710a7f6	The identifier for an API request for error tracking.
error	string	error_auth	Indicate error type if hit error. Empty if no error happened.
message	string	Invalid access_token.	Indicate error details if hit error. Empty if no error happened.
warning	object[]		Indicate warning message you should take care.
warning.order_sn	string	201201V81SYYDG	Shopee's unique identifier for an order.
warning.package_number	string		Shopee's unique identifier for the package under an order.
response	object		Detail informations you are querying.
response.result_list	object[]		The list of the result data.
response.result_list.order_sn	string	201201E81SYYKE	Shopee's unique identifier for an order.
response.result_list.package_number	string	60489687088750	Shopee's unique identifier for the package under an order.
response.result_list.suggest_shipping_document_type	string	THERMAL_AIR_WAYBILL	The shipping document type Shopee suggests. If you don't select any shipping document type, Shopee will use this as default shipping document type.
response.result_list.selectable_shipping_document_type	string[]	["THERMAL_AIR_WAYBILL"]	The shipping document type you can select of this order.
response.result_list.fail_error	string	logistics.order_not_exist	Indicate error type if one element hit error.
response.result_list.fail_message	string	The order_sn 201201V81SYYDG you provided is not exist. Please check	Indicate error details if one element hit error.

§5 Common parameters

Common parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature 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_list": [
        {
            "order_sn": "201201E81SYYKE",
            "package_number": "60489687088750"
        },
        {
            "order_sn": "201201V81SYYDG"
        }
    ]
}

§8 Response sample

Response sample

§9 JSON

JSON

{
    "error": "",
    "message": "",
    "response": {
        "result_list": [
            {
                "order_sn": "201201E81SYYKE",
                "package_number": "60489687088750",
                "suggest_shipping_document_type": "THERMAL_AIR_WAYBILL",
                "selectable_shipping_document_type": [
                    "THERMAL_AIR_WAYBILL"
                ]
            },
            {
                "order_sn": "201201V81SYYDG",
                "fail_error": "logistics.order_not_exist",
                "fail_message": "The order_sn 201201V81SYYDG you provided is not exist. Please check"
            }
        ]
    },
    "warning": [
        {
            "order_sn": "201201V81SYYDG"
        }
    ],
    "request_id": "8412939d0fbd48c9a548fba4b710a7f6"
}

§10 Error example

Error example

§11 JSON

JSON

{
    "error": "error_param",
    "message": "Wrong parameters, detail: order_list is a required field.",
    "request_id": "f91490e1cdbd59f3db580a3c3dfd8adb"
}

§12 Errors

Errors

Error	Description	Solution
logistics.error_param	The order is being allocated, please wait until the allocate is completed.
common.batch_api_all_failed	Failed, please check result_list for more details.
error_not_found	Wrong parameters, detail: {msg}.
error_param	Wrong parameters, detail: {msg}.
error_permission	Sorry you don't have the permission, detail: {msg}.
error_server	System error. Please try again later.
logistics.package_number_not_found	The package_number {package_number} is not exist.
logistics.invalid_address_version	Some addresses are no longer supported per new regulation, please update to avoid wrong fulfilment
logistics.can_not_print_jit_order	This shipping channel only supports document printing in Shopee seller center
error_network	Inner http call failed
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_shop	shopid is invalid
error_param	request not from gateway

§13 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App 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_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The 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_suspended	The API is offline. Please call v2 API instead.
error_limit	The 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_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your 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_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_auth	Invalid partner_id or shopid.
shop_no_linked	Partner and shop has no linked.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
partner_shop_no_link	Invalid partner_id or shop_id, please have a check.
error_ashop_api_permission	The shop is Affiliate shop has no permission to call this API.
error_kyc_auth	No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_auth	System error, please try again later.
error_param	There is no shop_id in query.
error_param	shop_id is invalid, should be an integer between 0 and 4294967295.

这条内容对你有帮助吗？