Versions Compared

Key

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

FBA单个订单创建接口描述

...

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

...

接口功能

...

FBA单个订单创建接口

...

订单类型

...

FBA

...

支持格式

...

JSON

...

开发人员

...

数据已丢失

...

请求方式

...

POST

...

发布日期

...

数据已丢失

...

请求改动

...

 

...

 

...

 

接口请求参数描述

参数

...

说明

...

是否必填

...

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

...

is_urgent

...

是否紧急订单

...

选填(0或1)

...

按客户填的传

...

delivery_service_id

...

邮递服务ID

...

必填

...

按客户填的传

...

销售跟踪号

...

选填

...

按用户填的传/或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号

...

选填

...

收件人是英国的才会传

...

shipper_eori

...

客人的EORI号

...

必填

...

收件人是英国的才会传

...

reason_for_export

...

出口原因

...

选填

...

传:SALE

...

content_type

...

包裹类型

...

选填

...

传:Other 

...

custom_identity_reference

...

自定义唯一跟踪号

...

选填

...

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

...

备注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)

...

products

...

产品-产品类型(product_type)为普通(normal)

[ {"client_sku":”IP-XX3355”,"quantity":5,”sales_price”:10,”ebay_transaction_id”:”yuhao0001”,”ebay_item_no”:”0001yuhao”,”product_type”:”normal”}, {"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
/平台销售价格, 美元)
按客户填的传(必填)

...

products

...

产品-产品类型(product_type)为定向共享产品(is_directional_shared_product)

[ {"client_sku":”IP-XX3355”,"quantity":5,”sales_price”:10,”ebay_transaction_id”:”yuhao0001”,”ebay_item_no”:”0001yuhao”,”product_type”:”normal”}, {"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
/平台销售价格, 美元)
按客户填的传(必填)

批量临时订单方式

  • Shared product is represented as ClientId#ProductId

  • Directional Shared product is represented as ShareFromClientId#ProductId#D#ShareToClientId

批量订单方式

  • ProductIds string should be able to take care format of 'ClientId-ProductIdxQuantity' For example 2-97*2 means

    • ClientId = 2, ProductId = 97, Quantity = 2

...

products

...

产品-产品类型(product_type)为普通共享产品(with_shared)

[ {"client_sku":”IP-XX3355”,"quantity":5,”sales_price”:10,”ebay_transaction_id”:”yuhao0001”,”ebay_item_no”:”0001yuhao”,”product_type”:”normal”}, {"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
/平台销售价格, 美元)
按客户填的传(必填)

批量临时订单方式

  • Shared product is represented as ClientId#ProductId

  • Directional Shared product is represented as ShareFromClientId#ProductId#ShareToClientId

批量订单方式

ProductIds string should be able to take care format of 'ClientId-ProductIdxQuantity' For example 2-97*2 means

...

FBA单个订单创建接口描述


URL

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

接口功能

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号

选填

收件人是英国的才会传

shipper_eori

客人的EORI号

必填

收件人是英国的才会传

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)

请求描述

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

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"
}

返回结果

Code Block
{
    "data": {
        "commodity_code": null,
        "total_price_customs_export": null,
        "name_customs": null,
        "total_quantity": null,
        "weight": null,
        "price": null,
        "price_customs_export": null,
        "period": null,
        "total_of_consignments": null,
        "type": "FBA",
        "total": null,
        "external_code": null,
        "external_code1": null,
        "external_code2": null,
        "max_length": null,
        "max_width": null,
        "max_depth": null,
        "handling_fee_first_item": null,
        "handling_fee_other_item": null,
        "handling_fee_first_product": null,
        "handling_fee_other_product": null,
        "handling_fee": null,
        "handling_fee_urgent_consignment": null,
        "handling_fee_limit": null,
        "delivery_fee": null,
        "delivery_fee_type": null,
        "return_consignment_id": null,
        "return_consignment_action_type": null,
        "return_consignment_action_name": null,
        "quantity": null,
        "total_price_customs_export_internal": null,
        "battery_type_name_list": null,
        "battery_type_id_list": null,
        "delivery_service_name": null,
        "sku_count": null,
        "product_company_ref": null,
        "id": 2106010360034080,
        "company_id": 36,
        "client_id": 4790,
        "warehouse_id": null,
        "consignment_product_quantity": "0",
        "consignment_product_reference": null,
        "delivery_service_id": 6337,
        "delivery_service_id_internal": null,
        "delivery_package_size_id": null,
        "delivery_package_size_id_internal": null,
        "total_price": "0.00",
        "total_price_internal": "0.00",
        "total_sales_price": null,
        "total_cost": "0.000",
        "total_delivery_fee": "0.00",
        "total_delivery_cost": "0.000",
        "total_handling_fee": "0.00",
        "total_handling_cost": "0.000",
        "length": "0.00",
        "width": "0.00",
        "depth": "0.00",
        "total_weight": "0.00",
        "total_volume": "0.00",
        "total_volume_weight": "0.0000",
        "total_fee_weight": "0.0000",
        "actual_cost": "0.000",
        "guarantee_percentage": "0.00",
        "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_email": "1851717668@bird.co.uk",
        "sender_telephone": "1851717668",
        "sales_reference": "MYSQL100",
        "sales_price": "100.000",
        "customs_price": "0.000",
        "sales_order_id": "MYSQL100",
        "custom_identity_reference": 1622512679,
        "payment_reference": null,
        "delivery_reference": null,
        "tracking_reference": null,
        "special_instruction": "派大星",
        "neighbour_instruction": null,
        "omp_name": "JAVA",
        "omp_vat_number": "202101110000",
        "shipper_eori": "202101110000",
        "temp_consignment_info_id": null,
        "is_urgent": "0",
        "is_forced_delivery_service": "0",
        "create_time": "2021-06-01 09:57:59",
        "finish_time": null,
        "arrive_time": null,
        "update_time": "2021-06-01 09:57:59",
        "status": "PREPARING",
        "stock_status": "ONLY_ORI_STOCK_ENOUGH",
        "reason_for_export": "SALE",
        "content_type": "GIFT",
        "primary_keys": [
            "id"
        ]
    },
    "success": true,
    "moduleName": "client"
}