Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

请求描述

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

...

title(以下为折叠内容,签署合同时以下信息无需参考,仅供第三方对接参考)

使用接口调试工具postman
请求描述
温馨提示:
1、请注意必填字段,创建订单时,必填字段未填会报错。
2、如遇到下单被拦截提示报错的情况,请及时反馈飞鸟客服协助处理。

Http请求格式:

...

languagepy

...

1-2本地/2-2专线订单批量创建接口描述

...

URL

...

https://test.birdsystem.com/client/Consignment/Post-Pending-Consignment-With-Products-Json

...

接口功能

...

批量创建订单接口

...

订单类型

...

本地订单/专线订单

...

支持格式

...

JSON

...

开发人员

...

数据已丢失

...

请求方式

...

POST/GET

...

发布日期

...

数据已丢失

...

请求改动

接口请求参数描述

...

参数

...

说明

...

是否必填

...

是否对接字段/取值内容(请求根据实际情况选择填写)

...

is_urgent

...

是否紧急订单

...

选填(0或1)

...

按客户填的传

...

delivery_service_id

...

邮递服务ID

...

必填

...

按客户填的传

...

sales_reference

...

销售跟踪号

...

选填

...

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

...

sales_order_id

...

销售订单号

...

选填

...

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

...

custom_identity_reference

...

自定义唯一跟踪号

...

选填

...

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

...

contact

...

收件联系人

...

必填

...

按用户填的传

...

business_name

...

公司

...

选填

...

按用户填的传

...

address_line1

...

地址行1

...

必填

...

按用户填的传

...

address_line2

...

地址行2

...

选填

...

按用户填的传

...

city

...

城市

...

必填

...

按用户填的传

...

county

...

省/郡

...

选填

...

按用户填的传

...

post_code

...

邮编

...

必填

...

按用户填的传

...

country_iso

...

国家

...

必填

...

按用户填的传

...

telephone

...

电话

...

选填

...

按用户填的传

...

email

...

电子邮箱

...

选填

...

按用户填的传

...

special_instruction

...

备注1

...

选填

...

按用户填的传

...

neighbour_instruction

...

备注2

...

选填

...

按用户填的传

...

type

...

订单类型

...

必填

...

本地订单传(LOCAL)
专线订单(DIRECT)

代理专线(AGENT_DIRECT)

...

products

...

