GET Get Package Shipping Document
Get Package Shipping Document Shop Required scope: seller.fulfillment.basic For orders shipped by TikTok Shop, this API retrieves the URL of shipping documents (shipping label and packing slip) for a package specified by the package ID. This API is only applicable to "TikTok Shipping" orders. To obtain the shipping documents URL via this API, first call "Ship Package" to ship the corresponding package. Version 202309
GET/fulfillment/202309/packages/{package_id}/shipping_documents
Request
Path
| Properties | Type | Description |
|---|---|---|
| package_id Required | string | TikTok Shop package ID. |
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| document_type Required | string | Available document types: - SHIPPING_LABEL: Returns the shipping label in PDF format by default.- PACKING_SLIP: Returns the packing slip in PDF format by default.- SHIPPING_LABEL_AND_PACKING_SLIP: Returns both the shipping label and the packing slip for the package, both in PDF format by default. - SHIPPING_LABEL_PICTURE: Returns the shipping label in PNG format. - HAZMAT_LABEL: Returns the hazmat label in PDF format by default. You must only use this value when there are hazmat items in the package. When you use the value, document_size is fixed to A4, and you don't need to specify document_size.- INVOICE_LABEL: For Brazil market only, document_size is fixed to A6, and you don't need to specify document_size. Returns the invoice label in PDF format by default |
| document_size | string | Use this field to specify the size of the document to obtain. This parameter is only applicable to shipping labels, picking slips, and packing slips that are in the PDF format. It is not applicable for hazmat labels as these are fixed to A4. If you specify SHIPPING_LABEL_PICTURE for the document_type, any value specified in the document_size will be ignored. Possible values: - A6 (Default)- A5 |
| document_format | string | The format of the shipping document.Possible values: - PDF (Default)- ZPL (Only for BR and MX market)Note: Not applicable for SHIPPING_LABEL_PICTURE document type. |
| shipping_period | string | Obtain shipping labels from designated last-mile delivery providers for cross-border scenarios.Possible values: - DEFAULT (Default)- LAST_MILE (Only cross-border services under the 4PL model with the business solution of 3PL for main transport & customs clearance + 4PL for last-mile delivery will return the last-mile shipping label; calls from all other scenarios will be invalid.) |
| shop_cipher Required | string | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | 11006010 | Internal package status error, please try again later. | | 11034002 | This API is only applicable to TikTok Shipping orders. For seller shipping, please obtain the shipping label offline and upload it to TikTok Shop via API or Seller Center. | | 11034009 | Warehouse does not exist. | | 11034023 | Shipping document generation timeout error, please try again later. | | 11034025 | Internal package tag error, pleaser try again later. | | 11034037 | The shipping document is still being generated by the logistics provider, please try again later. | | 21008017 | This API is only applicable to TikTok Shipping orders. For seller shipping, please obtain the shipping label offline and upload it to TikTok Shop via API or Seller Center. | | 21008043 | This package is fulfilled by TikTok. Shipping documents cannot be printed. | | 21008109 | Unable to retrieve shipping information, please double check the order status. | | 21011001 | Package not found. If the error persists, please contact the platform for assistance. | | 21021010 | Package item has after-sale request, please process the after-sale request first. | | 21023022 | Unknown label print timeout error. If the error persists, please contact the platform for assistance. | | 21023034 | Internal package update error, please try again later. | | 21023035 | Please arrange shipment before retrieving the shipping document. | | 21023046 | Package has already been shipped. | | 21023059 | Package has already been cancelled. | | 21042102 | Documents couldn't be printed after the package has been pickup. | | 21042104 | Documents couldn't be printed before shipped.Please check shipping is arranged and try again. | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext