Version: 1.0.4
e货运开放平台 API,包括用户管理、托运信息发布、报价管理
Operation | Description |
---|---|
POST /oauth/token?grant_type=client_credentials | 获得车商 Access Token |
POST /oauth/token?grant_type=password | 获得用户的 Access Token |
POST /oauth/token?grant_type=refresh_token | 刷新 Access Token |
Operation | Description |
---|---|
POST /members | 注册用户 |
PUT /members | 更新已注册的用户信息 |
GET /members | 返回当前第三方平台注册的用户列表 |
GET /members/{memberId} | 按用户编号查找用户 |
GET /members/current | 得到当前用户信息 |
Operation | Description |
---|---|
GET /cars/quote | 试算轿车托运价格 |
Operation | Description |
---|---|
GET /cars/search/{first}/{startCitys}/{endCitys}/{maxNum} | 查找轿车托运信息 |
Operation | Description |
---|---|
POST /cars | 发布新轿车托运信息 |
PUT /cars | 更新已发布的轿车托运信息 |
GET /cars | 当前用户所发布的轿车托运信息 |
GET /cars/{shipmentId} | 按轿车托运信息编号查找轿车 |
GET /cars/{shipmentId}/complete | 完成轿车托运 |
GET /cars/{shipmentId}/cancel | 取消轿车托运 |
GET /cars/{shipmentId}/paid | 轿车托运已支付定金 |
GET /cars/{shipmentId}/carrier | 获得接受报价托运公司的联系方式 |
Operation | Description |
---|---|
GET /bids/shipment/{shipmentId}/deposit/{value} | 获取托运信息的定金 |
GET /bids/shipment/{shipmentId} | 获取托运信息的报价 |
GET /bids/shipment/{shipmentId}/{bidId} | 获取单个报价 |
GET /bids/{bidId}/accept | 接受报价 |
GET /bids/{bidId}/reject/{bidStatus} | 拒绝报价 |
按托运信息编号获取定金数据.
Authorization | Bearer Access Token |
header | string | |
shipmentId | 托运信息编号 |
path | integer (int64) | |
value | 出价值 |
path | number (float) |
application/json
返回对应轿车托运的定金
接受托运信息的指定报价.
Authorization | Bearer Access Token |
header | string | |
bidId | 报价编号 |
path | integer (int64) |
application/json
成功接受报价
当前用户没登录
拒绝托运信息的指定报价.
Authorization | Bearer Access Token |
header | string | |
bidId | 报价编号 |
path | integer (int64) | |
bidStatus | 新的报价状态,也就是拒绝报价的原因 |
path | string |
application/json
成功拒绝报价
当前用户没登录
通过传入的起始城市编码和目的城市编码试算两城市之间的轿车托运价格
Authorization | Bearer Access Token |
header | string | |
startCity | 起始城市编码,每个城市的编码请参考城市编码表. |
query | integer (int32) | |
endCity | 目的城市编码,每个城市的编码请参考城市编码表. |
query | integer (int32) |
Uses default content-types: application/json
返回试算轿车托运价格结果
按起始城市编码和目的城市编码查找轿车托运信息
Authorization | Bearer Access Token |
header | string | |
first | 启始记录位置. |
path | integer (int32) | |
startCitys | 起始城市编码,每个城市的编码请参考城市编码表. |
path | string | |
endCitys | 目的城市编码,每个城市的编码请参考城市编码表. |
path | string | |
maxNum | 一次最多返回多少条记录. |
path | integer (int32) |
Uses default content-types: application/json
成功返回查询的轿车托运信息
取消指定托运编号的轿车托运信息
Authorization | Bearer Access Token |
header | string | |
shipmentId | 要取消的轿车托运编号 |
path | integer (int64) |
application/json
成功取消轿车托运信息
提供的轿车托运编号不正确
没查到想对应编号的轿车托运信息
ehy_auth | cars_write , cars_read |
把指定托运编号的轿车托运信息设置为已完成托运状态
Authorization | Bearer Access Token |
header | string | |
shipmentId | 要完成的轿车托运编号 |
path | integer (int64) |
application/json
成功完成轿车托运信息
提供的轿车托运编号不正确
没查到想对应编号的轿车托运信息
ehy_auth | cars_write , cars_read |
设置指定托运编号的轿车托运信息已支付过定金
Authorization | Bearer Access Token |
header | string | |
shipmentId | 已支付定金的轿车托运编号 |
path | integer (int64) |
application/json
成功设置已支付定金
提供的轿车托运编号不正确
没查到想对应编号的轿车托运信息
ehy_auth | cars_write , cars_read |
用车商申请的Client Id 和 Client Secret 换 Access Token, 此 Access Token 用于代客户注册用户.
grant_type | client_credentials |
query | string client_credentials | |
client_id | e货运开放平台为第三方应用分配的 client id |
query | string | |
client_secret | e货运开放平台为第三方应用分配的 client secret |
query | string | |
scope | 申请的访问权限,如:members_read |
query | string |
application/json
Access Token
用车用户注册时的电话号码或邮件地址及密码换 Access Token, 此 Access Token 可发布轿车托运信息.
grant_type | password |
query | string password | |
client_id | e货运开放平台为第三方应用分配的 client id |
query | string | |
client_secret | e货运开放平台为第三方应用分配的 client secret |
query | string | |
username | 登录的用户名 |
query | string | |
password | 登录的密码 |
query | string | |
scope | 申请的访问权限,如:members_read |
query | string |
application/json
Access Token
用 Refresh Token 刷新 Access Token.
grant_type | refresh_token |
query | string refresh_token | |
client_id | e货运开放平台为第三方应用分配的 client id |
query | string | |
client_secret | e货运开放平台为第三方应用分配的 client secret |
query | string | |
refresh_token | Refresh Token |
query | string |
application/json
Access Token
托运报价详细信息
报价编号
给报价的托运信息编号
报价托运公司编号
报价托运公司名称
报价托运公司的信誉评分
报价托运公司收到的评价总个数
报价托运公司状态
报价托运公司是否经过认证
报价价格
应支付定金
托运方式
轿运车类型
启运日期类型
车主接受报价之后多少天提车
计算提车日期的第一个时间点
计算提车日期的第二个时间点
送达日期类型
提车之后多少天送达
计算送达日期的第一个时间点
计算送达日期的第二个时间点
报价描述
报价是否包含保险
是全额保还只是包含基本保险
报价状态
信息过期时间
创建时间
修改时间
轿车托运信息,它将包含Shipment对象里所有属性
车型编号
是否能开
是不是敞篷车
是不是改装车
轿车估值,单位为万元
托运公司信息
托运公司编号
托运公司名称
托运公司的联系人信息
注册用户信息
用户编号
用户名称
邮件地址
电话号码
登录密码
最后登录时间
创建时间
修改时间
托运信息基本属性
托运信息编号
车商编号
托运信息名称
托运信息描述
发布托运信息的用户编号
发布托运信息的联系人信息
要托运货物的总个数
起始城市编码
起始区县编码
目的城市编码
目的区县编码
托运线路参考距离
启运日期类型
期望接受报价之后多少天提车
计算提车日期的第一个时间点
计算提车日期的第二个时间点
送达日期类型
期望提车之后多少天送达
计算送达日期的第一个时间点
计算送达日期的第二个时间点
收到的报价总数
当前状态
是否已支付定金
目标价格
信息过期时间
创建时间
修改时间