尘锋SCRM开放平台
  1. 订单
尘锋SCRM开放平台
  • 接入前准备
    • 接口鉴权说明
    • 回调接入指南
    • 报错code码说明
    • 省市区code码
    • 获取附件URL访问签名
    • 更新日志
  • 对接方案介绍
    • 联系人架构介绍
    • 员工概览
    • ERP打通
    • 客户信息打通
    • 订单打通
    • 微信unionid互通场景
    • 获客助手对接场景
  • API文档
    • 客户
      • 联系人
        • 联系人管理
          • 查询联系人
          • 新增联系人
          • 编辑联系人
          • 删除联系人
          • 编辑联系人状态
          • 获取联系客户统计数据
          • 外部ID
            • 删除联系人外部ID
            • 更新联系人外部ID
            • 绑定外部ID与联系人ID
        • 联系人字段ID
          • 查询联系人自定义字段模板
          • 查询跟进状态列表
          • 查询联系人公海列表
          • 无效&放弃&删除原因查询
          • 联系人类型与标签和自定义字段关联关系
          • 联系人类型
          • 联系人联系方式
          • 多级联选列表
          • 来源
            • 来源列表查询(企业&联系人)
            • 编辑来源
            • 创建来源
        • 标签库
          • 给联系人打标签
          • 好友标签(企业微信标签)
            • 查询好友标签列表
            • 编辑好友标签
            • 新增好友标签
          • 联系人标签
            • 编辑联系人标签值
            • 新增联系人标签组
            • 编辑联系人标签组
            • 新增联系人标签值
            • 查询联系人标签列表
        • 跟进团队
          • 编辑(联系人/企业)共享人
          • 查询创建⼈跟进⼈和共享⼈
        • 跟进提醒
          • 查询跟进提醒
          • 新增跟进提醒
          • 编辑跟进提醒
          • 完成跟进提醒
          • 删除跟进提醒
        • 跟进记录
          • 查询跟进记录
          • 查询跟进记录模板
          • 新增跟进记录
        • 在职继承
          • 分配在职成员联系人
          • 查询接替状态
        • 签到
          • 查询签到记录
        • 行为轨迹
          • 轨迹参数说明
          • 上报轨迹事件
          • 查询轨迹事件
          • 查询旅程项目
      • 企业
        • 企业字段ID
          • 查询企业字段ID
          • 查询企业跟进状态
          • 查询企业公海列表
          • 来源列表查询(企业&联系人)
          • 查询企业类型
          • 查询企业删除原因
          • 查询多级联选
        • 企业管理
          • 查询企业列表
          • 新增企业
          • 编辑企业
          • 删除企业
          • 企业绑定联系人
          • 更新企业跟进人
          • 放弃企业到公海
          • 分配公海中企业
        • 企业标签
          • 查询企业标签
      • 好友
        • 查询好友列表
        • 编辑好友信息
        • 好友关联联系人
        • 好友取消关联联系人
        • unionId上传&关联externalUserId
      • 客户群
        • 查询客户群列表
        • 查询客户群详情
        • 编辑客户群标签
        • 查询群标签列表
        • 查询群聊数据统计-按群主聚合方式
        • 查询群聊数据统计-按自然日聚合方式
    • 销售机会
      • 销售机会管理
        • 查询销售机会列表
        • 新增销售机会
        • 编辑销售机会
        • 删除销售机会
        • 新增销售机会协同人
        • 移除销售机会协同人
        • 销售机会绑定订单
        • 销售机会解绑订单
        • 销售机会阶段变更记录
      • 销售机会字段ID
        • 查询销售机会字段ID
        • 查询销售机会类型
        • 查询销售机会阶段
        • 查询协同角色ID
        • 查询竞争对手
        • 查询丢单原因
        • 查询销售机会多级联选选项
        • 修改销售机会多级联选选项
    • 交易
      • 订单
        • 查询订单列表
        • 新增&编辑订单
        • 查询订单自定义字段ID
        • 修改订单归属人/归属部门
        • 订单发货
        • 查询物流公司列表
        • 查询订单来源
        • 编辑自主下单
      • 售后单
        • 查询售后单列表
        • 创建售后单
        • 售后单操作退款
      • 回款单
        • 查询回款单列表
        • 创建回款单
      • 会员积分
        • 查询会员列表
        • 新增会员
        • 变更会员等级
        • 查询会员等级变更明细
        • 变更会员积分
        • 变更会员成长值
        • 查询会员积分变更明细
        • 使用会员积分
      • 商品类
        • 查询商品列表
        • 查询商品详情
        • 新增商品
        • 商品图片/视频上传
        • 编辑商品库存
    • 员工
      • 查询员工信息
      • 编辑员工信息
      • 部门信息查询
      • 批量为员工启用系统
      • 给员工发送企微通知
    • 预约单
      • 查询预约列表
    • 评论
      • 查询评论列表接口
    • 运营
      • 活码
        • 查询活码详情
        • 查询活码列表
      • 表单
        • 查询表单字段模板
        • 查询表单填写内容
      • sop
        • 查询sop列表
        • 查询sop执行情况列表
      • 素材
        • 查询素材列表
        • 查询素材详情
        • 查询员工发送素材明细
      • 营销任务
        • 查询营销任务执行情况
        • 查询营销任务列表
      • 朋友圈
        • 获取企业发布的朋友圈员工执行情况
        • 获取朋友圈的互动数据
        • 获取企业全部发布列表
      • 获客助手短链
        • 查询获客助手来源及链接信息
        • 查询获客助手配置列表
        • 获取专属短链详情列表
        • 生成用户专属短链接
    • 会话存档
      • 上传会话存档记录
    • 通话短信
      • 查询通话记录列表
      • 电销手机外呼
      • 查询通话录音转文字结果
      • 查询短信记录列表
    • 页面嵌入
      • 页面嵌入配置说明
      • 解密嵌入页面传参
      • 菜单嵌入说明
    • 应用
      • 楼盘管理
        • 查询楼盘
        • 新增楼盘
        • 删除楼盘
      • 外联盟管理
        • 查询外联盟
        • 新增外联盟
        • 编辑外联盟
        • 删除外联盟
        • 启停用外联盟
        • 查询外联盟字段ID
        • 外联盟多级联选选项
  • 事件推送
    • 联系人
      • 新增联系人事件
      • 编辑联系人事件
      • 联系人跟进状态变更事件
      • 删除联系人事件
      • 联系人合并事件
      • 跟进提醒
        • 联系人跟进提醒状态变更
      • 联系人流转
        • 跟进团队变更事件
        • 联系人流转事件
      • 跟进记录
        • 跟进记录操作事件
    • 好友
      • 添加好友事件
      • 好友与联系人绑定事件
      • 好友与联系人解绑事件
      • 好友主动删除员工事件
      • 员工主动删除好友事件
      • 更新好友信息事件
    • 客户群
      • 新增客户群事件
      • 变更客户群事件
      • 解散客户群事件
    • 销售机会
      • 销售机会负责人变更
      • 销售机会协同人变更
      • 销售机会操作事件
    • 企业
      • 企业跟进团队流转事件
      • 企业新增事件
      • 编辑企业事件
      • 企业跟进状态变更事件
      • 企业删除事件
    • 交易
      • 推送说明
      • 订单
        • 新增订单事件
        • 编辑订单事件
        • 订单状态变更事件
        • 订单支付完成事件
        • 删除订单事件
      • 售后单
        • 售后单创建事件
        • 编辑售后单事件
        • 售后单状态变更事件
        • 删除售后单事件
        • 售后单退款成功事件
      • 商品
        • 新增商品事件
        • 商品库存变更事件
        • 编辑商品事件
        • 商品状态变更事件
      • 会员积分
        • 新增会员事件
        • 会员合并事件
        • 成长值变更事件
        • 会员等级变更事件
        • 会员积分变更事件
    • 工单
      • 新增工单事件
      • 流转工单事件
      • 编辑工单事件
    • 运营
      • 提交表单事件
    • 通话短信
      • 通话记录操作事件
      • 短信记录操作事件
    • 预约单
      • 新增预约单事件
    • 应用
      • 楼盘
        • 新增楼盘事件
        • 编辑楼盘事件
        • 删除楼盘事件
      • 外联盟
        • 新增外联盟事件
        • 编辑外联盟事件
        • 删除外联盟事件
        • 启/停外联盟事件
        • 外联盟审批完成事件
  1. 订单

