(42) Combined listing change

POST

This webhook is triggered when a combined listing is created, updated (the list of products in the combined listing changes), or deleted. Prerequisite: The “Product Basic” API scope is enabled in Partner Center. For more information, refer to Access Scope.

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

type

required

The ID of the webhook type.

integer

Allowed value: 42

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

combined_listing_id

The combined listing ID.

string

products

The current list of products in this combined listing after the change.

Array<object>

object

id

The product id.

string

status

The status of the combined listing. Possible values:

• LIVE
• SYSTEM_DEACTIVATED
• SELLER_DEACTIVATED
• DELETED

Note: Only products in LIVE combined listings will appear on the product display page.

string

Allowed values: LIVE SYSTEM_DEACTIVATED SELLER_DEACTIVATED DELETED

change_type

The type of change made to this combined listing. Possible values:

• CREATE: The combined listing was created.
• UPDATE: The combined listing was updated to add or remove products.
• DELETE: The combined listing was deleted.

string

Allowed values: CREATE UPDATE DELETE

added_product_ids

The list of products that were newly added to the combined listing.

Array<string>

removed_product_ids

The list of products that were removed from the combined listing.

Array<string>

Example

{
  "type": 42,
  "tts_notification_id": "7327112393057371910",
  "shop_id": "7494049642642441621",
  "timestamp": 1644412885,
  "data": {
    "combined_listing_id": "123456789",
    "products": [
      {
        "id": "987654321"
      },
      {
        "id": "987654322"
      }
    ],
    "status": "LIVE",
    "change_type": "UPDATE",
    "added_product_ids": [
      "987654321"
    ],
    "removed_product_ids": [
      "987654333"
    ]
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.