Query marketing events list

Requires read_marketing_event access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/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 .
Query Parameters
  • limit integer
    The number of listings for return is 50 by default , which needs to be less than 250
    Example: 10
  • offset integer
    The marketing event that skips
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 eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
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_eventsobject[]
    Marketing events
  • marketing_event_id string
    Yingxiao id for marketing events
    Example: MA_6062143268514178052
  • utm_content string
    Distinguish between the same ad and different links
    Example: googleAds
  • utm_medium string
    Identification source type
    Example: email
  • utm_term string
    Key words for identification search
    Example: This is search word for utm item
  • preview_url string
    Url to preview
    Example: www.shopline.com/preview/mobile.com
  • started_at string
    Start time
    Example: 2022-12-15T09:00:00+08:00
  • manage_url string
    Managed links
    Example: www.shopline.com
  • remote_id string
    Resources id
    Example: 6019932248291157288
  • utm_source string
    Advertising customers , advertising websites
    Example: www.shopline.com
  • utm_campaign string
    Identify specific advertising
    Example: google
  • 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: MA_6062143268514178052
  • marketing_channel string
    Marketing event select channels ● search ● display ● social ● email ● referral ● sms
    Example: search
  • 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: www.shopline.com
  • description string
    Marketing campaign description
    Example: This is description for marketing event
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required
— query
— query

Language

curl --request GET \
     --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'
Examples
Paging query marketing events
Response
{
  "marketing_events": [
    {
      "manage_url": "https://manong.myshopline.com/admin/",
      "remote_id": "6019932248291157288",
      "started_at": "2022-12-15T09:00:00+08:00",
      "utm_campaign": "google",
      "utm_medium": "email",
      "utm_content": "googleAds",
      "utm_term": "This is search word for utm item",
      "marketing_event_id": "MA_6062143268514178052",
      "utm_source": "manong.myshopline.com",
      "preview_url": "https://manong.myshopline.com/",
      "event_type": "ad",
      "referring_domain": "manong.myshopline.com",
      "description": "This is description for marketing event",
      "marketing_channel": "search",
      "id": 4355,
      "ended_at": "2023-12-15T09:00:00+08:00"
    },
    {
      "description": "This is description of marketing event",
      "utm_term": "This is utm term name",
      "referring_domain": "www.shopline.com",
      "utm_campaign": "google",
      "started_at": "2022-12-15T09:00:00+08:00",
      "marketing_event_id": "MA_6019937483067761963",
      "marketing_channel": "search",
      "utm_medium": "email",
      "preview_url": "www.shopline.com/preview/mobile.com",
      "event_type": "ad",
      "manage_url": "www.shopline.com/admin/1.html",
      "ended_at": "2023-12-15T09:00:00+08:00",
      "id": 4073,
      "utm_source": "www.shopline.com",
      "remote_id": "32ff8e60-9027-4d9c-8286-9f6059aaf97a",
      "utm_content": "googleAds"
    }
  ]
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.