新增&编辑订单

编辑订单时,需要传入全量订单数据,暂不支持编辑部分订单信息
导入订单会以“代客下单”类型存在系统中,导入成功后,会根据当前订单状态发送消息通知对应员工
订单核心元素(订单必备内容)
购买人为关联联系人(或企业)、业绩归属员工、业绩归属部门、订单创建人、商品(skuList)
商品说明
一个商品(goods)支持创建多个规格(sku)
商品库支持通过接口维护 新增商品
商品库也支持通过尘锋管理后台维护,操作路径为:"交易-商品-商品列表"
商品分为虚拟商品和实物商品,虚拟商品无需发货,不需要填写收货地址,实物商品必须填写收货地址 省市区code码
不支持导入订单时自动创建商品
业绩归属人、归属部门等,与系统的业绩目标功能有关联 查询员工信息
当传入的orderId 或 outOrderNumber 已在系统中存在时,将进行修改操作
如果需要修改某订单所关联的outOrderNumber,请求参数需要同时携带orderId、新的outOrderNumber
订单来源说明
代客下单为自定义来源:请先在尘锋管理后台维护来源库,操作路径为"交易-店铺设置-店铺设置-订单设置-订单来源设置",再通过接口获取枚举值 查询订单来源
订单自定义字段说明
如预设字段未能满足您的需求,可使用自定义字段存储个性化信息,请先在尘锋管理后台维护字段数据,操作路径为"交易-店铺-店铺设置-订单设置-订单自定义字段设置",再通过接口获取枚举值 查询订单自定义字段ID
`POST https://qw-openapi-tx.dustess.com/java-data-exchange-srv/api/order/v1/create-valet?accessToken=`

