查询订单列表 - 尘锋SCRM开放平台

订单业务类型分为：自主下单、代客下单

自主下单说明：微信用户(unionId)通过访问尘锋基于微信公众号开发的H5商城、微信小程序商城自主下单

代客下单说明：企业员工主动在尘锋创建订单并关联企业(corpId)(企业订单)或关联联系人(memberId)(个人订单)

联系人&unionId关系说明

在本接口中，联系人的id命名为memberId，非customerId

unionId与联系人是一对多关联关系，所以自主下单会存在同时返回memberId+unionId的情况

订单来源说明

自主下单固定来源：H5商城、小程序商城

代客下单为自定义来源：请先在尘锋管理后台维护来源库，操作路径为"商城-店铺-店铺设置-订单设置-订单来源设置",再通过接口获取枚举值查询订单来源

`POST https://qw-openapi-tx.dustess.com/java-data-exchange-srv/api/order/v1/get-list?accessToken=`

Content-Type: application/json

请求参数

参数名称	类型	描述	是否必须
`goodsName`	`String`	商品名称	`false`
`limitSize`	`Int`	分页查询限制条数(默认10，最大100)	`false`
`nextPageBeginNumber`	`String`	下一页数据查询起始编码（对应商品或订单编码）	`false`
`orderId`	`String`	订单编码	`false`
`orderIdList`	`String[]`	订单编码列表	`false`
`externalOrderIdList`	`String[]`	外部订单id列表	`false`
`orderSource`	`Int`	订单来源 1小程序商城 2 h5商城	`false`
`orderStatus`	`Int`	订单状态 10 待支付 20 待发货 25 待审核 26审核中 27 审核失败 30 待成团 40 待收货 50 已完成 70 已取消 100 已关闭 101 待自提	`false`
`orderStatusList`	`Int[]`	订单状态集合 10 待支付 20 待发货 25 待审核 26审核中 27 审核失败 30 待成团 40 待收货 50 已完成 70 已取消 100 已关闭 101 待自提	`false`
`placeOrderEndTime`	`String`	以订单下单时间范围进行查询，起始时间，格式为：yyyy-MM-dd HH:mm:ss	`false`
`placeOrderStartTime`	`String`	以订单下单时间范围进行查询，结束时间，格式为：yyyy-MM-dd HH:mm:ss	`false`
`receiverMobile`	`String`	收货人电话	`false`
`receiverName`	`String`	收货人	`false`
`updateStartTime`	`String`	以订单更新时间范围进行查询，起始时间，格式为： yyyy-MM-dd HH:mm:ss	`false`
`updateEndTime`	`String`	以订单更新时间范围进行查询，结束时间，格式为： yyyy-MM-dd HH:mm:ss	`false`
`followUserIds`	`String[]`	订单业绩归属人，员工id	`false`
`customerIds`	`String[]`	联系人id	`false`
`corpIds`	`String[]`	企业id	`false`
`ids`	`String[]`	订单id	`false`

请求参数示例
json - Request-Example:

{
	"goodsName": "",
	"limitSize": 0,
	"nextPageBeginNumber": "",
	"orderId": "",
    "orderIdList": [],
    "externalOrderIdList": [],
	"orderSource": 0,
	"orderStatus": 0,
    "orderStatusList": [],
	"placeOrderEndTime": "",
	"placeOrderStartTime": "",
	"receiverMobile": "",
	"receiverName": "",
	"followUserIds": [],
	"customerIds": [],
	"corpIds": [],
	"ids": []
}

成功响应

参数名称	类型	描述
`code`	`Int`	状态码
`data`	`Object[]`	数据
`logMessageId`	`String`	调用链日志id
`msg`	`String`	消息
`success`	`Bool`	是否成功

data 字段类型说明

