Table of Contents

minLevel	1
maxLevel	7

说明

批量订单是为了方便进行一次性处理大量订单而提供的一个创建临时处理订单的接口，通过派分处理任务让系统自动处理临时订单并自动生成本地出库订单

按调用的先后顺序, 有三个接口 上传临时订单 、 处理临时订单、查询处理结果

1. 上传临时订单

接口格式

url	http://test.birdsystem.com/client/consignment-upload/Temp-Consignment-Json
接口功能	批量添加订单
支持参数格式	JSON	开发人员
method	POST	发布日期

接口参数

参数

类型

必填

说明

contact

STRING

Status

colour	Red
title	必填

联系人

business_name

STRING

Status

colour	Green
title	选填

公司名称

name_customs

STRING

Status

colour	Green
title	选填

产品英文名称

address_line1

STRING

Status

colour	Red
title	必填

地址行1

address_line2

STRING

Status

colour	Green
title	选填

地址行2

address_line3

STRING

Status

colour	Green
title	选填

地址行3

city

STRING

Status

colour	Red
title	必填

城市

county

STRING

Status

colour	Green
title	选填

省/郡

post_code

STRING

Status

colour	Red
title	必填

邮编

country_name

STRING

Status

colour	Green
title	选填

国家名称

telephone

STRING

Status

colour	Green
title	选填

电话号码

email

STRING

Status

colour	Green
title	选填

电子邮箱

sales_order_id

STRING

Status

colour	Green
title	选填

销售订单ID, 【yodel 出口必填】

payment_reference

STRING

Status

colour	Green
title	选填

付款凭证

special_instruction

STRING

Status

colour	Green
title	选填

备注1

product_company_ref

STRING

Status

colour	Red
title	必填

以拼接字符串方式提供的多个产品信息, 多个产品以”+”号连接:

单个产品格式如下:

产品英文名##产品中文名##客户SKU||产品报关价格||重量||产品属性||图片地址||产品销售价格||海关编码||原产地国家||eBay订单交易号||eBay产品ID*数量

其中：

Code Block

language	js

产品英文名   必填
产品中文名   选填
客户SKU     选填
产品报关价格  必填, 单位美元(USD), 2位小数
重量        必填, 单位g
产品属性     必填, 产品属性名称或者ID，多个属性用#号分隔
图片地址     选填, 产品的图片http地址
产品销售价格  选填, 单位美元(USD), 2位小数
海关编码     选填, 海关HS Code
原产地国家    选填,  ISO 2位国家代码
eBay订单交易号 选填
eBay产品ID    选填
数量          必填

选填项可以省略。例如最简单的写法:

product1||2||300||其他*2+product2||2||400||电池*1+…..

产品属性取值参考:

Code Block

language	js

ID,名称
1,内置锂离子电池
2,插头
3,纯电池
4,纺织品
5,家居品
6,玩具类
7,Led类
9,其它
10,内置锂金属电池
11,干电池
14,指尖陀螺
15,DGM
16,UK认证
17,普货
18,UK禁运
19,磁性物质
20,激光产品
21,电子类
22,木质类
23,团团侠专用属性
58,电池
59,管制产品
60,伪电池

delivery_service_name

STRING

Status

colour	Green
title	选填

邮递服务名称从邮递服务查询获取邮递服务列表，只能填写订单类型为AGENT_DIRECT的服务, 且要与报文中的type字段对应.

status

STRING

Status

colour	Green
title	选填

订单状态：PENDING

type

STRING

Status

colour	Green
title	选填

订单类型：AGENT_DIRECT

thirty_system_id

STRING

Status

colour	Green
title	选填

第三方系统单号ID. 会在response中返回，以便ERP能将返回数据与其批量提交的数据一一对应

custom_identity_reference

STRING

Status

colour	Green
title	选填

自定义唯一跟踪号 (如果填写了，会进行重复检测，同一批量订单种类同一站点下的订单，6个月内不能有重复的标识，重复的话会返回: {"success":false,"message":"Duplicate consignment identity reference [....]"})

sales_reference

STRING

Status

colour	Green
title	选填

销售跟踪号

sales_price

STRING

Status

colour	Green
title	选填

销售平台单价

omp_name

STRING

Status

colour	Green
title	选填

销售平台名称，(必须是英文)【royal mail，yodel 出口必填】

常见的平台代码如下:

Code Block

