Get order attribution in bulk

Requires read_orders access scope.
For more info, refer to:
access permission.
POST https://{handle}.myshopline.com/admin/openapi/v20260301/orders/order_attribution_info.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 .
Get a list of attribution details based on the specified order IDs.
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
Request Body
  • orders array required
    A list of order IDs.
    Maximum size: 500
    Example: ["[\"21071058873779430237494658\",\"21069159447203440732216088\"]"]
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
  • dataobject[]
    List of order attribution data.
  • days_for_conversion integer
    The number of days taken for order conversion.
  • first_interactionobject
    The details of the buyer's first interaction that led to the order.
  • first_interact_time string
    Time of the first interaction. Format: ISO 8601.
    Example: 2025-03-21T17:46:17+08:00
  • first_interaction_source string
    First referrer source type. Valid values are:
    • Direct : Directly visiting the store
    • Social : Visiting the store through social media recommendations
    • Search : Visiting the store via search engine recommendations
    • Other : Visiting the store through recommendations from other websites
    • AI Chat : Visiting the store through recommendations from AI chat conversations
    Example: Social
  • first_landing_page_url string
    First landing page URL.
  • first_referrer_name string
    First referrer name.
    Example: Facebook
  • first_referrer_url string
    First referrer URL.
  • first_utm_parametersobject
    UTM parameters from the first interaction, used for advertising order attribution.
  • first_utm_campaign string
    First UTM campaign theme.
    Example: black_friday_2025
  • first_utm_content string
    First UTM campaign content.
    Example: textlink vs button
  • first_utm_medium string
    First UTM campaign medium.
    Example: social
  • first_utm_name string
    First UTM campaign name.
    Example: main_banner_v1
  • first_utm_source string
    First UTM campaign source.
    Example: google
  • first_utm_term string
    First UTM campaign term.
    Example: running+shoes
  • last_interactionobject
    The details of the buyer's latest interaction that led to the order.
  • last_interact_time string
    Time of the latest interaction. Format: ISO 8601.
    Example: 2025-03-21T17:48:14+08:00
  • last_interaction_source string
    Latest referrer source type. Valid values are:
    • Direct : Directly visiting the store
    • Social : Visiting the store through social media recommendations
    • Search : Visiting the store via search engine recommendations
    • Other : Visiting the store through recommendations from other websites
    • AI Chat : Visiting the store through recommendations from AI chat conversations
    Example: Social
  • last_landing_page string
    Latest landing page URL.
  • last_referrer_name string
    Latest referrer name.
    Example: Facebook
  • last_referrer_url string
    Latest referrer URL.
  • last_utm_parametersobject
    UTM parameters from the latest interaction, used for advertising order attribution.
  • last_utm_campaign string
    Latest UTM campaign theme.
    Example: black_friday_2025
  • last_utm_content string
    Latest UTM campaign content.
    Example: textlink vs button
  • last_utm_medium string
    Latest UTM campaign medium.
    Example: social
  • last_utm_name string
    Latest UTM campaign name.
    Example: main_banner_v1
  • last_utm_source string
    Latest UTM campaign source.
    Example: google
  • last_utm_term string
    Latest UTM campaign term.
    Example: running+shoes
  • order_seq string
    Order ID.
    Example: 21071058873779430237494658
  • order_time string
    Order completion time. Format: ISO 8601.
    Example: 2025-03-21T17:48:57+08:00
  • total_traffics integer
    The number of interactions a user has before order conversion.
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required

Body

required
{
  "orders": [
    "[\"21071058873779430237494658\",\"21069159447203440732216088\"]"
  ]
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/orders/order_attribution_info.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Get order attribution in bulk
Request
{
  "orders": [
    "21069159447203440732129066"
  ]
}
Response
{
  "data": [
    {
      "days_for_conversion": 1,
      "first_interaction": {
        "first_interact_time": "2025-03-21T17:46:17+08:00",
        "first_interaction_source": "Direct",
        "first_landing_page_url": "https://www.example.com/collections?utm_content=textlink&utm_campaign=black_friday_2025&utm_term=running&utm_source=google&utm_name=main_banner_v1&utm_medium=social",
        "first_referrer_name": "Direct",
        "first_referrer_url": null,
        "first_utm_parameters": {
          "first_utm_campaign": "black_friday_2025",
          "first_utm_content": "textlink",
          "first_utm_medium": "social",
          "first_utm_name": "main_banner_v1",
          "first_utm_source": "google",
          "first_utm_term": "running"
        }
      },
      "last_interaction": {
        "last_interact_time": "2025-03-21T17:48:14+08:00",
        "last_interaction_source": "Search",
        "last_landing_page": "https://www.example.com/",
        "last_referrer_name": "Google",
        "last_referrer_url": "https://www.example.com/",
        "last_utm_parameters": {
          "last_utm_campaign": null,
          "last_utm_content": null,
          "last_utm_medium": null,
          "last_utm_name": null,
          "last_utm_source": null,
          "last_utm_term": null
        }
      },
      "order_seq": "21069159447203440732129066",
      "order_time": "2025-03-21T17:48:57+08:00",
      "total_traffics": 2
    }
  ]
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.