参数名称	类型	描述
`addressInfo`	`Object`	订单收货地址信息
`addressInfo.address`	`String`	地址详情
`addressInfo.area`	`String`	区编码
`addressInfo.areaName`	`String`	区名称
`addressInfo.city`	`String`	市编码
`addressInfo.cityName`	`String`	市名称
`addressInfo.postCode`	`String`	邮编
`addressInfo.province`	`String`	省编码
`addressInfo.provinceName`	`String`	省名称
`addressInfo.receiverName`	`String`	收货人
`addressInfo.receiverMobile`	`String`	收货人电话
`confirmReceiverTime`	`String`	确认收货时间 yyyy-MM-dd HH:mm:ss
`memberInfo`	`Object`	购买人（仅当订单关联联系人时返回）
`memberInfo.memberId`	`String`	购买人ID(指联系人ID，代客下单场景：个人订单一定存在，商城下单场景：不一定存在)
`memberInfo.externalMemberId`	`String`	联系人所关联的外部系统ID
`memberInfo.corpId`	`String`	企业Id（代客下单场景：联系人关联的企业ID）
`memberInfo.unionId`	`String`	购买人的unionId（代客下单场景：个人订单不一定存在，商城下单场景：一定存在）
`memberInfo.name`	`String`	购买人的名称（如有购买人ID：联系人名称；如没有购买人ID：微信用户授权昵称）
`memberInfo.mobile`	`String`	购买人的手机号（代客下单场景：联系人手机号码；商城下单场景：微信用户授权手机号）
`couponTotalPrice`	`String`	优惠券总价（单位：元）
`createTime`	`String`	创建时间 yyyy-MM-dd HH:mm:ss
`deliveryTime`	`String`	发货时间 yyyy-MM-dd HH:mm:ss
`goodsName`	`Object[]`	商品名称
`goodsTotalPrice`	`String`	商品总价（单位：元）
`goodsType`	`Int`	商品类型 1:普通商品,2:虚拟商品
`id`	`String`	订单id，示例:5cb54fc6-da88-4e4d-8b1e-1cb38d971053
`orderId`	`String`	订单编号，示例：1658036738972467200
`externalOrderId`	`String`	外部订单id
`orderSource`	`Int`	订单来源类型（自主下单固定类型：1.小程序商城 2.H5商城其他均为代客下单类型，来源为自定义）
`orderSourceName`	`String`	订单来源名称（自主下单固定类型：1.小程序商城 2.H5商城其他均为代客下单类型，来源为自定义）
`orderStatus`	`Int`	订单状态- 10 待支付 20 待发货 25 待审核 26审核中 27 审核失败 30 待成团 40 待收货 50 已完成 70 已取消 100 已关闭 101 待自提
`paymentTotalPrice`	`String`	实付总价（单位：元）（`paymentTotalPrice`=`goodsTotalPrice`-`couponTotalPrice`-`preferentialPrice`）
`preferentialPrice`	`String`	管理员手动改价的优惠金额
`remark`	`String`	买家备注
`businessesRemark`	`String`	卖家备注
`followUserId`	`String`	订单业绩归属人，员工id
`payNumber`	`String`	支付流水号
`payType`	`Int`	付款方式 1 线上付款 2 线下付款 3 余额支付
`payTime`	`String`	付款时间格式：yyyy-MM-dd HH:mm:ss
`relateAftersaleIds`	`String[]`	相关联的售后单id
`auditInfoList`	`Object[]`	订单审批信息
`auditInfoList.id`	`String`	审核单id
`auditInfoList.userId`	`String`	审核员工id
`auditInfoList.approvalTime`	`String`	审核时间时间格式：yyyy-MM-dd HH:mm:ss
`updateTime`	`String`	更新时间 yyyy-MM-dd HH:mm:ss
`deliveryFee`	`String`	订单运费金额（单位：元）
`goodsInfoList`	`Object[]`	订单商品列表
`goodsInfoList.cover`	`String`	封面图
`goodsInfoList.num`	`Int`	数量
`goodsInfoList.skuId`	`String`	sku ID
`goodsInfoList.skuName`	`String`	sku 名称
`goodsInfoList.goodsId`	`String`	商品ID(为空表示未关联上商品)
`goodsInfoList.goodsName`	`String`	商品名称
`goodsInfoList.skuPrice`	`String`	sku 单价（单位：元）
`goodsInfoList.paymentPrice`	`String`	实付总价（单位：元）
`goodsInfoList.preferentialPrice`	`String`	优惠总价（单位：元）
`goodsInfoList.goodsCode`	`String`	商品编码
`goodsInfoList.skuCode`	`String`	SKU编码
`dealTime`	`String`	下单时间（格式：yyyy-MM-dd HH:mm:ss）
`orderSourceInfo`	`Object`	来源信息
`orderSourceInfo.code`	`Int`	来源code
`orderSourceInfo.name`	`String`	名称
`orderSourceInfo.shopName`	`String`	店铺名称
`vouchers`	`Object[]`	凭证信息
`relateExpressInfoList`	`Object[]`	相关联的物流信息
`relateExpressInfoList.id`	`String`	物流id
`relateExpressInfoList.deliveryName`	`String`	物流公司名称
`relateExpressInfoList.wayBillID`	`String`	运单号
`relateExpressInfoList.createdTime`	`String`	发货时间格式：yyyy-MM-dd HH:mm:ss
`createName`	`String`	订单创建人名称
`createId`	`String`	订单创建人id
`corpId`	`String`	企业id（订单关联企业时返回）
`deptId`	`String`	订单业绩归属部门id
`deptName`	`String`	部门名称
`isPay`	`Bool`	是否支付（true-是 false-否）
`refundTime`	`String`	退款时间格式：yyyy-MM-dd HH:mm:ss
`withoutShip`	`Bool`	是否需要发货: true 需要，false不需要
`customFields`	`Object[]`	自定义字段
`customFields.arrVal`	`String[]`	数组值用以存放 checkbox
`customFields.id`	`String`	自定义字段ID
`customFields.intVal`	`Int`	数字值用以存放 number
`customFields.kind`	`String`	用以区分值类型 date、 dateTime、checkbox、single、multi、radio、select、number
`customFields.strVal`	`String`	字符串类型值，用于date、 dateTime、single、multi、radio、select、attachment

