Search Package

Retrieve package IDs based on specified conditions. Package creation time and information update time are the common querying conditions.

---

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

• create_time
• update_time
• order_pay_time

Specify the order for sorting the returned results by using the sort_order parameter. | sort_order |string |N |ASC |The sort order for the sort_field parameter. Default: DESC Possible values:

• ASC: Ascending order
• DESC: Descending order | page_token |string |N |6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA |An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. | shop_cipher |string |N |GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 |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 |

• 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. |

Query

https://open-api.tiktokglobalshop.com/fulfillment/202309/packages/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=20&sort_field=order_pay_time&sort_order=ASC&page_token=6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA

Body

{"create_time_ge":1623812664,"create_time_lt":1623812664,"update_time_ge":1623812664,"update_time_lt":1623812664,"package_status":"PROCESSING"}

• 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. | ^^tracking_number |string |6617675021119438849 |Package tracking number. | ^^shipping_provider_name |string |TT Virtual express |Package shipping provider. | ^^shipping_provider_id |string |6617675021119438849 |Package shipping provider ID. | ^^order_line_item_ids |[]string |["1729382476852921560"] |The order line item ID contained in the package. |

{"code":0,"data":{"next_page_token":"6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA","total_count":221,"packages":[{"id":"577828281214600000","orders":[{"id":"577828281214600000","skus":[{"id":"577828281214883345","name":"white,128g","image_url":"https://p19-oec-sg.ibyteimg.com/tos-maliva-i-o3syd03w52-us/12345670","quantity":5}]}],"create_time":1635338186,"update_time":1635338186,"status":"PROCESSING","tracking_number":"6617675021119438849","shipping_provider_name":"TT Virtual express","shipping_provider_id":"6617675021119438849","order_line_item_ids":["1729382476852921560"]}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

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