Content-Type: application/json
接口限制:每分钟调用600次;单次最多导入50条;
请求参数
请求参数名类型说明是否必须
orderListObject[]订单列表(最大50条数据)true
orderList.addressObject订单收货地址信息,购买虚拟商品不需要传,购买实物商品可以传false
orderList.address.addressString详细地址false
orderList.address.areaString区code省市区code码false
orderList.address.areaNameString区名称false
orderList.address.cityString市codefalse
orderList.address.cityNameString市名称false
orderList.address.consigneeString收货人false
orderList.address.mobileString收货人手机号false
orderList.address.provinceString省codefalse
orderList.address.provinceNameString省名称false
orderList.cnameString客户名称false
orderList.creatorString订单创建人Id(代客下单->创建人=创建员工id)true
orderList.customFieldsObject[]自定义字段数组 查询订单自定义字段IDfalse
orderList.customFields.idString自定义字段Idtrue
orderList.customFields.aryValString[]数组类型值,默认值为:[]false
orderList.customFields.numValInt数字类型值,支持2位小数。默认值为:0true
orderList.customFields.strValString字符串类型值,默认值为:空字符串""false
orderList.customFields.valTypeString自定义字段类型,valType=file自定义附件时,对应的资源id,放入aryValtrue
orderList.customerIdString联系人Id (联系人Id、外部系统联系人Id、企业Id至少必传一)查询联系人false
orderList.externalCustomerIdString外部系统联系人Id (联系人Id、外部系统联系人Id、企业Id至少必传一)false
orderList.corpIdString企业Id (联系人Id、外部系统联系人Id、企业Id至少必传一)查询企业列表false
orderList.dealTimeString订单的下单时间,不能晚于当前时间,格式 yyyy-MM-dd HH:mm:sstrue
orderList.depIdString业绩归属部门Id,即该订单业绩归属于哪个部门,部门idtrue
orderList.followUserIdString业绩归属人Id,即该订单业绩归属于哪个员工,员工id 查询员工信息true
orderList.goodsObject[]商品数据 查询商品列表true
orderList.goods.skuIdString商品SKU IDtrue
orderList.goods.numberInt商品数量true
orderList.goods.amountString该商品实付价格(总价,单位:元),最多两位小数,"1.01"元true
orderList.isPayBool是否已经支付false
orderList.isVerifyBool是否校验起购数量:false 不校验,true 校验false
orderList.noteString备注信息false
orderList.orderIdString尘锋订单id(和外部订单id至少必传一个)false
orderList.outOrderNumberString外部系统订单号(和尘锋订单id至少必传一个),如需修改订单的外部订单号,参考文档头部说明false
orderList.payTypeInt付款方式:1 线上付款;2 线下付款true
orderList.sourceObject订单来源 查询订单来源false
orderList.source.shopNameString店铺名称false
orderList.sourceCodeInt来源Codefalse
orderList.statusInt订单状态:10 待支付、 20 待发货、 40 待收货、 50 已完成、 70 已取消true
orderList.vouchObject[]订单凭证信息;已付款需上传凭证(最多10个)false
orderList.vouch.nameString资源名称false
orderList.vouch.urlIdString资源通过接口上传后获取的Id 商品图片/视频上传false
orderList.auditTimeString审核时间:格式 yyyy-MM-dd HH:mm:ssfalse
orderList.confirmReceiptTimeString确认收货时间:格式 yyyy-MM-dd HH:mm:ssfalse
orderList.deliveryTimeString发货时间:格式 yyyy-MM-dd HH:mm:ssfalse
orderList.payTimeString支付时间:格式 yyyy-MM-dd HH:mm:ssfalse
orderList.refundTimeString退款时间:格式 yyyy-MM-dd HH:mm:ssfalse
orderList.withoutShipString是否需要发货 true 无需发货,false 需要false
orderList.deliveryFeeString订单运费金额 (单位:元),最多2位小数,"1.01"元false
请求参数示例
{
	"orderList": [{
		"address": {
			"address": "四川省成都市高新区天府二街",
			"area": "50001",
			"areaName": "成都",
			"city": "111",
			"cityName": "成都",
			"consignee": "张嘿嘿",
			"mobile": "18888888888",
			"province": "028",
			"provinceName": "四川省"
		},
		"auditTime": "2021-09-22 11:00:00",
		"cname": "",
		"confirmReceiptTime": "",
		"creator": "1",
		"customFields": [{
				"aryVal": [],
				"id": "field0",
				"numVal": 0,
				"strVal": "单选项值",
				"valType": "radio"
			},
			{
				"aryVal": [],
				"id": "field2",
				"numVal": 0,
				"strVal": "多行文本",
				"valType": "multi"
			},
			{
				"aryVal": [],
				"id": "field3",
				"numVal": 0,
				"strVal": "2023-05-15 14:49:39",
				"valType": "dateTime"
			},
			{
				"aryVal": [],
				"id": "87417f2d-9de2-11ec-a395-3257353df390",
				"numVal": 0,
				"strVal": "单行文本",
				"valType": "single"
			},
			{
				"aryVal": [],
				"id": "732d8347-b85a-491e-93aa-6f535591b91a",
				"numVal": 2,
				"strVal": "",
				"valType": "number"
			},
			{
				"aryVal": [],
				"id": "a6caf6f0-cec0-409f-9214-3ac90251dd7c",
				"numVal": 0,
				"strVal": "2023-05-15",
				"valType": "date"
			},
			{
				"aryVal": [
					"{\"key\":\"bbb270d5-bddc-4b19-b6ca-5f20a0b9a094/4ce816bc-e70a-464f-8ef3-21c8efe49ce8/ca874035-44c4-429a-ae76-42dd1d7b812a\",\"value\":\"电商渠道/京东商城/学生专区\"}"
				],
				"id": "12192654-fa89-4884-9735-6ee950a5135a",
				"numVal": 0,
				"strVal": "电商渠道/京东商城/学生专区",
				"valType": "cascade"
			}
		],
		"customerId": "xx",
		"externalCustomerId": "xxx",
		"corpId": "jj",
		"dealTime": "",
		"deliveryTime": "",
		"depId": "12",
		"followUserId": "1",
		"goods": [{
			"amount": "15.09",
			"number": 3,
			"skuId": "dsadas"
		}],
		"isPay": true,
		"isVerify": true,
		"note": "dasdas",
		"orderId": "",
		"outOrderNumber": "test001",
		"payTime": "",
		"payType": 1,
		"refundTime": "",
		"sourceCode": 1,
		"status": 10,
		"vouch": [],
		"withoutShip": true,
		"deliveryFee": ""
	}]
}
成功响应
响应参数名类型描述
logMessageIdString调用链日志id
msgString消息
successBool是否成功
codeInt状态码,500200成功请求
dataObject数据
data 字段类型说明
响应参数名类型描述
failedObject[]保存失败的记录
failed.codeInt请求失败时 状态码
failed.indexInt该记录在原数组的索引
failed.msgString失败时:错误信息
failed.orderNumberString失败时为空字符串
successObject[]请求成功的记录
success.codeInt请求成功时 状态码500200
success.indexInt该记录在原数组的索引
success.msgString成功时msg为"ok"
success.orderNumberString请求成功时,创建订单的OrderNumber(非外部订单号)
成功响应示例
{
  "code": 500200,
  "data": {
    "failed": [],
    "success": [
      {
        "code": 500200,
        "index": 0,
        "msg": "ok",
        "orderNumber": "284273429434073088"
      }
    ]
  },
  "logMessageId": "bb8cec1c-86ed-9407-9f57-1e2804062169",
  "msg": "成功",
  "reqid": "bb8cec1c-86ed-9407-9f57-1e2804062169",
  "success": true
}
修改于 2024-12-17 01:34:34
上一页
查询订单列表
下一页
查询订单自定义字段ID
Built with