Versions Compared

Key

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

FBA单个订单创建接口描述

URL

https://test.birdsystem.com/client/Consignment/

接口功能

FBA单个订单创建接口

订单类型

FBA订单

支持格式

JSON

开发人员

请求方式

POST

发布日期

请求改动

 

 

 

...

参数

说明

是否必填

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

is_urgent

是否紧急订单

选填(0或1)

按客户填的传

delivery_service_id

邮递服务ID

必填

按客户填的传


sales_reference

销售跟踪号

选填

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

sales_price

订单销售价格

选填

按用户填的传

sales_order_id

销售订单号

选填

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

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号

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

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

shipper_eori

客人的EORI号

选填

英国发往EU必填

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

reason_for_export

出口原因

选填

传:SALE

content_type

包裹类型

选填

传:Other 

custom_identity_reference

自定义唯一跟踪号

选填

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


special_instruction

备注1

选填

按用户填的传

contact

收件联系人

必填

按用户填的传

business_name

公司

选填

按用户填的传

address_line1

地址行1

必填

按用户填的传

address_line2

地址行2

选填

按用户填的传

address_line3

地址行3

选填

按用户填的传

city

城市

必填

按用户填的传

county

省/郡

选填

按用户填的传

post_code

邮编

必填

按用户填的传

country_iso

国家

必填

按用户填的传

telephone

电话

选填

按用户填的传

email

电子邮箱

选填

按用户填的传

sender_contact

发件人

选填(DPD服务必填)

按客户填的传

sender_business_name

发件人公司

选填

按用户填的传

sender_address_line1

发件人地址1

选填

按用户填的传

sender_address_line2

发件人地址2

选填

按用户填的传

sender_address_line3

发件人地址3

选填

按用户填的传

sender_city

发件人城市

选填

按用户填的传

sender_county

发件人省/郡

选填

按用户填的传

sender_post_code

发件人邮编

选填

按用户填的传

sender_country_iso

发件人国家

选填

按用户填的传

sender_telephone

发件人电话

选填

按用户填的传

sender_email

发件人电子邮箱

选填

按用户填的传

update_time

更新时间

系统自动更新字段

按用户填的传

type

订单类型

必填

FBA订单(FBA)

ioss_vat_number

IOSS号

必填

按用户实际IOSS号传
FBA发往欧盟国家时,必填
限制填12位字符,格式两位字母+十位数字

receiver_eori

收件人EORI

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

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

receiver_pid_number

收件人个人证件号

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

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

请求描述

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

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

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

Http请求格式:请求格式:

Code Block
POST /client/Consignment/ HTTP/1.1
Host: {{Bird_URL}}
Headres:
  api_key: {{api_key}}
  company_id: {{company_id}}
  Cookie: PHPSESSID=3s3nejv43u9bhirsrvq9nge254
Body
  raw

{
    "is_urgent": "0",
    "delivery_service_id": "6337",
    "sales_reference": "MYSQL100",
    "sales_price": "100",
    "sales_order_id": "MYSQL100",
    "omp_name": "JAVA",
    "omp_vat_number": "202101110000",
    "shipper_eori": "202101110000",
    "reason_for_export": "SALE",
    "content_type": "GIFT",
    "custom_identity_reference": "{{$timestamp}}",
    "special_instruction": "派大星",
    "contact": "派大星",
    "business_name": "bird",
    "address_line1": "云谷",
    "address_line2": "云阁",
    "address_line3": "一栈",
    "city": "云城",
    "county": "云岛",
    "post_code": "13149999",
    "country_iso": "GB",
    "telephone": "1851717668",
    "email": "1851717668@bird.co.uk",
    "sender_contact": "派大星",
    "sender_business_name": "bird",
    "sender_address_line1": "云谷",
    "sender_address_line2": "云阁",
    "sender_address_line3": "一栈",
    "sender_city": "云城",
    "sender_county": "云岛",
    "sender_post_code": "13149999",
    "sender_country_iso": "GB",
    "sender_telephone": "1851717668",
    "sender_email": "1851717668@bird.co.uk",
    "update_time": "2021-05-31 12:08:39",
    "type": "FBA",
    "ioss_vat_number":"172848",
    "receiver_eori"="1",
    "receiver_pid_number"="2"    
}_id=&id=&is_urgent=0&delivery_service_id=5318&delivery_package_size_id=&sales_reference=&sales_price=&sales_order_id=&omp_name=&omp_vat_number=1&shipper_eori=191966856000&ioss_vat_number=&receiver_eori=1&receiver_pid_number=2&reason_for_export=&custom_identity_reference=&consignment_delivery_agent-net17track_code=&special_instruction=&contact=test&business_name=&address_line1=asdasd&address_line2=asdasda&address_line3=asdsada&city=&county=&post_code=asd&country_iso=CN&telephone=&email=&sender_contact=&sender_business_name=&sender_address_line1=&sender_address_line2=&sender_address_line3=&sender_city=&sender_county=&sender_post_code=&sender_country_iso=GB&sender_telephone=&sender_email=&arrive_time=&update_time=2021-11-05+09%3A41%3A04&type=FBA&browser_company_id=2

