(1) Order status change

POST

The order status change webhook is triggered when the order_status of an order changes.

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

type

required

The ID of the webhook type.

integer

Allowed value: 1

tts_notification_id

The ID of the notification.

string

shop_id

The shop ID.

string

timestamp

The Unix timestamp when the webhook was triggered.

integer format: int64

data

object

order_id

The identification of a TikTok Shop order

string

order_status

The most recent order status, with possible values:

• UNPAID
• ON_HOLD
• AWAITING_SHIPMENT
• AWAITING_COLLECTION
• CANCEL
• IN_TRANSIT
• DELIVERED
• COMPLETED

string

Allowed values: UNPAID ON_HOLD AWAITING_SHIPMENT AWAITING_COLLECTION CANCEL IN_TRANSIT DELIVERED COMPLETED

is_on_hold_order

Indicates whether the order has experienced or will experience ON_HOLD status

boolean

update_time

The order status update time, represented as a Unix timestamp (seconds).

integer format: int64

Example

{
  "type": 1,
  "tts_notification_id": "7327112393057371910",
  "shop_id": "7494049642642441621",
  "timestamp": 1644412885,
  "data": {
    "order_id": "576486316948490001",
    "order_status": "UNPAID",
    "is_on_hold_order": false,
    "update_time": 1644412885
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.