接口文档

概览

本文档详细描述了推送订单信息到第三方接口的配置要求、参数说明及示例。

接口详情

推送订单信息

描述

实时将订单信息主动推送至第三方，支持销售和退货两种类型的订单数据。

配置项

参数名	类型	说明
`url`	String	第三方接口地址/Post接口
`app_Id`	String	开放平台AppId
`version`	String	推送的接口版本号，默认为"1.0.0"
`format`	String	数据格式（当前仅支持json）
`re_succ`	Integer	是否验证成功（0-不验证，1-验证。根据errorCode确认是否重试）
`brand_id`	Integer	品牌ID
`platform_id`	Integer	平台类型
`platform_shop_id`	String	平台门店ID
`sh_shop_id`	String	食亨中台门店ID

请求参数

参数名	类型	说明
`appId`	string	开放平台AppID
`docNo`	string	唯一编号
`orderNo`	string	订单号
`date`	string	日期格式（yyyy-MM-dd HH:mm:ss）
`brandId`	Integer	品牌ID
`platformId`	Integer	平台类型
`platformShopId`	String	平台门店ID
`platformShopName`	String	平台门店名称
`saleType`	String	交易类型（销售：SALE / 退货：SALES_RETURN）
`originalPrice`	BigDecimal	原价
`totalDiscount`	BigDecimal	折扣总额
`actualPrice`	BigDecimal	实收金额
`payList`	PayItem[]	支付明细列表
`goodsList`	GoodsItem[]	商品明细列表
`originalOrder`	OriginalOrder	退货原单信息（仅退货时存在）

PayItem

支付明细

参数名	类型	说明
`payAmount`	BigDecimal	支付金额
`payChannelId`	Integer	支付渠道id
`payChannel`	string	支付渠道名称

GoodsItem

商品分组

参数名	类型	说明
`groupName`	String	分组名称
`detail`	GoodsDetail[]	商品详情

GoodsDetail

商品详情

参数名	类型	说明
`name`	String	商品名称
`originalPrice`	BigDecimal	单品原价
`actualPrice`	BigDecimal	单品实收
`count`	BigDecimal	数量
`totalPrice`	BigDecimal	总价

OriginalOrder

退货原单信息

参数名	类型	说明
`docNo`	String	原单唯一编号
`orderNo`	String	原始订单号
`orderDate`	String	原始订单日期

支付方式对照表

-3:其他未知团购,
0:美团团购,
1:口碑团购,
2:抖音团购,
3:微信,
4:支付宝,
6:现金,
7:余额,
8:礼品卡,
10:美团自营核销,
12:美团支付-货到付款,
13:美团支付-在线支付,
14:饿了么-货到付款,
15:饿了么-在线支付,
16:抖音支付-在线支付,
20:刷卡,
21:自外送会员,
22:美餐网,
23:小秘书,
24:美团团餐,
30:0元付,
31:小程序,
65:快手团购,
70:美团圈圈,
71:银联,
72:第三方支付,
73:京东支付,
74:美团小白盒,
75:企业团餐,
76:校园卡,
77:抖音外卖,
78:自营外卖,
80:优惠券记账,
90:混合支付,
999999:其他

示例

推送配置示例

{
  "url": "localhost:8383/test",
  "app_Id": "abcdefg",
  "version": "1.0.0",
  "format": "json",
  "re_succ": 1
}

推送(销售)数据示例

{
    "appId": "abcdefg",
    "actualPrice": 7,
    "brandId": 7777,
    "docNo":"AA000001",
    "orderNo": "11699844373077565067149",
    "originalPrice": 35,
    "date": "2023-11-13 10:59:34",
    "platformId": 6,
    "platformShopId": "35",
    "platformShopName": "bingbing干拌麻辣烫",
    "saleType": "SALE",
    "totalDiscount": 28,
    "goodsList": [
        {
            "detail": [
                {
                    "actualPrice": 35,
                    "count": 1,
                    "name": "黄皮柠檬茶",
                    "originalPrice": 35,
                    "totalPrice": 35
                }
            ],
            "groupName": "默认篮子"
        }
    ],
    "payList": [
        {
            "payAmount": 7,
            "payChannel": "余额",
            "payChannelId": 7
        }
    ]
}

推送(退货)数据示例

{
    "actualPrice": -7,
    "appId": "abcdefg",
    "brandId": 7777,
    "docNo":"AA000002",
    "orderNo": "11699844373077565067149",
    "originalPrice": -35,
    "date": "2023-11-13 11:00:31",
    "platformId": 6,
    "platformShopId": "35",
    "platformShopName": "bingbing干拌麻辣烫",
    "saleType": "SALES_RETURN",
    "totalDiscount": -28,
    "goodsList": [
        {
            "detail": [
                {
                    "actualPrice": 35,
                    "count": 1,
                    "name": "黄皮柠檬茶",
                    "originalPrice": 35,
                    "totalPrice": 35
                }
            ],
            "groupName": "默认篮子"
        }
    ],
    "originalOrder": {
        "orderDate": "2023-11-13",
        "docNo": "AA000001"
        "orderNo": "11699844373077565067149",
    },
    "payList": [
        {
            "payAmount": -7,
            "payChannel": "余额",
            "payChannelId": 7,
        }
    ]
}

响应示例

{
  "errorCode": 0,
  "msg": "success"
}

通用商场推送数据（实时订单数据）

接口文档#

概览#

接口详情#

推送订单信息#

描述#

配置项#

请求参数#

PayItem#

GoodsItem#

GoodsDetail#

OriginalOrder#

支付方式对照表#

示例#

推送配置示例#

推送(销售)数据示例#

推送(退货)数据示例#

响应示例#

接口文档

概览

接口详情

推送订单信息

描述

配置项

请求参数

PayItem

GoodsItem

GoodsDetail

OriginalOrder

支付方式对照表

示例

推送配置示例

推送(销售)数据示例

推送(退货)数据示例

响应示例