Ship Package

POST

/fulfillment/202309/packages/{package_id}/ship

Use this API to ship a package. There are two kinds of shipping options available: TikTok Shipping or Seller Shipping.

• TikTok Shipping: Schedule a package handover time for TikTok Shipping carriers to pickup a package from seller.
• Seller Shipping: Seller arranges their own shipping, and uploads a tracking number and shipping_provider_id. Package ID can be obtained from Get Order Detail.
• In-store Pickup: Confirms shipment and notifies the buyer that the order is ready for pickup.

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.

Request Body

Media typeapplication/json

object

handover_method

Possible values:

• PICKUP: A logistics carrier will pick up the package(s) from the seller’s pickup address.
• DROP_OFF: The seller will need to drop off the package(s) to a designated location.

string

Allowed values: PICKUP DROP_OFF

pickup_slot

Pickup time slot.

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

self_shipment

Only needed for merchant self-shipping packages. Check the delivery_option field of Get Package Detail to see how to differentiate platform-logistics and self-shipping. Use the shipping_provider_id retrieved from Get Shipping Providers and upload the corresponding tracking_number.

object

tracking_number

required

For packages with the SEND_BY_SELLER delivery option type (seller shipping), you must provide the package’s tracking number.

string

shipping_provider_id

required

For packages with the SEND_BY_SELLER delivery option type (seller shipping), you must provide the shipping provider information. Please use the Get Shipping Providers API to obtain the shipping_provider_id.

string

Example

{
  "handover_method": "PICKUP",
  "pickup_slot": {
    "start_time": 1623812664,
    "end_time": 1623812664
  },
  "self_shipment": {
    "tracking_number": "JX12345",
    "shipping_provider_id": "6617675021119438849"
  }
}

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

Example

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