产品
[ {"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”}

]

...

必填

...

按客户填的传
client_sku/id,quantity(必填)

(ebay_transaction_id
/eBay订单交易号
ebay_item_no
/eBay产品ID)eBay的订单需要传(选填)

(sales_price
/平台销售价格, 美元)
按客户填的传(必填)

...

omp_name

...

销售平台名称

...

选填

...

按用户填的传

Expand
title举例

举例
'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

...

销售平台VAT号

...

选填

...

收件人是英国的才会传

...

shipper_eori

...

客人的EORI号

...

必填

...

收件人是英国的才会传

...

reason_for_export

...

出口原因

...

选填

...

传:SALE

...

content_type

...

包裹类型

...

选填

...

传:Other 

...

sender_contact

...

发件人

...

选填(DPD服务必填)

...

按客户填的传

...

sender_address_line1

...

发件人地址行1

...

选填(DPD服务必填)

...

按客户填的传

...

sender_address_line2

...

发件人地址行2

...

选填

...

按客户填的传

...

sender_city

...

发件人城市

...

选填(DPD服务必填)

...

按客户填的传

...

sender_county

...

发件人省/郡

...

选填

...

按客户填的传

...

sender_post_code

...

发件人邮编

...

选填(DPD服务必填)

...

按客户填的传

...

sender_country_iso

...

发件人国家

...

选填(DPD服务必填)

...

按客户填的传

...

sender_email

...

发件人电子邮箱

...

选填

...

按客户填的传

...

sender_telephone

...

发件人电话

...

选填(DPD服务必填)

...

按客户填的传

...

ioss_vat_number

...

IOSS号

...

必填

...

填写客户实际IOSS号
订单发往欧盟国家时,必填
限制填12位字符,格式两位字母+十位数字

1-2本地/2-2专线订单批量创建接口描述

URL

https://test.birdsystem.com/client/Consignment/Post-Pending-Consignment-With-Products-Json

1

接口功能

批量创建订单接口

订单类型

本地订单/专线订单

2

支持格式

JSON

开发人员

3

请求方式

POST/GET

发布日期

4

请求改动

接口请求参数描述

参数

说明

是否必填

是否对接字段/取值内容(请求根据实际情况选择填写)

1

is_urgent

是否紧急订单

选填(0或1)

按客户填的传

2

delivery_service_id

邮递服务ID

必填

按客户填的传

3

sales_reference

销售跟踪号

选填

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

4

sales_order_id

销售订单号

选填

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

5

custom_identity_reference

自定义唯一跟踪号

选填

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

6

contact

收件联系人

必填

按用户填的传

7

business_name

公司

选填

按用户填的传

8

address_line1

地址行1

必填

按用户填的传

9

address_line2

地址行2

选填

按用户填的传

10

city

城市

必填

按用户填的传

11

county

省/郡

选填

按用户填的传

12

post_code

邮编

必填

按用户填的传

13

country_iso

国家

必填

按用户填的传

14

telephone

电话

选填

按用户填的传

15

email

电子邮箱

选填

按用户填的传

16

special_instruction

备注1

选填

按用户填的传

17

neighbour_instruction

备注2

选填

按用户填的传

18

type

订单类型

必填

本地订单传(LOCAL)
专线订单(DIRECT)

19

products

产品
[ {"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”}

]

必填

按客户填的传
client_sku/id,quantity(必填)

(ebay_transaction_id
/eBay订单交易号
ebay_item_no
/eBay产品ID)eBay的订单需要传(选填)

(sales_price
/平台销售价格, 美元)
按客户填的传(必填)

20

omp_name

销售平台名称

选填

按用户填的传

Expand
title举例

举例
'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'=手工订单

21

omp_vat_number

销售平台VAT号

选填(DPD服务按要求必填)

英国发往非英国且公司不为空(“business_name“字段)的DPD订单 要求必填

22

shipper_eori

客人的EORI号

选填

英国发往EU必填

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

23

reason_for_export

出口原因

选填

传:SALE

24

content_type

包裹类型

选填

传:Other 

25

sender_contact

发件人

选填(DPD服务必填)

按客户填的传

26

sender_address_line1

发件人地址行1

选填(DPD服务必填)

按客户填的传

27

sender_address_line2

发件人地址行2

选填

按客户填的传

28

sender_city

发件人城市

选填(DPD服务必填)

按客户填的传

29

sender_county

发件人省/郡

选填

按客户填的传

30

sender_post_code

发件人邮编

选填(DPD服务必填)

按客户填的传

31

sender_country_iso

发件人国家

选填(DPD服务必填)

按客户填的传

32

sender_email

发件人电子邮箱

选填

按客户填的传

33

sender_telephone

发件人电话

选填(DPD服务必填)

按客户填的传

34

ioss_vat_number

IOSS号

必填

填写客户实际IOSS号
订单发往欧盟国家时,必填
限制填12位字符,格式两位字母+十位数字

35

receiver_eori

收件人EORI

选填(DPD服务按要求必填)

英国发往非英国且公司不为空(“business_name“字段)的DPD订单 要求必填

36

receiver_pid_number

收件人个人证件号

选填(DPD服务按要求必填)

英国发往挪威、西班牙、意大利的DPD订单 要求必填

37

is_compensation_for_delay

是否需要晚必赔服务(仅支持部分服务,偏远地区除外

选填

取值0/1,默认为0,非0传1

请求描述

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

Expand
title(以下为折叠内容,签署合同时以下信息无需参考,仅供第三方对接参考)

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

JSON请求格式:

Code Block
languagepy
[
    {
        "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"
    }
]

返回结果:

Code Block
languagejson
{
     "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",
               "idlength": "30.00",
 
      "quantity": 1,         "ebay_transaction_idwidth": "22220.00",
          "ebay_item_no": "33"       }"depth": "0.00",
      {         "idtotal_weight": 1,
  "50.00",
     "quantity": 1,         "ebaytotal_transaction_idvolume": "2222504000.00",
               "ebaytotal_itemvolume_noweight": "33504000.0000",
               "salestotal_fee_priceweight": "1050.0000",
               "countryguarantee_of_originpercentage": "CN0.00",
      }     ],     "sales_order_idcontact": "1234567654yuhao",
    "omp_name": "ebay",     "omp_vat_number": "12345",     "shipperbusiness_eoriname": "12345000FN",
    "reason_for_export": "Sale",     "content_type": "Gift"   } ]