成功响应示例

{
	"code": 500200,
	"msg": "成功",
	"data": [{
		"id": "5cb54fc6-da88-4e4d-8b1e-1cb38d971053",
		"orderId": "1352503155765547008",
		"externalOrderId": "",
		"orderStatus": 70,
		"orderSource": 2,
		"orderSourceName": "小程序商城",
		"goodsTotalPrice": "0.01",
		"paymentTotalPrice": "0.01",
		"addressInfo": {
			"receiverName": "1",
			"receiverMobile": "18243541111",
			"postCode": "100040",
			"province": "110000",
			"city": "110100",
			"area": "110101",
			"provinceName": "北京",
			"cityName": "北京市",
			"areaName": "东城区",
			"address": "c"
		},
		"couponTotalPrice": "0",
		"preferentialPrice": "0",
		"deliveryTime": "",
		"confirmReceiverTime": "",
		"goodsType": 1,
		"goodsName": [
			"回归商品1"
		],
		"customFields": [{
				"aryVal": [],
				"id": "field0",
				"numVal": 0,
				"strVal": "普通会员",
				"valType": "radio"
			},
			{
				"aryVal": [],
				"id": "field1",
				"numVal": 0,
				"strVal": "123",
				"valType": "single"
			},
			{
				"aryVal": [],
				"id": "field2",
				"numVal": 0,
				"strVal": "123",
				"valType": "multi"
			},
			{
				"aryVal": [],
				"id": "field3",
				"numVal": 0,
				"strVal": "2023-04-19 16:18:59",
				"valType": "dateTime"
			},
			{
				"aryVal": [],
				"id": "87417f2d-9de2-11ec-a395-3257353df390",
				"numVal": 0,
				"strVal": "123",
				"valType": "single"
			}
		],
		"createTime": "2021-01-22 14:27:35",
		"updateTime": "2021-01-22 14:30:35",
		"remark": "",
		"memberInfo": {
			"externalMemberId": "",
			"memberId": "e0a95fcc-1111-1111-1111-52453f2e2ecd",
			"name": "ZhangSan",
			"mobile": "18382121111"
		},
		"goodsInfoList": [{
			"cover": "",
			"goodsId": "1440862079425712128",
			"goodsName": "周期购",
			"num": 1,
			"skuId": "77dbebda-1111-1111-1111-38ff8b2a6b05",
			"skuName": "周期购 1",
			"skuPrice": "0",
			"paymentPrice": "0",
			"preferentialPrice": "0"
		}],
		"payNumber": "4200001141202107299956826445",
		"followUserId": "2992",
		"deliveryFee": "",
		"dealTime": "2021-01-22 11:39:38",
		"orderSourceInfo": {
			"code": 1,
			"name": "小程序商城",
			"shopName": ""
		},
		"vouchers": null,
		"buyerRemark": "",
		"payType": 1,
		"payTime": "",
		"relateAftersaleIds": [],
		"auditInfoList": [{
			"id": "123123",
			"userId": "234234235",
			"approvalTime": "2022-08-01 12:00:00"
		}],
		"relateExpressInfoList": [{
			"id": "123123",
			"deliveryName": "顺丰速递",
			"wayBillID": "SF234234534534",
			"createdTime": "2022-08-01 12:00:00"
		}],
		"createName": "张三",
		"createId": "12345",
		"corpId": "12345",
		"deptId": "12345",
		"deptName": "12345",
		"isPay": true,
		"refundTime": "2022-08-01 12:00:00",
		"withoutShip": true
	}],
	"logMessageId": "e07ac992ce9b41f490a7d64b0fa1377d",
	"success": true
}