(25) Opportunity matching status change

POST

This webhook is triggered when the status of opportunity matching for a candidate product changes. Prerequisite: The “Product Opportunities” API scope is enabled in Partner Center. For more information, refer to Access Scope. 📌 This webhook is currently available only to a limited set of developers.

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

type

required

The ID of the webhook type.

integer

Allowed value: 25

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

external_product_id

An external product identifier used in the external ecommerce platform.

string

opportunity_matching_status

The status of opportunity matching. Possible values:

• PENDING: Waiting for opportunity matching.
• MATCHED: There are one or more matched opportunities.
• NOT_MATCHED: There are no matches.

string

Allowed values: PENDING MATCHED NOT_MATCHED

opportunity_ids

A list of IDs for the matched opportunities.

Array<string>

opportunity_matching_end_time

The time by which the system will stop matching opportunities for this candidate product. Unix timestamp.

• Default: 60 days from the upload time.
• Latest allowable time: 60 days from the upload time.

integer format: int64

update_time

The time when the opportunity matching status is last updated. Unix timestamp.

integer format: int64

Example

{
  "type": 25,
  "tts_notification_id": "7327112393057371910",
  "shop_id": "7494049642642441621",
  "timestamp": 1730458800,
  "data": {
    "external_product_id": "576486316948490000",
    "opportunity_matching_status": "PENDING",
    "opportunity_ids": [
      "213231",
      "213233"
    ],
    "opportunity_matching_end_time": 1735603200,
    "update_time": 1730458800
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.