友朋运营商开放平台
  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.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 
必需
示例值:
consumer.order.list
biz_content
string 
必需
Page:获取地N页数
StartTime:起始 Unix 时间戳,秒
EndTime:结束 Unix 时间戳,秒
示例值:
{"page":1,"StartTime":1682870400,"EndTime":1685548799}
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.list"' \
--form 'biz_content="{\"page\":1,\"StartTime\":1682870400,\"EndTime\":1685548799}"' \
--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 
必需
data
object 
必需
total
integer 
总页数
必需
per_page
integer 
每页数量
必需
current_page
integer 
当前页数
必需
last_page
integer 
必需
from
integer 
必需
to
integer 
必需
data
array [object {63}] 
必需
示例
{
    "error_code": 0,
    "error_msg": "SUCCESS",
    "data": {
        "total": 4,
        "per_page": 20,
        "current_page": 1,
        "last_page": 1,
        "from": 0,
        "to": 20,
        "data": [
            {
                "UserID": "5c3333326b4cf400110f1b6b",
                "TID": "5f4cd8a151b37c00108a6357",
                "OID": "5e6b52d1b427cd001094a32a",
                "BID": "",
                "BarCode": "6970399920415",
                "OriginalPrice": 1,
                "Price": 1,
                "Discount": 100,
                "CostPrice": 0,
                "Temperature": 1,
                "PayType": 21,
                "ClientIPAddress": "113.118.45.62",
                "PayExtend": {
                    "SpecExtend": {}
                },
                "ScenesType": 0,
                "ReceiptNo": "OD230525145335113680",
                "FID": "5e96f3d52a35a000104c18cc",
                "ReplenisherAccountID": "5a0aa2a97c7481000f47c188",
                "ExplainLocation": "",
                "Address": "友朋总部",
                "PlaceID": "6141ad84b7e8e0001131a5e6",
                "InnerCode": "",
                "PlaceName": "超市",
                "Country": "",
                "Province": "广东省",
                "City": "深圳市",
                "District": "宝安区",
                "LandMarkName": "固戍",
                "IndustryParentName": "购物",
                "IndustryName": "购物中心",
                "TerminalName": "唯一在线",
                "DeviceCode": "998871745707",
                "DeviceProductionCode": "998871745707",
                "TradeNo": "230525115263503993",
                "PayTime": 1684997625,
                "TradeStatus": 2,
                "RefundsTime": 1684997834,
                "RefundsType": 0,
                "BrandSellSupplyPrice": 0,
                "CabinetName": "A",
                "CargoNum": 2,
                "CargoDisplayName": "02",
                "MotorIndex": 1,
                "ShipmentsTime": 1684997626,
                "ShipmentsStatus": 1,
                "ShipmentsError": "",
                "UserRefundsStatus": 2,
                "UserRefundsTime": 1684997801,
                "UserRefundsReason": "REFUNDS_REASON_DELIVERY_FAIL",
                "UserRefundsRemarks": "展示",
                "UserRefundsImageUrl": [
                    "https://res.yopoint.com/consumer/20230525/793dc51a79db831237c8367351381a41.jpeg"
                ],
                "OpAccountID": "5e8163f923bd6800107fd053",
                "RefundsRemarks": "123",
                "FromReceiptNo": "",
                "BizSource": 0,
                "FromOrderInfo": {},
                "UserTakeTime": 0,
                "CreateAt": 1684997615,
                "UpdatedAt": 1684997834,
                "id": "646f05ef7b217d00110b0399",
                "UserVO": {
                    "Platform": 1,
                    "OpenID": "oA0rgwSuKDaFnD9Z75rqmWavULrg",
                    "Scope": "userinfo",
                    "MemberID": "5c45bc9de2e567001b97c9fe",
                    "NickName": "HH",
                    "Sex": 0,
                    "Province": "",
                    "City": "",
                    "ImageUrl": "https://thirdwx.qlogo.cn/mmopen/vi_32/T6DibKNlGcQ63DtYReMdrDsnibf5ZLw09XRd8RUxLJ2znFn5J2ffuENI3ibft7VLFYMFmjic65bkrb8BA31xBvuibJg/132",
                    "CreateAt": 1546859314,
                    "UpdatedAt": 1698285277,
                    "isFirstFlash": true,
                    "LastLoginTime": 1698285277,
                    "LastIPAddress": "113.90.239.187",
                    "id": "5c3333326b4cf400110f1b6b"
                },
                "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"
                },
                "ProductName": "元气森林气泡水白桃味瓶装480ml(冷)"
            }
        ]
    }
}
修改于 2024-02-29 07:21:37
上一页
cabinet.order.get
下一页
consumer.order.get
Built with