Remove Promotion Activity Products

DELETE

/promotion/202309/activities/{activity_id}/products

Use this API for FIXED_PRICE, DIRECT_DISCOUNT, FLASHSALE, BUY_MORE_SAVE_MORE, BUY_X_GET_Y, GIFT_WITH_PURCHASE, and SHIPPING_DISCOUNT activities. Provide at least one non-empty removal list; omitting the body, sending an empty object, or sending only empty lists does not request an item removal.

• When removing ordinary activity products from a PRODUCT-scoped activity, use product_ids and do not provide sku_ids.
• When removing ordinary activity products or SKUs from a VARIATION-scoped activity, use product_ids, sku_ids, or both.
• For GIFT_WITH_PURCHASE, provide a non-empty product_ids list; the other removal lists are not processed by its branch.
• For BUY_MORE_SAVE_MORE or BUY_X_GET_Y, benefit_product_ids removes benefit-product relations without requiring product_ids.
• For a SHOP-scoped BUY_MORE_SAVE_MORE, BUY_X_GET_Y, or SHIPPING_DISCOUNT activity, exclude_product_ids removes excluded-product relations. You can provide multiple applicable non-empty lists in one ordinary non-GWP request. You cannot remove items from a DEACTIVATED or EXPIRED activity.

Authorizations

• accessToken

Parameters

Path Parameters

activity_id

required

string

The unique identifier of the promotion activity.

Query Parameters

shop_cipher

required

string

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

Request Body

Media typeapplication/json

object

product_ids

IDs of the products to remove. Max count: 300.

Array<string>

<= 300 items

sku_ids

IDs of the SKUs to remove. Do not specify this field for a product-level activity. Max count: 300.

Array<string>

<= 300 items

benefit_product_ids

IDs of benefit-product relations to remove from a BUY_MORE_SAVE_MORE or BUY_X_GET_Y activity. Maximum: 100 IDs.

Array<string>

exclude_product_ids

IDs of excluded-product relations to remove from a SHOP-scoped BUY_MORE_SAVE_MORE, BUY_X_GET_Y, or SHIPPING_DISCOUNT activity. Maximum: 100 IDs.

Array<string>

Example

{
  "product_ids": [
    "7493989962827597361"
  ],
  "sku_ids": [
    "7135657830438176513"
  ],
  "benefit_product_ids": [
    "7493989962827597361"
  ],
  "exclude_product_ids": [
    "7493989962827597361"
  ]
}

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

activity_id

A unique ID that identifies activities.

string

status

Activity status. Possible values:

• DRAFT: Promotion activities with this status are not available to TikTok users.
• NOT_START: Promotion activities with this status are not available to TikTok users until the set activity start time.
• ONGOING: Promotion activities with this status are available to TikTok users.
• EXPIRED: Promotion activities with this status are not available to TikTok users because it has expired.
• DEACTIVATED: The activity has been deactivated by the seller and is not available to TikTok users.
• NOT_EFFECTIVE: The activity is terminated by the platform and is not available to TikTok users.

string

Allowed values: DRAFT NOT_START ONGOING EXPIRED DEACTIVATED NOT_EFFECTIVE

update_time

The time when the response was generated, as a Unix timestamp in seconds (UTC).

integer format: int64

Example

{
  "code": 0,
  "data": {
    "activity_id": "7136104329798256386",
    "status": "ONGOING",
    "update_time": 1661765135
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}