2.1 批量创建

Owned by to Hallucin Grape (Unlicensed)
Last updated: 2024-07-08 by tuhao
3 min read

接口说明

用于批量创建一个或者多个代理专线订单，并将订单自动改到已出地址贴状态，随后可直接获取地址贴.

接口格式

URL

https://<系统域名>/client/Consignment/Post-Pending-Consignment-With-Products-Json

URL

https://<系统域名>/client/Consignment/Post-Pending-Consignment-With-Products-Json

接口功能

批量创建代理专线订单

订单类型

代理专线订单

支持参数格式

JSON

开发人员

 

请求方式

POST

发布日期

 

接口参数

参数

类型

必填

说明

是否对接字段/取值内容

参数

类型

必填

说明

是否对接字段/取值内容

is_urgent

BOOL

选填

是否紧急订单，取值0或者1, 默认为0

按客户填的传

delivery_service_id / delivery_service_name

INT/STRING

必填

邮递服务ID或者邮递服务名称，从 https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1953628356 获取邮递服务列表，只能填写订单类型为AGENT_DIRECT的服务, 且要与报文中的type字段对应.

按客户填的传

sales_reference

STRING

选填

销售跟踪号

按用户填的传/或REP系统单号

sales_order_id

STRING

选填

销售订单号

按用户填的传/或REP系统单号

custom_identity_reference

STRING

选填

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

按用户填的传或REP系统单号（birdsystem会根据改字段判断订单是否重复）

contact

STRING

必填

收件联系人

按用户填的传

business_name

STRING

选填

公司

按用户填的传

address_line1

STRING

必填

地址行1

按用户填的传

address_line2

STRING

选填

地址行2

按用户填的传

city

STRING

必填

城市

按用户填的传

county

STRING

选填

省/郡

按用户填的传

post_code

STRING

必填

邮编

按用户填的传

country_iso

STRING

必填

国家, 填2位ISO国家代码, 不同邮递服务能发的国家不同.

按用户填的传

telephone

STRING

选填

电话

按用户填的传

email

STRING

选填

电子邮箱

按用户填的传

special_instruction

STRING

选填

备注1

按用户填的传

neighbour_instruction

STRING

选填

备注2

按用户填的传

type

STRING

必填

订单类型, AGENT_DIRECT

按用户填的传

products

JSON ARRAY

必填

产品详细信息数组, 其详细见 产品字段描述

[ { "product_name": "3apple29", "product_name_cn":"3苹果29", "brand":"asd品牌", "client_ref":"a4624", "price_customs_export": 3, "sales_price": 10, "hs_code":"12121212", "country_of_origin":"CN", "weight": 300, "quantity": 1, "product_customs_property":["其它"], "ebay_transaction_id":"yuhao0001", "ebay_item_no":"0001yuhao", "attachment-url":"http://www.qqma.com/imgpic2/cpimagenew/2018/4/5/6e1de60ce43d4bf4b9671d7661024e7a.jpg" }, { "product_name": "phone case", "product_name_cn":"手机壳", "brand":"asd品牌", "client_ref":"SG-P11", "price_customs_export": 4, "sales_price": 10, "hs_code":"12121212", "country_of_origin":"CN", "weight": 200, "quantity": 1, "product_customs_property":["其它"], "ebay_transaction_id":"yuhao000111", "ebay_item_no":"000111yuhao", "attachment-url":"http://www.qqma.com/imgpic2/cpimagenew/2018/4/5/6e1de60ce43d4bf4b9671d7661024e7a.jpg" } ]

按用户填的传

parcel_pieces

JSON ARRAY

选填

一票多件的多包裹信息，如果仅一个包裹时可不用填.

[ {"weight":500, "length":25, "width":20, "depth":15, "description":"table"}, {"weight":400, "length":22, "width":18, "depth":13, "description":"chair"} ]

其中, 重量单位为克（g），尺寸单位为毫米（mm）

按用户填的传

payment_reference

STRING

选填

付款凭证

按用户填的传

omp_name

STRING

选填

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

常见的平台代码如下:

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

选填

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

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

按用户填的传

shipper_eori

STRING

选填

客人的EORI号, 必须是国家代码+12位数字，例如:GB000000777888 ，必须提前在鸟系统备案VAT，详询客服. 参考接口: https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1540403 ，【royal mail，yodel 出口必填】

英国发往EU必填

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

按用户填的传

reason_for_export

STRING

选填

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

【dpd 出口必填】

一般传：SALE

content_type

STRING

选填

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

【royalmail 出口必填】

一般传：OTHER 

sender_contact

STRING

选填

发件人 （DPD服务必填）

按客户填的传

sender_address_line1

STRING

选填

发件人地址行1 （DPD服务必填）

按客户填的传

sender_address_line2

STRING

选填

发件人地址行2

按客户填的传

sender_city

STRING

选填

发件人城市 （DPD服务必填）

按客户填的传

sender_county

STRING

选填

发件人省/郡

按客户填的传

sender_post_code

STRING

选填

发件人邮编 （DPD服务必填）

按客户填的传

sender_country_iso

STRING

选填

发件人国家, 填2位ISO国家代码 （DPD服务必填）

按客户填的传

sender_email

STRING

选填

发件人电子邮箱

按客户填的传

sender_telephone

STRING

选填

发件人电话 （DPD服务必填）

按客户填的传

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

按客户填的传

 

产品参数描述：products

参数

类型

必填

说明

参数

类型

必填

说明

product_name

STRING

必填

产品英文名称

product_name_cn

STRING

必填

产品中文名称

brand

STRING

选填

品牌

client_sku/client_ref

STRING

选填

客户SKU，两个字段名称二选一

price_customs_export/price

FLOAT(10,2)

必填

两个字段名称二选一, 此SKU的出口报关价，两位小数，单位为美元(USD)

sales_price

FLOAT(10,2)

选填

此SKU的销售单价，两位小数，单位为美元(USD)

hs_code

STRING

选填

商品海关编码

country_of_origin

STRING

选填

产地国家，两位ISO国家代码

weight

INT

必填

此SKU的重量 (单个重量, 而非总重量)， 单位克(g)

quantity

INT

必填

此SKU的数量

product_customs_property

STRING/ARRAY

必填

此SKU的属性名称或者ID，多个属性用逗号分隔 或者 按JSON数组传。取值参考下表:

attachment-url

STRING

选填

图片URL

ebay_transaction_id

STRING

选填

eBay订单交易号

ebay_item_no

STRING

选填

eBay产品ID

接口示例

温馨提示：

1、只有邮递服务状态为正常时，该服务才能正常下单。（举例：&status=ACTIVE）

2、请注意必填字段，创建订单时，必填字段未填会报错。
3、如遇到下单被拦截提示报错的情况，请及时反馈飞鸟客服协助处理。

请求

返回

line: 创建失败的时候, 会告知是哪一个line出错.
data是创建成功的订单号和跟踪号的键值对 json对象

异常返回

必填项receiver_eori未填