POST Print Label
Print Label Shop Required scope: seller.fbt.info This API uses an asynchronous Long-Running Operation (LRO) pattern to generate label files. This pattern allows you to trigger a generation task and track its progress until completion. ** Workflow Steps **
- Initiate Send a request with order_id and the desired print_items.
- Response: The API begins the print task and returns a task_status of PROCESSING.
- Poll Send subsequent requests using the same fields from Step 1. If the print task is still processing, the API will continue to return PROCESSING.
- Frequency: We recommend polling every 3–5 seconds.
- Complete When the status returns SUCCESS, the response body will include a download_url for your generated ZIP file. Version 202602
POST/fbt/202602/inbound_orders/label_print
Request
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. |
| 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 |
Body
| Properties | Type | Description |
|---|---|---|
| order_id Required | string | The numeric identifier of the inbound order to update tracking information for. Note: Provide the numeric sequence only; do not include the "IBR" prefix (e.g., use 123456 instead of IBR123456). |
| print_items | []string | Specifies the types of documents to be generated in this request. Multiple values can be included to receive a combined output.Allowed Values:* CARTON_PALLET_LABEL: Identification labels to be stuck on at least two adjacent sides of each carton.* PACKING_PICKING_LIST: Warehouse document for identifying and packing items.* FBT_BARCODE: Fulfilled by TikTok barcodes.Note: If this list is empty or omitted, CARTON_LABEL will be generated by default. |
| carton_label_format | string | Specifies the layout and dimensions for the carton labels. If this parameter is omitted or an invalid value is provided, the system will use the default single-label format.Allowed Values:* DEFAULT_1UP: Standard format (1 label per page).* A4_4UP: A4 paper format (4 labels per page).Note: If no value is provided, DEFAULT_1UP will be used as the default format. |
| barcode_format | string | Specifies the layout and dimensions for the generated label PDF. If this parameter is omitted or an invalid value is provided, the system will use the default thermal label format.Allowed Values:Standard / Default* DEFAULT_40MM_60MM: Standard 40mm x 60mm thermal label formatA4 Paper Layouts* A4_21UP_60_0MM_40_0MM: 21-up labels (60.0mm x 40.0mm) on A4* A4_21UP_63_5MM_38_1MM: 21-up labels (63.5mm x 38.1mm) on A4* A4_24UP_63_5MM_33_9MM: 24-up labels (63.5mm x 33.9mm) on A4* A4_24UP_64_6MM_33_8MM: 24-up labels (64.6mm x 33.8mm) on A4* A4_24UP_66_0MM_33_9MM: 24-up labels (66.0mm x 33.9mm) on A4* A4_24UP_66_0MM_35_0MM: 24-up labels (66.0mm x 35.0mm) on A4* A4_24UP_70_0MM_36_0MM: 24-up labels (70.0mm x 36.0mm) on A4* A4_24UP_70_0MM_37_0MM: 24-up labels (70.0mm x 37.0mm) on A4* A4_27UP_63_5MM_29_6MM: 27-up labels (63.5mm x 29.6mm) on A4* A4_40UP_52_5MM_29_7MM: 40-up labels (52.5mm x 29.7mm) on A4* A4_44UP_48_5MM_25_4MM: 44-up labels (48.5mm x 25.4mm) on A4US Letter Layouts* US_LETTER_30UP_1IN_2_625IN: 30-up labels (1" x 2-5/8") on US LetterNote: If no value is provided, DEFAULT_40MM_60MM will be used as the default format. |
Example
CurlGoNode.jsJavaEnable word wrap
1234567891011121314curl-X POST 'https://open-api.tiktokglobalshop.com/fbt/202602/inbound_orders/label_print?sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&app_key=38abcd' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json' -d '{ "order_id": "5766071177167344427", "print_items": [ "CARTON_PALLET_LABEL", "FBT_BARCODE", "PACKING_PICKING_LIST" ], "carton_label_format": "DEFAULT_1UP", "barcode_format": "DEFAULT_40MM_60MM"}'
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
{"code":0,"data":{"download_url":"https://lf16-oec-sc-sign.tiktokcdn-us.com/obj/tos-useast5-v-6091-tx/bff/upload/c656f0bf-d21c-485a-a130-e2cc4a531aec/inbound_files.zip?lk3s=5375a957&x-expires=1772107010&x-signature=7SD9BUI9UAVZ%2FUFJjddPxi8z4D4%3D","task_status":"PROCESSING"},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
Error Code
View common error codes
| Code | Message | | --- | --- | | 39001002 | Request or request parameters are empty. Please recheck the input parameters. | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 39015007 | Access denied. The API requires the seller to be bound to exactly one merchant. | | 39015009 | SellerId input is invalid | | 39015010 | No inbound orders found for the merchant. |
Is this content helpful?Helpful
Not Helpful
PreviousNext