Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

接口说明:

批量订单是为了方便地处理大量订单而提供的一个临时订单,包括邮递服务、地址等信息,通过如下API创建:

url
URLhttp://test.birdsystem.com/client/consignment-upload/Temp-Consignment-Json
method
接口功能
post
创建批量代理专线订单
body

sales_reference

销售跟踪号

VARCHAR(50)

sales_order_id

eBay或Amazon订单ID

(注:对eBay订单,如果客户有多个eBay账户,那么请把eBay卖家ID信息

也填在这里,可以按以下格式: “SellerUserID : OrderID” )

VARCHAR(50)delivery_reference邮递跟踪号VARCHAR(50)custom_identity_reference

自定义惟一标识 

(注: 如果填写了,会进行检测,同一种类型同一站点下的批量订单,6个月内不能有重复的标识)

重复的话会返回: {"success":false,"message":"Duplicate consignment identity reference [....]"}

VARCHAR(50)

支持格式

json属性如下:

delivery_service_name

邮递服务

必填

INT(4)

JSON开发人员
请求方式POST发布日期

参数说明:


参数

说明必选类型

contact

联系人

必填

VARCHAR(100)

business_name

公司


VARCHAR(255)

address_line1

地址行1

必填

VARCHAR(100)

address_line2

地址行2


VARCHAR(100)

address_line3

地址行3


VARCHAR(100)

city

城市

必填

VARCHAR(50)

county

省/郡


VARCHAR(50)

post_code

邮编

必填

VARCHAR(10)

country_name

国家 获取国家

必填

CHAR(2)

telephone

电话


VARCHAR(50)

email

电子邮件


VARCHAR(255)

sales_reference

销售跟踪号


VARCHAR(50)

payment_reference
付款跟踪号
VARCHAR(50)

telephone

电话


VARCHAR(50)

product_company_ref

产品(定向共享产品标记为ClientId#ProductId#D * 数量)

代理专线订单是: product_name##product_name_cn##client_ref||ProductPrice||ProductWeight||ProductCustomsProperty*Quantity
例如: test1##测试1##47||5||10||电池,其他*2 (多个海关属性用逗号连接)

注:若不填写client_ref(选填项),则格式为 :                                                                                                                                               product_name##product_name_cn||ProductPrice||ProductWeight||ProductCustomsProperty*Quantity

若不填写product_name_cn,则格式为:

product_name##0##client_ref||ProductPrice||ProductWeight||ProductCustomsProperty*Quantity(用0占位)

必填VARCHAR(255)

email

电子邮件

VARCHAR(255)

special_instruction:

备注1

VARCHAR(255)

neighbour_instruction:

备注2

VARCHAR(255)

type

订单类型必填'AGENT_DIRECT'
Code Block
languagejs

special_instruction

备注1


VARCHAR(255)

neighbour_instruction

备注2


VARCHAR(255)

sales_order_id

eBay或Amazon订单ID

(注:对eBay订单,如果客户有多个eBay账户,那么请把eBay卖家ID信息

也填在这里,可以按以下格式: “SellerUserID : OrderID” )


VARCHAR(50)
custom_identity_reference

自定义惟一标识 

(注: 如果填写了,会进行检测,同一种类型同一站点下的批量订单,6个月内不能有重复的标识)

重复的话会返回: {"success":false,"message":"Duplicate consignment identity reference [....]"}


VARCHAR(50)
product_company_ref

产品信息,格式如下:

产品英文名称##产品中文名称##客户sku||内部出口报关价||重量||产品属性||图片URL||平台销售单价(币种USD)||出口报关编码||产地*数量

多个产品用“+”号相连,示例:

Product1##产品##062589||2||10||其他||www.baidu.com||5||4202929190||cn*1+Product2##产品2##78954623||2||30||电池,其他||www.baidu.com||5||4202929190||cn*1  (多个海关属性用逗号连接) 获取产品属性

ps:不填写非必填字段,需用0占位;否则传值会错位显示

必填VARCHAR(255)

delivery_service_name

邮递服务名称,或者使用delivery_service_id参数,指的是邮递服务id,即渠道代码 获取邮递服务

必填

INT(4)

status批量订单状态必填'PENDING'

type

订单类型必填'AGENT_DIRECT'
thirty_system_id第三方系统id
VARCHAR(50)

ebay_transaction_id

eBay订单交易号,加在product_company_ref里边


VARCHAR(50)

ebay_item_no

eBay产品ID,加在product_company_ref里边


VARCHAR(50)
ioss_vat_numberIOSS号,订单发往欧盟国家是,必填,限制填12位字符,格式两位字母+十位数字必填VARCHAR(12)

omp_vat_number

销售平台VAT号

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

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


shipper_eori
royal mail,dpd,欧盟及全球派服务必填

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


必填VARCHAR(50)

receiver_eori

收件人EORI

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

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


receiver_pid_number

收件人个人证件号

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

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


is_compensation_for_delay

是否需要“晚必赔”服务

(只支持部分邮递服务,且偏远地区除外)传0/1,默认0,非0传1

选填BOOL

请求示例:

Code Block
languagejs
GET /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": "Norman Drurytest",
        "business_name": null,
        "address_line1": "3, Northam Close123 letter",
        "address_line2": "Marshside",
        "address_line3": null,
        "city": "SouthportAtlanta",
        "county": "Merseyside",
        "post_code": "PR9 9GA30309",
        "country_name": "United KingdomGermany",
        "telephone": "01704 226830",
        "email": null,
        "sales_order_id": "110222319566123456-0789",
        "payment_reference": "Royal Mail 1st Class Standard",
        "special_instruction": null,
        "product_company_ref": "light1##灯1##47yuhao_product##yuhao_product_cn##122*1||1.5||2||其它||www.baidu.com||3||其它*1+light2##灯2##47||11||3||其它*1||yuhao12||cn||eaby_yuhao1||eaby_yuhao1",
"product_company_ref":"ProductName##ProductNameCN##ClientSKU*Quantity||ProductPrice||ProductWeight||productPropertyNames||imgSrc||PlatformSalesPrice||HsCode||CountryOfOrigin||ebayTransactionId||ebayItemNo",
        "product_company_ref":"产品英文名称##产品中文名称##sku*产品数量||出口报关价格||重量||产品属性名称||图片地址||平台销售价格||商品报关编码||产地||ebay订单ID||ebay产品ID",
        "delivery_service_name": "代理平邮UK24D 中德平邮",
        "status": "PENDING",
        "type": "AGENT_DIRECT",
        "thirty_system_id":"2222222",
    }
]
需要填写销售跟踪号请自行添加参数
    "sales_reference