wish,  Wish
smt,  速卖通
ebay,  eBay
amazon,  Amazon
lazada,  Lazada
dh,  敦煌
jd,  京东
jdid,  京东印尼
cd,  Cdiscount
shopify,  Shopify
magento,  Magento
woocomm,  Woocommerce
joom,  Joom
shopee,  Shopee
tophatter,  Tophatter
magento2,  Magento2
walmart,  Walmart
mymall,  MyMall
ueeshop,  Ueeshop
shopyy,  Shopyy
vova,  Vova
kilimall,  Kilimall
gogomall,  GogoMall
shoplazza,  店匠
gearbest,  Gearbest
mercado,  Mercado
jumia,  Jumia
tiki,  Tiki
xshoppy,  XShoppy
shopline,  Shopline
alibaba,  Alibaba
bigcommer,  BigCommerce
shopbase,  ShopBase
allegro,  Allegro
daraz,  Daraz
other,  手工订单

omp_vat_number

STRING

Status

colour	Green
title	选填

销售平台VAT号, 【yodel 出口必填】

英国发往非英国且公司不为空（"business_name"字段）的DPD订单必填

shipper_eori

STRING

Status

colour	Green
title	选填

客人的EORI号, 必须是国家代码+12位数字，例如:GB000000777888 ，必须提前在鸟系统备案VAT，详询客服. 参考接口: 获取VAT账号，【royal mail，yodel 出口必填】

英国发往EU必填

英国发往非英国的DPD服务必填

reason_for_export

STRING

Status

colour	Green
title	选填

出口原因, 取值【SALE:销售; RETURN REPLACEMENT:退换; GIFT:礼物】【dpd 出口必填】

content_type

STRING

Status

colour	Green
title	选填

包裹类型, 取值【GIFT:礼物; DOCUMENTS:文件; OTHER:其他】【royalmail 出口必填】

ioss_vat_number

STRING

Status

colour	Red
title	必填

IOSS号, 发往欧盟国家时必填, 限制填12位字符, 格式: 两位字母+十位数字

receiver_eori

STRING

Status

colour	Green
title	选填

收件人EORI 英国发往非英国且公司不为空（“business_name“字段）的DPD订单必填

receiver_pid_number

STRING

Status

colour	Green
title	选填

收件人个人证件号, 英国发往挪威、西班牙、意大利的DPD订单必填

is_compensation_for_delay

BOOL

Status

colour	Green
title	选填

是否需要晚必赔服务（仅支持部分服务，偏远地区除外）, 取值0或者1, 默认为0

接口示例

Expand

请求

地址：http://branch.birdsystem.com/client/consignment-upload/temp-consignment-json

Code Block

language	json

[
     {
          "contact": "Norman Drury",
          "business_name": 1,
          "address_line1": "3Northam Close",
          "address_line2": "Marshside",
          "address_line3": null,
          "city": "Southport",
          "county": "Merseyside",
          "post_code": "12345",
          "country_name": "Norway",
          "telephone": "01704 226830",
          "email": null,
          "delivery_service_id": "5315",
          "sales_reference": "2",
          "sales_order_id": "1234567654",
          "special_instruction": null,
          "product_company_ref": "1-1*1||ebayid||ebatproduct||18+1996125*1||ebayid2||ebatproduct2||20",
          "type": "LOCAL",
          "sender_contact": "123",
          "omp_name": "ebay",
          "omp_vat_number": "12345",
          "shipper_eori": "12345600",
          "reason_for_export": "Sale",
          "content_type": "Gift",
          "ioss_vat_number": 172848,
          "receiver_eori":"123456",
          "receiver_pid_number":"12",
          "sender_address_line1": "SHENZHENG BANTIAN",
          "sender_city": "SHENZHEN",
          "sender_post_code": 12345,
          "sender_country_iso": "CN",
          "sender_telephone": "155465751714",
          "is_compensation_for_delay": "1"
     }
]

返回

Code Block

language	json

{
    "message": "File successfully uploaded! 1 records has been imported.",
    "success": true,
    "moduleName": "client"
}

异常返回

报错时需检查字段填写是否完整。contact, post_code, city, country_name, product sku, quantity, address_line1.

Code Block

language	json

{
    "success": false,
    "message": "Accounted the following exceptions:<br>  Row: 1 : Bulk Order with required the following fields:contact, post_code, city, country_name, product sku, quantity, address_line1.<br>"
}

2. 处理临时订单

接口格式

