Get Package Detail

Returns information about a package, including handover time slot, tracking number, and shipping provider information.

---

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Query

https://open-api.tiktokglobalshop.com/fulfillment/202309/packages/5433567853345?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY

• TO FULFILL：Waiting for the merchant or warehouse to ship the package.
• PROCESSING: Package has been arranged by seller. Waiting for carrier to collect the parcel.
• FULFILLING: Package has been collected by carrier and in transit.
• COMPLETED: Package has been delivered.
• CANCELLED: Package has been canceled. Normally, the package is canceled due to the package being lost or damaged. | ^package_sub_status |string |Created |-ISSUE：Package allocation failed, need to contact the platform. -CREATED：Package has been created -STOCKING：Platform verification completed, waiting for the merchant to ship -RTSING：Purchasing shipping label and waiting for the carrier to return results. -RTS_success：Purchasing shipping label success,seller can print label. -HBW:Only for FBT order ,has been create to the warehouse -HBWING:Only for FBT order ,creating to the warehouse -TTS：Carriers pickup the package. -Delivery：The package has been delivered to the buyer. -Ship_exception：Cannot delivered to buyer, maybe damaged or lost. | ^ship_exception_reason |string |PACKAGE_LOST |-PACKAGE_DAMAGAED -PACKAGE_LOST -RETURNED_TO_SHIPPER -PACKAGE_SCRAP | ^split_and_combine_tag |string |SPLIT |Possible values:
• DEFAULT: The package has not undergone any combine or split operation.
• COMBINE: The package has been consolidated with another order.
• SPLIT: The order has been split into multiple orders. | ^has_multi_skus |bool |true |Whether there are multiple SKU IDs in a package. | ^note_tag |string |BUYER_UNNOTED |Possible values:
• BUYER_UNNOTED: The order has not been noted by buyer.
• BUYER_NOTED: The order has been noted by buyer. | ^shipping_provider_name |string |TT Virtual express |Package shipping provider name. | ^shipping_provider_id |string |6617675021119438849 |Package shipping provider ID. | ^shipping_type |string |TIKTOK |The method of delivery. Possible values:
• TIKTOK: Shipping service provided by TikTok. The seller should obtain a shipping label from TikTok.
• SELLER: Seller provides shipping, including through 3rd party fulfillment providers on behalf of the seller. | ^delivery_option_name |string |Shipped from seller |Delivery option name. For display purposes only. | ^delivery_option_id |string |7091146663229654785 |Order delivery option ID. Delivery option ID is mapped to seller configured logistics templates ID. | ^tracking_number |string |6617675021119438849 |Package tracking number. | ^last_mile_tracking_number |string |6617675021119438849 |For cross-border order only. Cross-border order last mile tracking number. | ^pickup_slot |object | |Time slots available for pickup. | ^^start_time |int |1635338186 |Start of the time slot when a package is scheduled to be picked up by carrier. Unix timestamp. | ^^end_time |int |1635338186 |End of time slot when a package is scheduled to be picked up by carrier. Unix timestamp. | ^create_time |int |1635338186 |Package creation time. Unix timestamp. | ^handover_method |string |PICKUP |Whether the package is delivered by pick up or drop off. Possible values:
• PICKUP: A Logistics carrier will pickup the package(s) from the seller's pickup address.
• DROP_OFF: Seller will need to drop off the package(s) to a designated location. | ^order_line_item_ids |[]string |["1729382476852921560"] |The order line item ID contained in the package. | ^recipient_address |object | |Recipient address. | ^^full_address |string |1*** Coleman Ave San Jose, CA 95110 |The complete recipient addresses information. | ^^phone_number |string |(+1)213--1234 |The telephone number of the buyer. Please note, if this order use platform logistics, phone number will be desensitized. | ^^name |string |Zay |The name of the recipient. Please note, if this order uses platform logistics, recipient name will be desensitized | ^^postal_code |string |95110 |The postal code that can be used by seller for shipping (in the U.S, this refers to the ZIP code). | ^^address_detail |string |Unit one building 8 |Full buyer detail address. | ^^region_code |string |US |Region code. | ^^address_line1 |string |TikTok 5800 bristol Pkwy |The first line of the street address | ^^address_line2 |string |Suite 100 |The second line of the street address. | ^^address_line3 |string |Suite 100 |The third line of the street address. Usually only for the Brazilian market. | ^^address_line4 |string |Suite 100 |The fourth line of the street address. Usually only for the Brazilian market. | ^sender_address |object | |Sender address. | ^^full_address |string |1 Coleman Ave San Jose, CA 95110 |The complete sender addresses information. | ^^phone_number |string |(+1)213-***-1234 |The telephone number of the sender. | ^^name |string |Zay |The name of the sender. | ^^postal_code |string |95110 |The postal code of the sender. | ^^address_detail |string |Unit one building 8 |Full sender detail address. | ^^region_code |string |US |Region code of the sender. | ^^address_line1 |string |TikTok 5800 bristol Pkwy |The first line of the sender's street address. | ^^address_line2 |string |Suite 100 |The second line of the sender's street address. | ^^address_line3 |string |Suite 100 |The third line of the sender's street address. Usually only for the Brazilian market. | ^^address_line4 |string |Suite 100 |The fourth line of the sender's street address. Usually only for the Brazilian market. | ^weight |object | |The weight of the scheduled package. | ^^value |string |1.2 |The value of the weight of the scheduled package. | ^^unit |string |GRAM |The unit of measurement used to measure the weight. Possible values:
• GRAM
• POUND | ^dimension |object | |The dimensions of the scheduled package. | ^^length |string |1.2 |The length of the scheduled package. | ^^width |string |0.2 |The width of the scheduled package. | ^^height |string |0.03 |The height of the scheduled package. | ^^unit |string |CM |The unit of measurement used to measure the length. Possible values:
• CM
• INCH | ^update_time |int |1635338186 |The time the package has been updated. Unix timestamp. | ^insurance |object | |Provides details of shipping insurance auto-enrolled during label purchase | ^^is_purchased |bool |true |Whether insurance has been purchased for the package. | ^^coverage_amount |string |200 |The insurance coverage amount for the package. Units: USD. | ^^is_claim_eligible |bool |true |Whether the order is eligible for an insurance claim, based on eligible refund reasons. | ^^claim_status |string |CLAIM_PENDING |The insurance claim status. Available values:
• NOT_STARTED: Claim has not been initiated for this package.
• CLAIM_PENDING: Claim is currently under review.
• APPROVED: Claim has been approved.
• DECLINED: Claim has been declined. | ^biz_extension_tags |[]string |["NON_MCF"] |Special tags for current package if any.
• NON_MCF: whether this package was shipped as a MCF order while in fact it is not. | ^warehouse_id |string |7317467398322308906 |Seller Warehouse id for this package |

