v2.logistics.create_shipping_document_job

POST /api/v2/logistics/create_shipping_document_job

This API creates a shipping document job for selected documents. The system receives requests and returns a job ID along with success and failure details.

Endpoint URL

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

Common Request 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

Request Parameters

Name	Type	Required	Sample	Description
shipping_document_type	string	True	THERMAL_UNPACKAGED_LABEL	The type of shipping document. Available values: THERMAL_UNPACKAGED_LABEL
unpackaged_sku_requests	object[]	False		List of Unpackaged SKUs to generate labels for. Note: The unpackaged_sku_requests and package_list cannot be populated at the same time, please select one.
unpackaged_sku_id	string	False	844091087_11192347	Unpackaged SKU ID of the model.
quantity	int64	False	10	Number of copies for the generated labels (maximum 600 total across all requested SKUs).
package_list	string[]	False		List of Package Numbers to generate labels for. (maximum 600 total) Note: The unpackaged_sku_requests and package_list cannot be populated at the same time, please select one.

Response Parameters

Name	Type	Sample	Description
request_id	string	5551ce8db5314c70a362dfe33544f074	The identifier of the 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.
response	object		Detail informations you are querying.
job_id	string	SDK0001_a86148a97a6e04ce2ed468968de344b7	Generated Job ID which will be used for status tracking and download the Shipping Document
success_id_list	string[]	["844091087_11192347"]	List of Package Number or Unpackaged SKU ID that succeeds in generating Shipping Document
fail_list	object[]		List of Package Numbers or Unpackaged SKUs that failed in generating Shipping Document
id	string	844091087_11192342	Package Number or Unpackaged SKU ID that failed in generating Shipping Document
fail_error	string	error_param	Indicate error type if one element hit error.
fail_message	string	Wrong parameters, detail: This Unpackaged SKU ID is not eligible for printing. Reason: Invalid SKU ID.	Indicate error details if one element hit error.