新增企业店铺订单
最后更新:2024/04/25企业可通过此接口将自有店铺的订单同步到本应用客户画像内的订单数据中,若是新订单则还会在客户画像自动创建购买商品的客户动态( 历史订单不会创建客户动态)。
其中,下单时间在“同步订单时间点对应的小时整点(例如8:20同步的订单,小时整点为8点)”之前的订单视为历史订单,在那之后的订单视为新订单;
该接口有调用频率限制:最多100次/秒,超过调用频率后可能会被限制使用该接口。
请求方式: POST(HTTPS)
请求地址: https://open.wshoto.com/openapi/mall/external/order/add?access_token=x
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
Body参数:
{
"order_code": "fake_data",
"parent_order_code": "fake_data",
"shop_id": 35,
"sale_type": 1,
"order_type_name": "fake_data",
"payment_status": 1,
"order_status": 1,
"order_view_status": "fake_data",
"delivery_type": 5,
"buyer_id": "fake_data",
"shipping_amount": 39.84,
"total_quantity": 91,
"order_discount_amount": 19.29,
"order_total_amount": 79.22,
"order_actual_pay": 84.13,
"order_time": 78,
"pay_time": 76,
"shipping_time": 91,
"cancel_time": 89,
"finish_time": 36,
"buyer_remark": "fake_data",
"seller_remark": "fake_data",
"ext": {
"tmp_key": "tmp_value"
},
"user_id": "abc",
"sku_detail": [
{
"sku_id": "fake_data",
"sku_name": "fake_data",
"spu_id": "fake_data",
"spu_name": "fake_data",
"thumbnail": "fake_data",
"price": 21,
"quantity": 3,
"sku_total_amount": 92.36,
"sku_discount_amount": 54.95,
"sku_actual_pay": 48.94
}
]
}
参数 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
order_code | string | 64 | 是 | 订单号,唯一值,该字段作为更新订单信息唯一条件 |
parent_order_code | string | 64 | 否 | 父订单号 |
shop_id | long | 是 | 店铺id | |
sale_type | int | 否 | 销售类型:1 订单 2 退单 3 换货单. 默认值为1 | |
order_type_name | string | 64 | 否 | 订单类型名称(类似:秒杀,拼团) |
payment_status | int | 是 | 支付状态 0:未支付 1:已支付 | |
order_status | int | 是 | 订单状态 0:进行中,1:已完成:2:已取消 | |
order_view_status | string | 20 | 是 | 订单展示状态 (用于页面展示,例如:已完成,未完成等等) |
delivery_type | int | 是 | 配送类型 0:无需配送 1:线下自提 2:线上配送 | |
buyer_id | string | 64 | 是 | 购买人id,以企业微信客户externalUserId数据为准 |
total_quantity | int | 是 | 商品总数量(如果sale_type为空或者是1时,total_quantity > 0;如果sale_type 为2或者3时,该值不限制正负和零) | |
shipping_amount | double | 是 | 运费,单位:元.最多支持小数点后两位小数,超出的部分将被忽略, 配送类型delivery_type为0,1时候,运费传0,其他场景则正常传入运费金额 |
|
order_discount_amount | double | 是 | 订单总优惠金额,单位:元.最多支持小数点后两位小数,超出的部分将被忽略 | |
order_total_amount | double | 是 | 订单总价,单位:元.最多支持小数点后两位小数,超出的部分将被忽略 | |
order_actual_pay | double | 是 | 订单总实付金额,单位:元.最多支持小数点后两位小数,超出的部分将被忽略 | |
order_time | long | 是 | 下单时间(yyyy-MM-dd HH:mm:ss),时间戳,精度:秒 | |
pay_time | long | 否 | 支付时间(yyyy-MM-dd HH:mm:ss),时间戳,精度:秒 | |
shipping_time | long | 否 | 发货时间(yyyy-MM-dd HH:mm:ss),时间戳,精度:秒 | |
cancel_time | long | 否 | 取消时间(yyyy-MM-dd HH:mm:ss),时间戳,精度:秒 | |
finish_time | long | 否 | 完成时间(yyyy-MM-dd HH:mm:ss),时间戳,精度:秒 | |
seller_remark | string | 255 | 否 | 商家备注 |
buyer_remark | string | 255 | 否 | 买家留言 |
ext | object | 否 | 扩展信息以key value的形式, KEY会作为页面左侧的菜单展示内容出现,value会作为页面左侧的菜单展示内容出现,value只能为字符串类型数据.(拓展字段key为“物流信息”时支持传入json格式数据,例如:{\"type\": \"link\", \"value\": \"https://www.xxx.com\\", \"desc\": \"点击查看物流\"},type-类型,外部链接类型type写死为 "link", value-外部链接的具体地址,desc-外部链接描述) |
|
user_id | string | 否 | 关联员工id,员工在本三方应用的密文用户id,可通过「获取成员列表」接口获取或通过「自建应用用户id批量转三方应用用户id」接口转换得到; 关联员工可作为订单的业绩归属和订单数据权限隔离依据,在订单详情页会展示此关联员工 |
|
sku_detail | Detail[] | 是 | 商品明细,数组长度最小长度为1 | |
sku_id | string | 64 | 否 | skuid |
sku_name | string | 64 | 否 | sku名称 |
spu_id | string | 64 | 是 | spuid |
spu_name | string | 64 | 是 | spu名称 |
thumbnail | string | 500 | 否 | 缩略图路径,默认使用系统缩略图 |
price | double | 是 | 商品单价,单位:元.最多支持小数点后两位小数,超出的部分将被忽略 | |
quantity | int | 是 | 数量(如果sale_type为空或者是1时,total_quantity > 0;如果sale_type 为2或者3时,该值不限制正负和零) | |
sku_discount_amount | double | 是 | 商品优惠金额,单位:元.最多支持小数点后两位小数,超出的部分将被忽略 | |
sku_total_amount | double | 是 | 商品总价,单位:元.最多支持小数点后两位小数,超出的部分将被忽略 | |
sku_actual_pay | double | 是 | 商品实付金额,单位:元.最多支持小数点后两位小数,超出的部分将被忽略 |
返回值:
{
"code": 0,
"msg": "请求成功",
"data": {
"order_code": ""
}
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 返回码 |
msg | string | 对返回码的文本描述内容 |
data | object | 返回信息 |
order_code | string | 订单号 |