接口说明

用于批量创建一个或者多个本地/专线订单，并将订单自动改到待处理状态，交由仓库处理.

接口格式

URL	https://test.birdsystem.com/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或者邮递服务名称，从邮递服务查询获取邮递服务列表，只能填写订单类型为LOCAL/DIRECT的服务, 且要与报文中的type字段对应.	按客户填的传
sales_reference	STRING	选填	销售跟踪号	按用户填的传或REP系统单号
sales_order_id	STRING	选填	销售订单号	按用户填的传或ERP系统单号
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	必填	订单类型取值LOCAL或DIRECT, LOCAL是本地订单, DIRECT是专线订单	按用户填的传
products	JSON ARRAY	必填	产品详细信息数组, 其详细见产品字段描述 [ { "client_sku":"IP-XX3355", "quantity":5, "sales_price":10, "ebay_transaction_id":"yuhao0001", "ebay_item_no”:”0001yuhao" }, { "id":2, "quantity":4, "sales_price":10, "ebay_transaction_id":"yuhao0002", "ebay_item_no":"0002yuhao" }, { "reference":2, "quantity":3, "sales_price":10, "ebay_transaction_id":"yuhao0002", "ebay_item_no":"0002yuhao" } ]	按用户填的传
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	选填	销售平台名称, 常见的平台代码如下: 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号英国发往非英国且公司不为空（"business_name"字段）的DPD订单必填	按用户填的传
shipper_eori	STRING	选填	客人的EORI号, 必须是国家代码+12位数字，例如:GB000000777888 ，必须提前在鸟系统备案VAT，详询客服. 参考接口: 获取VAT账号英国发往EU必填英国发往非英国的DPD服务必填	按用户填的传
reason_for_export	STRING	选填	出口原因, 取值【SALE:销售; RETURN REPLACEMENT:退换; GIFT:礼物】	一般传：SALE
content_type	STRING	选填	包裹类型, 取值【GIFT:礼物; DOCUMENTS:文件; OTHER:其他】	一般传：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

参数	类型	必填	说明
id/client_sku/reference	INT/STRING	必填	产品id/客户SKU/产品reference client_sku有另一个同义词是client_ref 产品reference是由 “设置”->”账户” 中的批量订单设置来决定字段值是产品id还是客户SKU 也支持定向共享产品.其格式：当参数名为id时，用产品来源客人ID#产品ID#D , 例如 11#13756#D 当参数名为client_sku时，用产品来源客人ID#客户SKU#D , 例如 11#PRRA-1-SG#D 当参数名为reference时，用产品来源客人ID#reference值#D , 例如 11#13756#D
quantity	INT	必填	此SKU的数量
ebay_transaction_id	STRING	选填	eBay订单交易号
ebay_item_no	STRING	选填	eBay产品ID
sales_price	FLOAT(10,2)	选填	此SKU的销售单价，两位小数，单位为美元(USD)

接口示例

（以下为折叠内容，签署合同时以下信息无需参考，仅供第三方对接参考）

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

请求

[
    {
        "contact": "yuhao",
        "business_name": "FN",
        "address_line1": "DPF4",
        "address_line2": "D474",
        "address_line3": null,
        "city": "Atlanta",
        "county": "Georgia",
        "post_code": "30309",
        "country_iso": "CN",
        "telephone": "01704 226830",
        "email": null,
        "delivery_service_id": "5315",
        "sales_reference": "2",
        "sales_order_id": "110222319566-0",
        "special_instruction": null,
        "type":"LOCAL",
        "products":[
            {"id":1,"quantity":1,"sales_price":"10"}
        ],
        "sales_order_id": "",
        "omp_name": "ebay",
        "omp_vat_number": "1",
        "shipper_eori": "191966856000",
        "reason_for_export": "Sale",
        "content_type": "Gift",
        "ioss_vat_number":"",
        "receiver_eori":"1",
        "receiver_pid_number":"",
        "is_compensation_for_delay": "1"
    }
]

返回

{
     "success": true,
     "data": [
          {
               "id": 2111050020000095,
               "company_id": 2,
               "client_id": 1,
               "warehouse_id": null,
               "consignment_product_quantity": "1",
               "consignment_product_reference": "1",
               "delivery_service_id": 5315,
               "delivery_service_id_internal": 5315,
               "delivery_package_size_id": 958,
               "total_price": "0.00",
               "total_sales_price": "10.00",
               "total_delivery_fee": "1.00",
               "total_handling_fee": "0.00",
               "length": "0.00",
               "width": "0.00",
               "depth": "0.00",
               "total_weight": "50.00",
               "total_volume": "504000.00",
               "total_volume_weight": "504000.0000",
               "total_fee_weight": "50.0000",
               "guarantee_percentage": "0.00",
               "contact": "yuhao",
               "business_name": "FN",
               "address_line1": "DPF4",
               "address_line2": "D474",
               "address_line3": null,
               "city": "Atlanta",
               "county": "Georgia",
               "post_code": "30309",
               "country_iso": "CN",
               "telephone": "01704 226830",
               "email": null,
               "sender_contact": null,
               "sender_business_name": null,
               "sender_address_line1": null,
               "sender_address_line2": null,
               "sender_address_line3": null,
               "sender_city": null,
               "sender_county": null,
               "sender_post_code": null,
               "sender_country_iso": null,
               "sender_email": null,
               "sender_telephone": null,
               "sales_reference": "2",
               "sales_price": "0.000",
               "customs_price": "2.000",
               "sales_order_id": null,
               "custom_identity_reference": null,
               "payment_reference": null,
               "delivery_reference": null,
               "tracking_reference": null,
               "special_instruction": null,
               "neighbour_instruction": null,
               "omp_name": "ebay",
               "omp_vat_number": "1",
               "shipper_eori": "191966856000",
               "receiver_eori": "1",
               "receiver_pid_number": null,
               "ioss_vat_number": null,
               "temp_consignment_info_id": null,
               "is_urgent": "0",
               "is_forced_delivery_service": "0",
               "create_time": "2021-11-05 18:19:53",
               "finish_time": null,
               "arrive_time": null,
               "update_time": "2021-11-05 18:19:53",
               "type": "LOCAL",
               "status": "PENDING",
               "stock_status": "ONLY_ORI_STOCK_ENOUGH",
               "reason_for_export": "SALE",
               "content_type": "GIFT",
               "is_hide_delivery_reference_to_consignment": "0",
               "delivery_service_is_signature": "1",
               "delivery_service_is_tracking": "0"
          }
     ],
     "moduleName": "client"
}

data是创建成功的订单号和跟踪号的键值对 json对象

异常返回

必填项receiver_eori未填

{

     "success": false,
     "message": "You must provide valid receiver_eori for consignment. 2111050020000098",
     "extraData": []
}

1.1 批量创建

接口说明

接口格式

接口参数

接口示例

请求

返回

异常返回