API 列表

order.message

  • 免费
  • 需要授权
  • 结果不加密
订单消息推送 防止请求量过大 我们推送售后和地址修改的订单 最重要的状态(退款/地址修改)已经推送给用户 剩下的定时全量同步就行 xiaodian.trade.sold.encrypted.get

公共参数

名称 类型 必选 描述
app_key Long 是 接入时申请的app_key
method String 是 接口名称
access_token String 是 Oauth2.0授权获得的access_token
sign String 是 对 API 调用参数（除sign外）进行 md5 加密获得。参数的顺序为字母表的顺序
timestamp Long 是 时间戳，使用Unix时间戳格式
format String 是 响应格式。默认为json格式，固定
sign_method String 否 参数的加密方法选择，当前只支持Md5
version String 否 API协议版本，固定值为：1.0

输入参数

名称 类型 必选 描述 示例值

返回参数

名称 类型 描述 默认值
orderId
Number 订单id（正向交易时为shopOrderId,逆向交易时为itemOrderId）
updated
Number 订单更新时间
status
String 订单状态
event
Object 推送事件code - desc 
return_goods_requested - 买家发起退货,等待卖家同意 
refund_requested - 买家发起退款，等待卖家同意 
return_goods_shipped - 买家发货，等待卖家收货 
modify_ship_to_address - 买家修改收货地址（未发货前可修改一次）
code
String 事件代码
desc
String 事件描述
refundId
Number 退款Id（仅逆向交易时）
sellerId
Number 卖家Id(加密)  用户授权登录时可获取

请求参数示例

返回示例

1).
{
"orderId":25243509208972,
"shopOrderId":2133243243243
"event":{"code":"refund_requested", "desc":"买家发起退款，等待卖家同意"},
"updated":1582268739,
"status":"ORDER_PAID",
"refundId":"279703638",
"sellerId":"123456"
}
2).
推送回调结果示例：

成功收到推送消息时：
{"code"："000000"，
"msg"："succeed"}
消息推送失败时：
{"code":"000001",
"msg":"failed"}

异常示例

API测试工具