友朋运营商开放平台
  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 列表

cabinet.order.get

POST
https://api.yopoint.com/api/gateway/index
使用场景:
根据 ReceiptNo,获取自取柜订单详情 。 可使用接口 cabinet.order.list 或 异步回调通知 notify.cabinet.order.simple 中获得 ReceiptNo
业务参数说明
参数名称类型是否必须说明
ReceiptNostringN订单号(订单号和交易单号必填一项)
TradeNostringN交易单号

请求参数

Header 参数
Content-Type
string 
必需
默认值:
application/x-www-form-urlencoded
Body 参数multipart/form-data
appid
string 
必需
示例值:
{{appid}}
method
string 
必需
示例值:
cabinet.order.get
biz_content
string 
必需
ReceiptNo:友朋系统订单号
TradeNo:交易单号
示例值:
{"ReceiptNo":"VI231228102118586561"}
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="cabinet.order.get"' \
--form 'biz_content="{\"ReceiptNo\":\"VI231228102118586561\"}"' \
--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 
必需
CID
string 
自取柜ID
必需
OID
string 
运营商ID
必需
DeviceCode
string 
设备编号
必需
运营商自行定义
TerminalName
string 
设备名称
必需
运营商自行定义
UserID
string 
用户ID
必需
OpenID
string 
平台的用户ID
必需
PayType
integer 
支付方式
必需
1是微信,2是支付宝,201品牌商微信, 202品牌商支付宝
ScenesType
integer 
支付场景
必需
0=扫码支付 1=友朋刷脸 2=微信刷脸 3=支付宝刷脸 4=密码购
ServiceStatus
integer 
服务状态
必需
0=未开始服务 1=服务中 2=服务结束
TradeNo
string 
支付订单号
必需
微信支付,支付宝平台的交易流水号
ReceiptNo
string 
友朋订单号
必需
LandMarkName
string 
必需
IndustryParentName
string 
必需
IndustryName
string 
必需
PayTime
integer 
支付时间
必需
Products
array [object {7}] 
商品明细
必需
DoorStatus
integer 
门状态
必需
-1=没有开门 0=已关门 1=已开门
TradeStatus
integer 
交易状态
必需
0=等待结算 1=已支付成功 2=已退款成功 -1=已取消订单
Price
integer 
订单金额
必需
单位:分
PayPrice
integer 
实付金额
必需
单位: 分
IsSuspicious
integer 
异常订单
必需
0=正常 1=异常订单
RefundsProducts
array [object {8}] 
退款商品
必需
RefundsPrice
integer 
退款金额
必需
单位:分
RefundsTime
integer 
退款时间
必需
id
string 
订单ID
必需
UserVO
object 
用户信息
必需
微信用户隐私变更后,不再有用户数据
NotifyUrl
string 
必需
示例
{
    "error_code": 0,
    "error_msg": "SUCCESS",
    "sub_error_code": null,
    "sub_error_msg": null,
    "data": {
        "CID": "5f6da2362201410011fe7b72",
        "OID": "5e6b52d1b427cd001094a32a",
        "DeviceCode": "A001",
        "TerminalName": "测试机器",
        "UserID": "59e6f137360c5c000f27b6ce",
        "OpenID": "oNlHk5OU_e6DSo5_shMj-8SGJJjQ",
        "PayType": 90,
        "ScenesType": 0,
        "ServiceStatus": 2,
        "TradeNo": "",
        "ReceiptNo": "VI231228102118586561",
        "LandMarkName": "西田",
        "IndustryParentName": "公司企业工厂",
        "IndustryName": "孵化器、投资类公司",
        "PayTime": 1703730094,
        "Products": [
            {
                "Qty": 1,
                "BarCode": "6970399920439",
                "Name": "元气森林0糖苏打气泡水卡曼橘味480ml",
                "Price": 1,
                "CostPrice": 54,
                "TotalPrice": 1,
                "ProductVO": {
                    "Name": "元气森林0糖苏打气泡水卡曼橘味480ml",
                    "ImageUrl": "https://res.yopoint.com/resource/20220518/209efc9347453c3f724963b1ce8e482a.png",
                    "ImageFixWidthUrl": "https://res.yopoint.com/resource/20220518/de208490ab6f7ef29a948ccd9188d428.png"
                }
            }
        ],
        "DoorStatus": 0,
        "TradeStatus": 2,
        "Price": 1,
        "PayPrice": 1,
        "IsSuspicious": 0,
        "RefundsProducts": [
            {
                "Qty": 1,
                "BarCode": "6970399920439",
                "Name": "元气森林0糖苏打气泡水卡曼橘味480ml",
                "Price": 1,
                "CostPrice": 54,
                "TotalPrice": 1,
                "ProductVO": {
                    "Name": "元气森林0糖苏打气泡水卡曼橘味480ml",
                    "ImageUrl": "https://res.yopoint.com/resource/20220518/209efc9347453c3f724963b1ce8e482a.png",
                    "ImageFixWidthUrl": "https://res.yopoint.com/resource/20220518/de208490ab6f7ef29a948ccd9188d428.png"
                },
                "RealQty": 1
            }
        ],
        "RefundsPrice": 1,
        "RefundsTime": 1705389672,
        "id": "658cdb9e42860000117be999",
        "UserVO": {
            "Platform": 1,
            "OpenID": "oA0rgwSG46LCDG8Xnhv90IO7T10I",
            "Scope": "userinfo",
            "MemberID": "5a001d72e7edb5000f2e25f6",
            "NickName": "钱钱🙃",
            "Sex": 0,
            "Province": "",
            "City": "",
            "ImageUrl": "https://thirdwx.qlogo.cn/mmopen/vi_32/295czzN8HT0ZTSicHgW2EHBeYIKuqOu2YptIAyTwIRNQA1pvJ0DjqdNONo0MBlsNOpAuHTkNEBCGMl16ZcarD7w/132",
            "CreateAt": 1508307255,
            "UpdatedAt": 1701251219,
            "isFirstFlash": false,
            "LastLoginTime": 1701251219,
            "LastIPAddress": "113.118.47.101",
            "id": "59e6f137360c5c000f27b6ce",
            "MemberVO": {
                "Mobile": "13800138000",
                "NickName": "HH",
                "Sex": 2,
                "Platform": [
                    1,
                    2,
                ]
            }
        },
        "NotifyUrl": ""
    }
}
修改于 2024-02-29 07:21:35
上一页
cabinet.order.list
下一页
consumer.order.list
Built with