{"code":0,"data":{"package_id":"5433567853345","orders":[{"id":"54335448533296","skus":[{"id":"2729382476852921560","name":"white,128g","image_url":"https://p19-oec-sg.ibyteimg.com/tos-maliva-i-o3syd03w52-us/12345670c","quantity":5}]}],"package_status":"PROCESSING","package_sub_status":"Created","ship_exception_reason":"PACKAGE_LOST","split_and_combine_tag":"SPLIT","has_multi_skus":true,"note_tag":"BUYER_UNNOTED","shipping_provider_name":"TT Virtual express","shipping_provider_id":"6617675021119438849","shipping_type":"TIKTOK","delivery_option_name":"Shipped from seller\n","delivery_option_id":"7091146663229654785","tracking_number":"6617675021119438849","last_mile_tracking_number":"6617675021119438849","pickup_slot":{"start_time":1635338186,"end_time":1635338186},"create_time":1635338186,"handover_method":"PICKUP","order_line_item_ids":["1729382476852921560"],"recipient_address":{"full_address":"1*** Coleman Ave San Jose, CA 95110\n","phone_number":"(+1)213-***-1234\n","name":"Zay","postal_code":"95110\n","address_detail":"Unit one building 8\n","region_code":"US","address_line1":"TikTok 5800 bristol Pkwy\n","address_line2":"Suite 100\n","address_line3":"Suite 100\n","address_line4":"Suite 100\n"},"sender_address":{"full_address":"1*** Coleman Ave San Jose, CA 95110","phone_number":"(+1)213-***-1234\n","name":"Zay","postal_code":"95110","address_detail":"Unit one building 8","region_code":"US","address_line1":"TikTok 5800 bristol Pkwy","address_line2":"Suite 100","address_line3":"Suite 100","address_line4":"Suite 100"},"weight":{"value":"1.2","unit":"GRAM"},"dimension":{"length":"1.2","width":"0.2","height":"0.03","unit":"CM"},"update_time":1635338186,"insurance":{"is_purchased":true,"coverage_amount":"200","is_claim_eligible":true,"claim_status":"CLAIM_PENDING"},"biz_extension_tags":["NON_MCF"],"warehouse_id":"7317467398322308906"},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code