Versions Compared

Old Version 15

changes.mady.by.user tuhao

Saved on

compared with

New Version 16

changes.mady.by.user tuhao

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

接口说明

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

接口格式

URL

https://test.birdsystem.com/client/Consignment/Post-Pending-Consignment-With-Products-
Table of Contents

接口说明

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

接口格式

URL

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

接口功能

批量创建本地/专线订单

订单类型

本地订单/专线订单

支持格式

JSON

开发人员

请求方式

POST

发布日期

接口参数

参数

类型

必填

说明

是否对接字段/取值内容

is_urgent

BOOL

Status
colourGreen
title选填

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

按客户填的传

delivery_service_id / delivery_service_name

INT/STRING

Status
colourRed
title必填

邮递服务ID，邮递服务ID或者邮递服务名称，从 邮递服务查询 获取可用邮递服务列表，只能填写订单类型为LOCAL/DIRECT的邮递服务

按客户填的传

sales_reference

STRING

Status
colourGreen
title选填

销售跟踪号

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

sales_order_id

STRING

Status
colourGreen
title选填

销售订单号

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

custom_identity_reference

STRING

Status
colourGreen
title选填

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

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

contact

STRING

Status
colourRed
title必填

收件联系人

按用户填的传

business_name

STRING

Status
colourGreen
title选填

公司

按用户填的传

address_line1

STRING

Status
colourRed
title必填

地址行1

按用户填的传

address_line2

STRING

Status
colourGreen
title选填

地址行2

按用户填的传

city

STRING

Status
colourRed
title必填

城市

按用户填的传

county

STRING

Status
colourGreen
title选填

省/郡

按用户填的传

post_code

STRING

Status
colourRed
title必填

邮编

按用户填的传

country_iso

STRING

Status
colourRed
title必填

国家, 填2位ISO国家代码

按用户填的传

telephone

STRING

Status
colourGreen
title选填

电话

按用户填的传

email

STRING

Status
colourGreen
title选填

电子邮箱

按用户填的传

special_instruction

STRING

Status
colourGreen
title选填

备注1

按用户填的传

neighbour_instruction

STRING

Status
colourGreen
title选填

备注2

按用户填的传

type

STRING

Status
colourRed
title必填

订单类型 取值LOCAL或DIRECT本地订单传 LOCAL
专线订单传 DIRECT, LOCAL是本地订单, DIRECT是专线订单

按用户填的传

products

JSON ARRAY

Status
colourRed
title必填

产品
[ {

"client_sku":"IP-XX3355",

"quantity":5,

产品详细信息数组, 其详细见表格

Code Block
languagejs
[
  {
    "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":"
yuhao0001
yuhao0002",

    "ebay_item_no
”
":
”0001yuhao
"0002yuhao"
  },

{

"id

  {
    "reference":2,

    "quantity":
4,
3,
    "sales_price":10,

    "ebay_transaction_id":"yuhao0002",

"ebay_item_no":"0002yuhao"}

]

按客户填的传
client_sku/id/reference，quantity（必填）

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

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

    "ebay_item_no":"0002yuhao"
  }
]

按用户填的传

parcel_pieces

JSON ARRAY

Status
colourGreen
title选填

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

[

Code Block
languagejs
[
  {"weight":500, "length":25, "width":20, "depth":15, "description":"table"},

  {"weight":400, "length":22, "width":18, "depth":13, "description":"chair"}

]

备注：重量为克（g），长度为毫米（mm）其中, 重量单位为克（g），尺寸单位为毫米（mm）

按用户填的传

payment_reference

STRING

Status
colourGreen
title选填

付款凭证

按用户填的传

omp_name

STRING

Status
colourGreen
title选填

销售平台名称

按用户填的传

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

STRING

Status
colourGreen
title选填

销售平台VAT号

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

shipper_eori

STRING

Status
colourGreen
title选填

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

英国发往EU必填

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

reason_for_export

STRING

Status
colourGreen
title选填

出口原因, 取值【Sale:销售; ReturnReplacement:退换; Gift:礼物】

一般传：SALE

content_type

STRING

Status
colourGreen
title选填

包裹类型, 取值【Gift 礼物；Documents 文件和 Other 其他】

一般传：Other 

sender_contact

STRING

Status
colourGreen
title选填

发件人 （DPD服务必填）

按客户填的传

sender_address_line1

STRING

Status
colourGreen
title选填

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

按客户填的传

sender_address_line2

STRING

Status
colourGreen
title选填

发件人地址行2

按客户填的传

sender_city

STRING

Status
colourGreen
title选填

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

按客户填的传

sender_county

STRING

Status
colourGreen
title选填

发件人省/郡

按客户填的传

sender_post_code

STRING

Status
colourGreen
title选填

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

按客户填的传

sender_country_iso

STRING

Status
colourGreen
title选填

发件人国家 （DPD服务必填）

按客户填的传

sender_email

STRING

Status
colourGreen
title选填

发件人电子邮箱

按客户填的传

sender_telephone

STRING

Status
colourGreen
title选填

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

按客户填的传

ioss_vat_number

STRING

Status
colourRed
title必填

IOSS号, 订单发往欧盟国家时必填

填写客户实际IOSS号
限制填12位字符，格式两位字母+十位数字

receiver_eori

STRING

Status
colourGreen
title选填

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

receiver_pid_number

STRING

Status
colourGreen
title选填

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

is_compensation_for_delay

BOOL

Status
colourGreen
title选填

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

Anchor
post_pending_local_product_description
post_pending_local_product_description
产品字段参数描述：products

参数

类型

必填

说明

id/client_sku/reference

INT/STRING

Status
colourRed
title必填

产品id/客户SKU/产品reference

client_sku有另一个同义词是client_ref

产品reference是根据批量订单产品字段的设置来识别是id还是客户SKU

quantity

INT

Status
colourRed
title必填

数量

ebay_transaction_id

STRING

Status
colourGreen
title选填

eBay订单交易号

ebay_item_no

STRING

Status
colourGreen
title选填

eBay产品ID

sales_price

FLOAT

Status
colourGreen
title选填

销售价格

接口示例

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

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

请求

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",
               "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未填

Code Block
languagejson
{

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