Skip to main content

v2.logistics.create_shipping_document

POST /api/v2/logistics/create_shipping_document

Use this api to create shipping document task for each order or package and this API is only available after retrieving the tracking number.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/logistics/create_shipping_document

Common Request Parameters

NameTypeSampleDescription
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

Request Parameters

NameTypeRequiredSampleDescription
order_listobject[]TrueThe list of order you want to create shipping document. limit [1, 50]
order_snstringTrue201118BCKPJQQ8Shopee's unique identifier for an order.
package_numberstringFalse2485710696837122445Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is not a package number.
tracking_numberstringFalseSPXID02742637123BThe tracking number of order. Required except for the channel allow print before arrange shipment.
shipping_document_typestringFalseNORMAL_AIR_WAYBILLThe type of shipping document. Available values: NORMAL_AIR_WAYBILL, THERMAL_AIR_WAYBILL, NORMAL_JOB_AIR_WAYBILL, THERMAL_JOB_AIR_WAYBILL, THERMAL_UNPACKAGED_LABEL

Response Parameters

NameTypeSampleDescription
request_idstring5551ce8db5314c70a362dfe33544f074The identifier of the 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.
warningobject[]Indicate warning message you should take care.
order_snstring201118BCKPJKW0Shopee's unique identifier for an order.
package_numberstring12345678Shopee's unique identifier for the package under an order.
responseobjectDetail informations you are querying.
result_listobject[]The list of the result data.
order_snstring201118BCKPJQQ8Shopee's unique identifier for an order.
package_numberstring2485710696837122445Shopee's unique identifier for the package under an order.
fail_errorstringlogistics.order_not_existIndicate error type if one element hit error.
fail_messagestringThe order_sn 201118BCKPJKW0 you provided is not exist. Please checkIndicate error details if one element hit error.