订阅 Webhook

POST https://{handle}.myshopline.com/admin/openapi/v20261201/webhooks.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

订阅指定的 Webhook 事件，例如商品创建或订单更新等。你必须提供一个 URL 用于应用接收事件通知。

注意：该 API 仅支持订阅 v20240601 及更高版本的 Webhook 事件。对于更早版本的 Webhook 事件，通过如下方式进行管理：

公共应用和自定义应用：进入 SHOPLINE 合作伙伴后台，前往应用 > Webhook 配置。
私有应用：进入 SHOPLINE 商家后台，前往应用 > 开发应用 > 编辑 > 权限配置。

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
Authorization string required

资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
例子:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

请求体

webhookobject required

Webhook 事件订阅的配置信息。
api_version string required

Webhook 事件的版本号，仅支持 v20240601 及更高的版本。
例子: v20240601
topic string required

订阅的具体事件，如 products/create 表示“商品创建”事件。目前每次调用只能订阅一个事件，不支持传入多个事件标识。事件标识符可通过对应的 webhook 文档找到。
例子: products/create
address string required

接收事件通知的回调 URL 地址。平台将在相关事件发生时，将事件数据推送到此地址。
最大长度限制：255
例子: https://www.shopline.com/webhook

状态码

更多状态码信息，参考 HTTP 状态码。

响应头

traceId

请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

webhookobject

Webhook 事件订阅的配置信息。
id integer

订阅记录的唯一标识符。
例子: 13814
topic string

已成功订阅的具体事件，如 products/create 表示“商品创建”事件。
updated_at string

Webhook 订阅记录最近一次更新的日期和时间。格式：ISO 8601。
例子: 2024-01-31T18:21:06+08:00
address string

应用接收 Webhook 事件通知的 URL 地址。
例子: https://www.shopline.com/webhook
api_version string

Webhook 事件的版本号。
例子: v20240601
created_at string

首次成功订阅该 Webhook 事件的日期与时间。格式：ISO 8601。
例子: 2024-01-31T18:21:06+08:00

API Explorer

调试台

示例代码

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

Authorization — header required

Body

Body required

{
  "webhook": {
    "address": "https://www.shopline.com/webhook",
    "api_version": "v20240601",
    "topic": "products/create"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/webhooks.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议