URL	http://test.birdsystem.com/client/Temp-Consignment-Info/Convert-Into-Consignment/?type=LOCAL&ids=XXX
接口功能	处理批量临时本地订单到正式订单
支持参数格式	URL	开发人员
请求方式	GET	发布日期

接口参数

参数

类型

必填

说明

type

STRING

Status

colour	Red
title	必填

订单类型，取值为'AGENT_DIRECT'，代表代理专线订单

ids

STRING

Status

colour	Green
title	选填

要处理的临时订单id列表，多个订单用下划线分隔；如果不传的话，默认取所有待处理的订单

includeProblemConsignments

BOOL

Status

colour	Green
title	选填

是否包含有问题的订单，传1时表示包括有问题的订单；不传或者传其他值表示忽略有问题的订单

接口示例

Expand

请求

Code Block
http://test.birdsystem.com/client/Temp-Consignment-Info/Convert-Into-Consignment/?type=LOCAL&ids=XXX

返回

Code Block

language	json

{
    "numberOfTotalConsignmentsToProcess": 1,
    "taskId": 1,
    "success": true,
    "refresh": false
}

其中taskId是当前正在运行的后台任务的id。（目前使用后台异步任务模式, 开启一个后台任务后, 不等后台完成, 就返回后台任务的id）

异常返回

报错时需检查字段填写是否完整。contact, post_code, city, country_name, product sku, quantity, address_line1.

Code Block

language	json

{
    "success": false,
    "message": "Accounted the following exceptions:<br>  Row: 1 : Bulk Order with required the following fields:contact, post_code, city, country_name, product sku, quantity, address_line1.<br>"
}

3. 查询处理结果

接口格式

URL	http://test.birdsystem.com/client/Gearman-background-tasks/Get-Detail?id=xxxx
接口功能	查询后台任务处理情况
支持格式	URL	开发人员
请求方式	GET	发布日期

接口参数

参数

类型

必填

说明

id

INT

Status

colour	Green
title	选填

后台任务ID，为空默认查询所有后台任务

接口示例

Expand

请求

Code Block
http://test.birdsystem.com/client/Gearman-Background-Tasks/?api_key=3726bea9879ed020fb78c184e969ee69&company_id=36&id=1122

返回

Code Block

language	json

