(39) Activity status change

POST

When a promotion activity of the specified type starts, expires, or is deactivated, you’ll receive this webhook. This webhook will only be triggered when all the following conditions are met:

• Your App has been authorized the Promotion Information scope.
• The activities are of the following types:
  • FIXED_PRICE
  • DIRECT_DISCOUNT
  • SHIPPING_DISCOUNT
  • BUY_MORE_SAVE_MORE
  • FLASHSALE (Only available in SEA markets: SG, TH, ID, MY, PH, VN)
• One of the following status changes happens:
  • The activity starts: the status changes from NOT_START to ONGOING.
  • The activity expires: the status changes from ONGOING to EXPIRED.
  • The activity is deactivated: the status changes to DEACTIVATED.

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

type

required

The ID of the webhook type.

integer

Allowed value: 39

tts_notification_id

The ID of the notification.

string

shop_id

The ID of the shop.

string

timestamp

The time when this webhook was triggered, represented by Unix timestamp.

integer format: int64

data

object

activity_id

The ID of the promotion activity.

string

update_time

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

integer format: int64

activity_type

The type of the promotion activity. Possible values are:

• FIXED_PRICE
• DIRECT_DISCOUNT
• SHIPPING_DISCOUNT
• BUY_MORE_SAVE_MORE
• FLASHSALE (Only available in SEA markets: SG, TH, ID, MY, PH, VN)

string

Allowed values: FIXED_PRICE DIRECT_DISCOUNT SHIPPING_DISCOUNT BUY_MORE_SAVE_MORE FLASHSALE

product_level

Activity product dimension, values are:

• PRODUCT
• VARIATION
• SHOP

string

Allowed values: PRODUCT VARIATION SHOP

status

The current status of the promotion activity. Possible values are:

• ONGOING
• EXPIRED
• DEACTIVATED

string

Allowed values: ONGOING EXPIRED DEACTIVATED

Example

{
  "type": 39,
  "shop_id": "7494049642642441621",
  "tts_notification_id": "7327112393057371910",
  "timestamp": 1644412885,
  "data": {
    "activity_id": "7136104329798256386",
    "update_time": 1644412885,
    "activity_type": "FIXED_PRICE",
    "product_level": "PRODUCT",
    "status": "ONGOING"
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.