• 开发者平台
  • >
  • 餐饮文档中心

订单状态推送通知收费

(上行接口)客如云门店产生新订单或订单状态变更会推送对应状态给第三方合作者,合作者按operation值处理具体场景 注:由于消息中间件特性,有小概率会重复推送消息,建议开发者以订单id和订单状态为判断标准,设计程序时,需做好幂等判断

授权方式:门店授权

请求描述

HTTP请求方式:POST
HTTP请求头类型:Content-Type=application/json
URI: 第三方提供

业务参数

参数名 类型 是否必填 参数描述
operation Integer 订单操作类型 1.订单创建;13.订单确认(接受订单);14.拒绝订单;15.订单取消;16.订单作废;19.退货;20.退款;21.反结账;26.订单完成;91.合单;92挂账;93.支付完成
shopId Long 客如云门店Id
brandId Long 客如云品牌Id
tradeId Long 客如云订单Id
relatedTradeId Long 是 否 原单Id(若operation=19,20时,才会返回,relatedTradeId代表原单ID,tradId代表退货单ID)
mergeTradeIds List 被合并的订单列表(operation=91时,才会返回此值,tradeId代表合并后的订单ID)
customerId Long 会员Id
tradePayStatus Integer 订单支付状态 1:UNPAID:未支付;2:PAYING:支付中(目前组合支付使用);3:PAID:已支付;4:REFUNDING:退款中;5:REFUNDED:已退款;6:REFUND_FAILED:退款失败;8:WAITING_REFUND:等待退款;9:PAID_FAIL:支付失败
tradePayForm Integer 支付方式 1:线下支付;2:在线支付;3:组合支付(暂时是微信在使用)

业务示例(JSON)

{
    "operation":1,
    "shopId":247900002,
    "brandId":2479,
    "tradeId":123456789,
    "tradePayStatus":2,
    "tradePayForm":2
}

响应参数

参数名 类型 是否必填 参数描述
code Int 返回编码,详见错误码
message String 返回信息
messageUuid String 消息uuid
result Pager 返回响应数据,json对象或数组,可为空

响应示例(JSON)

{
    "code":0,
    "message":"OK",
    "messageUuid":"3b4cce269b0d45a3a2a783e91bed263a"
}
目录