订单查询

接口路径:

https://gateway-smart.shouqianba.com/api/platform/v1/order?access_token={access_token}

限流

20 次/秒

说明

  • 商家可以通过此接口获取到订单数据

请求参数

字段 类型 必须 示例值 说明
orderSn String 210000001000001 订单号

返回参数

订单基础信息

字段 类型 必须 示例值 说明
orderSn String 210000001000001 订单号
orderType Enum QR_FOOD 订单类型,详见下方订单类型枚举定义
ctime String 1702276912510 下单时间
remark String 不吃香菜 订单备注
originalAmount Number 1800 订单金额
merchantDiscountTotalAmount Number 200 商家优惠金额
platformServiceAmount Number 200 平台服务费
packageAmount Number 120 打包费
deliveryAmount Number 450 配送费
expectedIncomeAmount Number 2060 预计收入
refundAmount Number 120 退款金额
goods Array 详见下方商品数据结构定义
customer Object 详见下方顾客数据结构定义
delivery Object 详见下方配送数据结构定义
discounts Array 详见下方优惠数据结构定义
payments Array 详见下方支付数据结构定义

订单基础信息数据补充说明 订单金额 = 商品总金额 + 打包费 + 配送费 预计收入 = 订单金额 - 商家优惠金额 - 平台服务费

订单类型 orderType 枚举说明

含义
QR_FOOD 扫码点单:顾客到店扫二维码点单的业务场景
TAKEOUT 外卖配送:顾客线上点餐后,由配送员将餐点递送到指定位置的业务场景
SELF_PICKUP 到店自取:顾客点单后需要到店自行取餐的业务场景
PAY_FIRST 收银订单:商家使用收银机或手机收银为顾客点单的业务场景
EAT_FIRST 先下单后付款:顾客到店多人点单,最后统一结账的业务场景

商品数据

字段 类型 必须 示例值 说明
id String 5f0b3900-08e6-43ff-9343-e982ca94233f 商品 ID
name String 西瓜 商品名称
categoryId String f4a60826-90f9-4a80-8252-24039edca952 分类 ID
categoryName String 时令水果 分类名称
spec String 中果 规格
originalAmount Number 2000 原始单价
quantity Number 2.28 销售数量,最多 3 位小数
discountQuantity Number 2 享受商品优惠的商品数量,最多 3 位小数
totalDiscountAmount Number 240 商品优惠总金额
attributes Array 属性,详见下方商品属性数据结构定义
materials Array 加料,详见下方商品加料数据结构定义
totalAmount Number 4560 商品总金额

商品数据补充说明 商品总金额 = 原始单价 * 销售数量 + 加料总金额 - 商品优惠总金额

商品属性

字段 类型 必须 示例值 说明
id String 1e018812-98e9-4a7e-967f-6441d21ac252 属性 ID
name String 微辣 属性名称

商品加料

字段 类型 必须 示例值 说明
id String 5f0b3900-08e6-43ff-9343-e982ca94233f 加料 ID
name String 荷包蛋 加料名称
price Number 5500 加料单价
quantity Number 1 加料数量,最多 3 位小数

商品加料数据补充说明 加料总金额 = 加料单价 * 加料数量

顾客数据

字段 类型 必须 示例值 说明
name String 张三 姓名
contactNumber String 13198810000 联系电话
address String 上海市中江路879号天地软件园26幢 地址

配送数据

字段 类型 必须 示例值 说明
riderName String 王五 骑手姓名
riderContactNumber String 13198810000 骑手联系电话
transitStationName String 张三 中转站站长姓名
transitStationContactNumber String 13198810000 中转站联系电话

优惠数据

字段 类型 必须 示例值 说明
name String 全场折扣 优惠名称
amount Number 120 优惠金额

支付数据