,  例如 "sales_reference":"12345"

返回

js
Code Block
language
":"123456",
        "":"新增 销售订单ID 【yodel 出口必填】",
        "sales_order_id": "1234567654",
        "":"// 新增 销售平台名称 (必须是英文), ebay, amazon 等 【royal mail,yodel 出口必填】",
        "omp_name": "ebay",
        "":"// 新增 销售平台的vat号 【yodel 出口必填】",
        "omp_vat_number": "12345",
        "":"// 新增 客户的eori号  【royal mail,dpd,欧盟及全球派服务必填】】",
        "shipper_eori": "12345000",
        "":"// 新增 出口原因: (Sale:销售; ReturnReplacement:退换; Gift:礼物),【dpd 出口必填】",
        "reason_for_export": "Sale",
        "":"// 新增 包裹类型: (Gift:礼物;Documents:文件,Other:其他),【royalmail 出口必填】",
        "content_type": "Gift",
        "ioss_vat_number":172848,
        "is_compensation_for_delay": "1"
    }
]

注:产品的“品牌”字段暂时无法用此接口上传。

返回示例

Code Block
title创建批量代理专线订单返回结果
collapsetrue
{
    "data": {
        "2222": "

...

46520946"
    },
    "message": "File successfully uploaded! 1 records has been imported.",
    "success": true,
    "moduleName": "client"
}

返回参数说明:

参数说明
data键值对分别是 thirty_system_
id: 第三方系统id

country_name: 可以通过/client/Country获取

delivery_service_name: 可以通过/client/Delivery-Service 获取

product_company_ref: 产品id*数量, 多个产品的话 产品id*数量+产品id*数量, 可以通过/client/Product 获取

如果是代理专线订单,product_company_ref格式变为:  Product_name||Product_name_cn||ProductPrice||ProductWeight||ProductCustomsProperty*Quantity
例如: 产品1||5||10||电池,其他*2 (多个海关属性用逗号连接)
id和临时批量订单id
message成功/失败信息
successtrue/false
moduleNameclient