Page Comparison

FBA单个订单创建接口描述FBA单个订单创建接口描述

URL	https://

test.birdsystem.com

<系统域名>/client/Consignment/
接口功能	FBA单个订单创建接口	订单类型

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

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",{
     "client_id": "",
     "id": "",
     "is_urgent": "0",
     "delivery_service_id": "5318",
     "delivery_package_size_id": "",
     "sales_reference": "",
     "sales_price": "",
     "deliverysales_serviceorder_id": "6337",
     "salesomp_referencename": "MYSQL100",
     "salesomp_vat_pricenumber": "1001",
     "salesshipper_order_ideori": "MYSQL100191966856000",
     "ompioss_vat_namenumber": "JAVA",
     "ompreceiver_vat_numbereori": "2021011100001",
     "shipperreceiver_pid_eorinumber": "2021011100002",
     "reason_for_export": "SALE",
     "contentcustom_identity_typereference": "GIFT",
     "custom_identity_referenceconsignment_delivery_agent-net17track_code": "{{$timestamp}}",
     "special_instruction": "派大星",
     "contact": "派大星test",
     "business_name": "bird",
     "address_line1": "云谷asdasd",
     "address_line2": "云阁asdasda",
     "address_line3": "一栈asdsada",
     "city": "云城",
     "county": "云岛",
     "post_code": "13149999asd",
     "country_iso": "GBCN",
     "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","",
     "arrive_time": "",
     "update_time": "2021-11-05-31 1209:0841:3904",
     "type": "FBA",
     "iossbrowser_vatcompany_numberid": "1728482"
}

返回结果

Code Block