返回结果

Code Block
{
    "data": {
        "commodity_code": null,
        "total_handling_fee": "0.00",
        "reason_for_export": null,
        "total_cost": "0.000",
        "delivery_reference": null,
        "max_depth": null,
        "tracking_reference": null,
        "handling_fee_other_product": null,
        "delivery_fee_type": null,
        "county": null,
        "omp_vat_number": "1",
        "sender_telephone": null,
        "is_forced_delivery_service": "0",
        "type": "FBA",
        "total_delivery_fee": "0.00",
        "max_width": null,
        "delivery_fee": null,
        "battery_type_name_list": null,
        "price": null,
        "guarantee_percentage": "0.00",
        "sales_reference": null,
        "sales_order_id": null,
        "total_quantity": null,
        "id": 21110800200000022111080020000006,
        "consignment_product_reference": null,
        "max_length": null,
        "business_name": null,
        "period": null,
        "stock_status": "ONLY_ORI_STOCK_ENOUGH",
        "return_consignment_id": null,
        "payment_reference": null,
        "arrive_time": null,
        "sender_business_name": null,
        "is_urgent": "0",
        "actual_cost": "0.000",
        "custom_identity_reference": null,
        "handling_fee": null,
        "battery_type_id_list": null,
        "status": "PREPARING",
        "total_delivery_cost": "0.000",
        "sender_address_line1": null,
        "city": null,
        "sender_address_line2": null,
        "sender_address_line3": null,
        "total_handling_cost": "0.000",
        "delivery_package_size_id_internal": null,
        "sender_county": null,
        "receiver_pid_number": 2,
        "handling_fee_urgent_consignment": null,
        "update_time": "2021-11-08 1012:5600:4137",
        "address_line3": "asdsada",
        "total_price_customs_export": null,
        "address_line2": "asdasda",
        "address_line1": "asdasd",
        "external_code": null,
        "country_iso": "CN",
        "email": null,
        "name_customs": null,
        "handling_fee_other_item": null,
        "company_id": 2,
        "delivery_package_size_id": null,
        "temp_consignment_info_id": null,
        "return_consignment_action_type": null,
        "omp_name": null,
        "shipper_eori": "191966856000",
        "depth": "0.00",
        "total_price_customs_export_internal": null,
        "post_code": "asd",
        "width": "0.00",
        "sales_price": "0.000",
        "warehouse_id": null,
        "total_volume": "0.00",
        "delivery_service_id_internal": null,
        "primary_keys": [
            "id"
        ],
        "delivery_service_name": null,
        "external_code2": null,
        "external_code1": null,
        "client_id": 1,
        "delivery_service_id": 53155318,
        "total_of_consignments": null,
        "contact": "test",
        "sender_email": null,
        "sender_contact": null,
        "create_time": "2021-11-08 1012:5600:4137",
        "total_fee_weight": "0.0000",
        "weight": null,
        "handling_fee_first_product": null,
        "telephone": null,
        "finish_time": null,
        "ioss_vat_number": null,
        "product_company_ref": null,
        "sku_count": null,
        "consignment_product_quantity": "0",
        "customs_price": "0.000",
        "sender_post_code": null,
        "total_volume_weight": "0.0000",
        "handling_fee_first_item": null,
        "total_weight": "0.00",
        "receiver_eori": "1",
        "total": null,
        "neighbour_instruction": null,
        "content_type": null,
        "total_sales_price": null,
        "price_customs_export": null,
        "return_consignment_action_name": null,
        "quantity": null,
        "total_price": "0.00",
        "length": "0.00",
        "sender_country_iso": "GB",
        "sender_city": null,
        "handling_fee_limit": null,
        "special_instruction": null,
        "total_price_internal": "0.00"
    },
    "success": true,
    "moduleName": "client"
}