1.1、查询邮递服务
1.1.1接口接口说明
...
1.1.2请求参数
...
1.1.3返回字段
1表示为是，0表示为否
...
...
...
...
...
...
...
...
...
...
...
...
...
...
1.2接口示例
接口请求示例
URL:http://test.birdsystem.com/client/delivery-service?id=5217
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
company_id:{{bs.default_company_id}}
api_key:{{bs.default_api_key}}
id:5217 |
接口返回示例
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"total": 1,
"data": [
{
"id": 5217,
"company_id": 36,
"restrict_max_length_contact": "20",
"restrict_max_length_address_line1": "20",
"restrict_max_length_address_line2": "35",
"restrict_max_length_address_line3": "35",
"restrict_max_length_post_code": "0",
"restrict_regex_post_code": null,
"restrict_regex_telephone": null,
"name": "飞鸟小包",
"locale_name": "",
"is_signature": "0",
"is_tracking": "0",
"is_express": "0",
"is_international": "0",
"is_customs_required": "0",
"is_check_post_code": "0",
"is_check_telephone": "0",
"is_allow_urgent_consignment": "1",
"is_hide_delivery_reference_to_consignment": "0",
"special_type": null,
"consignment_type": "LOCAL",
"consignment_notice_enable": "0",
"consignment_notice": "",
"status": "ACTIVE"
}
],
"success": true,
"moduleName": "client"
} |
2查询可用产品属性
2.1.1、接口
...
2.1.2、请求参数
...
2.1.3、返回字段
...
...
...
...
...
...
int
...
...
...
...
...
...
2.2.1接口示例：
接口请求示例：
地址：http://test.birdsystem.com/client/product-customs-property
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
company_id:{{bs.default_company_id}}
api_key:{{bs.default_api_key}}
id:1 |
接口返回示例：
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"total": 1,
"data": [
{
"id": 1,
"name": "内置锂离子电池",
"value_type": "BOOL",
"default_value": "sdsf",
"symbol": "#",
"is_separate_picking_list": "1",
"is_separate_warehouse_transfer": "1",
"consignment_priority": "2",
"picking_list_group": "HK",
"create_time": "2015-07-07 10:12:52",
"special_type": "BETTERY",
"primary_keys": [
"id"
]
}
],
"success": true,
"moduleName": "client"
} |
查询参数为空或输入无效参数，则默认查询所有产品属性
创建订单
地址: POST http://test.birdsystem.com/client/consignment/Post-Pending-Consignment-With-Products-Json
...
参数
...
is_urgent
...
是否是紧急订单
...
TINYINT(1)
...
delivery_service_id
...
邮递服务ID
...
必填
...
INT(4)
...
sales_reference
...
销售跟踪号
...
VARCHAR(50)
...
自定义惟一标识
(注: 如果填写了，会进行检测，同一种类型同一站点下的订单，6个月内不能有重复的标识)
重复的话会返回: {"success":false,"message":"Duplicate consignment identity reference [....]"}
...
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_iso
...
国家
...
必填
...
CHAR(2)
...
telephone
...
电话
...
VARCHAR(50)
...
...
电子邮件
...
VARCHAR(255)
...
type
...
products
...
产品
...
必填
包含
id /client_sku/reference 和quantity的json对象例如：
[{"client_sku":”IP-XX3355”,"quantity":5}, {"id":2,"quantity":4},
{"reference":2,"quantity":4}
]
注
id ：飞鸟产品系统id，飞鸟系统自动生成的。
client_sku ：主要是给那些有自己的SKU体系的客户用的。如果传了值就是你们传的，如果没传，系统会自动根据 client_id-id的格式生成。
client_ref： id和sku都可以填，但部分接口不适用，post-pending不适用client_ref参数。
reference是基于客户对批量订单产品字段的设置, 自动识别为ID或者SKU.
对于代理专线订单, 需要传如下格式的产品 (每个字段均是必填):
[ {"name":”IP-XX3355”,"name_cn":"中文产品名","quantity":5,"weight":5,"price":5},]
...
数据结构如下：
[
{"weight":500, "length":25, "width":20, "depth":15, "description":"table"},
{"weight":400, "length":22, "width":18, "depth":13, "description":"chair"},
]
备注：重量为克（g），长度为毫米（mm）
...
参数 说明
product_customs_property： 产品属性性可以用名称，也可以用ID，获取途径如上。 [必填]
product_name_cn：产品中文名称 ，不填写会影响清关文件 [必填]
sales_price： 订单在销售平台的价格，(不填的话会自动调用产品申报价格)。
sales_reference：需要填写销售跟踪号请自行添加参数 sales_reference, 例如 "sales_reference":"12345"
weight：重量，单位为g [必填]
price_customs_export：海关出口报关价，单位为美元。（用product_name或name、product_name_cn,或name_cn、price_customs_export或 price都可以上传对应的值） [必填]
client_ref：对应客户sku 是产品的唯一标识即可，可配置在面单显示此字段，便于拣货。 [必填]
custom_identity_reference：自定义唯一跟踪号，属于排重字段，防止重复订单，填写后会检查同一订单类型下6个月内是否有重复订单，重复则报错提示。
brand：品牌
attachment-url：产品图片URL，传送图片链接供飞鸟质检审核产品（只能传网上的图片，不能传本地的）
returnLabel：直接对接获取面单参数标识 ，returnLable =1 时可以直接获取面单，=0 不直接获取面单。（只适用于下一个订单的情况，批量创建多个订单的时候不起作用）
| Code Block |
|---|
[
{
"delivery_service_id": "5198",
"type":"AGENT_DIRECT",
"business_name": "",
"contact": "Rochelle Kerr",
"address_line1": "23 Portelet Court",
"city": "London",
"county": "London",
"post_code": "N1 5TL",
"country_iso": "GB",
"telephone": "07983-467763-467763",
"custom_identity_reference":"224SF242321",
"products": [
{
"product_name": "3apple29",
"product_name_cn":"3苹果29",
"brand":"asd品牌",
"client_ref":"a4624",
"price_customs_export": "3",
"sales_price":"10",
"weight": "300",
"quantity": "1",
"product_customs_property":["普货"],
"attachment-url":"http://www.qqma.com/imgpic2/cpimagenew/2018/4/5/6e1de60ce43d4bf4b9671d7661024e7a.jpg"
},
{
"product_name": "4apple29",
"product_name_cn":"4苹果29",
"brand":"asd品牌",
"client_ref":"a5456",
"price_customs_export": "3",
"sales_price":"10",
"weight": "300",
"quantity": "1",
"product_customs_property":["内置锂离子电池"],
"attachment-url":"http://www.qqma.com/imgpic2/cpimagenew/2018/4/5/6e1de60ce43d4bf4b9671d7661024e7a.jpg"
}
]
}
] |
line: 创建失败的时候, 会告知是哪一个line出错.
返回
| Code Block | ||
|---|---|---|
| ||
{
"success": true,
"data": [
{
"id": 2001210360000027,
"company_id": 36,
"client_id": 47,
"warehouse_id": null,
"consignment_product_quantity": "2",
"consignment_product_reference": "3apple29,4apple29",
"delivery_service_id": 5198,
"delivery_service_id_internal": 5198,
"delivery_package_size_id": 877,
"total_price": "0.00",
"total_delivery_fee": "9.00",
"total_handling_fee": "0.00",
"length": "0.00",
"width": "0.00",
"depth": "0.00",
"total_weight": "600.00",
"total_volume": "0.00",
"total_volume_weight": "0.0000",
"guarantee_percentage": "0.00",
"contact": "Rochelle Kerr",
"business_name": null,
"address_line1": "23 Portelet Court",
"address_line2": null,
"address_line3": null,
"city": "London",
"county": "London",
"post_code": "N1 5TL",
"country_iso": "GB",
"telephone": "07983-467763-467763",
"email": null,
"sender_contact": null,
"sender_business_name": null,
"sender_address_line1": null,
"sender_address_line2": null,
"sender_address_line3": null,
"sender_city": null,
"sender_county": null,
"sender_post_code": null,
"sender_country_iso": null,
"sender_email": null,
"sender_telephone": null,
"sales_reference": null,
"sales_price": "0.000",
"customs_price": "6.000",
"custom_identity_reference": "224SF242321",
"sales_order_id": null,
"payment_reference": null,
"delivery_reference": "0B043873700001DFE9790",
"tracking_reference": null,
"special_instruction": null,
"neighbour_instruction": null,
"temp_consignment_info_id": null,
"is_urgent": "0",
"is_forced_delivery_service": "0",
"create_time": "2020-01-21 18:22:57",
"finish_time": null,
"arrive_time": null,
"update_time": "2020-01-21 18:22:57",
"type": "AGENT_DIRECT",
"status": "ADDRESS_LABEL_PRINTED",
"stock_status": "ONLY_ORI_STOCK_ENOUGH",
"is_hide_delivery_reference_to_consignment": "0"
}
],
"moduleName": "client"
} |
...
| Include Page | ||||
|---|---|---|---|---|
|