Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Table of Contents |
---|
接口说明
用于批量创建一个或者多个代理专线订单,并将订单自动改到已出地址贴状态,随后可直接获取地址贴.
接口格式
URL
https://test.birdsystem.com/client/Consignment/Post-Pending-Consignment-With-Products-Json
接口功能
批量创建代理专线订单
订单类型
代理专线订单
支持格式
JSON
开发人员
请求方式
POST
发布日期
接口参数
参数
类型
必填
说明
是否对接字段/取值内容
is_urgent
Table of Contents |
---|
接口说明
用于批量创建一个或者多个代理专线订单,并将订单自动改到已出地址贴状态,随后可直接获取地址贴.
接口格式
URL | https://test.birdsystem.com/client/Consignment/Post-Pending-Consignment-With-Products-Json | ||
---|---|---|---|
接口功能 | 批量创建代理专线订单 | 订单类型 | 代理专线订单 |
支持参数格式 | JSON | 开发人员 | |
请求方式 | POST | 发布日期 |
接口参数
参数
类型
必填
说明
参数 | 类型 | 必填 | 说明 | 是否对接字段/取值内容 | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
is_urgent | BOOL |
| 是否紧急订单,取值0或者1, 默认为0 | 按客户填的传 | |||||||||||||||||||||||||||||||||
delivery_service_id / delivery_service_name | INT/STRING |
| 邮递服务ID或者邮递服务名称,从 邮递服务查询 获取邮递服务列表,只能填写订单类型为AGENT_DIRECT的服务, 且要与报文中的type字段对应. | 按客户填的传 | |||||||||||||||||||||||||||||||||
sales_reference | STRING |
| 销售跟踪号 | 按用户填的传/或REP系统单号 | |||||||||||||||||||||||||||||||||
sales_order_id | STRING |
| 是否紧急订单,取值0或者1, 默认为0 | 按客户填的传 | |||||||||||||||||||||||||||||||||
delivery_service_id | INT |
| 邮递服务ID,从 邮递服务查询 获取可用邮递服务列表,只能填写订单类型为AGENT_DIRECT的邮递服务 | 按客户填的传 | |||||||||||||||||||||||||||||||||
sales_reference | STRING |
| 销售跟踪号 | 按用户填的传/或REP系统单号 | |||||||||||||||||||||||||||||||||
sales_order_id | STRING |
| 销售订单号 | 按用户填的传/或REP系统单号 | |||||||||||||||||||||||||||||||||
销售订单号 | 按用户填的传/或REP系统单号 | ||||||||||||||||||||||||||||||||||||
custom_identity_reference | STRING |
| 自定义唯一跟踪号 (如果填写了,会进行检测,同一种类型同一站点下的订单,6个月内不能有重复的标识, 重复的话会返回如果填写了,会进行检测,同一订单种类同一站点下的订单,6个月内不能有重复的标识,重复的话会返回: {"success":false,"message":"Duplicate consignment identity reference [....]"}) | 按用户填的传/或REP系统单号(birdsystem会根据改字段判断订单是否重复)按用户填的传或REP系统单号(birdsystem会根据改字段判断订单是否重复) | |||||||||||||||||||||||||||||||||
contact | STRING |
| 收件联系人 | 按用户填的传 | |||||||||||||||||||||||||||||||||
business_name | STRING |
| 公司 | 按用户填的传 | |||||||||||||||||||||||||||||||||
address_line1 | STRING |
| 地址行1 | 按用户填的传 | |||||||||||||||||||||||||||||||||
address_line2 | STRING |
| 地址行2 | 按用户填的传 | |||||||||||||||||||||||||||||||||
city | STRING |
| 城市 | 按用户填的传 | |||||||||||||||||||||||||||||||||
county | STRING |
| 省/郡 | 按用户填的传 | |||||||||||||||||||||||||||||||||
post_code | STRING |
| 邮编 | 按用户填的传 | |||||||||||||||||||||||||||||||||
country_iso | STRING |
| 国家, 填2位ISO国家代码,例如英国用GB填2位ISO国家代码, 美国用US不同邮递服务能发的国家不同. | 按用户填的传 | |||||||||||||||||||||||||||||||||
telephone | STRING |
| 电话 | 按用户填的传 | |||||||||||||||||||||||||||||||||
STRING |
| 电子邮箱 | 按用户填的传 | ||||||||||||||||||||||||||||||||||
special_instruction | STRING |
| 备注1 | 按用户填的传 | |||||||||||||||||||||||||||||||||
neighbour_instruction | STRING |
| 备注2 | 按用户填的传 | |||||||||||||||||||||||||||||||||
type | STRING |
| 订单类型, AGENT_DIRECT传 AGENT_DIRECT | 按用户填的传 | |||||||||||||||||||||||||||||||||
products | JSON ARRAY |
| 产品产品详细信息数组, 其详细见 产品字段描述
{
} ] | (ebay_transaction_id (sales_price | |||||||||||||||||||||||||||||||||
parcel_pieces | JSON ARRAY |
| 多包裹信息,如果仅一个包裹时可不用填. [ {"weight":500, "length":25, "width":20, "depth":15, "description":"table"}, {"weight":400, "length":22, "width":18, "depth":13, "description":"chair"} ] 备注:重量为克(g),长度为毫米(mm) | 按用户填的传 | |||||||||||||||||||||||||||||||||
payment_reference | STRING |
| 付款凭证 | 按用户填的传 | |||||||||||||||||||||||||||||||||
omp_name | STRING |
| 销售平台名称 | 按用户填的传
| omp_vat_number | STRING |
| 销售平台VAT号 英国发往非英国且公司不为空(“business_name“字段)的DPD订单 要求必填 | shipper_eori | STRING |
| 客人的EORI号, 必须是国家代码+12位数字,例如:GB000000777888 ,必须提前在鸟系统备案,详询客服. 参考接口: 获取VAT账号 英国发往EU必填 英国发往非英国的DPD服务必填 | |||||||||||||||||||||||||
reason_for_export | STRING |
| 出口原因, 取值【Sale:销售; ReturnReplacement:退换; Gift:礼物】 | 传:SALE | |||||||||||||||||||||||||||||||||
content_type | STRING |
| 包裹类型, 取值【Gift 礼物;Documents 文件和 Other 其他】 | 传:Other | |||||||||||||||||||||||||||||||||
sender_contact | STRING |
| 发件人 (DPD服务必填) | 按客户填的传 | |||||||||||||||||||||||||||||||||
sender_address_line1 | STRING |
| 发件人地址行1 (DPD服务必填) | 按客户填的传 | |||||||||||||||||||||||||||||||||
sender_address_line2 | STRING |
| 发件人地址行2 | 按客户填的传 | |||||||||||||||||||||||||||||||||
sender_city | STRING |
| 发件人城市 (DPD服务必填) | 按客户填的传 | |||||||||||||||||||||||||||||||||
sender_county | STRING |
| 发件人省/郡 | 按客户填的传 | |||||||||||||||||||||||||||||||||
| 按用户填的传 | ||||||||||||||||||||||||||||||||||||
parcel_pieces | JSON ARRAY |
| 一票多件的多包裹信息,如果仅一个包裹时可不用填.
其中, 重量单位为克(g),尺寸单位为毫米(mm) | 按用户填的传 | |||||||||||||||||||||||||||||||||
payment_reference | STRING |
| 付款凭证 | 按用户填的传 | |||||||||||||||||||||||||||||||||
omp_name | STRING |
| 销售平台名称, 必须是英文 【royal mail,yodel 出口必填】 常见的平台代码如下:
| 按用户填的传 | |||||||||||||||||||||||||||||||||
omp_vat_number | STRING |
| 发件人邮编 (DPD服务必填) | 按客户填的传 | sender_country_iso销售平台VAT号 , 【yodel 出口必填】 英国发往非英国且公司不为空("business_name"字段)的DPD订单必填 | 按用户填的传 | |||||||||||||||||||||||||||||||
shipper_eori | STRING |
| 发件人国家 (DPD服务必填) | 按客户填的传 | sender_email客人的EORI号, 必须是国家代码+12位数字,例如:GB000000777888 ,必须提前在鸟系统备案VAT,详询客服. 参考接口: 获取VAT账号 ,【royal mail,yodel 出口必填】 英国发往EU必填 英国发往非英国的DPD服务必填 | 按用户填的传 | |||||||||||||||||||||||||||||||
reason_for_export | STRING |
| 发件人电子邮箱 | 按客户填的传 | sender_telephone出口原因, 取值【SALE:销售; RETURN REPLACEMENT:退换; GIFT:礼物】 【dpd 出口必填】 | 一般传:SALE | |||||||||||||||||||||||||||||||
content_type | STRING |
| 发件人电话 (DPD服务必填) | 按客户填的传 | ioss_vat_number包裹类型, 取值【GIFT:礼物; DOCUMENTS:文件; OTHER:其他】 【royalmail 出口必填】 | 一般传:OTHER | |||||||||||||||||||||||||||||||
sender_contact | STRING |
| IOSS号, 订单发往欧盟国家时必填 | 填写客户实际IOSS号 | receiver_eori
| 发件人 (DPD服务必填) | 按客户填的传 | ||||||||||||||||||||||||||||||
sender_address_line1 | STRING |
| 收件人EORI 英国发往非英国且公司不为空(“business_name“字段)的DPD订单 要求必填 | receiver_pid_number发件人地址行1 (DPD服务必填) | 按客户填的传 | ||||||||||||||||||||||||||||||||
sender_address_line2 | STRING |
| 发件人地址行2 | 收件人个人证件号 英国发往挪威、西班牙、意大利的DPD订单 要求必填按客户填的传 | is_compensation_for_delay | ||||||||||||||||||||||||||||||||
sender_city | STRING |
| 是否需要晚必赔服务(仅支持部分服务,偏远地区除外), 取值0或者1, 默认为0 |
产品字段参数描述:products
发件人城市 (DPD服务必填) | 按客户填的传 | ||||
sender_county | STRING |
|
---|
|
发件人省/郡 |
按客户填的传 |
sender_ |
---|
post_ |
---|
code | STRING |
|
---|
|
产品中文名称
| 发件人邮编 (DPD服务必填) | 按客户填的传 | ||||||
sender_country_iso | STRING |
|
---|
品牌
发件人国家, 填2位ISO国家代码 (DPD服务必填) | 按客户填的传 | |||||||
sender_email | STRING |
|
---|
客户SKU
price_customs_export
FLOAT
Status | ||||
---|---|---|---|---|
|
出口报关价
sales_price
发件人电子邮箱 | 按客户填的传 | |||||||
sender_telephone | STRING |
|
---|
平台销售价格
发件人电话 (DPD服务必填) | 按客户填的传 | ||||
ioss_vat_number | STRING |
|
---|
|
商品海关编码
| IOSS号, 发往欧盟国家时必填, 限制填12位字符, 格式: 两位字母+十位数字 | 按客户填的传 | |||||||
receiver_eori | STRING |
| 收件人EORI 英国发往非英国且公司不为空(“business_name“字段)的DPD订单必填 |
---|
产地
weight
按客户填的传 | |||||
receiver_pid_number | STRING |
|
---|
|
重量
quantity
| 收件人个人证件号 英国发往挪威、西班牙、意大利的DPD订单必填 | 按客户填的传 | |||
is_compensation_for_delay | BOOL |
|
---|
|
数量
product_customs_property
| 是否需要晚必赔服务(仅支持部分服务,偏远地区除外), 取值0或者1, 默认为0 | 按客户填的传 |
Anchor | ||||
---|---|---|---|---|
|
参数 | 类型 | 必填 | 说明 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
product_name | STRING |
| 产品属性名称产品英文名称 | |||||||||||
product_customsname_property[]cn | STRING/INT |
| 产品中文名称 | |||||||||||
brand | STRING |
| 品牌 | |||||||||||
client_sku/client_ref | STRING |
| 客户SKU,两个字段名称二选一 | |||||||||||
price_customs_export/price | FLOAT(10,2) |
| 两个字段名称二选一, 此SKU的出口报关价,两位小数,单位为美元(USD) | |||||||||||
sales_price | FLOAT(10,2) |
| 此SKU的销售单价,两位小数,单位为美元(USD) | |||||||||||
hs_code | STRING |
| 商品海关编码 | |||||||||||
country_of_origin | STRING |
| 产地国家,两位ISO国家代码 | |||||||||||
weight | INT |
| 此SKU的重量, 单位克(g) | |||||||||||
quantity | INT |
| 此SKU的数量 | |||||||||||
product_customs_property | STRING/ARRAY |
| 此SKU的属性名称或者ID,多个属性用逗号分隔 或者 按JSON数组传。取值参考下表:
| |||||||||||
attachment-url | STRING |
| 图片URL | |||||||||||
ebay_transaction_id | STRING |
| eBay订单交易号 | |||||||||||
ebay_item_no | STRING |
| eBay产品ID |
接口示例
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
温馨提示: 1、只有邮递服务状态为正常时,该服务才能正常下单。(举例: 2、请注意必填字段,创建订单时,必填字段未填会报错。 请求
返回
line: 创建失败的时候, 会告知是哪一个line出错. 异常返回必填项
|