Skip to content

(4) Package update

POST

The package update webhook is triggered when package updates such as combine, split, cancel the combine package operation, etc. occur.

Media typeapplication/json
object
type
required

The ID of the webhook type.

integer
Allowed value: 4
tts_notification_id

The ID of the notification.

string
shop_id

The shop ID.

string
timestamp

The Unix timestamp when the webhook was triggered.

integer format: int64
data
object
sc_type

Type of the event trigger, with possible values:

  • COMBINE
  • CANCEL_COMBINE
  • SPLIT
  • CANCEL_SPLIT
  • ADDRESS_UPDATE_SPLIT
  • CANCEL_FULFILL_SPLIT
  • FULFILL_UNCOMBINE
  • PARTLY_CANCEL_SPLIT
  • SPLIT_BY_SKU_CANCEL
string
Allowed values: COMBINE CANCEL_COMBINE SPLIT CANCEL_SPLIT ADDRESS_UPDATE_SPLIT CANCEL_FULFILL_SPLIT FULFILL_UNCOMBINE PARTLY_CANCEL_SPLIT SPLIT_BY_SKU_CANCEL
role_type

Operator of the event trigger, with possible values:

  • ROLE_USER
  • ROLE_SELLER
  • ROLE_OPERATOR
  • ROLE_SYSTEM
string
Allowed values: ROLE_USER ROLE_SELLER ROLE_OPERATOR ROLE_SYSTEM
package_list

Package list updated by the event trigger

Array<object>
object
package_id

The identification of a package

string
order_id_list

List of order IDs in a given package

Array<string>
update_time

The time when the package was updated, represented as a Unix timestamp (seconds).

integer format: int64
Example
{
"type": 4,
"tts_notification_id": "7327112393057371910",
"shop_id": "7494049642642441621",
"timestamp": 1644412885,
"data": {
"sc_type": "COMBINE",
"role_type": "ROLE_USER",
"package_list": [
{
"package_id": "123456",
"order_id_list": [
"152523",
"532123"
]
}
],
"update_time": 1644412885
}
}

Return HTTP 200 to acknowledge receipt.