ezbuy.parcel.search （搜索包裹信息）
GET
调用方获取符合搜索条件的包裹时使用 公共参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| method | string | y | api接口名称 |
| app_key | string | y | ezbuy分配给应用的AppKey |
| sign_method | string | y | 签名摘要算法，可选值：hmac,md5 |
| sign | string | y | api输入参数的签名结果 |
| timestamp | string | y | 日期，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8。ezbuy api服务端允许客户端请求的最大时间误差为10分钟 |
| version | string | y | api协议版本，可选值：1.0 |
请求参数
| 名称 | 类型 | 是否必须 | 示例值 | 限制 | 描述 |
|---|---|---|---|---|---|
| order_nums | []string | n | ["25374807059070976-4","25374807059070976-5"] | 精确搜索 | |
| parcel_nums | []string | n | ["PAS16456147330710","PAS16456147330711"] | 包裹号,精确搜索 | |
| sub_parcel_nums | []string | n | ["PAS16456147330710-1P","PAS16456147330710-2P"] | 子包裹号,精确搜索 | |
| parcel_status | []number | n | [1,2,3] | 包裹状态 包裹状态 | |
| start_pay_date | number | n | 1646374205 | 订单付款起始时间的时间戳 | |
| end_pay_date | number | n | 1646374205 | 订单付款结束时间的时间戳, | |
| start_cancel_date | number | n | 1646374205 | 订单取消起始时间的时间戳 | |
| end_cancel_date | number | n | 1646374205 | 订单取消结束时间的时间戳 | |
| start_create_date | number | n | 1646374205 | 订单开始时间的时间戳 | |
| end_dreate_date | number | n | 1646374205 | 订单结束时间的时间戳 | |
| fields | string | n | status,product_name | 需返回的字段列表；可选值为ParcelOrderData数据结构中定义的字段，多个字段用“,”分隔, 默认返回全部 | |
| page_no | number | y | 1 | 当前页码，默认值为1 | |
| page_size | number | y | 10 | 每页条数,每页返回最多返回100条,默认值为10 |
响应参数
| 名称 | 类型 | 示例值 | 描述 | |
|---|---|---|---|---|
| request_id | string | 92128f6e-daf3-11e7-a003-f45c89aebcfb | 请求id | |
| status | RespCode | 接口响应状态 | ||
| data | total | number | 10 | 匹配条件的总记录数 |
| parcel_list | ParcelOrderData[] | 匹配的包裹列表 | ||
响应示例
{
"request_id":"ac72b7ff-a5a3-11ec-afc1-069e106da207",
"status":{
"code":"E0",
"message":"success"
},
"data":{
"total":332,
"parcel_list":[
{
"consignee":{
"address":"22 dsfds #22 - 2322",
"address_type":4,
"mobile":"+6599876453",
"username":"8nasdn",
"zip_code":"453323"
},
"delivery_method":2,
"ezorder_id":"327435878582430976",
"order_items":[
{
"cancel_date":0,
"cancel_reason":0,
"cus_region":100000000,
"dispatch_date":1635479404,
"order_item_id":"27435892339717376",
"order_num":"327435878582430976-8",
"order_status":1003000,
"paid_amount":34000,
"paid_date":1635306604,
"product_id":497229,
"product_name":"local Martin boots men's Chelsea winter boots Vintage shoes",
"quantity":2,
"remark":"",
"seller_sku_id":"",
"sku_id":497231,
"sku_img":"http://7xiata.com1.z0.glb.clouddn.com/FsAKsM_qgc7OlWv42u0H7li_6_vF",
"sku_name":"黑色；39；动物皮",
"unit_price":15999,
"warehouse":5
}
],
"parcel_num":"PAS16353066170658",
"parcel_status":1,
"shop_id":1282,
"splited":true,
"sub_parcel_items":[
{
"create_date":1635318385,
"order_items":[
{
"cancel_date":0,
"cancel_reason":0,
"cus_region":100000000,
"dispatch_date":1635479404,
"order_item_id":"27435892339717376",
"order_num":"327435878582430976-8",
"order_status":1003000,
"paid_amount":34000,
"paid_date":1635306604,
"product_id":497229,
"product_name":"local Martin boots men's Chelsea winter boots Vintage shoes",
"quantity":2,
"remark":"",
"seller_sku_id":"",
"sku_id":497231,
"sku_img":"http://7xiata.com1.z0.glb.clouddn.com/FsAKsM_qgc7OlWv42u0H7li_6_vF",
"sku_name":"黑色；39；动物皮",
"unit_price":15999,
"warehouse":5
}
],
"sub_parcel_num":"PAS16353066170658-1P",
"sub_parcel_status":1,
"update_date":1635318385
}
]
}
]
}
}
ezbuy.parcel.split （拆分包裹）
POST
调用方拆分包裹/还原被拆分包裹时使用 公共参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| method | string | y | api接口名称 |
| app_key | string | y | ezbuy分配给应用的AppKey |
| sign_method | string | y | 签名摘要算法，可选值：hmac,md5 |
| sign | string | y | api输入参数的签名结果 |
| timestamp | string | y | 日期，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8。ezbuy api服务端允许客户端请求的最大时间误差为10分钟 |
| version | string | y | api协议版本，可选值：1.0 |
请求参数
| 名称 | 类型 | 是否必须 | 示例值 | 限制 | 描述 |
|---|---|---|---|---|---|
| parcel_num | string | y | 包裹号 | ||
| sub_parcels | SplitParcelData[] | n | 子包裹数据列表 |
响应参数
| 名称 | 类型 | 示例值 | 描述 | |
|---|---|---|---|---|
| request_id | string | 92128f6e-daf3-11e7-a003-f45c89aebcfb | 请求id | |
| status | RespCode | 接口响应状态 | ||
请求参数示例
{
"parcel_num":"PAS16462885330002",
"sub_parcels":[
{
"items":[
{
"order_item_id":"27620138316464384",
"quantity":4
}
]
},
{
"items":[
{
"order_item_id":"27620138316465408",
"quantity":11
}
]
}
]
}
ezbuy.parcel.dispatch （包裹发货）
POST
调用方包裹发货时使用 公共参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| method | string | y | api接口名称 |
| app_key | string | y | ezbuy分配给应用的AppKey |
| sign_method | string | y | 签名摘要算法，可选值：hmac,md5 |
| sign | string | y | api输入参数的签名结果 |
| timestamp | string | y | 日期，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8。ezbuy api服务端允许客户端请求的最大时间误差为10分钟 |
| version | string | y | api协议版本，可选值：1.0 |
请求参数
| 名称 | 类型 | 是否必须 | 示例值 | 限制 | 描述 |
|---|---|---|---|---|---|
| parcels | DispatchParcelData[] | y | 包裹数据列表 |
响应参数
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| request_id | string | 92128f6e-daf3-11e7-a003-f45c89aebcfb | 请求id |
| status | RespCode | 接口响应状态 |
ezbuy.parcel.search.address （查询地址列表）
POST
调用方查询卖家发货地址列表时使用 公共参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| method | string | y | api接口名称 |
| app_key | string | y | ezbuy分配给应用的AppKey |
| sign_method | string | y | 签名摘要算法，可选值：hmac,md5 |
| sign | string | y | api输入参数的签名结果 |
| timestamp | string | y | 日期，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8。ezbuy api服务端允许客户端请求的最大时间误差为10分钟 |
| version | string | y | api协议版本，可选值：1.0 |
响应参数
| 名称 | 类型 | 示例值 | 描述 | |
|---|---|---|---|---|
| request_id | string | 92128f6e-daf3-11e7-a003-f45c89aebcfb | 请求id | |
| status | RespCode | 接口响应状态 | ||
| data | ||||
| addresses | DispatchAddressData[] | 卖家发货地址列表 | ||
ezbuy.parcel.search.pickup （查询取货计划）
POST
调用方查询取货计划时使用 公共参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| method | string | y | api接口名称 |
| app_key | string | y | ezbuy分配给应用的AppKey |
| sign_method | string | y | 签名摘要算法，可选值：hmac,md5 |
| sign | string | y | api输入参数的签名结果 |
| timestamp | string | y | 日期，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8。ezbuy api服务端允许客户端请求的最大时间误差为10分钟 |
| version | string | y | api协议版本，可选值：1.0 |
请求参数
| 名称 | 类型 | 是否必须 | 示例值 | 限制 | 描述 |
|---|---|---|---|---|---|
| start_date | number | y | 1635318385 | 开始时间 | |
| end_date | number | y | 1635318399 | 结束时间 |
响应参数
| 名称 | 类型 | 示例值 | 描述 | |
|---|---|---|---|---|
| request_id | string | 92128f6e-daf3-11e7-a003-f45c89aebcfb | 请求id | |
| status | RespCode | 接口响应状态 | ||
| data | total | number | 10 | 匹配条件的总记录数 |
| task_items | SearchPickupData[] | 取货任务列表 | ||
| pickup_periods | PickupPeriodModel[] | 可取货日期列表 | ||
ezbuy.parcel.upsert.pickup （预约取货计划）
POST
调用方预约取货计划时使用 公共参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| method | string | y | api接口名称 |
| app_key | string | y | ezbuy分配给应用的AppKey |
| sign_method | string | y | 签名摘要算法，可选值：hmac,md5 |
| sign | string | y | api输入参数的签名结果 |
| timestamp | string | y | 日期，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8。ezbuy api服务端允许客户端请求的最大时间误差为10分钟 |
| version | string | y | api协议版本，可选值：1.0 |
请求参数
| 名称 | 类型 | 是否必须 | 示例值 | 限制 | 描述 |
|---|---|---|---|---|---|
| task_no | string | n | 任务编号 | ||
| pickup_date | number | y | 1635318385 | 取货日期 | |
| period | PeriodModel | y | {"id":389189,"pickup_start":"08:00:00","pickup_end":"16:00:00"} | 取货时间段 | |
| provider | string | y | ezbuy | 物流商 | |
| address_id | string | y | 27620138316464384 | 地址Id | |
| remark | string | n | 备注 |
响应参数
| 名称 | 类型 | 示例值 | 描述 | |
|---|---|---|---|---|
| request_id | string | 92128f6e-daf3-11e7-a003-f45c89aebcfb | 请求id | |
| status | RespCode | {"code":"E0","message":"success"} | 接口响应状态 | |
| data | task_no | string | abc10101 | 取货任务编号 |
ezbuy.parcel.delete.pickup （删除取货）
POST
调用方删除取货时使用 公共参数
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| method | string | y | api接口名称 |
| app_key | string | y | ezbuy分配给应用的AppKey |
| sign_method | string | y | 签名摘要算法，可选值：hmac,md5 |
| sign | string | y | api输入参数的签名结果 |
| timestamp | string | y | 日期，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8。ezbuy api服务端允许客户端请求的最大时间误差为10分钟 |
| version | string | y | api协议版本，可选值：1.0 |
请求参数
| 名称 | 类型 | 是否必须 | 示例值 | 限制 | 描述 |
|---|---|---|---|---|---|
| task_no | string | y | 任务编号 |
响应参数
| 名称 | 类型 | 示例值 | 描述 | |
|---|---|---|---|---|
| request_id | string | 92128f6e-daf3-11e7-a003-f45c89aebcfb | 请求id | |
| status | RespCode | {"code":"E0","message":"success"} | 接口响应状态 | |