--- title: "批量同步营销事件统计数据" description: "批量同步营销事件统计数据（创建营销参与）" doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/zh-hans-cn/docs/admin-rest-api/marketing/marketing-events/mass-sync-marketing-event-statistics' md: 'https://developer.shopline.com/zh-hans-cn/docs/admin-rest-api/marketing/marketing-events/mass-sync-marketing-event-statistics.md' --- # 批量同步营销事件统计数据 批量同步营销事件统计数据（创建营销参与） - **Base URL:** `https://{handle}.myshopline.com/admin/openapi` - **Required Scopes:** `write_marketing_event` - **API Version:** v20270301 - **API Type:** Admin - **API Protocol:** RESTful ## Endpoint ```http POST /sales/marketing_events/sync_data.json ``` ## Base URL * `https://{handle}.myshopline.com/admin/openapi` * `{handle}`: `handle` ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 `open001.myshopline.com` 的店铺，其 `handle` 是 `open001` 。 ## Required Permissions * `write_marketing_event` ## Request ### Request Headers * `Content-Type` string (required) 字段值固定为 `application/json; charset=utf-8`。 * `Authorization` string (required) 资源的访问令牌。参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。 ### Request Body * `marketing_activity_datas` array 营销事件数据，统计数据为全量数据 * `add_cart_sum` long 加购数 * `impression_num` long 曝光数，指展示次数 * `custom_sale_data_list` array 自定义拓展-销售数据，最多5个 * `value` string 数据值 * `name` string 数据名称，最长20个字符 * `tool_tips` string 提示语，最长30个字符 * `type` integer 数据类型,1-金额;2-百分比;3-数值 * `custom_activity_engagement_list` array 自定义拓展-活动参与度，最多5个 * `type` integer 数据类型,1-金额;2-百分比;3-数值 * `value` string 数据值 * `name` string 数据名称，最长20个字符 * `tool_tips` string 提示语，最长30个字符 * `order_amount` long 销售额 * `order_num` long 订单数 * `new_buyer_sum` long 新客数 * `unsubscribed_num` long 取消订阅数 * `check_out_sum` long 结账数 * `marketing_event_id` string 营销事件的唯一id * `spend_cost` long 营销成本 * `occurred_on` long 发生时间，标准13位时间戳 * `visitor_amount` long 访客数 * `click_num` long 点击数 * `old_buyer_sum` long 老客数 * `bounced_num` long 弹回数 * `order_product_sum` long 订单商品总数 * `has_send_num` long 发送数 * `has_delivery_num` long 送达数 * `order_visitor_amount` long 下单用户数 * `regional_visit_list` array 地区访问量-排行榜，最多5个 * `name` string 名称，最长200个字符 * `count` long 访问量 * `benefit_amount` long 优惠金额 * `reported_as_spam_num` long 报告为垃圾邮件数 * `get_unit_cost` long 获得单位成本 * `product_sale_list` array 商品销量-排行榜，最多10个 * `count` long 销量 * `product_id` string 商品id * `purchase_num` long 购买数 * `open_sum` long 打开数 ## Response ### Status Codes * `200` 更多状态码信息，参考 [HTTP 状态码](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/http-status-code.md?lang=zh-hans-cn)。 * `401` * `429` ### Response Headers * `traceId` 请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。 ### Response Body #### 200 * `sucess_count` integer 成功总数 #### 401 * `errors` string 错误描述。 #### 429 * `errors` string 错误描述。 ## OpenAPI Definition ```json { "description": "批量同步营销事件统计数据（创建营销参与）", "externalDocs": { "description": "接口使用的权限点: `write_marketing_event` ，更多权限点使用信息，请参考:", "url": "ec20/3cv5d7wpfgr6a8z5/xabczf5442284vkq?lang=zh-hans-cn", "errorTableDescription": "" }, "operationId": "srGU5dHy", "parameters": [ { "name": "Content-Type", "in": "header", "description": "字段值固定为 `application/json; charset=utf-8`。", "required": true, "style": "string", "schema": { "name": "Content-Type", "type": "string", "example": "application/json; charset=utf-8" } }, { "name": "Authorization", "in": "header", "description": "资源的访问令牌。参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。", "required": true, "style": "string", "schema": { "name": "Authorization", "description": "资源的访问令牌。请参考 [应用授权](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/app-authorization.md?lang=zh-hans-cn) 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入", "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" }, "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "marketing_activity_datas": { "name": "marketing_activity_datas", "description": "营销事件数据，统计数据为全量数据", "type": "array", "items": { "name": "marketing_activity_datas", "description": "营销事件数据，统计数据为全量数据", "type": "object", "properties": { "add_cart_sum": { "name": "add_cart_sum", "description": "加购数", "type": "long", "example": 100 }, "impression_num": { "name": "impression_num", "description": "曝光数，指展示次数", "type": "long", "example": 100 }, "custom_sale_data_list": { "name": "custom_sale_data_list", "description": " 自定义拓展-销售数据，最多5个", "type": "array", "items": { "name": "custom_sale_data_list", "description": " 自定义拓展-销售数据，最多5个", "type": "object", "properties": { "value": { "name": "value", "description": "数据值", "type": "string", "example": "100" }, "name": { "name": "name", "description": "数据名称，最长20个字符", "type": "string", "example": "FackbookOrderCount" }, "tool_tips": { "name": "tool_tips", "description": "提示语，最长30个字符", "type": "string", "example": "Order from Fackbook count" }, "type": { "name": "type", "description": " 数据类型,1-金额;2-百分比;3-数值", "type": "integer", "example": 3 } }, "example": { "type": 3, "value": "100", "name": "FackbookOrderCount", "tool_tips": "Order from Fackbook count" } }, "example": [ { "name": "FackbookOrderCount", "tool_tips": "Order from Fackbook count", "type": 3, "value": "100" } ] }, "custom_activity_engagement_list": { "name": "custom_activity_engagement_list", "description": "自定义拓展-活动参与度，最多5个", "type": "array", "items": { "name": "custom_activity_engagement_list", "description": "自定义拓展-活动参与度，最多5个", "type": "object", "properties": { "type": { "name": "type", "description": " 数据类型,1-金额;2-百分比;3-数值", "type": "integer", "example": 2 }, "value": { "name": "value", "description": "数据值", "type": "string", "example": "0.09" }, "name": { "name": "name", "description": "数据名称，最长20个字符", "type": "string", "example": "FackbookOrderConversionRate" }, "tool_tips": { "name": "tool_tips", "description": "提示语，最长30个字符", "type": "string", "example": "Fackboo order conversion rate" } }, "example": { "name": "FackbookOrderConversionRate", "tool_tips": "Fackboo order conversion rate", "type": 2, "value": "0.09" } }, "example": [ { "name": "FackbookOrderConversionRate", "tool_tips": "Fackboo order conversion rate", "type": 2, "value": "0.09" } ] }, "order_amount": { "name": "order_amount", "description": "销售额", "type": "long", "example": 100 }, "order_num": { "name": "order_num", "description": "订单数", "type": "long", "example": 100 }, "new_buyer_sum": { "name": "new_buyer_sum", "description": "新客数", "type": "long", "example": 100 }, "unsubscribed_num": { "name": "unsubscribed_num", "description": "取消订阅数", "type": "long", "example": 100 }, "check_out_sum": { "name": "check_out_sum", "description": "结账数", "type": "long", "example": 100 }, "marketing_event_id": { "name": "marketing_event_id", "description": "营销事件的唯一id", "type": "string", "example": "MA_12323312324" }, "spend_cost": { "name": "spend_cost", "description": "营销成本", "type": "long", "example": 100 }, "occurred_on": { "name": "occurred_on", "description": "发生时间，标准13位时间戳", "type": "long", "example": 1672246800000 }, "visitor_amount": { "name": "visitor_amount", "description": "访客数", "type": "long", "example": 100 }, "click_num": { "name": "click_num", "description": "点击数", "type": "long", "example": 100 }, "old_buyer_sum": { "name": "old_buyer_sum", "description": "老客数", "type": "long", "example": 1001672246800000 }, "bounced_num": { "name": "bounced_num", "description": "弹回数", "type": "long", "example": 100 }, "order_product_sum": { "name": "order_product_sum", "description": "订单商品总数", "type": "long", "example": 100 }, "has_send_num": { "name": "has_send_num", "description": "发送数", "type": "long", "example": 100 }, "has_delivery_num": { "name": "has_delivery_num", "description": "送达数", "type": "long", "example": 100 }, "order_visitor_amount": { "name": "order_visitor_amount", "description": "下单用户数", "type": "long", "example": 100 }, "regional_visit_list": { "name": "regional_visit_list", "description": "地区访问量-排行榜，最多5个", "type": "array", "items": { "name": "regional_visit_list", "description": "地区访问量-排行榜，最多5个", "type": "object", "properties": { "name": { "name": "name", "description": "名称，最长200个字符", "type": "string", "example": "ua" }, "count": { "name": "count", "description": "访问量", "type": "long", "example": 100 } }, "example": { "count": 100, "name": "ua" } }, "example": [ { "count": 100, "name": "ua" } ] }, "benefit_amount": { "name": "benefit_amount", "description": "优惠金额", "type": "long", "example": 100 }, "reported_as_spam_num": { "name": "reported_as_spam_num", "description": "报告为垃圾邮件数", "type": "long", "example": 100 }, "get_unit_cost": { "name": "get_unit_cost", "description": "获得单位成本", "type": "long", "example": 100 }, "product_sale_list": { "name": "product_sale_list", "description": "商品销量-排行榜，最多10个", "type": "array", "items": { "name": "product_sale_list", "description": "商品销量-排行榜，最多10个", "type": "object", "properties": { "count": { "name": "count", "description": "销量", "type": "long", "example": 100 }, "product_id": { "name": "product_id", "description": "商品id", "type": "string", "example": "16062938070772167548642145" } }, "example": { "count": 100, "product_id": "16062938070772167548642145" } }, "example": [ { "count": 100, "product_id": "16062938070772167548642145" } ] }, "purchase_num": { "name": "purchase_num", "description": "购买数", "type": "long", "example": 100 }, "open_sum": { "name": "open_sum", "description": "打开数", "type": "long", "example": 100 } }, "example": { "order_visitor_amount": 100, "unsubscribed_num": 100, "has_delivery_num": 100, "visitor_amount": 100, "regional_visit_list": [ { "count": 100, "name": "ua" } ], "spend_cost": 100, "bounced_num": 100, "custom_sale_data_list": [ { "type": 3, "value": "100", "name": "FackbookOrderCount", "tool_tips": "Order from Fackbook count" } ], "open_sum": 100, "reported_as_spam_num": 100, "has_send_num": 100, "marketing_event_id": "MA_12323312324", "click_num": 100, "impression_num": 100, "add_cart_sum": 100, "new_buyer_sum": 100, "order_product_sum": 100, "product_sale_list": [ { "count": 100, "product_id": "16062938070772167548642145" } ], "occurred_on": 1672246800000, "purchase_num": 100, "order_amount": 100, "get_unit_cost": 100, "check_out_sum": 100, "benefit_amount": 100, "custom_activity_engagement_list": [ { "value": "0.09", "name": "FackbookOrderConversionRate", "tool_tips": "Fackboo order conversion rate", "type": 2 } ], "old_buyer_sum": 1001672246800000, "order_num": 100 } }, "example": [ { "order_num": 100, "purchase_num": 100, "check_out_sum": 100, "product_sale_list": [ { "count": 100, "product_id": "16062938070772167548642145" } ], "occurred_on": 1672246800000, "marketing_event_id": "MA_12323312324", "custom_activity_engagement_list": [ { "type": 2, "value": "0.09", "name": "FackbookOrderConversionRate", "tool_tips": "Fackboo order conversion rate" } ], "new_buyer_sum": 100, "open_sum": 100, "spend_cost": 100, "has_delivery_num": 100, "add_cart_sum": 100, "impression_num": 100, "visitor_amount": 100, "old_buyer_sum": 1001672246800000, "order_visitor_amount": 100, "order_product_sum": 100, "order_amount": 100, "has_send_num": 100, "regional_visit_list": [ { "name": "ua", "count": 100 } ], "click_num": 100, "reported_as_spam_num": 100, "bounced_num": 100, "custom_sale_data_list": [ { "type": 3, "value": "100", "name": "FackbookOrderCount", "tool_tips": "Order from Fackbook count" } ], "benefit_amount": 100, "unsubscribed_num": 100, "get_unit_cost": 100 } ] } }, "example": { "marketing_activity_datas": [ { "custom_sale_data_list": [ { "value": "100", "name": "FackbookOrderCount", "tool_tips": "Order from Fackbook count", "type": 3 } ], "open_sum": 100, "order_num": 100, "get_unit_cost": 100, "has_delivery_num": 100, "order_visitor_amount": 100, "unsubscribed_num": 100, "regional_visit_list": [ { "name": "ua", "count": 100 } ], "order_amount": 100, "impression_num": 100, "custom_activity_engagement_list": [ { "name": "FackbookOrderConversionRate", "tool_tips": "Fackboo order conversion rate", "type": 2, "value": "0.09" } ], "spend_cost": 100, "visitor_amount": 100, "check_out_sum": 100, "occurred_on": 1672246800000, "benefit_amount": 100, "new_buyer_sum": 100, "reported_as_spam_num": 100, "purchase_num": 100, "add_cart_sum": 100, "has_send_num": 100, "old_buyer_sum": 1001672246800000, "product_sale_list": [ { "count": 100, "product_id": "16062938070772167548642145" } ], "bounced_num": 100, "order_product_sum": 100, "marketing_event_id": "MA_12323312324", "click_num": 100 } ] } } } }, "required": true }, "responses": { "200": { "description": "更多状态码信息，参考 [HTTP 状态码](https://developer.shopline.com/zh-hans-cn/docs/apps/api-instructions-for-use/http-status-code.md?lang=zh-hans-cn)。", "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "sucess_count": { "name": "sucess_count", "description": "成功总数", "type": "integer", "example": 1 } }, "example": { "sucess_count": 1 } } } } }, "401": { "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "错误描述。", "type": "string" } }, "required": [ "errors" ] } } } }, "429": { "headers": { "traceId": { "description": "请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "错误描述。", "type": "string" } }, "required": [ "errors" ] } } } } }, "security": [ { "oauth2": [] } ], "method": "post", "path": "/sales/marketing_events/sync_data.json", "servers": [ { "url": "https://{handle}.myshopline.com/admin/openapi", "variables": { "handle": { "default": "openapiceshidianpu", "description": "`handle` ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 `open001.myshopline.com` 的店铺，其 `handle` 是 `open001` 。" } } } ], "info": { "title": "批量同步营销事件统计数据", "version": "v20270301" }, "authIndexes": [ "write_marketing_event" ] } ```