Create marketing events

Requires write_marketing_event access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20261201/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 string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

Request Body

marketing_eventobject

Marketing events
utm_term string

Key words for identification search
Example: This is search word for utm item
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
marketing_channel string required

Marketing event select channels ● search ● display ● social ● email ● referral ● sms
Example: search
remote_id string

Resources id
Example: 6019932248291157288
utm_source string

Advertising customers , advertising websites
Example: manong.myshopline.com
utm_medium string

Identification source type
Example: email
utm_campaign string

Identify specific advertising
Example: google
started_at string

Start time
Example: 2022-12-15T09:00:00+08:00
description string

Description
Example: This is description for marketing event
ended_at string

End time
Example: 2023-12-15T09:00:00+08:00
referring_domain string

Domain name for marketing events , if marketing_channel is search and social , specify is needed
Example: manong.myshopline.com
utm_content string

Distinguish between the same ad and different links
Example: googleAds
preview_url string

Url to preview(Examples link are for reference only)
Example: https://manong.myshopline.com/
manage_url string

Managed links (Examples link are for reference only)
Example: https://manong.myshopline.com/admin/

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

marketing_eventobject

Marketing events
remote_id string

Resources id
Example: 6019942645165466925
referring_domain string

Domain name for marketing events , if marketing_channel is search and social , specify is needed
Example: manong.myshopline.com
preview_url string

Url to preview
Example: https://manong.myshopline.com/
marketing_channel string

Marketing event select channels ● search ● display ● social ● email ● referral ● sms
Example: search
description string

Marketing campaign description
Example: This is description for marketing event
utm_medium string

Identification source type
Example: email
utm_campaign string

Identify specific advertising
Example: google
utm_term string

Key words for identification search
Example: This is search word for utm item
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
marketing_event_id string

Yingxiao id for marketing events
Example: MA_6019943243021559089
manage_url string

Managed links (Examples link are for reference only)
Example: https://manong.myshopline.com/admin/
ended_at string

End time
Example: 2023-12-15T09:00:00+08:00
started_at string

Start time
Example: 2022-12-15T09:00:00+08:00
utm_content string

Distinguish between the same ad and different links
Example: googleAds
utm_source string

Advertising customers , advertising websites
Example: manong.myshopline.com

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

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

Language

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

Was this article helpful to you?

SHOPLINE

Legal