orders/query
目录 |
1.接口说明
1.1接口描述
订单交易查询
1.2适用版本
支持U8V12.0 及更高版本
2.使用场景
订单交易查询
3.接口调用说明
3.1请求说明
| url | https://api.yonyouup.com/api/orders/query |
| 格式 | JSON |
| https请求方式 | POST |
| 编码类型 | UTF-8 |
3.2url参数说明
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| from_account | string | 是 | 调用方id |
| to_account | string | 是 | 提供方id |
| app_key | string | 是 | 应用编码 |
| token | string | 是 | api调用唯一识别码 |
| ds_sequence | number | 否 | 数据源序号(默认取应用的第一个数据源) |
3.3请求体参数说明
| 参数 | 类型 | 参数路径 | 是否必填 | 描述 |
|---|---|---|---|---|
| name | string | conditions | 否 | 条件属性 |
| value1 | string | conditions | 否 | 条件属性值 |
| type | string | conditions | 否 | 条件属性类型(string/number/date/datetime/datetime2/refer/tree/ 注:date和datetime均为+1天减1秒,datetime2不特殊处理 ) |
| op | string | conditions | 否 | 条件匹配方式(eq/neq/gt/egt/lt/elt/between/in/not in/like) |
| pageIndex | number | pager | 否 | 当前页 |
| pageSize | number | pager | 否 | 单页显示个数 |
| totalPage | number | pager | 否 | 总共页数 |
| totalCount | number | pager | 否 | 总共数据数 |
| name | string | orders | 否 | 需要排序字段 |
| entity | string | orders | 否 | 对应平台字段 |
| order | string | orders | 否 | 排序方式(desc/asc) |
| name | string | fields | 否 | 返回显示字段 |
| entity | string | fields | 否 | 对应平台字段 |
| format | string | fields | 否 | 返回显示格式(json/xml) |
3.4请求示例
POST https://api.yonyouup.com/yilian/orders/query?from_account=openapi_dev&to_account=openapi_ent&app_key=opa6fdd4bea98b95ad7&token=843d03f66e6544e19707ccec11030296
POST 内容:
{
"conditions":[
{
"name":"mid",
"value1":"3541861",
"type":"string",
"op":"eq"
}
],
"pager":{
"pageIndex":1,
"pageSize":8,
"totalPage":null,
"totalCount":null
},
"orders":[
{
"name":"trade_code",
"entity":"MemberLevel",
"order":"desc"
}
],
"fields":[
{
"name":"realname"
},
{
"name":"create_time",
"format":"Y-m-d H:i:s"
}
]
}
3.5返回参数说明
| 参数说明 | 类型 | 参数路径 | 描述 |
|---|---|---|---|
| errcode | string | 错误码,0 为正常。 | |
| errmsg | string | 错误信息。 | |
| mid | string | data | 会员统一id |
| trade_code | string | data | 交易单号 |
| trade_date | date | data | 交易日期 |
| goods_code | string | data | 商品编码 |
| goods_name | string | data | 商品名称 |
| quantity | number | data | 交易数量 |
| sum | number | data | 交易金额 |
| level_name | string | data | 会员级别名称 |
| trade_source | string | data | 交易来源 |
| memo | string | data | 备注 |
| create_time | date | data | 创建时间 |
| digest | string | data | 摘要 |
| pageIndex | number | pager | 当前页 |
| pageSize | number | pager | 单页显示个数 |
| totalPage | number | pager | 总共页数 |
| totalCount | number | pager | 总共数据数 |
3.6正确返回示例
JSON示例:
{
"errcode":0,
"data":[
{
"mid":3541861,
"trade_code":"LS201507020003",
"trade_date":"2015-07-02 10:29:47",
"goods_code":null,
"goods_name":"电商测试02",
"quantity":1,
"sum":66,
"trade_source":"wjlzyd",
"memo":"wjlzyd:订单LS201507020003,
消费66.00元。",
"create_time":"2015-07-02",
"digest":null
}
],
"pager":{
"pageIndex":1,
"pageSize":10,
"totalPage":3,
"totalCount":"27"
}
}
3.7错误返回示例
application/json;charset=UTF-8
{
"errcode" : "30021",
"errmsg" : "此应用未上线"
}