# 5.餐饮订单查询接口

# 简要描述

品牌方可通过此接口主动获取订单数据，支持按时间范围查询和增量订单查询
适用于订单回调推送失败或需要主动获取订单数据的场景

# 接口说明

功能说明	说明
按时间范围查询	支持按订单创建时间范围查询订单数据
增量订单查询	以指定订单号或小票号为起点，查询该订单之后产生的所有新订单
分页返回	当有多条数据时，通过分页返回，每页默认15条

# HTTP请求信息

# 请求方式

POST

# 请求URL

{domain}/open-api/order/list

# 请求头

参数名	必选	类型	说明
Content-Type	是	string	application/json

# 请求体参数

参数名	必选	类型	长度限制	示例	说明
param	是	string	-	-	参数体
sign	是	string	-	45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892	签名
storeKey	是	string	-	-	餐厅key
appId	是	string	-	-	APPID

# param 参数

参数名	必选	类型	长度限制	示例	说明
startTime	条件必选*	string	-	2024-01-01 00:00:00	订单创建开始时间，格式：yyyy-MM-dd HH:mm:ss。按时间范围查询时必填
endTime	条件必选*	string	-	2024-01-01 23:59:59	订单创建结束时间，格式：yyyy-MM-dd HH:mm:ss。按时间范围查询时必填
orderInnerNo	条件必选*	string	-	CCP20220428011068111	起始订单号，查询该订单之后的所有新订单。按订单号增量查询时必填
receiptNo	条件必选*	string	-	INV202401010001	起始小票号，查询该小票对应订单之后的所有新订单。按小票号增量查询时必填
pageNum	否	Integer	-	1	页码，从1开始，不传默认为1
pageSize	否	Integer	-	15	每页条数，不传默认为15，最大100

查询规则：

按时间范围查询：传入 startTime 和 endTime
按订单号增量查询：传入 orderInnerNo
按小票号增量查询：传入 receiptNo

# 返回参数

参数名	类型	示例	说明
code	int	10000	状态码参考列表
message	string	success	状态码信息
data	object	-	订单数据

# data 参数说明

参数名	类型	说明
total	Integer	总记录数
pageNum	Integer	当前页码
pageSize	Integer	每页条数
list	Array	订单列表

# list 参数说明

参数名	必选	类型	长度限制	示例	说明
orderInnerNo	是	string	-	CCP20220428011068111	订单No
restaurantNo	是	string	-	dasddasd	餐厅No
branchIdentifier	是	string	-	dasddasd	三方门店标识
orderSerialNumber	是	Integer	-	-	订单序列号
channelCode	否	string	-	-	支付渠道code
channelName	否	string	-	-	支付渠道名称
payProductType	否	Integer	-	-	支付产品类型: 0-线下支付 1-PaymentLink 2-BillPayment 3-BankTransfer 4-QrStatic 5-QrDynamic 6-Cpm 7-Balance
discountAmount	否	Integer	-	-	店家优惠金额
fee	否	Integer	-	-	线上支付手续费
serviceFee	否	Integer	-	-	服务费
packageFee	否	Integer	-	-	打包费
deliveryFee	否	Integer	-	-	配送费用
merchantDeliveryFee	否	Integer	-	-	商户配送费用
realAmount	是	Integer	-	-	实际支付金额
totalAmount	否	Integer	-	-	总金额
orderStatus	是	Integer	-	-	订单状态 1待接单 2已接单 3已完成 4已取消
paymentStatus	是	Integer	-	-	支付状态 1-未支付 2-已支付 3-支付失败 4-退款中 5-已退款 6-退款待处理 7-退款失败 8-取消退款
customerNum	否	Integer	-		用餐人数
createTime	是	String	-		订单创建时间格式：yyyy-MM-dd HH:mm:ss
completeTime	否	String	-		订单完成时间格式：yyyy-MM-dd HH:mm:ss
paymentTime	是	String	-		支付时间格式：yyyy-MM-dd HH:mm:ss
refundTime	否	String	-		退款时间格式：yyyy-MM-dd HH:mm:ss
discountType	否	Integer	-		优惠类型 1pwd 2商户自定义折扣 3pwd折扣-人 4sc折扣-整单 5sc折扣-人数 6优惠券
receiptNo	否	string	-	00000000000012	小票号
refundReceiptNo	否	string	-	00000000000012	退款小票号
skuList	是	list	-	1	订单菜品数据
remark	否	string	-	备注	备注
lessVat	否	Integer	-	-	特殊折扣免税金额
surcharge	否	Integer	-	-	附加费

