友朋运营商开放平台
  1. API 列表
友朋运营商开放平台
  • 友朋运营商平台第三方开放平台接口文档
  • 业务场景
    • 场景:自取柜第三方支付业务逻辑
    • 场景:异步通知第三方业务回调地址
    • 场景:自取柜售货机订单同步给第三方
  • API 列表
    • api.test
      POST
    • cabinet.list
      POST
    • cabinet.product.stock
      POST
    • cabinet.open.door
      POST
    • cabinet.order.refund.apply
      POST
    • cabinet.order.user.appeal
      POST
    • cabinet.order.list
      POST
    • cabinet.order.get
      POST
    • consumer.order.list
      POST
    • consumer.order.get
      POST
  1. API 列表

consumer.order.get

POST
https://api.yopoint.com/api/gateway/index
使用场景:
根据 ReceiptNo,获取售货机订单详情 可使用接口 consumer.order.list 或 异步回调通知 notify.consumer.order.simple 中获得 ReceiptNo

请求参数

Header 参数
Content-Type
string 
必需
默认值:
application/x-www-form-urlencoded
Body 参数multipart/form-data
appid
string 
必需
示例值:
{{appid}}
method
string 
必需
示例值:
consumer.order.get
biz_content
string 
必需
ReceiptNo:友朋系统订单号
示例值:
{"ReceiptNo":"OD230525150120138603"}
version
string 
必需
示例值:
1.0.0
timestamp
string 
必需
示例值:
{% mock 'timestamp', 's' %}
sign_type
string 
必需
示例值:
md5

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.yopoint.com/api/gateway/index' \
--form 'appid=""' \
--form 'method="consumer.order.get"' \
--form 'biz_content="{\"ReceiptNo\":\"OD230525150120138603\"}"' \
--form 'version="1.0.0"' \
--form 'timestamp="{% mock '\''timestamp'\'', '\''s'\'' %}"' \
--form 'sign_type="md5"'

返回响应

