Appearance
2.订单
2.1查询订单列表及详情
POST /b2c-oms-server/order/list
接口描述
查询门店订单信息
请求
| 参数名称 | 数据类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|
| accessId | string | lakala | Y | 接入ID：服务方定义，发起方按接口填入 |
| timestamp | string | 1629955213000 | Y | 请求时间(UTC)毫秒,发起请求系统时间 |
| shopId | integer | Y | 操作涉及门店ID | |
| pageSize | integer | Y | 页长 | |
| pageNumber | integer | Y | 第几页，比如此次查第一页 | |
| posId | integer | N | POS ID | |
| orderNumber | string | N | 订单号 | |
| customerId | string | N | 客户号 | |
| searchCondition | string | N | 搜索条件 商品名称或者条码 | |
| startDate | string | Y | 开始日期，例如2021-09-24 则查询起始时间：2021-09-24 00:00:00 | |
| endDate | string | Y | 截止日期, 例如2021-09-24 则查询起始时间：2021-09-24 23:59:59 | |
| staffId | string | N | 收银员ID | |
| orderType | integer | Y | 订单类型，0：所有；1：一般订单；2：现金收支；3：账户充值, 39：积分兑换 | |
| memberUserId | integer | N | 指定会员用户Id | |
| saleOrderId | string | N | 订单主键ID | |
| start | integer | N | ||
| commChainId | string | N |
响应
| 参数名称 | 数据类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|
| _code | string | 200 | Y | 响应码：200 成功；其他失败 |
| _message | string | SUCCESS | Y | 响应描述信息 |
| timestamp | string | 1629955213000 | Y | 响应时间(UTC)毫秒,发起请求系统时间 |
| sid | string | abc123 | Y | 交易流水号，请求值原样返回 |
| paging | object | N | ||
| ⇥pageIndex | integer | N | 当前页码 | |
| ⇥pageSize | integer | N | 当前页码 | |
| ⇥total | integer | N | 总量 | |
| set | array | N | 集合 | |
| ⇥saleOrderId | string | Y | 订单ID | |
| ⇥staffId | string | Y | 收银员id | |
| ⇥staffName | string | Y | 收银员名字 | |
| ⇥posId | string | Y | pos机id | |
| ⇥orderStatus | string | Y | 订单状态 | |
| ⇥orderNumber | string | Y | 订单号 | |
| ⇥productTotalPrice | integer | Y | 商品总金额(分) | |
| ⇥totalDiscountAmount | integer | Y | 订单总优惠金额(分) | |
| ⇥totalExtraFee | integer | Y | 订单总附加费用(分) | |
| ⇥zeroAmount | integer | Y | 订单抹零金额(分) | |
| ⇥actualTotalPrice | integer | Y | 订单实付金额(分) | |
| ⇥totalRefundAmount | integer | Y | 订单已退款总金额(分) | |
| ⇥pendingRefundAmount | integer | Y | 在途退货金额(分) | |
| ⇥creationTime | string | Y | 订单时间 | |
| ⇥shopId | integer | N | ||
| ⇥shopName | string | N | ||
| ⇥passiveSourceList | array | N | 用户支付方式 | |
| ⇥⇥passiveSourceName | string | N | 支付付款名称 | |
| ⇥⇥passiveTypeName | string | N | 支付方式名称 | |
| ⇥⇥passiveSource | string | N | 支付方式code | |
| ⇥⇥originalPaymentAmount | string | N | 支付金额 | |
| ⇥⇥saleOrderId | string | N | 订单号 | |
| ⇥⇥payeeAccount | string | N | 自定义支付的payee_account | |
| ⇥salesOrderItemList | array | N | 订单明细 | |
| ⇥⇥id | string | Y | id | |
| ⇥⇥barcode | string | Y | 商品条码 | |
| ⇥⇥unit | string | Y | 主单位 | |
| ⇥⇥saleOrderId | string | Y | 销售订单号 | |
| ⇥⇥productId | integer | Y | 商品id | |
| ⇥⇥saleMenuItemId | integer | Y | 销售报价单ID | |
| ⇥⇥productName | string | Y | 产品名称 | |
| ⇥⇥skuName | string | Y | sku名称 | |
| ⇥⇥unitPrice | integer | Y | 单价 | |
| ⇥⇥quantity | integer | Y | 数量 | |
| ⇥⇥totalPrice | integer | Y | 总价 | |
| ⇥⇥totalDiscount | integer | Y | 总折扣金额 | |
| ⇥⇥actualTotalPrice | integer | Y | 实际总价 | |
| ⇥⇥sharedTotalPrice | integer | Y | 退货时，基于订单总可退金额摊派应退总金额 | |
| ⇥⇥sharedAvgUnitPrice | integer | Y | 基于本摊派应退总金额计算单件退货金额 | |
| ⇥⇥refundedQuantity | integer | Y | 已退货数量 | |
| ⇥⇥refundAmount | integer | Y | 已退货金额 | |
| ⇥⇥orderStatus | string | Y | 状态 | |
| ⇥⇥weigh | integer | Y | 称重商品重量g | |
| ⇥⇥weighing | integer | Y | 是否称重商品：0否，1是 | |
| ⇥⇥refundedWeight | integer | Y | 称重商品退货重量g | |
| ⇥salesOrderDiscountList | array | N | 优惠明细 | |
| ⇥⇥id | string | Y | id | |
| ⇥⇥saleOrderId | string | Y | 销售订单号 | |
| ⇥⇥discountId | integer | Y | 优惠活动编号 | |
| ⇥⇥discountAmount | integer | Y | 优惠金额(分) | |
| ⇥⇥discountName | string | Y | 优惠活动名称 | |
| ⇥salesOrderExtraFeeList | array | N | 订单附加费 | |
| ⇥⇥id | string | Y | id | |
| ⇥⇥saleOrderId | string | Y | 销售订单编号 | |
| ⇥⇥feeTypeId | integer | Y | 附加费用类型 | |
| ⇥⇥extraFeeName | string | N | ||
| ⇥⇥extraFeeKey | string | N | ||
| ⇥⇥extraFee | integer | Y | 费用(分) | |
| ⇥salesOrderRefundList | array | N | 退货信息 | |
| ⇥⇥saleOrderRefundId | string | Y | 订单退货记录ID | |
| ⇥⇥saleOrderId | string | Y | 订单编号 | |
| ⇥⇥quantity | integer | Y | 退货商品数量 | |
| ⇥⇥refundAmount | integer | Y | 退货商品总金额(分) | |
| ⇥⇥tradeState | string | Y | 退款结果 | |
| ⇥⇥createTime | string | Y | 退货时间 | |
| ⇥⇥tradeGoing | string | Y | 退款去向 | |
| ⇥⇥salesOrderItemRefundList | array | Y | 退货商品明细 | |
| ⇥⇥⇥saleOrderItemRefundId | string | Y | 订单商品项退货记录ID | |
| ⇥⇥⇥saleOrderRefundId | string | Y | 订单退货记录ID | |
| ⇥⇥⇥saleOrderItemId | string | Y | 订单商品项记录ID | |
| ⇥⇥⇥productName | string | Y | 商品名称 | |
| ⇥⇥⇥quantity | integer | Y | 订单商品项退货数量 | |
| ⇥⇥⇥refundAmount | integer | Y | 订单商品项退货金额(分) | |
| ⇥⇥⇥createTime | string | Y | 订单商品项退货时间 | |
| ⇥⇥⇥refundedWeight | integer | Y | 称重商品退货重量g | |
| ⇥⇥⇥weighing | integer | Y | 是否称重商品：0否，1是 | |
| ⇥⇥paymentRefundTypeList | array | Y | 支付退款明细 | |
| ⇥⇥⇥saleOrderId | string | N | ||
| ⇥⇥⇥refundType | string | N | 类型 | |
| ⇥⇥⇥refundAmount | string | N | ||
| ⇥⇥⇥payeeAccount | string | N | ||
| ⇥memberInfoResponse | object | N | ||
| ⇥⇥memberId | string | N | 会员号 | |
| ⇥⇥memberStatus | string | N | 会员状态 0 正常 1 暂停2 注销 | |
| ⇥⇥systemCode | string | N | 系统编码(接入系统ID) | |
| ⇥⇥memberSrc | string | N | 会员来源 | |
| ⇥⇥userId | string | N | 用户中心ID | |
| ⇥⇥groupId | string | N | 分组ID | |
| ⇥⇥platformId | string | N | 平台ID | |
| ⇥⇥memberName | string | N | 会员昵称 | |
| ⇥⇥realName | string | N | 姓名 | |
| ⇥⇥remarkName | string | N | 会员名 | |
| ⇥⇥mobile | string | N | 手机号 | |
| ⇥⇥mobileId | string | N | 手机号摘要 | |
| ⇥⇥gender | string | N | 性别 | |
| ⇥⇥specialDay | string | N | 纪念日 | |
| string | N | |||
| ⇥⇥memberDesc | string | N | 会员描述 | |
| ⇥⇥scoreStatus | integer | N | 积分功能状态 0-未启用 1-开启 2-暂停消费，开放获取 3-暂停获取，开放消费 4-暂停获取消费 5-关闭功能 | |
| ⇥⇥amount | integer | N | 会员积分，1积分等值（RMB）1分钱 | |
| ⇥⇥depositStatus | integer | N | 储值功能状态 0-未启用 1-开启 2-暂停消费，开放充值 3-暂停充值，开放消费 4-暂停充值消费 5-关闭功能 | |
| ⇥⇥depositAmount | integer | N | 会员储值,单位（RMB）分 |