创建营销事件

需要 write_marketing_event 权限点。

更多权限点使用信息，请参考：

POST https://{handle}.myshopline.com/admin/openapi/v20260301/sales/marketing_events.json

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

创建marketingEvent

请求头

Content-Type string required

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

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

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

请求体

marketing_eventobject

营销事件
referring_domain string

营销事件的目的域名,如果marketing_channel是search和social的时候，需要指定
例子: manong.myshopline.com
remote_id string

资源id
例子: 6019932248291157288
description string

描述
例子: This is description for marketing event
utm_campaign string

标识具体的广告
例子: google
utm_medium string

标识来源类型
例子: email
utm_source string

广告客户、广告网站
例子: manong.myshopline.com
utm_term string

标识搜索的关键字
例子: This is search word for utm item
event_type string required

● ad：广告 ● post：推送（FB贴文） ● message：短信 ● retargeting：动态重定向广告 ● transactional： ● affiliate：分销/KOL/红人 ● loyalty：礼品卡 ● newsletter：订阅邮件 ● abandoned_cart：弃单 ● live：直播
例子: ad
manage_url string

管理页的url（示例仅提供参考）
例子: https://manong.myshopline.com/admin/
started_at string

开始时间
例子: 2022-12-15T09:00:00+08:00
utm_content string

区分同一个广告不同的链接
例子: googleAds
ended_at string

结束时间
例子: 2023-12-15T09:00:00+08:00
marketing_channel string required

营销事件选择的渠道● search ● display ● social ● email ● referral ● sms
例子: search
preview_url string

预览页的url（示例url仅提供参考）
例子: https://manong.myshopline.com/

状态码

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

响应头

traceId

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

响应体

marketing_eventobject

营销事件
event_type string

● ad：广告 ● post：推送（FB贴文） ● message：短信 ● retargeting：动态重定向广告 ● transactional： ● affiliate：分销/KOL/红人 ● loyalty：礼品卡 ● newsletter：订阅邮件 ● abandoned_cart：弃单 ● live：直播
例子: ad
description string

营销活动描述
例子: This is description for marketing event
id string

营销事件的id
例子: 4073
ended_at string

结束时间
例子: 2023-12-15T09:00:00+08:00
preview_url string

预览页的url（示例url仅提供参考）
例子: https://manong.myshopline.com
manage_url string

管理页的url（示例url仅提供参考）
例子: https://manong.myshopline.com/admin/
referring_domain string

营销事件的目的域名,如果marketing_channel是search和social的时候，需要指定
例子: manong.myshopline.com
remote_id string

资源id
例子: 6019942645165466925
utm_content string

区分同一个广告不同的链接
例子: googleAds
utm_medium string

标识来源类型
例子: email
utm_source string

广告客户、广告网站
例子: manong.myshopline.com
started_at string

开始时间
例子: 2022-12-15T09:00:00+08:00
utm_campaign string

标识具体的广告
例子: google
utm_term string

标识搜索的关键字
例子: This is search word for utm item
marketing_channel string

营销事件选择的渠道● search ● display ● social ● email ● referral ● sms
例子: search
marketing_event_id string

营销事件的唯一id
例子: MA_6019943243021559089

API Explorer

调试台

示例代码

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "marketing_event": {
    "utm_campaign": "google",
    "description": "This is description for marketing event",
    "marketing_channel": "search",
    "preview_url": "https://manong.myshopline.com/",
    "utm_content": "googleAds",
    "utm_source": "manong.myshopline.com",
    "ended_at": "2023-12-15T09:00:00+08:00",
    "manage_url": "https://manong.myshopline.com/admin/",
    "utm_medium": "email",
    "event_type": "ad",
    "referring_domain": "manong.myshopline.com",
    "utm_term": "This is search word for utm item",
    "remote_id": "6019932248291157288",
    "started_at": "2022-12-15T09:00:00+08:00"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/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'

这篇文章对你有帮助吗？

SHOPLINE

条款协议