(27) Inventory status change

POST

This webhook will be triggered in either of the following situations:

• The current_inventory_status has dropped to LOW_STOCK / OUT_OF_STOCK.
• TikTok Shop predicts the available_quantity will drop to 0 in X days.

Note: The value of X can be system-configured or manually set by the seller.

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

type

required

The ID of the webhook type.

integer

Allowed value: 27

tts_notification_id

The ID of this webhook notification.

string

shop_id

The shop ID.

string

timestamp

The time when this webhook is triggered. Unix timestamp.

integer format: int64

data

object

product_id

The ID of the product.

string

sku_id

The ID of the SKU.

string

trigger_reason

object

alert_type

PREDICTION: TikTok Shop predicts the inventory will go out of stock in X days REALTIME: The inventory has reached LOW_STOCK or OUT_OF_STOCK

string

lead_days

When alert_type == PREDICTION, the value is the time slot between update_time and the predicted out-of-stock date. When alert_type == REALTIME, the parameter is not returned.

integer format: int64

low_stock_threshold

When alert_type == REALTIME, the value is the low stock threshold met. When alert_type == PREDICTION, the parameter is not returned.

integer format: int64

current_inventory_status

SUFFICIENT_STOCK: defined as having enough stocks. LOW_STOCK: defined as available stock ≤ stock alert value OUT_OF_STOCK: defined as having 0 available stock.

string

inventory_distribution

object

total_quantity

The total quantity of the stock physically in the warehouses. total_quantity=available_quantity + creator_reserved_quantity + campaign_reserved_quantity + committed_quantity.

integer format: int64

available_quantity

The total number of SKUs available for ordering in the warehouses.

integer format: int64

creator_reserved_quantity

The total number of SKUs reserved for creators in the warehouses.

integer format: int64

campaign_reserved_quantity

The total number of SKUs reserved for campaigns in the warehouses.

integer format: int64

committed_quantity

The total number of SKUs reserved by existing customer orders in the warehouses.

integer format: int64

update_time

The time when the status changed, represented as a Unix timestamp (seconds).

integer format: int64

Example

{
  "type": 27,
  "tts_notification_id": "7327112393057371910",
  "shop_id": "7494049642642441621",
  "timestamp": 1644412885,
  "data": {
    "product_id": "732357708734418520388",
    "sku_id": "73235770873441823254",
    "trigger_reason": {
      "alert_type": "PREDICTION",
      "lead_days": 21
    },
    "current_inventory_status": "LOW_STOCK",
    "inventory_distribution": {
      "total_quantity": 100,
      "available_quantity": 50,
      "creator_reserved_quantity": 20,
      "campaign_reserved_quantity": 20,
      "committed_quantity": 10
    },
    "update_time": 1627587600
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.