🟢200成功
application/json
Body
error_code
integer 
0成功 -1失败
必需
error_msg
string 
必需
sub_error_code
null 
必需
sub_error_msg
null 
必需
data
object 
必需
UserID
string 
用户ID
必需
TID
string 
设备ID
必需
OID
string 
运营商ID
必需
BID
string 
品牌商ID
必需
BarCode
string 
商品条码
必需
OriginalPrice
integer 
订单价格
必需
单位分
Price
integer 
实付金额
必需
单位分
Discount
integer 
折扣
必需
CostPrice
integer 
成本价
必需
Temperature
integer 
温度
必需
温度 0=常温 1=冷 2=热
PayType
integer 
支付方式
必需
1微信支付,2支付宝,201品牌商微信支付,202品牌商支付宝
ClientIPAddress
string 
必需
PayExtend
object 
必需
ScenesType
integer 
必需
ReceiptNo
string 
必需
FID
string 
必需
ReplenisherAccountID
string 
补货员账号ID
必需
ExplainLocation
string 
必需
Address
string 
必需
PlaceID
string 
必需
InnerCode
string 
必需
PlaceName
string 
必需
Country
string 
必需
Province
string 
必需
City
string 
必需
District
string 
必需
LandMarkName
string 
必需
IndustryParentName
string 
必需
IndustryName
string 
必需
TerminalName
string 
必需
DeviceCode
string 
设备编号
必需
DeviceProductionCode
string 
必需
TradeNo
string 
交易订单号
必需
PayTime
integer 
必需
TradeStatus
integer 
交易状态
必需
0=等待支付,1=支付成功,2=退款成功
RefundsTime
integer 
必需
RefundsType
integer 
必需
BrandSellSupplyPrice
integer 
必需
CabinetName
string 
货柜编号
必需
CargoNum
integer 
货道号
必需
CargoDisplayName
string 
货道名
必需
MotorIndex
integer 
电机号
必需
ShipmentsTime
integer 
出货上报时间
必需
ShipmentsStatus
integer 
出货状态
必需
0=等待出货 1=出货成功 -1=出货失败
ShipmentsError
string 
出货错误信息
必需
UserRefundsStatus
integer 
用户退款申请状态
必需
0=未申请 1=申请退款 -1=拒绝退款 2=通过退款
UserRefundsTime
integer 
必需
UserRefundsReason
string 
用户退款原因
必需
REFUNDS_REASON_DELIVERY_FAIL=没有掉货 REFUNDS_REASON_PRODUCT_BROKEN=商品损坏 REFUNDS_REASON_PRODUCT_CANNOT_PICKOUT=商品无法取出
UserRefundsRemarks
string 
必需
UserRefundsImageUrl
array[string]
必需
OpAccountID
string 
退款操作的AccountID
必需
RefundsRemarks
string 
退款备注
必需
FromReceiptNo
string 
必需
BizSource
integer 
必需
FromOrderInfo
object 
必需
UserTakeTime
integer 
必需
CreateAt
integer 
必需
UpdatedAt
integer 
必需
id
string 
必需
UserVO
object 
必需
ProductVO
object 
必需
TerminalVO
object 
必需
ProductName
string 
必需
QRCodeUrl
string 
必需
Token
string 
必需
示例
{
    "error_code": 0,
    "error_msg": "SUCCESS",
    "sub_error_code": null,
    "sub_error_msg": null,
    "data": {
        "UserID": "5c3333326b4cf400110f1b6b",
        "TID": "5f4cd8a151b37c00108a6357",
        "OID": "5e6b52d1b427cd001094a32a",
        "BID": "",
        "BarCode": "6970399920415",
        "OriginalPrice": 1,
        "Price": 1,
        "Discount": 100,
        "CostPrice": 0,
        "Temperature": 1,
        "PayType": 1,
        "ClientIPAddress": "113.118.45.62",
        "PayExtend": {
            "SpecExtend": {},
            "sub_mch_id": "1601491075",
            "sub_appid": ""
        },
        "ScenesType": 0,
        "ReceiptNo": "OD230525150120138603",
        "FID": "5e96f3d52a35a000104c18cc",
        "ReplenisherAccountID": "5a0aa2a97c7481000f47c188",
        "ExplainLocation": "",
        "Address": "友朋总部",
        "PlaceID": "6141ad84b7e8e0001131a5e6",
        "InnerCode": "",
        "PlaceName": "超市",
        "Country": "",
        "Province": "广东省",
        "City": "深圳市",
        "District": "宝安区",
        "LandMarkName": "固戍",
        "IndustryParentName": "购物",
        "IndustryName": "购物中心",
        "TerminalName": "唯一在线",
        "DeviceCode": "998871745707",
        "DeviceProductionCode": "998871745707",
        "TradeNo": "4200001853202305258978581330",
        "PayTime": 1684998086,
        "TradeStatus": 1,
        "RefundsTime": 0,
        "RefundsType": 0,
        "BrandSellSupplyPrice": 0,
        "CabinetName": "A",
        "CargoNum": 2,
        "CargoDisplayName": "02",
        "MotorIndex": 1,
        "ShipmentsTime": 1684998087,
        "ShipmentsStatus": 1,
        "ShipmentsError": "",
        "UserRefundsStatus": 0,
        "UserRefundsTime": 0,
        "UserRefundsReason": "",
        "UserRefundsRemarks": "",
        "UserRefundsImageUrl": [],
        "OpAccountID": "",
        "RefundsRemarks": "",
        "FromReceiptNo": "",
        "BizSource": 0,
        "FromOrderInfo": {},
        "UserTakeTime": 0,
        "CreateAt": 1684998080,
        "UpdatedAt": 1684998087,
        "id": "646f07c085b5d80011a318a7",
        "UserVO": {
            "OpenID": "oA0rgwSuKDaFnD9Z75rqmWavULrg",
            "Platform": 1,
            "id": "5c3333326b4cf400110f1b6b",
            "MemberID": "5c45bc9de2e567001b97c9fe",
            "NickName": "张熙",
            "Sex": 0,
            "Province": "",
            "City": "",
            "ImageUrl": "https://thirdwx.qlogo.cn/mmopen/vi_32/T6DibKNlGcQ63DtYReMdrDsnibf5ZLw09XRd8RUxLJ2znFn5J2ffuENI3ibft7VLFYMFmjic65bkrb8BA31xBvuibJg/132"
        },
        "ProductVO": {
            "Name": "元气森林气泡水白桃味瓶装480ml",
            "ImageUrl": "https://res.yopoint.com/resource/20230630/204b8886596065ae62e2c542ab01855a.png",
            "ImageFixWidthUrl": "https://res.yopoint.com/resource/20230630/40b530af65f05d5ac75c99f6388533d5.png"
        },
        "TerminalVO": {
            "Name": "唯一在线",
            "DeviceCode": "998871745707",
            "Code": "998871745707",
            "Address": "友朋总部",
            "PlaceName": "超市"
        },
        "ProductName": "元气森林气泡水白桃味瓶装480ml(冷)",
        "QRCodeUrl": "https://c.yopoint.com/e8605598516b1236b26eb323a644b78c?showwxpaytitle=1",
        "Token": "e8605598516b1236b26eb323a644b78c"
    }
}
修改于 2024-02-29 07:21:53
上一页
consumer.order.list
Built with