Skip to main content

POST Update Tracking

Update Tracking Shop Required scope: seller.fbt.info This API manages carton-level tracking information for inbound orders. It utilizes upsert logic to create new tracking records or overwrite existing entries as required. Only orders which are shipped but have not yet been marked as "Delivered" or "Received" yet can be updated, with a 5-time edit limit per carton. Version 202602

POST/fbt/202602/inbound_orders/tracking_update

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse 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

PropertiesTypeDescription
order_id RequiredstringThe 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).
parcel_tracking_info[]objectParcel tracking info.

Example

CurlGoNode.jsJavaEnable word wrap

1234567891011121314curl-X POST 'https://open-api.tiktokglobalshop.com/fbt/202602/inbound_orders/tracking_update?app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json' -d '{ "order_id": "5766071177167344427", "parcel_tracking_info": [ { "provider_name": "FEDEX", "tracking_number": "889042812410", "carton_number": "C0001" } ]}'

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

{"code":0,"data":{},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

Error Code

View common error codes

| Code | Message | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 39001002 | Request or request parameters are empty. Please recheck the input parameters. | | 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. | | 39015015 | Parcel tracking info list is empty. | | 39015016 | Tracking provider is invalid or unsupported. | | 39015017 | Carton number is invalid or missing. | | 39015018 | Failed to update tracking info for inbound order. Please check that the inbound order is in "Shipped" status and try again. If the issue persists and the cause is unknown, please contact platform support. | | 39015019 | Tracking number is invalid or missing. |

Is this content helpful?Helpful

Not Helpful

PreviousNext