Create marketing events

Requires write_marketing_event access scope.

For more info , refer to:

[]

access permission

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

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

marketing_eventobject
[]
Marketing events
description string
[]
Description
[]
Example: This is description for marketing event
ended_at string
[]
End time
[]
Example: 2023-12-15T09:00:00+08:00
event_type string required
[]
●ad : advertising ● post : push ( fb post-chinese ) ● message : sms ● retargeting : dynamic redirect advertising ● transactional : ● affiliate : distribution / kol / red people ●Loyalty : gift card ● newsletter : subscription mail ● abandoned_cart : discard ● live : live broadcast
[]
Example: ad
manage_url string
[]
Managed links (Examples link are for reference only)
[]
Example: https://manong.myshopline.com/admin/
marketing_channel string required
[]
Marketing event select channels ● search ● display ● social ● email ● referral ● sms
[]
Example: search
preview_url string
[]
Url to preview(Examples link are for reference only)
[]
Example: https://manong.myshopline.com/
referring_domain string
[]
Domain name for marketing events , if marketing_channel is search and social , specify is needed
[]
Example: manong.myshopline.com
remote_id string
[]
Resources id
[]
Example: 6019932248291157288
started_at string
[]
Start time
[]
Example: 2022-12-15T09:00:00+08:00
utm_campaign string
[]
Identify specific advertising
[]
Example: google
utm_content string
[]
Distinguish between the same ad and different links
[]
Example: googleAds
utm_medium string
[]
Identification source type
[]
Example: email
utm_source string
[]
Advertising customers , advertising websites
[]
Example: manong.myshopline.com
utm_term string
[]
Key words for identification search
[]
Example: This is search word for utm item

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

marketing_eventobject
[]
Marketing events
description string
[]
Marketing campaign description
[]
Example: This is description for marketing event
ended_at string
[]
End time
[]
Example: 2023-12-15T09:00:00+08:00
event_type string
[]
●ad : advertising ● post : push ( fb post-chinese ) ● message : sms ● retargeting : dynamic redirect advertising ● transactional : ● affiliate : distribution / kol / red people ●Loyalty : gift card ● newsletter : subscription mail ● abandoned_cart : discard ● live : live broadcast
[]
Example: ad
id string
[]
Id for marketing events
[]
Example: 4073
manage_url string
[]
Managed links (Examples link are for reference only)
[]
Example: https://manong.myshopline.com/admin/
marketing_channel string
[]
Marketing event select channels ● search ● display ● social ● email ● referral ● sms
[]
Example: search
marketing_event_id string
[]
Yingxiao id for marketing events
[]
Example: MA_6019943243021559089
preview_url string
[]
Url to preview
[]
Example: https://manong.myshopline.com/
referring_domain string
[]
Domain name for marketing events , if marketing_channel is search and social , specify is needed
[]
Example: manong.myshopline.com
remote_id string
[]
Resources id
[]
Example: 6019942645165466925
started_at string
[]
Start time
[]
Example: 2022-12-15T09:00:00+08:00
utm_campaign string
[]
Identify specific advertising
[]
Example: google
utm_content string
[]
Distinguish between the same ad and different links
[]
Example: googleAds
utm_medium string
[]
Identification source type
[]
Example: email
utm_source string
[]
Advertising customers , advertising websites
[]
Example: manong.myshopline.com
utm_term string
[]
Key words for identification search
[]
Example: This is search word for utm item

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "marketing_event": {
    "description": "This is description for marketing event",
    "ended_at": "2023-12-15T09:00:00+08:00",
    "event_type": "ad",
    "manage_url": "https://manong.myshopline.com/admin/",
    "marketing_channel": "search",
    "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"
  }
}

Language

curl --request POST \
     --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' \
     --data '
{
  "marketing_event": {
    "description": "This is description for marketing event",
    "ended_at": "2023-12-15T09:00:00+08:00",
    "event_type": "ad",
    "manage_url": "https://manong.myshopline.com/admin/",
    "marketing_channel": "search",
    "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"
  }
}
'

Was this article helpful to you?

SHOPLINE

Legal