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

POST
https://api.yopoint.com/api/gateway/index
使用场景:
通过时间段获取当前运营商下的自取柜订单列表

请求参数

Header 参数
Content-Type
string 
必需
默认值:
application/x-www-form-urlencoded
Body 参数multipart/form-data
appid
string 
必需
示例值:
{{appid}}
method
string 
必需
示例值:
cabinet.order.list
biz_content
string 
必需
Page:获取地N页数
StartTime:起始 Unix 时间戳,秒
EndTime:结束 Unix 时间戳,秒
pageSize:每页记录数,最多支持100
示例值:
{"page":1,"StartTime":1708617600,"EndTime":1709222399,pageSize:20}
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.list"' \
--form 'biz_content="{\"page\":1,\"StartTime\":1708617600,\"EndTime\":1709222399,pageSize:20}"' \
--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 
必需
total
integer 
总页数
必需
per_page
integer 
每页数量
必需
current_page
integer 
当前页数
必需
last_page
integer 
必需
from
integer 
必需
to
integer 
必需
data
array [object {60}] 
必需
示例
{
    "error_code": 0,
    "error_msg": "SUCCESS",
    "sub_error_code": null,
    "sub_error_msg": null,
    "data": {
        "CID": "5f6da2362201410011fe7b72",
        "OID": "5e6b52d1b427cd001094a32a",
        "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,
        "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:42
上一页
cabinet.order.user.appeal
下一页
cabinet.order.get
Built with