字段 类型 必须 示例值 说明
transSn Number 7894259236461446 支付订单号
payWay Enum WECHAT 支付通道,枚举详见下方说明
subPayWay Enum QRCODE 子支付通道,枚举详见下方说明
payTime Number 1702276912510 支付时间戳

支付数据补充说明 不包含退款数据

支付通道枚举说明

含义
ALIPAY 支付宝
WECHAT 微信
BAIDU 百度钱包
JD 京东钱包
QQ qq钱包
NFC NFC支付
QUICK_PASS 银联云闪付
SODEXO 索迪斯支付
BALANCE 储值支付
CARD 储值卡
CASH 现金支付
ACCOUNTING 记账

子支付通道枚举说明

含义
BARCODE 条码支付
QRCODE 二维码支付
WAP wap支付
MINI 小程序支付
APP APP支付

请求数据示例

入参

{
  "orderSn": "2100001234567891"
}

出参

{
  "code": 0,
  "message": "成功",
  "data": {
    "orderSn": "2100001247457212",
    "orderType": "QR_FOOD",
    "ctime": 1700318325713,
    "remark": "不吃香菜",
    "originalAmount": 1200,
    "merchantDiscountTotalAmount": 800,
    "platformServiceAmount": 120,
    "packageAmount": 110,
    "deliveryAmount": 450,
    "expectedIncomeAmount": 800,
    "refundAmount": 499,
    "goods": [
      {
        "id": "5f0b3900-08e6-43ff-9343-e982ca94233f",
        "name": "牛肉拉面",
        "categoryId": "f4a60826-90f9-4a80-8252-24039edca952",
        "categoryName": "面食",
        "spec": "大份",
        "originalAmount": 1200,
        "quantity": 3.201,
        "totalAmount": 800,
        "discountQuantity": 1.304,
        "totalDiscountAmount": 400,
        "attributes": [
          {
            "id": "5f0b3900-08e6-43ff-9343-e982ca94233f",
            "name": "微辣"
          },
          {
            "id": "e7d8d7ec-dfbb-4da1-89c2-59e815fcd42a",
            "name": "二细"
          }
        ],
        "materials": [
          {
            "id": "5f0b3900-08e6-43ff-9343-e982ca94233f",
            "name": "荷包蛋",
            "price": 120,
            "quantity": 2
          },
          {
            "id": "ff0ac207-6170-492c-b16c-bea0a4c968c0",
            "name": "火腿肠",
            "price": 220,
            "quantity": 1
          }
        ]
      },
      {
        "id": "5b62eafb-3b0d-47eb-a67e-e65766f1acf8",
        "name": "番茄鸡蛋盖浇饭",
        "categoryId": "0c3ca86b-9eed-48f2-99e5-c78e3289d352",
        "categoryName": "盖浇饭",
        "spec": "小份",
        "originalAmount": 1100,
        "quantity": 3,
        "totalAmount": 3300,
        "discountQuantity": 1.300,
        "totalDiscountAmount": 300,
        "attributes": [],
        "materials": []
      }
    ],
    "discounts": [
      {
        "name": "满减优惠",
        "amount": 249
      },
      {
        "name": "全场折扣",
        "amount": 112
      }
    ],
    "payments": [
      {
        "transSn": "7894259236461446",
        "payWay": "WECHAT",
        "subPayWay": "QRCODE",
        "payTime": 170000000001
      },
      {
        "transSn": "7894259236461447",
        "payWay": "ALIPAY",
        "subPayWay": "BARCODE",
        "payTime": 170000000002
      }
    ],
    "customer": {
      "name": "张三",
      "address": "北京市海淀区中关村南大街5号",
      "contactNumber": "13800138000"
    },
    "delivery": {
      "transitStationName": "中关村中转站",
      "transitStationContactNumber": "13800138001",
      "riderName": "李四",
      "riderContactNumber": "13800138002"
    }
  }
}

错误码列表

错误码 含义
50003 订单不存在
50004 订单类型不支持

results matching ""

    No results matching ""