需要 read_marketing_event 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20250601/sales/marketing_events.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handleopen001
分页查询所有营销事件的列表
查询参数
  • limit integer
    返回的列表数量,默认为50,需要小于等于250
    Example: 10
  • offset integer
    跳过的营销事件
请求头
  • Content-Type required
    字段值固定为application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。请参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
响应
更多状态码信息请参考 HTTP 状态码

响应头
  • traceId
    traceId
响应体
  • marketing_eventsobject[]
    营销事件
  • description string
    营销活动描述
    Example: This is description for marketing event
  • ended_at string
    结束时间
    Example: 2023-12-15T09:00:00+08:00
  • event_type string
    ● ad:广告 ● post:推送(FB贴文) ● message:短信 ● retargeting:动态重定向广告 ● transactional: ● affiliate:分销/KOL/红人 ● loyalty:礼品卡 ● newsletter:订阅邮件 ● abandoned_cart:弃单 ● live:直播
    Example: ad
  • id string
    营销事件的id
    Example: MA_6062143268514178052
  • manage_url string
    管理的链接
    Example: www.shopline.com
  • marketing_channel string
    营销事件选择的渠道● search ● display ● social ● email ● referral ● sms
    Example: search
  • marketing_event_id string
    营销事件的唯一id
    Example: MA_6062143268514178052
  • preview_url string
    预览的url
    Example: www.shopline.com/preview/mobile.com
  • referring_domain string
    营销事件的目的域名,如果marketing_channel是search和social的时候,需要指定
    Example: www.shopline.com
  • remote_id string
    资源id
    Example: 6019932248291157288
  • started_at string
    开始时间
    Example: 2022-12-15T09:00:00+08:00
  • utm_campaign string
    标识具体的广告
    Example: google
  • utm_content string
    区分同一个广告不同的链接
    Example: googleAds
  • utm_medium string
    标识来源类型
    Example: email
  • utm_source string
    广告客户、广告网站
    Example: manong.myshopline.com
  • utm_term string
    标识搜索的关键字
    Example: This is search word for utm item
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

header required
query
query

Language

curl --request GET \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/sales/marketing_events.json \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'accept: application/json'
Examples
分页查询营销事件
Response
{
"marketing_events": [
{
"description": "This is description for marketing event",
"ended_at": "2023-12-15T09:00:00+08:00",
"event_type": "ad",
"id": 4355,
"manage_url": "https://manong.myshopline.com/admin/",
"marketing_channel": "search",
"marketing_event_id": "MA_6062143268514178052",
"preview_url": "https://manong.myshopline.com/",
"referring_domain": "manong.myshopline.com",
"remote_id": "6019932248291157288",
"started_at": "2022-12-15T09:00:00+08:00",
"utm_campaign": "google",
"utm_content": "googleAds",
"utm_medium": "email",
"utm_source": "manong.myshopline.com",
"utm_term": "This is search word for utm item"
},
{
"description": "This is description of marketing event",
"ended_at": "2023-12-15T09:00:00+08:00",
"event_type": "ad",
"id": 4073,
"manage_url": "www.shopline.com/admin/1.html",
"marketing_channel": "search",
"marketing_event_id": "MA_6019937483067761963",
"preview_url": "www.shopline.com/preview/mobile.com",
"referring_domain": "www.shopline.com",
"remote_id": "32ff8e60-9027-4d9c-8286-9f6059aaf97a",
"started_at": "2022-12-15T09:00:00+08:00",
"utm_campaign": "google",
"utm_content": "googleAds",
"utm_medium": "email",
"utm_source": "www.shopline.com",
"utm_term": "This is utm term name"
}
]
}
这篇文章对你有帮助吗?

Error loading component.

Error loading component.