{
    "data": {
        "commodity_code": null,
        "total_price_customs_export": null_handling_fee": "0.00",
        "reason_for_export": null,
        "total_cost": "0.000",
        "namedelivery_customsreference": null,
        "totalmax_quantitydepth": null,
        "weighttracking_reference": null,
        "pricehandling_fee_other_product": null,
        "pricedelivery_customsfee_exporttype": null,
        "periodcounty": null,
        "totalomp_ofvat_consignmentsnumber": null"1",
        "typesender_telephone": "FBA"null,
        "totalis_forced_delivery_service": null"0",
        "external_codetype": null"FBA",
        "externaltotal_delivery_code1fee": null"0.00",
        "externalmax_code2width": null,
        "maxdelivery_lengthfee": null,
        "max_widthbattery_type_name_list": null,
        "max_depthprice": null,
        "handling_fee_first_itemguarantee_percentage": null"0.00",
        "handling_fee_other_itemsales_reference": null,
        "handlingsales_feeorder_first_productid": null,
        "handling_fee_other_producttotal_quantity": null,
        "handling_feeid": null2111080020000006,
        "handling_feeconsignment_urgentproduct_consignmentreference": null,
        "handlingmax_fee_limitlength": null,
        "deliverybusiness_feename": null,
        "delivery_fee_typeperiod": null,
        "returnstock_consignment_idstatus": null"ONLY_ORI_STOCK_ENOUGH",
        "return_consignment_action_typeid": null,
        "return_consignment_action_namepayment_reference": null,
        "quantityarrive_time": null,
        "totalsender_price_customs_export_internalbusiness_name": null,
        "battery_type_name_listis_urgent": null"0",
        "battery_type_id_listactual_cost": null"0.000",
        "deliverycustom_serviceidentity_namereference": null,
        "skuhandling_countfee": null,
        "productbattery_type_companyid_reflist": null,
        "idstatus": 2106010360034080"PREPARING",
        "companytotal_delivery_idcost": 36"0.000",
        "clientsender_address_idline1": 4790null,
        "warehouse_idcity": null,
        "consignmentsender_productaddress_quantityline2": "0"null,
        "consignmentsender_productaddress_referenceline3": null,
        "deliverytotal_servicehandling_idcost": 6337"0.000",
        "delivery_servicepackage_size_id_internal": null,
        "delivery_package_size_idsender_county": null,
        "deliveryreceiver_package_size_id_internalpid_number": null2,
        "total_pricehandling_fee_urgent_consignment": "0.00"null,
        "totalupdate_price_internaltime": "0.002021-11-08 12:00:37",
        "totaladdress_sales_priceline3": null"asdsada",
        "total_costprice_customs_export": "0.000"null,
        "totaladdress_delivery_feeline2": "0.00asdasda",
        "totaladdress_delivery_costline1": "0.000asdasd",
        "totalexternal_handling_feecode": "0.00"null,
        "totalcountry_handling_costiso": "0.000CN",
        "lengthemail": "0.00"null,
        "widthname_customs": "0.00"null,
        "depthhandling_fee_other_item": "0.00"null,
        "totalcompany_weightid": "0.00"2,
        "total_volumedelivery_package_size_id": "0.00"null,
        "totaltemp_consignment_volumeinfo_weightid": "0.0000"null,
        "totalreturn_consignment_fee_weight": "0.0000"action_type": null,
        "actualomp_costname": "0.000"null,
        "guaranteeshipper_percentageeori": "0.00191966856000",
        "contactdepth": "派大星0.00",
        "business_nametotal_price_customs_export_internal": "bird"null,
        "addresspost_line1code": "云谷asd",
        "address_line2width": "云阁0.00",
        "addresssales_line3price": "一栈0.000",
        "citywarehouse_id": "云城"null,
        "countytotal_volume": "云岛0.00",
        "post_codedelivery_service_id_internal": "13149999"null,
        "countryprimary_isokeys": "GB",[
           "telephone": "1851717668id",
        "email": "1851717668@bird.co.uk"],
        "senderdelivery_service_contactname": "派大星"null,
        "senderexternal_business_namecode2": "bird"null,
        "sender_addressexternal_line1code1": "云谷"null,
        "senderclient_address_line2id": "云阁"1,
        "senderdelivery_addressservice_line3id": "一栈"5318,
        "sendertotal_of_cityconsignments": "云城"null,
        "sender_countycontact": "云岛test",
        "sender_post_codeemail": "13149999"null,
        "sender_country_isocontact": "GB"null,
        "sender_email": "1851717668@bird.co.ukcreate_time": "2021-11-08 12:00:37",
        "sendertotal_fee_telephoneweight": "18517176680.0000",
        "sales_referenceweight": "MYSQL100"null,
        "sales_pricehandling_fee_first_product": "100.000"null,
        "customs_pricetelephone": "0.000"null,
        "salesfinish_order_idtime": "MYSQL100"null,
        "customioss_identityvat_referencenumber": 1622512679null,
        "paymentproduct_company_referenceref": null,
        "deliverysku_referencecount": null,
        "trackingconsignment_product_referencequantity": null"0",
        "specialcustoms_instructionprice": "派大星0.000",
        "neighboursender_post_instructioncode": null,
        "omptotal_volume_nameweight": "JAVA0.0000",
        "omphandling_fee_vatfirst_numberitem": "202101110000"null,
        "shippertotal_eoriweight": "2021011100000.00",
        "iossreceiver_vat_numbereori": "1728481",
        "temp_consignment_info_idtotal": null,
        "isneighbour_urgentinstruction": "0"null,
        "is_forced_delivery_servicecontent_type": "0"null,
        "createtotal_sales_timeprice": "2021-06-01 09:57:59"null,
        "finishprice_customs_timeexport": null,
        "arrive_timereturn_consignment_action_name": null,
        "update_timequantity": "2021-06-01 09:57:59"null,
        "statustotal_price": "PREPARING0.00",
        "stock_statuslength": "ONLY_ORI_STOCK_ENOUGH0.00",
        "reasonsender_forcountry_exportiso": "SALEGB",
        "contentsender_typecity": "GIFT"null,
        "primaryhandling_fee_keyslimit": [null,
        "special_instruction": null,
  "id"         ]"total_price_internal": "0.00"
    },
    "success": true,
    "moduleName": "client"
}

Versions Compared

Old Version 14

New Version Current

Key