返回结果:

Code Block
languagejson
{   "successaddress_line1": true"DPF4",
  "data": [     {       "idaddress_line2": 2111050020000049"D474",
      "company_id": 2,         "clientaddress_idline3": 1null,
      "warehouse_id": null,         "consignment_product_quantitycity": "2",Atlanta",
               "consignment_product_referencecounty": "1,3Georgia",
      "delivery_service_id": 5317,         "delivery_service_id_internalpost_code": 5317"30309",
      "delivery_package_size_id": 958,         "totalcountry_priceiso": "0.00CN",
               "total_sales_pricetelephone": "10.0001704 226830",
       "total_delivery_fee": "1.00",       "total_handling_feeemail": "0.00"null,
      "length": "0.00",         "widthsender_contact": "0.00"null,
      "depth": "0.00",         "totalsender_business_weightname": "75.00"null,
      "total_volume": "1040500.00",         "totalsender_volumeaddress_weightline1": "1144550.0000"null,
      "total_fee_weight": "75.0000",         "guaranteesender_address_percentageline2": "0.00"null,
      "contact": "Norman Drury",       "businesssender_address_nameline3": null,
      "address_line1": "3, Northam Close",       "addresssender_line2city": "Marshside"null,
      "address_line3         "sender_county": null,
      "city": "Southport",         "countysender_post_code": "Merseyside"null,
      "post_code": "PR9 9GA",       "sender_country_iso": "GB"null,
      "telephone": "01704 226830",       "sender_email": null,
      "sender_contact": null,         "sender_business_nametelephone": null,
       "sender_address_line1": null,       "sendersales_address_line2reference": null"2",
      "sender_address_line3": null,         "sendersales_cityprice": null"0.000",
      "sender_county": null,         "sendercustoms_post_codeprice": null"2.000",
      "sender_country_iso": null,            "sendersales_order_emailid": null,
      "sender_telephone": null,         "salescustom_identity_reference": "2"null,
      "sales_price": "0.000",         "customspayment_pricereference": "5.000"null,
       "sales_order_id": 1234567654,       "customdelivery_identity_reference": null,
      "payment_reference": null,         "deliverytracking_reference": null,
       "tracking_reference": null,       "special_instruction": null,
               "neighbour_instruction": null,
               "omp_name": "ebay",
               "omp_vat_number": "123451",
               "shipper_eori": "12345000191966856000",
               "receiver_eori": null,"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 1318:5019:2253",
               "finish_time": "2021-11-05 13:50:23", null,
               "arrive_time": null,
               "update_time": "2021-11-05 1318:5019:2353",
               "type": "DIRECTLOCAL",
               "status": "FINISHEDPENDING",
               "stock_status": "ONLY_ORI_STOCK_ENOUGH",
               "reason_for_export": "SALE",: "SALE",
               "content_type": "GIFT",
               "is_hide_delivery_reference_to_consignment": "0",
               "delivery_service_is_signature": "01",
               "delivery_service_is_tracking": "0"
          }
     ],
     "moduleName": "client"
}

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

返回异常示例

必填项receiver_eori未填

Code Block
languagejson
{

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