Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Table of Contents | ||||
---|---|---|---|---|
|
说明
批量订单是为了方便进行一次性处理大量订单而提供的一个创建临时处理订单的接口,通过派分处理任务让系统自动处理临时订单并自动生成本地出库订单
按调用的先后顺序, 有三个接口 上传临时订单 、 处理临时订单 、 查询处理结果
1. 上传临时订单
接口格式
url | http://test.birdsystem.com/client/consignment-upload/Temp-Consignment-Json | ||
接口功能 | 批量添加订单 | ||
支持参数格式 | JSON | 开发人员 | |
method | POST | 发布日期 |
接口参数
参数 | 类型 | 必填 | 说明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
contact | STRING |
| 联系人 | ||||||||||
business_name | STRING |
| 公司名称 | ||||||||||
name_customs | STRING |
| 产品英文名称 | ||||||||||
address_line1 | STRING |
| 地址行1 | ||||||||||
address_line2 | STRING |
| 地址行2 | ||||||||||
address_line3 | STRING |
| 地址行3 | ||||||||||
city | STRING |
| 城市 | ||||||||||
county | STRING |
| 省/郡 | ||||||||||
post_code | STRING |
| 邮编 | ||||||||||
country_name | STRING |
| 国家名称 | ||||||||||
telephone | STRING |
| 电话号码 | ||||||||||
STRING |
| 电子邮箱 | |||||||||||
sales_order_id | STRING |
| 销售订单ID, 【yodel 出口必填】 | ||||||||||
payment_reference | STRING |
| 付款凭证 | ||||||||||
special_instruction | STRING |
| 备注1 | ||||||||||
product_company_ref | STRING |
| 以拼接字符串方式提供的多个产品信息, 多个产品以”+”号连接: 产品1*数量||eBay订单交易号||eBay产品ID||平台销售单价+产品2*数量||eBay订单交易号||eBay产品ID||平台销售单价+….. 其中:
例如: 1-1996129*1||ebayid||ebatproduct||18+1996125*1||ebayid2||ebatproduct2||20 选填项可以省略,例如最简单的格式: 1996129*1+1996125*2 其中的产品1,产品2,可以用 产品id/客户sku,由 “设置”->”账户” 中的 批量订单设置来决定: 也支持定向共享产品.其格式:
| ||||||||||
delivery_service_name | STRING |
| 邮递服务名称 从 邮递服务查询 获取邮递服务列表,只能填写订单类型为LOCAL/DIRECT的服务, 且要与报文中的type字段对应. | ||||||||||
status | STRING |
| 订单状态:PENDING | ||||||||||
type | STRING |
| 订单类型 取值LOCAL或DIRECT, LOCAL是本地订单, DIRECT是专线订单. 默认LOCAL | ||||||||||
thirty_system_id | STRING |
| 第三方系统单号ID. 会在response中返回,以便ERP能将返回数据与其批量提交的数据一一对应 | ||||||||||
custom_identity_reference | STRING |
| 自定义唯一跟踪号 (如果填写了,会进行重复检测,同一批量订单种类同一站点下的订单,6个月内不能有重复的标识, 重复的话会返回: {"success":false,"message":"Duplicate consignment identity reference [....]"}) | ||||||||||
sales_reference | STRING |
| 销售跟踪号 | ||||||||||
sales_price | STRING |
| 销售平台单价 | ||||||||||
omp_name | STRING |
| 销售平台名称,必须是英文 【royal mail,yodel 出口必填】 常见的平台代码如下:
| ||||||||||
omp_vat_number | STRING |
| 销售平台VAT号, 【yodel 出口必填】 英国发往非英国且公司不为空("business_name"字段)的DPD订单必填 | ||||||||||
shipper_eori | STRING |
| 客人的EORI号, 必须是国家代码+12位数字,例如:GB000000777888 ,必须提前在鸟系统备案VAT,详询客服. 参考接口: 获取VAT账号 ,【royal mail,yodel 出口必填】 英国发往EU必填 英国发往非英国的DPD服务必填 | ||||||||||
reason_for_export | STRING |
| 出口原因, 取值【SALE:销售; RETURN REPLACEMENT:退换; GIFT:礼物】【dpd 出口必填】 | ||||||||||
content_type | STRING |
| 包裹类型, 取值【GIFT:礼物; DOCUMENTS:文件; OTHER:其他】【royalmail 出口必填】 | ||||||||||
ioss_vat_number | STRING |
| IOSS号, 发往欧盟国家时必填, 限制填12位字符, 格式: 两位字母+十位数字 | ||||||||||
receiver_eori | STRING |
| 收件人EORI 英国发往非英国且公司不为空(“business_name“字段)的DPD订单必填 | ||||||||||
receiver_pid_number | STRING |
| 收件人个人证件号, 英国发往挪威、西班牙、意大利的DPD订单必填 | ||||||||||
is_compensation_for_delay | BOOL |
| 是否需要晚必赔服务(仅支持部分服务,偏远地区除外), 取值0或者1, 默认为0 |
接口示例
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
请求地址:http://branch.birdsystem.com/client/consignment-upload/temp-consignment-json
返回
异常返回报错时需检查字段填写是否完整。contact, post_code, city, country_name, product sku, quantity, address_line1.
|
2. 处理临时订单
接口格式
URL | http://test.birdsystem.com/client/Temp-Consignment-Info/Convert-Into-Consignment/?type=LOCAL&ids=XXX | ||
---|---|---|---|
接口功能 | 处理批量临时本地订单到正式订单 | ||
支持参数格式 | URL | 开发人员 | |
请求方式 | GET | 发布日期 |
接口参数
参数 | 类型 | 必填 | 说明 | ||||||
---|---|---|---|---|---|---|---|---|---|
type | STRING |
| 订单类型,取值为LOCAL或DIRECT,代表本地订单或专线订单 | ||||||
ids | STRING |
| 要处理的临时订单id列表,多个id用下划线分隔;如果不传的话,默认取所有待处理的订单 | ||||||
includeProblemConsignments | BOOL |
| 是否包含有问题的订单,传1时表示包括有问题的订单;不传或者传其他值表示忽略有问题的订单 |
接口示例
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
请求
返回
其中taskId是当前正在运行的后台任务的id。(目前使用后台异步任务模式, 开启一个后台任务后, 不等后台完成, 就返回后台任务的id) 异常返回报错时需检查字段填写是否完整。contact, post_code, city, country_name, product sku, quantity, address_line1.
|
3. 查询处理结果
接口格式
URL | http://test.birdsystem.com/client/Gearman-background-tasks/Get-Detail?id=xxxx | ||
接口功能 | 查询后台任务处理情况 | ||
支持参数格式 | URL | 开发人员 | |
请求方式 | GET | 发布日期 |
接口参数
参数 | 类型 | 必填 | 说明 | ||||||
---|---|---|---|---|---|---|---|---|---|
id | INT |
| 后台任务ID,为空默认查询所有后台任务 |
接口示例
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
请求
返回
status状态有 'QUEUE' (排队中), 'RUNNING'(运行中), 'FINISH' (已完成), 'ERROR' (出错), 'ABORTED' (已被人为中断)几种状态 4. 查询临时订单接口格式
接口参数
接口示例请求
返回
status状态有 'QUEUE' (排队中), 'RUNNING'(运行中), 'FINISH' (已完成), 'ERROR' (出错), 'ABORTED' (已被人为中断)几种状态 异常返回报错时需检查字段填写是否完整。contact, post_code, city, country_name, product sku, quantity, address_line1.
|