Requires write_marketing_event access scope.
For more info , refer to:
POST https://{handle}.myshopline.com/admin/openapi/v20250601/sales/flow/batch_sync_flow_data.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 .
batch sync flow data
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
  • app_key string required
    appKey
    Example: ee89294e244543bd9422b446de9dece9cf0ea14e
  • flow_data_listobject[] required
    Data list , max 100
  • delete_flow_node_data_listobject[]
    Process activity removed
  • bounce_rate string
    Bounce back rate
    Example: 10
  • buyer_num long required
    Number of users ordered
    Example: 5
  • click_rate string
    Click-through
    Example: 56.6
  • fail_rate string
    Failure rate
    Example: 0
  • has_delivery_num long required
    Delivery quantity
    Example: 5
  • has_send_num long required
    Sent quantity
    Example: 5
  • node_id string required
    Node id
    Example: 5a206848-5e7e-4e50-93de-01bb4d9c7ac5
  • occurred_on long required
    Data time , millisecond time stamp
    Example: 1672365600000
  • open_rate string
    Opening rate
    Example: 4
  • order_amount long required
    Sales , unit division
    Example: 344
  • order_num long required
    Number of orders
    Example: 5
  • parent_node_id string
    Parent node id for sorting , merge show
    Example: 5a206848-5e7e-4e50-93de-01bb4d9c7ac5
  • preview_image_url string
    Preview picture url
  • unsubscribe_rate string
    The cancellation rate
    Example: 0
  • flow_id string required
    Process id
    Example: 5598349859474639045
  • flow_node_data_listobject[]
    Sales
  • bounce_rate string
    Bounce back rate
    Example: 3
  • buyer_num long required
    Number of users ordered
    Example: 4
  • click_rate string
    Click-through
    Example: 80
  • fail_rate string
    Failure rate
    Example: 80
  • has_delivery_num long required
    Delivery quantity
    Example: 3
  • has_send_num long required
    Sent quantity
    Example: 3
  • node_id string required
    Node id
    Example: 5a206848-5e7e-4e50-93de-01bb4d9c7ac5
  • occurred_on long required
    Data time , millisecond time stamp
    Example: 1672365600000
  • open_rate string
    Opening rate
    Example: 3
  • order_amount long required
    Sales , unit division
    Example: 220
  • order_num long required
    Number of orders
    Example: 4
  • parent_node_id string
    Parent node id for sorting , merge show
    Example: 5a206848-5e7e-4e50-93de-01bb4d9c7ac5
  • preview_image_url string
    Preview picture url
    Example: https://kmalgo.oss-ap-southeast-1.aliyuncs.com/material_ec2/2022-09-24/be7a1b5b947d47529c97bc78de6b
  • unsubscribe_rate string
    The cancellation rate
    Example: 0
  • occurred_on long required
    Data time , millisecond time stamp
    Example: 1672365600000
  • order_amount long required
    Sales , unit division
  • order_num long required
    Order qty
  • send_count long required
    Number of send
    Example: 1
  • trigger_num long required
    Trigger count
    Example: 4
  • source_type string required
    Source type
    Example: smartpush-app
  • store_id string required
    Store id
    Example: 1658921299465
Response
For more information about status codes, see Http status code.

Response Headers
  • traceId
    traceId
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

header required

Body

required
{
  "app_key": "ee89294e244543bd9422b446de9dece9cf0ea14e",
  "flow_data_list": [
    {
      "delete_flow_node_data_list": [
        {
          "bounce_rate": "10",
          "buyer_num": 5,
          "click_rate": "56.6",
          "fail_rate": "0",
          "has_delivery_num": 5,
          "has_send_num": 5,
          "node_id": "5a206848-5e7e-4e50-93de-01bb4d9c7ac5",
          "occurred_on": 1672365600000,
          "open_rate": "4",
          "order_amount": 344,
          "order_num": 5,
          "parent_node_id": "5a206848-5e7e-4e50-93de-01bb4d9c7ac5",
          "preview_image_url": "",
          "unsubscribe_rate": "0"
        }
      ],
      "flow_id": "5598349859474639045",
      "flow_node_data_list": [
        {
          "bounce_rate": "3",
          "buyer_num": 4,
          "click_rate": "80",
          "fail_rate": "80",
          "has_delivery_num": 3,
          "has_send_num": 3,
          "node_id": "5a206848-5e7e-4e50-93de-01bb4d9c7ac5",
          "occurred_on": 1672365600000,
          "open_rate": "3",
          "order_amount": 220,
          "order_num": 4,
          "parent_node_id": "5a206848-5e7e-4e50-93de-01bb4d9c7ac5",
          "preview_image_url": "https://kmalgo.oss-ap-southeast-1.aliyuncs.com/material_ec2/2022-09-24/be7a1b5b947d47529c97bc78de6b",
          "unsubscribe_rate": "0"
        }
      ],
      "occurred_on": 1672365600000,
      "order_amount": 0,
      "order_num": 0,
      "send_count": 1,
      "trigger_num": 4
    }
  ],
  "source_type": "smartpush-app",
  "store_id": "1658921299465"
}

Language

curl --request POST \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/sales/flow/batch_sync_flow_data.json \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'accept: application/json'
Examples
Sync statistics to flow
Request
{
"app_key": "ee89294e244543bd9422b446de9dece9cf0ea14e",
"flow_data_list": [
{
"delete_flow_node_data_list": [
{
"bounce_rate": "0",
"buyer_num": "100",
"click_rate": "0.2",
"fail_rate": "0",
"has_delivery_num": "12",
"has_send_num": "12",
"node_id": "1ec9a4a4-8a0c-459d-8214-8347eff24270",
"occurred_on": "1672365600000",
"open_rate": "0.9",
"order_amount": "200",
"order_num": "2",
"unsubscribe_rate": "0"
}
],
"flow_id": "6062082672162813673",
"flow_node_data_list": [
{
"bounce_rate": "0",
"buyer_num": "0",
"click_rate": "0",
"has_delivery_num": "1",
"has_send_num": "1",
"node_id": "5a206848-5e7e-4e50-93de-01bb4d9c7ac5",
"occurred_on": "1672365600000",
"open_rate": "3",
"order_amount": "0",
"order_num": "0",
"preview_image_url": "https://kmalgo.oss-ap-southeast-1.aliyuncs.com/material_ec2/2022-09-24/be7a1b5b947d47529c97bc78de6b",
"unsubscribe_rate": "0"
}
],
"occurred_on": "1672365600000",
"order_amount": "0",
"order_num": "0",
"send_count": "1",
"trigger_num": "4"
}
],
"source_type": "smartpush-app",
"store_id": "1658921299465"
}
Response
{}
Was this article helpful to you?