订阅新的 Webhook

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

[]

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

[]

指定店铺、事件和版本，为单个店铺创建 Webhook 订阅

info

需要注意，当前接口仅支持 v20240601 及之后版本的 Webhook 事件。

更早版本请通过开发者中心进行管理。

请求头

Content-Type required
[]
字段值固定为application/json; charset=utf-8
Authorization string required
[]
资源的访问令牌。请参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

请求体

webhookobject required
[]
Webhook 对象
address string required
[]
插件用于接收事件推送的地址
[]
Example: https://www.shopline.com/webhook
api_version string required
[]
版本号，版本管理规范参见API管理规范
[]
Example: v20240601
topic string required
[]
事件的唯一标识
[]
Example: products/create

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

traceId
[]
traceId

响应体

webhookobject
[]
订阅对象
address string
[]
应用接收事件推送的地址
[]
Example: https://www.shopline.com/webhook
api_version string
[]
版本号，版本管理规范参见API管理规范
[]
Example: v20240601
created_at string
[]
事件创建的时间
[]
Example: 2024-01-31T18:21:06+08:00
id integer
[]
Webhook订阅记录的唯一 id
topic string
[]
事件的唯一标识
[]
Example: products/create
updated_at string
[]
事件最近一次修改成功的时间
[]
Example: 2024-01-31T18:21:06+08:00

API Explorer

调试台

Base URL

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

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/v20250601/webhooks.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json' \
     --data '
{
  "webhook": {
    "address": "https://www.shopline.com/webhook",
    "api_version": "v20240601",
    "topic": "products/create"
  }
}
'

这篇文章对你有帮助吗？

SHOPLINE

条款协议

Error loading component.