商户后台
供派娜(PayAny)聚合支付SaaS平台用户的商户进行管理终端、订单、退款、争议、运单、提现、报表等。
{platform}为merchant。
运单
运单列表。
创建
创建运单。
请求地址:/waybill/create
请求谓词:POST
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
txnId | 数值 | 是 | 交易号 | |
carrierId | 数值 | 是 | 承运商ID | |
trackNumber | 字符串 | 是 | 运单号 | |
datePickup | 日期 | 是 | 揽收日期 | |
dateDelivered | 日期 | 是 | 妥投日期 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
数值 | 是 | 返回运单编号 |
响应示例:
{ "status":200, "message":"ok", "data":123456789, "timestamp":1218154088000}
上传
批量上传运单(需要根据我们指定的模板进行编译后上传)。
请求地址:/waybill/upload
请求谓词:POST
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
file | byte[] | 是 | 文件字节 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
布尔 | 是 | true表示上传成功 false表示上传失败 |
响应示例:
{ "status":200, "message":"ok", "data":true, "timestamp":1218154088000}
查询
以分页形式提供运单的列表或查询结果。
请求地址:/waybill/list/{pageIndex}-{pageSize}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
pageIndex | 数值 | >=1 | 是 | 分页页码 为URL路径的一部分,非GET参数 |
pageSize | 数值 | 1~100 | 是 | 分页容量,建议20 为URL路径的一部分,非GET参数 |
waybillId | 数值 | 否 | 运单编号 | |
channelId | 数值 | 否 | 渠道编号 | |
midId | 数值 | 否 | 渠道商户号 | |
txnId | 数值 | 否 | 交易号 | |
carrierId | 文本 | 否 | 承运商编号 | |
trackNumber | 文本 | 否 | 运单号 | |
status | 数值 | 否 | 状态:(0:待审核,1:已通过,2:已拒绝) | |
dateStart | 时间 yyyy-mm-dd hh:mm:ss | 否 | 起始时间,包含 如:2008-08-08 08:08:08 | |
dateEnd | 时间 yyyy-mm-dd hh:mm:ss | 否 | 截止时间,包含 如:2018-10-18 18:18:18 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
pageIndex | 数值 | 是 | 分页页码 |
pageSize | 数值 | 是 | 分页容量 |
totalPageCount | 数值 | 是 | 总页数 |
totalItemCount | 数值 | 是 | 总记录数 |
items | 集合 | 是 | 对象集合,可以为空 |
items[].tenantId | 数值 | 是 | 同开发者帐号 |
items[].id | 数值 | 是 | 编号 |
items[].channelId | 数值 | 是 | 渠道编号 |
items[].mIDId | 数值 | 是 | 渠道商户号 |
items[].transactionId | 数值 | 是 | 交易编号 |
items[].merchantId | 数值 | 是 | 商户号 |
items[].txnId | 文本 | 是 | 交易号 |
items[].carrierId | 文本 | 是 | 承运商编号 |
items[].trackNumber | 文本 | 是 | 运单号 |
items[].datePickup | 时间 | 是 | 揽收日期 |
items[].dateDelivered | 时间 | 是 | 妥投日期 |
items[].status | 文本 | 是 | 状态:(0:待审核,1:已通过,2:已拒绝) |
items[].dateCreated | 时间 | 是 | 创建时间 |
items[].dateUpdated | 时间 | 否 | 最后变更时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "pageIndex":1, "pageSize":20, "totalPageCount":100, "totalItemCount":1998, "items":[ { "id":1231231, "tenantId":123456, "channelId":12345678, "mIDId":12345678, "transactionId":20080624141526, "merchantId":12345678, "txnId":2021041513322001, "carrierId":"121qeweq", "trackNumber":"asd12313", "datePickup":"2008-08-08T18:18:18", "dateDelivered":""2008-08-08T18:18:18"", "status":1, "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, { "id":1231231, "tenantId":123456, "channelId":12345678, "mIDId":12345678, "transactionId":20080624141526, "merchantId":12345678, "txnId":2021041513322001, "carrierId":"121qeweq", "trackNumber":"asd12313", "datePickup":"2008-08-08T18:18:18", "dateDelivered":""2008-08-08T18:18:18"", "status":1, "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, .... ] }, "timestamp":1218154088000}