Version: 1.0.3
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 |
---|---|
POST /pets | 发布新宠物托运信息 |
PUT /pets | 更新已发布的宠物托运信息 |
GET /pets | 当前用户所发布的宠物托运信息 |
GET /pets/{shipmentId} | 按宠物托运信息编号查找宠物 |
GET /pets/{shipmentId}/complete | 完成宠物托运 |
GET /pets/{shipmentId}/cancel | 取消宠物托运 |
GET /pets/{shipmentId}/carrier | 获得接受报价托运公司的联系方式 |
Operation | Description |
---|---|
GET /bids/shipment/{shipmentId} | 获取托运信息的报价 |
GET /bids/{bidId}/accept | 接受报价 |
GET /bids/{bidId}/reject/{bidStatus} | 拒绝报价 |
接受托运信息的指定报价.
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
成功拒绝报价
当前用户没登录
用合作平台申请的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
取消指定托运编号的宠物托运信息
Authorization | Bearer Access Token |
header | string | |
shipmentId | 要取消的宠物托运编号 |
path | integer (int64) |
application/json
成功取消宠物托运信息
提供的宠物托运编号不正确
没查到想对应编号的宠物托运信息
ehy_auth | pets_write , pets_read |
把指定托运编号的宠物托运信息设置为已完成托运状态
Authorization | Bearer Access Token |
header | string | |
shipmentId | 要完成的宠物托运编号 |
path | integer (int64) |
application/json
成功完成宠物托运信息
提供的宠物托运编号不正确
没查到想对应编号的宠物托运信息
ehy_auth | pets_write , pets_read |
托运报价详细信息
报价编号
给报价的托运信息编号
报价托运公司编号
报价托运公司名称
报价托运公司的信誉评分
报价托运公司收到的评价总个数
报价托运公司状态
报价托运公司是否经过认证
报价价格
应支付定金
托运方式
货车类型
启运日期类型
接受报价之后多少天提货
计算提货日期的第一个时间点
计算提货日期的第二个时间点
送达日期类型
提货之后多少天送达
计算送达日期的第一个时间点
计算送达日期的第二个时间点
报价描述
报价是否包含保险
是全额保还只是包含基本保险
报价状态
信息过期时间
创建时间
修改时间
托运公司信息
托运公司编号
托运公司名称
托运公司的联系人信息
注册用户信息
用户编号
用户名称
邮件地址
电话号码
登录密码
最后登录时间
创建时间
修改时间
托运信息基本属性
托运信息编号
第三方合作平台编号
托运信息名称
托运信息描述
发布托运信息的用户编号
发布托运信息的联系人信息
要托运货物的总个数
起始城市编码
起始区县编码
目的城市编码
目的区县编码
托运线路参考距离
启运日期类型
期望接受报价之后多少天提货
计算提货日期的第一个时间点
计算提货日期的第二个时间点
送达日期类型
期望提货之后多少天送达
计算送达日期的第一个时间点
计算送达日期的第二个时间点
收到的报价总数
当前状态
是否已支付定金
目标价格
信息过期时间
创建时间
修改时间