Get Package Handover Time Slots

GET

/fulfillment/202309/packages/{package_id}/handover_time_slots

Use this API to retrieve a specified package’s door-to-door pickup time slots and handover availability for pickup, drop-off, and, in the UK, van collection. When available, the response also provides a URL for finding drop-off locations.

Authorizations

• accessToken

Parameters

Path Parameters

package_id

required

string

TikTok Shop package ID.

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

can_pickup

Whether this package supports door-to-door collection.

boolean

can_drop_off

Whether this package be dropped off at a drop-off location

boolean

can_van_collection

Specific to UK. Use this field to determine whether van collection is available.

boolean

drop_off_point_url

View package drop-off locations via provided URL.

string

pickup_slots

Door-to-door collection time slots. Check avaliable to determine whether each time slot can be scheduled.

Array<object>

object

start_time

The start of the package pickup time slot, as a Unix timestamp in seconds.

integer format: int64

end_time

The end of the package pickup time slot, as a Unix timestamp in seconds.

integer format: int64

avaliable

Whether an appointment be made for this time slot.

boolean

Example

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