{
    "total": 1,
    "data": [
        {
            "id": 23184912,
            "parent_id": null,
            "gearman_queue_unique_key": "c7f518fc11b087a034c3b5daa2af1e99",
            "company_id": 36,
            "client_id": 4790,
            "user_type": "CLIENT",
            "user_id": 786,
            "sub_task_count": null,
            "type": "BULK_ORDERS",
            "note": "1 records processed, the number of error consignment: 0",
            "note_internal": "YToxMjp7czo0OiJ0eXBlIjtzOjU6IkxPQ0FMIjtzOjk6Im1lcmdlVHlwZSI7TjtzOjE2OiJ0b3RhbENvbnNpZ25tZW50IjtpOjE7czo4OiJjYWNoZUtleSI7czozODoiVEVNUF9DT05TSUdOTUVOVF9DT05UUk9MTEVSX0NWXzM2XzQ3OTAiO3M6MTA6ImNvbXBhbnlfaWQiO3M6MjoiMzYiO3M6OToiY2xpZW50X2lkIjtzOjQ6IjQ3OTAiO3M6MTU6Im5lZWRfc2VuZF9lbWFpbCI7aTowO3M6MTU6ImlzX2Zyb21fYnJvd3NlciI7YjowO3M6NDoibm90ZSI7czo0NzoiMCByZWNvcmRzIHByb2Nlc3NlZCwgMSByZWNvcmRzIHRvIGJlIHByb2Nlc3NlZC4iO3M6NjoibG9jYWxlIjtzOjU6ImVuX0dCIjtzOjg6InVzZXJpbmZvIjtzOjk4MToiTzoyNDoiQ2xpZW50XERiXE1vZGVsXFVzZXJJbmZvIjoyMjp7czoxMjoiACoAY2xpZW50X2lkIjtzOjQ6IjQ3OTAiO3M6MzU6IgAqAGN1c3RvbWVyX3NlcnZpY2VfY29tcGFueV91c2VyX2lkIjtzOjQ6IjE4MzQiO3M6MjM6IgAqAGNsaWVudF91c2VyX2dyb3VwX2lkIjtzOjQ6IjY2NjYiO3M6MTg6IgAqAGNsaWVudF9ncm91cF9pZCI7czozOiI4MDciO3M6Mjk6IgAqAGxvZ2luX2Zyb21fY29tcGFueV91c2VyX2lkIjtOO3M6MTk6IgAqAHBhcmVudF9jbGllbnRfaWQiO047czoxNDoiACoAZXh0cmFGaWVsZHMiO2E6NDp7aTowO3M6MTE6ImlzX2ludGVybmFsIjtpOjE7czoxMToiaXNfZXh0ZXJuYWwiO2k6MjtzOjk6InNpdGVfbmFtZSI7aTozO3M6OToidGVsZXBob25lIjt9czoxNDoiACoAcHJpbWFyeUtleXMiO2E6MTp7aTowO3M6MjoiaWQiO31zOjU6IgAqAGlkIjtzOjM6Ijc4NiI7czoxMzoiACoAY29tcGFueV9pZCI7czoyOiIzNiI7czoxMToiACoAdXNlcm5hbWUiO3M6NDoic3RhciI7czoxMzoiACoAZmlyc3RfbmFtZSI7czo0OiJzdGFyIjtzOjEyOiIAKgBsYXN0X25hbWUiO3M6NDoic3RhciI7czo4OiIAKgBlbWFpbCI7czoxNToiODc3NTgzMDBAcXEuY29tIjtzOjExOiIAKgBwYXNzd29yZCI7TjtzOjEwOiIAKgBhcGlfa2V5IjtzOjMyOiIzNzI2YmVhOTg3OWVkMDIwZmI3OGMxODRlOTY5ZWU2OSI7czoxMjoiACoAdGltZV96b25lIjtOO3M6MTU6IgAqAHRpbWVfem9uZV9pZCI7TjtzOjMxOiIAKgBpc19jaHJvbWVwaHBfaGFuZGxlcl9lbmFibGVkIjtzOjE6IjAiO3M6MjU6IgAqAGRpc2FsbG93ZWRQcm9wZXJ0eUxpc3QiO2E6MDp7fXM6MTI6IgAqAGV4dHJhRGF0YSI7YTo0OntzOjk6InRlbGVwaG9uZSI7TjtzOjExOiJpc19pbnRlcm5hbCI7czoxOiIxIjtzOjExOiJpc19leHRlcm5hbCI7czoxOiIwIjtzOjk6InNpdGVfbmFtZSI7czoyOiIzNiI7fXM6MjQ6IgAqAGNvbXBvc2l0ZUtleURlbGltaXRlciI7czoxOiJfIjt9IjtzOjEwOiJkb21haW5fa2V5IjtzOjIzOiJicmFuY2hfX2JpcmRzeXN0ZW1fX2NvbSI7fQ==",
            "create_time": "2020-12-24 16:59:14",
            "update_time": "2020-12-24 16:59:15",
            "start_time": "2020-12-24 16:59:14",
            "finish_time": "2020-12-24 16:59:15",
            "status": "FINISH",
            "primary_keys": [
                "id"
            ],
            "user_name": "star star",
            "user_username": "star"
        }
   ]
}

status状态有

'QUEUE' （排队中），

'RUNNING'（运行中），

'FINISH' （已完成），

'ERROR' （出错），

'ABORTED' （已被人为中断）几种状态
只有当status为'FINISH'时, data, errorData才会有数据
data中返回的键值对分别是临时本地订单id，销售跟踪号id
errorData中返回的键值对分别是临时本地订单id, 错误信息

异常返回

报错时需检查字段填写是否完整。contact, post_code, city, country_name, product sku, quantity, address_line1.

Code Block

language	json

{
    "success": false,
    "message": "Accounted the following exceptions:<br>  Row: 1 : Bulk Order with required the following fields:contact, post_code, city, country_name, product sku, quantity, address_line1.<br>"
}

Versions Compared

Old Version 10

New Version Current

Key

说明

1. 上传临时订单

接口格式

接口参数

接口示例

请求

返回

异常返回

2. 处理临时订单

接口格式

接口参数

接口示例

请求

返回

异常返回

3. 查询处理结果

接口格式

接口参数

接口示例

请求

返回

异常返回

Page Comparison

Versions Compared

Old Version 10

New Version Current

Key

说明

1. 上传临时订单

接口格式

接口参数

接口示例

请求

返回

异常返回

2. 处理临时订单

接口格式

接口参数

接口示例

请求

返回

异常返回

3. 查询处理结果

接口格式

接口参数

接口示例

请求

返回

异常返回