1-1-1. 创建订单(接口)
1、创建订单接口说明
url | |||
---|---|---|---|
接口功能 | 创建单个订单
| ||
支持格式 | json | 开发人员 | |
请求方式 | post | 发布日期 |
请求from参数
参数 | 必填 | 类型 | 说明 | |
---|---|---|---|---|
1 | is_urgent | 选填 | BOOL | 是否紧急订单 |
2 | delivery_service_id | 必填 | INT | 邮递服务ID ,参考接口: 获取邮递服务 |
3 | return_consignment-return_consignment_action_type | 选填 | VARCHAR | 退货服务种类 ( CONTAINER: 上架, ) |
4 | sales_reference | 选填 | VARCHAR | 销售跟踪号 |
5 | sales_price | 必填 | VARCHAR | 销售价格 |
6 | sales_order_id | 选填 | VARCHAR | 销售订单ID(YODEL服务必填) |
7 | custom_identity_reference | 选填 | VARCHAR | 自定义唯一标识 |
8 | omp_name | 选填 | VARCHAR | 销售平台名称,(必须是英文), ebay, amazon 等(royal mail,yodel 出口必填) |
9 | omp_vat_number | 选填 英国发往非英国且公司不为空(“business_name“字段)的DPD订单 要求必填 | VARCHAR | 销售平台VAT号 |
10 | shipper_eori | 选填(英国发往非英国的DPD服务必填) | VARCHAR | EORI号(royal mail,dpd 出口必填), 是国家代码+12位数字,例如: GB000000777888, 必须提前在鸟系统中备案, 详询客服。 参考接口: 获取VAT账号 英国发往非英国的DPD服务必填 |
11 | contact | 选填 | VARCHAR | 联系人 |
12 | business_name | 选填 | VARCHAR | 公司名称 |
13 | address_line1 | 选填 | VARCHAR | 地址行1 |
14 | address_line2 | 选填 | VARCHAR | 地址行2 |
15 | address_line3 | 选填 | VARCHAR | 地址行3 |
16 | city | 选填 | VARCHAR | 城市 |
17 | county | 选填 | VARCHAR | 省/郡 |
18 | post_code | 选填 | VARCHAR | 邮编 |
19 | country_iso | 必填 | CHAR(2) | 国家编码 |
20 | telephone | 选填 | VARCHAR | 电话号码 |
21 | 选填 | VARCHAR | 电子邮箱 | |
22 | special_instruction | 选填 | VARCHAR | 备注1 |
23 | neighbour_instruction | 选填 | VARCHAR | 备注2 |
24 | reason_for_expot | 选填 | VARCHAR | 出口原因(Sale:销售; ReturnReplacement:退换; Gift:礼物dpd 出口必填 |
25 | content_type | 选填 | VARCHAR | 包裹类型,值【Gift 礼物;Documents 文件和 Other 其他】 |
26 | type | 选填 | VARCHAR | 订单类型(LOCAL) |
27 | omp_vat_number | 选填 | VARCHAR | 销售平台的vat号(yodel 出口必填) |
28 | ioss_vat_number | 必填 | INT | 发往欧盟国家时,必填 |
29 | receiver_eori | 收件人EORI | 选填(DPD服务按要求必填) | 英国发往非英国且公司不为空(“business_name“字段)的DPD订单 要求必填 |
30 | receiver_pid_number | 收件人个人证件号 | 选填(DPD服务按要求必填) | 英国发往挪威、西班牙、意大利的DPD订单 要求必填 |
31 | is_compensation_for_delay | 选填 是否需要“晚必赔”服务(只支持部分邮递服务,偏远地区除外) | BOOL | 晚必赔服务,传0/1,默认为0,非0传1 |
返回字段
返回字段 | 字段类型 | 说明 | |
---|---|---|---|
1 | commodity_code | VARCHAR | 客户专线订单包裹代码 |
2 | total_price_customs_export | float(‘%.2f’) | 海关报关价格 |
3 | name_customs | VARCHAR | 产品英文名称 |
4 | total_quantity | VARCHAR | 总数量 |
5 | weight | VARCHAR | 重量 |
6 | price | float(‘%.2f’) | 价格 |
7 | price_customs_export | float('%.2f') | 海关出口价格 |
8 | period | DATA | 订单所在期间 |
9 | total_of_consignments | float(‘%.2f’) | 总邮递费用 |
10 | type | VARCHAR | 订单类型 |
11 | total | int | 拣货单产品总数 |
12 | external_code | VARCHAR | 外部服务代码 |
13 | external_code1 | VARCHAR | 外部服务代码1 |
14 | external_code2 | VARCHAR | 外部服务代码2 |
15 | max_length | INT | 最大长度 |
16 | max_width | INT | 最大宽度 |
17 | max_depth | INT | 最大高度 |
18 | handling_fee_first_item | float('%.2f') | 第一件产品手续费 |
19 | handling_fee_other_item | float('%.2f') | 其他产品手续费 |
20 | handling_fee_first_product | float('%.2f') | 第一件SKU手续费 |
21 | handling_fee_other_product | float('%.2f') | 其他SKU手续费 |
22 | handling_fee | float('%.2f') | 手续费 |
23 | handling_fee_urgent_consignment | float('%.2f') | 订单紧急手续费 |
24 | handling_fee_limit | float('%.2f') | 手续费列表 |
25 | delivery_fee | float('%.2f') | 邮递费用 |
26 | delivery_fee_type | int | 邮递费用类型 |
27 | return_consignment_id | INT | 退货订单ID |
28 | return_consignment_action_type | VARCHAR | 退货订单类型 |
29 | return_consignment_action_name | VARCHAR | 退货服务名称 |
30 | quantity | INT | 产品数量 |
31 | total_price_customs_export_INTernal | float('%.3f') | 国际出口总报关价 |
32 | battery_type_name_list | VARCHAR | 电池类型名称 |
33 | battery_type_id_list | INT | 电池类型ID |
34 | delivery_service_name | VARCHAR | 邮递服务名称 |
35 | sku_count | INT | SKU数量 |
36 | product_company_ref | VARCHAR | 批量订单产品代码 |
37 | id | INT | 订单ID |
38 | company_id | INT | 站点ID |
39 | client_id | INT | 客户ID |
40 | warehouse_id | INT | 仓库ID |
41 | consignment_product_quantity | INT | 订单产品数量 |
42 | consignment_product_reference | VARCHAR | 订单产品英文名称 |
43 | delivery_service_id | INT | 邮递服务ID |
44 | delivery_service_id_INTernal | INT | 邮递服务ID内部 |
45 | delivery_package_size_id | INT | 包裹尺寸ID |
46 | delivery_package_size_id_INTernal | INT | 包裹尺寸ID内部 |
47 | total_price | float('%.2f') | 产品总价格 |
48 | total_price_INTernal | float('%.2f') | 内部总价格 |
49 | total_cost | float('%.2f') | 产品成本 |
50 | total_delivery_fee | float('%.2f') | 总邮递服务费用 |
51 | total_delivery_cost | float('%.3f') | 总邮递服务成本 |
52 | total_handling_fee | float('%.2f') | 手续费 |
53 | total_handling_cost | float('%.3f') | 手续成本 |
54 | length | float('%.2f') | 长 |
55 | width | float('%.2f') | 宽 |
56 | depth | float('%.2f') | 高 |
57 | total_weight | float('%.2f') | 总重量 |
58 | total_volume | float('%.2f') | 总体积 |
59 | total_volume_weight | float('%.2f') | 总体积重 |
60 | total_fee_weight | float('%.2f') | 计费重 |
61 | actual_cost | float('%.2f') | 实际成本 |
62 | guarantee_percentage | VARCHAR | 担保比例 |
63 | contact | VARCHAR | 联系人 |
64 | business_name | VARCHAR | 公司名称 |
65 | address_line1 | VARCHAR | 地址行1 |
66 | address_line2 | VARCHAR | 地址行2 |
67 | address_line3 | VARCHAR | 地址行3 |
68 | city | VARCHAR | 城市 |
69 | county | VARCHAR | 省/郡 |
70 | post_code | VARCHAR | 邮编 |
71 | country_iso | CHAR(2) | 国家 |
72 | telephone | VARCHAR | 电话号码 |
73 | VARCHAR | 电子邮箱 | |
74 | sender_contact | VARCHAR | 发件人 |
75 | sender_business_name | VARCHAR | 发件公司名称 |
76 | sender_address_line1 | VARCHAR | 发件地址行1 |
77 | sender_address_line2 | VARCHAR | 发件地址行2 |
78 | sender_address_line3 | VARCHAR | 发件地址行3 |
79 | sender_city | VARCHAR | 发件城市 |
80 | sender_county | VARCHAR | 发件省/郡 |
81 | sender_post_code | VARCHAR | 发件邮编 |
82 | sender_country_iso | CHAR(2) | 发件国家 |
83 | sender_email | VARCHAR | 发件人电子邮箱 |
84 | sender_telephone | CARCHAR | 发件人电话号码 |
85 | sales_reference | VARCHAR | 销售跟踪号 |
86 | sales_price | float('%.2f') | 销售价格 |
87 | customs_price | float('%.2f') | 报关价格 |
88 | sales_order_id | VARCHAR | 销售订单ID |
89 | custom_identity_reference | VARCHAR | 自定义唯一标识 |
90 | omp_name | VARCHAR | 销售平台名称 |
91 | omp_vat_number | VARCHAR | 销售平台vat号 |
92 | shipper_eori | VARCHAR | eori号 |
93 | payment_reference | VARCHAR | 付款凭证 |
94 | delivery_reference | VARCHAR | 运输跟踪号 |
95 | tracking_reference | VARCHAR | 17tarck运输跟踪号 |
96 | special_instruction | VARCHAR | 备注1 |
97 | neighbour_instruction | VARCHAR | 备注2 |
98 | temp_consignment_info_id | VARCHAR | 批量订单ID |
99 | is_urgent | BOOL | 是否为紧急订单 |
100 | is_forced_delivery_service | BOOL | 是否强制选择一种邮递服务 |
101 | create_time | DATATIME | 创建时间 |
102 | finish_time | DATATIME | 完成时间 |
103 | arrive_time | DATATIME | 抵达时间 |
104 | update_time | DATATIME | 更新时间 |
105 | status | VARCHAR | 订单状态 |
106 | stock_status | VARCHAR | 库存状态 |
107 | reason_for_expot | VARCHAR | 出口原因 |
108 | content_type | VARCHAR | 包裹类型 |
109 | primary_keys | VARCHAR(ID) | 主键 |
110 | receiver_eori | VARCHAR | 收件人eori |
111 | receiver_pid_number | VARCHAR | 收件人个人证件号 |
2、接口示例:
接口请求示例
地址:http://test.birdsystem.com/client/Consignment
# api_key和company_id和提交数据中的delivery_service_id需要替换成实际数据
api_key #API秘钥
company_id #所需登录站点ID
请求参数示例
{
"client_id": "",
"id": "",
"is_urgent": "0",
"delivery_service_id": "5315",
"delivery_package_size_id": "",
"sales_reference": "",
"sales_price": "",
"sales_order_id": "",
"omp_name": "",
"omp_vat_number": "1",
"shipper_eori": "191966856000",
"ioss_vat_number": "",
"receiver_eori": "1",
"receiver_pid_number": "2",
"reason_for_export": "",
"custom_identity_reference": "",
"consignment_delivery_agent-net17track_code": "",
"special_instruction": "",
"contact": "test",
"business_name": "",
"address_line1": "asdasd",
"address_line2": "asdasda",
"address_line3": "asdsada",
"city": "",
"county": "",
"post_code": "asd",
"country_iso": "CN",
"telephone": "",
"email": "",
"sender_contact": "",
"sender_business_name": "",
"sender_address_line1": "",
"sender_address_line2": "",
"sender_address_line3": "",
"sender_city": "",
"sender_county": "",
"sender_post_code": "",
"sender_country_iso": "GB",
"sender_telephone": "",
"sender_email": "",
"arrive_time": "",
"update_time": "2021-11-05 09:41:04",
"type": "LOCAL",
"browser_company_id": "2",
"is_compensation_for_delay": "1"
}
接口返回示例
{
"data": {
"commodity_code": null,
"total_handling_fee": "0.00",
"reason_for_export": null,
"total_cost": "0.000",
"delivery_reference": null,
"max_depth": null,
"tracking_reference": null,
"handling_fee_other_product": null,
"delivery_fee_type": null,
"county": null,
"omp_vat_number": "1",
"sender_telephone": null,
"is_forced_delivery_service": "0",
"type": "LOCAL",
"total_delivery_fee": "0.00",
"max_width": null,
"delivery_fee": null,
"battery_type_name_list": null,
"price": null,
"guarantee_percentage": "0.00",
"sales_reference": null,
"sales_order_id": null,
"total_quantity": null,
"id": 2111080020000005,
"consignment_product_reference": null,
"max_length": null,
"business_name": null,
"period": null,
"stock_status": "ONLY_ORI_STOCK_ENOUGH",
"return_consignment_id": null,
"payment_reference": null,
"arrive_time": null,
"sender_business_name": null,
"is_urgent": "0",
"actual_cost": "0.000",
"custom_identity_reference": null,
"handling_fee": null,
"battery_type_id_list": null,
"status": "PREPARING",
"total_delivery_cost": "0.000",
"sender_address_line1": null,
"city": null,
"sender_address_line2": null,
"sender_address_line3": null,
"total_handling_cost": "0.000",
"delivery_package_size_id_internal": null,
"sender_county": null,
"receiver_pid_number": 2,
"handling_fee_urgent_consignment": null,
"update_time": "2021-11-08 11:51:56",
"address_line3": "asdsada",
"total_price_customs_export": null,
"address_line2": "asdasda",
"address_line1": "asdasd",
"external_code": null,
"country_iso": "CN",
"email": null,
"name_customs": null,
"handling_fee_other_item": null,
"company_id": 2,
"delivery_package_size_id": null,
"temp_consignment_info_id": null,
"return_consignment_action_type": null,
"omp_name": null,
"shipper_eori": "191966856000",
"depth": "0.00",
"total_price_customs_export_internal": null,
"post_code": "asd",
"width": "0.00",
"sales_price": "0.000",
"warehouse_id": null,
"total_volume": "0.00",
"delivery_service_id_internal": null,
"primary_keys": [
"id"
],
"delivery_service_name": null,
"external_code2": null,
"external_code1": null,
"client_id": 1,
"delivery_service_id": 5315,
"total_of_consignments": null,
"contact": "test",
"sender_email": null,
"sender_contact": null,
"create_time": "2021-11-08 11:51:56",
"total_fee_weight": "0.0000",
"weight": null,
"handling_fee_first_product": null,
"telephone": null,
"finish_time": null,
"ioss_vat_number": null,
"product_company_ref": null,
"sku_count": null,
"consignment_product_quantity": "0",
"customs_price": "0.000",
"sender_post_code": null,
"total_volume_weight": "0.0000",
"handling_fee_first_item": null,
"total_weight": "0.00",
"receiver_eori": "1",
"total": null,
"neighbour_instruction": null,
"content_type": null,
"total_sales_price": null,
"price_customs_export": null,
"return_consignment_action_name": null,
"quantity": null,
"total_price": "0.00",
"length": "0.00",
"sender_country_iso": "GB",
"sender_city": null,
"handling_fee_limit": null,
"special_instruction": null,
"total_price_internal": "0.00"
},
"success": true,
"moduleName": "client"
}
返回异常示例
请注意,订单的邮递服务ID,是与您当前所在的公司ID以及该订单需要发往的目的地国家亦或者是订单类型相关的,如果在提交的时候发生邮递服务的错误,请优先检查这部分的问题。