Get Package Handover Time Slots

资料正文

§1 Path: /fulfillment/202309/packages/{package_id}/handover_time_slots

§2 Method: [GET]

§3 Function Description

Use this API to retrieve the time slots available for pickup, drop-off, or van collection for the seller's specified package by using package ID.

§4 Common Parameters

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

Properties	Location	Type	Require	Sample	Properties description
shop_cipher	query	string	Y	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
content-type	header	string	Y	application/json	Allowed type: application/json

§5 Request Path Parameters

Properties	Type	Require	Sample	Properties description
package_id	string	Y	5433567853345	TikTok Shop package ID.

§6 Request Query Parameters

Properties	Type	Require	Sample	Properties description
app_key	string	Y	38abcd	Every single app will have a unique key. Please use the specific key assigned to your app.
sign	string	Y	5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c	Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp	int	Y	1623812664	Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.

§7 Request Sample

Query

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

§8 Response Parameters

Properties	Type	Sample	Properties description
code	int	0	The success or failure status code returned in API response.
message	string	Success	The success or failure messages returned in API response. Reasons of failure will be described in the message.
request_id	string	202203070749000101890810281E8C70B7	Request log
data	object		Specific return information
^can_pickup	bool	true	Whether this package supports door-to-door collection.
^can_drop_off	bool	true	Whether this package be dropped off at a drop-off location
^can_van_collection	bool	true	Specific to UK. Use this field to determine whether van collection is available.
^drop_off_point_url	string	true	View package drop-off locations via provided URL.
^pickup_slots	[]object		Time slot for door-to-door collection.
^^start_time	int	1623812664	The start date and time of the package pick up time slot. Unix timestamp.
^^end_time	int	1623812664	The end date and time of the package pick up time slot. Unix timestamp.
^^avaliable	bool	true	Whether an appointment be made for this time slot.

§9 Response Sample

{"code":0,"data":{"can_pickup":true,"can_drop_off":true,"can_van_collection":true,"drop_off_point_url":"true","pickup_slots":[{"start_time":1623812664,"end_time":1623812664,"avaliable":true}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

§10 Error Code

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

Code	Message
36009003	Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support.
11001027	System timeout. If this error persists, please contact the platform for assistance.
11021009	No available shipping services for this request. Please modify the package weight or check the recipient address. If the error persists, please contact the platform for assistance.
21001001	Invalid parameters. Please ensure you are passing the correct request parameter(s).