Process Statistics Synchronization

Requires write_marketing_event access scope.

For more info, refer to:

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

app_key string required

appKey
Example: ee89294e244543bd9422b446de9dece9cf0ea14e
flow_data_listobject[] required

Data list , max 100
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
delete_flow_node_data_listobject[]

Process activity removed
order_amount long required

Sales , unit division
Example: 344
bounce_rate string

Bounce back rate
Example: 10
open_rate string

Opening rate
Example: 4
parent_node_id string

Parent node id for sorting , merge show
Example: 5a206848-5e7e-4e50-93de-01bb4d9c7ac5
buyer_num long required

Number of users ordered
Example: 5
has_send_num long required

Sent quantity
Example: 5
occurred_on long required

Data time , millisecond time stamp
Example: 1672365600000
has_delivery_num long required

Delivery quantity
Example: 5
click_rate string

Click-through
Example: 56.6
fail_rate string

Failure rate
Example: 0
node_id string required

Node id
Example: 5a206848-5e7e-4e50-93de-01bb4d9c7ac5
preview_image_url string

Preview picture url
unsubscribe_rate string

The cancellation rate
Example: 0
order_num long required

Number of orders
Example: 5
flow_id string required

Process id
Example: 5598349859474639045
flow_node_data_listobject[]

Sales
fail_rate string

Failure rate
Example: 80
parent_node_id string

Parent node id for sorting , merge show
Example: 5a206848-5e7e-4e50-93de-01bb4d9c7ac5
unsubscribe_rate string

The cancellation rate
Example: 0
has_delivery_num long required

Delivery quantity
Example: 3
occurred_on long required

Data time , millisecond time stamp
Example: 1672365600000
order_amount long required

Sales , unit division
Example: 220
preview_image_url string

Preview picture url
Example: https://kmalgo.oss-ap-southeast-1.aliyuncs.com/material_ec2/2022-09-24/be7a1b5b947d47529c97bc78de6b
buyer_num long required

Number of users ordered
Example: 4
has_send_num long required

Sent quantity
Example: 3
node_id string required

Node id
Example: 5a206848-5e7e-4e50-93de-01bb4d9c7ac5
open_rate string

Opening rate
Example: 3
order_num long required

Number of orders
Example: 4
bounce_rate string

Bounce back rate
Example: 3
click_rate string

Click-through
Example: 80
source_type string required

Source type
Example: smartpush-app
store_id string required

Store id
Example: 1658921299465

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.

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "source_type": "smartpush-app",
  "store_id": "1658921299465",
  "app_key": "ee89294e244543bd9422b446de9dece9cf0ea14e",
  "flow_data_list": [
    {
      "occurred_on": 1672365600000,
      "order_amount": 0,
      "order_num": 0,
      "send_count": 1,
      "trigger_num": 4,
      "delete_flow_node_data_list": [
        {
          "node_id": "5a206848-5e7e-4e50-93de-01bb4d9c7ac5",
          "buyer_num": 5,
          "occurred_on": 1672365600000,
          "preview_image_url": "",
          "bounce_rate": "10",
          "fail_rate": "0",
          "order_amount": 344,
          "unsubscribe_rate": "0",
          "open_rate": "4",
          "has_delivery_num": 5,
          "has_send_num": 5,
          "order_num": 5,
          "parent_node_id": "5a206848-5e7e-4e50-93de-01bb4d9c7ac5",
          "click_rate": "56.6"
        }
      ],
      "flow_id": "5598349859474639045",
      "flow_node_data_list": [
        {
          "node_id": "5a206848-5e7e-4e50-93de-01bb4d9c7ac5",
          "fail_rate": "80",
          "has_send_num": 3,
          "occurred_on": 1672365600000,
          "order_amount": 220,
          "unsubscribe_rate": "0",
          "click_rate": "80",
          "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",
          "bounce_rate": "3",
          "buyer_num": 4,
          "has_delivery_num": 3,
          "open_rate": "3"
        }
      ]
    }
  ]
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/sales/flow/batch_sync_flow_data.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