# skuList参数说明

参数名	必选	类型	长度限制	示例	说明
categoryNo	是	string	-	分类no	分类no
categoryName	否	string	-	分类名称	分类名称
productNo	是	string	-	菜品no	菜品no
productName	否	string	-	菜品名称	菜品名称
variant	是	int	-	1	是否多规格1.是2否
skuNo	否	string	-	no	sku编码
skuName	是	string	-	name	sku名称
count	是	integer	-	1	用户的购买数量
price	是	integer	-	100	菜品金额（单位为分）
optionAmount	是	integer	-	10	选项附加金额
optionList	否	list	-	-	option集合

# optionList参数说明

参数名	必选	类型	长度限制	示例	说明
optionNo	否	string	-	no	option no
optionName	否	string	-	mingcheng	option 名称
optionItemList	否	list	-	-	option item详情

# optionItemList参数说明

参数名	必选	类型	长度限制	示例	说明
optionItemNo	否	string	-	no	option item no
optionItemName	否	list	-	item name	option item name
price	否	integer	-	100	价格（单位为分）

# 按时间范围查询 - 请求示例

{
  "appId": "123456",
  "storeKey": "12332",
  "sign": "abcdef",
  "param": "{\"startTime\":\"2024-01-01 00:00:00\",\"endTime\":\"2024-01-01 23:59:59\",\"pageNum\":1,\"pageSize\":15}"
}

# 按订单号增量查询 - 请求示例

{
  "appId": "123456",
  "storeKey": "12332",
  "sign": "abcdef",
  "param": "{\"orderInnerNo\":\"CCP20220428011068111\",\"restaurantNo\":\"dasddasd\",\"pageNum\":1,\"pageSize\":15}"
}

# 按小票号增量查询 - 请求示例

{
  "appId": "123456",
  "storeKey": "12332",
  "sign": "abcdef",
  "param": "{\"receiptNo\":\"INV202401010001\",\"restaurantNo\":\"dasddasd\",\"pageNum\":1,\"pageSize\":15}"
}

# 返回示例

# code 参考此列表

# 成功响应示例（按时间范围查询）

{
  "code": 10000,
  "message": "success",
  "data": {
    "total": 45,
    "pageNum": 1,
    "pageSize": 15,
    "list": [
      {
        "orderInnerNo": "CCP20220428011068111",
        "restaurantNo": "dasddasd",
        "branchIdentifier": "dasddasd",
        "orderSerialNumber": 1001,
        "discountAmount": 100,
        "fee": 50,
        "serviceFee": 30,
        "packageFee": 20,
        "deliveryFee": 0,
        "realAmount": 10000,
        "totalAmount": 10200,
        "orderStatus": 3,
        "paymentStatus": 2,
        "customerNum": 4,
        "createTime": "2024-01-01 12:00:00",
        "completeTime": "2024-01-01 13:00:00",
        "paymentTime": "2024-01-01 12:05:00",
        "refundTime": null,
        "discountType": 1,
        "receiptNo": "INV202401010001",
        "skuList": [
          {
            "categoryNo": "cat001",
            "categoryName": "川菜",
            "productNo": "prod001",
            "productName": "宫保鸡丁",
            "variant": 1,
            "skuNo": "sku001",
            "skuName": "大份",
            "count": 2,
            "price": 3800,
            "optionAmount": 0,
            "optionList": []
          }
        ],
        "remark": "不要辣",
        "lessVat": 100,
        "surcharge": 50
      }
    ]
  }
}

# 成功响应示例（按订单号/小票号增量查询）

