Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 35 Next »

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

销售平台名称

选填

按用户填的传

 举例

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

选填

收件人是英国的才会传

22

shipper_eori

客人的EORI号

必填

收件人是英国的才会传

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位字符,格式两位字母+十位数字

请求描述

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

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

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

Http请求格式:

POST /client/Consignment/Post-Pending-Consignment-With-Products-Json HTTP/1.1
Host: {{Bird_URL}}
Headres:
  api_key: {{api_key}}
  company_id: {{company_id}}
  Cookie: PHPSESSID=3s3nejv43u9bhirsrvq9nge254
Body
  raw
    [
    {
        "contact": "yuhao",
        "business_name": null,
        "address_line1": "DPF4",
        "address_line2": "D474",
        "address_line3": null,
        "city": "Atlanta",
        "county": "Georgia",
        "post_code": "30309",
        "country_iso": "GB",
        "telephone": "01704 226830",
        "email": null,
        "delivery_service_id": "2709",
        "sales_reference": "2",
        "sales_order_id": "110222319566-0",
        "special_instruction": null,
        "products":[
            {"id":2989352,"quantity":1,"sales_price":"10"}
        ],
        "#sales_order_id":" // 新增 销售订单ID 【yodel 出口必填】",
        "sales_order_id": "1234567654",
        "#omp_name":"// 新增 销售平台名称 (必须是英文), ebay, amazon 等 【royal mail,yodel 出口必填】",
        "omp_name": "ebay",
        "#omp_vat_number":"// 新增 销售平台的vat号 【yodel 出口必填】",
        "omp_vat_number": "12345",
        "#shipper_eori":"// 新增 客户的eori号  【royal mail,dpd 出口必填】",
        "shipper_eori": "12345000",
        "#reason_for_export":"// 新增 出口原因: (Sale:销售; ReturnReplacement:退换; Gift:礼物),【dpd 出口必填】",
        "reason_for_export": "Sale",
        "#content_type":"// 新增 包裹类型: (Gift:礼物;Documents:文件,Other:其他),【royalmail 出口必填】",
        "content_type": "Gift",
        "ioss_vat_number":"172848"
    }
]

返回结果:

{
    "success": true,
    "data": [
        {
            "id": 2103220360000003,
            "company_id": 36,
            "client_id": 47,
            "warehouse_id": null,
            "consignment_product_quantity": "1",
            "consignment_product_reference": "2685282",
            "delivery_service_id": 2709,
            "delivery_service_id_internal": 2709,
            "delivery_package_size_id": 617,
            "total_price": "0.00",
            "total_sales_price": "10.00",
            "total_delivery_fee": "0.00",
            "total_handling_fee": "0.50",
            "length": "0.00",
            "width": "0.00",
            "depth": "0.00",
            "total_weight": "250.00",
            "total_volume": "2097152.00",
            "total_volume_weight": "2097152.0000",
            "total_fee_weight": "250.0000",
            "guarantee_percentage": "0.00",
            "contact": "yuhao",
            "business_name": null,
            "address_line1": "DPF4",
            "address_line2": "D474",
            "address_line3": null,
            "city": "Atlanta",
            "county": "Georgia",
            "post_code": "30309",
            "country_iso": "GB",
            "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": "00.000",
            "customs_price": "2.000",
            "custom_identity_reference": null,
            "sales_order_id": 1234567654,
            "payment_reference": null,
            "delivery_reference": null,
            "tracking_reference": null,
            "special_instruction": null,
            "neighbour_instruction": null,
            "omp_name": "ebay",
            "omp_vat_number": "527",
            "shipper_eori": "1616407132",
            "ioss_vat_number": "172848",
            "temp_consignment_info_id": null,
            "is_urgent": "0",
            "is_forced_delivery_service": "0",
            "create_time": "2021-03-22 17:58:51",
            "finish_time": null,
            "arrive_time": null,
            "update_time": "2021-03-22 17:58:52",
            "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": "0",
            "delivery_service_is_tracking": "0"
        }
    ],
    "moduleName": "client"
}

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

返回异常示例

{
    "success": false,
    "message": "You must provide valid contact for consignment at line ."
}

  • No labels