{
  "code": 10000,
  "message": "success",
  "data": {
    "total": 38,
    "pageNum": 1,
    "pageSize": 15,
    "list": [
      {
        "orderInnerNo": "CCP20220428011068112",
        "restaurantNo": "dasddasd",
        "branchIdentifier": "dasddasd",
        "orderSerialNumber": 1002,
        "discountAmount": 0,
        "fee": 50,
        "serviceFee": 30,
        "packageFee": 20,
        "deliveryFee": 0,
        "realAmount": 8500,
        "totalAmount": 8600,
        "orderStatus": 3,
        "paymentStatus": 2,
        "customerNum": 2,
        "createTime": "2024-01-01 13:30:00",
        "completeTime": "2024-01-01 14:15:00",
        "paymentTime": "2024-01-01 13:35:00",
        "refundTime": null,
        "discountType": null,
        "receiptNo": "INV202401010002",
        "skuList": [
          {
            "categoryNo": "cat002",
            "categoryName": "湘菜",
            "productNo": "prod002",
            "productName": "鱼香肉丝",
            "variant": 2,
            "skuNo": "sku002",
            "skuName": "标准份",
            "count": 1,
            "price": 3200,
            "optionAmount": 0,
            "optionList": []
          }
        ],
        "remark": ""
      },
      {
        "orderInnerNo": "CCP20220428011068113",
        "restaurantNo": "dasddasd",
        "branchIdentifier": "dasddasd",
        "orderSerialNumber": 1003,
        "discountAmount": 200,
        "fee": 50,
        "serviceFee": 30,
        "packageFee": 40,
        "deliveryFee": 500,
        "realAmount": 15200,
        "totalAmount": 16020,
        "orderStatus": 3,
        "paymentStatus": 2,
        "customerNum": 6,
        "createTime": "2024-01-01 14:00:00",
        "completeTime": "2024-01-01 15:10:00",
        "paymentTime": "2024-01-01 14:05:00",
        "refundTime": null,
        "discountType": 2,
        "receiptNo": "INV202401010003",
        "skuList": [
          {
            "categoryNo": "cat001",
            "categoryName": "川菜",
            "productNo": "prod001",
            "productName": "宫保鸡丁",
            "variant": 1,
            "skuNo": "sku001",
            "skuName": "大份",
            "count": 1,
            "price": 3800,
            "optionAmount": 0,
            "optionList": []
          },
          {
            "categoryNo": "cat003",
            "categoryName": "粤菜",
            "productNo": "prod003",
            "productName": "红烧排骨",
            "variant": 1,
            "skuNo": "sku003",
            "skuName": "大份",
            "count": 2,
            "price": 5800,
            "optionAmount": 200,
            "optionList": [
              {
                "optionNo": "opt001",
                "optionName": "口味",
                "optionItemList": [
                  {
                    "optionItemNo": "item001",
                    "optionItemName": "微辣",
                    "price": 200
                  }
                ]
              }
            ]
          }
        ],
        "remark": "少放盐",
        "lessVat": 200,
        "surcharge": 80
      }
    ]
  }
}

# 响应示例

# Code 参考此列表

# 响应参数

参数名	类型	示例	说明
code	int	10000	状态码参考列表
message	string	success	状态码信息
data	boolean	-	成功与否

{
  "code": 10000,
  "message": "success",
  "data": true
}

# 失败响应示例

{
  "code": 21000,
  "message": "Service error, please contact administrator",
  "data": null
}

# 注意事项

查询频率限制：建议查询间隔不低于10秒，避免频繁请求
时间范围限制：单次按时间范围查询，时间跨度不超过30天
分页建议：建议按顺序查询所有分页数据，避免遗漏订单
数据时效性：订单数据可能会有5分钟以内的延迟
签名验证：所有请求必须进行签名验证，确保数据安全
HTTPS：建议使用HTTPS协议保证数据传输安全
日志记录：建议记录所有查询请求的日志，便于排查问题
增量查询说明：按订单号或小票号查询时，以该订单号为起点，返回其之后产生的所有新订单，按创建时间升序排列，支持分页。若无新订单则返回空列表

# 使用场景

订单回调推送失败：当订单回调推送失败4次后，可通过此接口主动获取订单数据
数据对账：定期按时间范围查询订单数据与商户系统进行对账
增量同步：品牌方记录最后处理的订单号或小票号，定时通过增量查询获取后续新订单，保持数据同步
历史数据同步：按时间范围批量查询历史订单数据

← 4. 税费试算 6.餐饮订单推送接口 →