1、基本信息
(1)请求方法: http post
(2)请求地址: http://{hostname}/apicenter/api/order
(3)说明:
新增订单一个订单仅包含一个包裹信息,一订单多包裹需要拆单
2、请求参数
| 名称 |
数据类型 |
说明 |
是否必填 |
| centre_code |
String |
仓库编码,测试使用CKMX |
是 |
| client_code |
String |
海外仓客户(店铺)编码,测试默认CK2023 |
是 |
| two_order_labeling |
integer |
2B订单标识(0:否 、 1:是) |
否 |
| two_logistics_type |
integer |
2B订单物流类型(1:卡派、2:自提、3:快递) |
否 |
| ship_type |
integer |
订单模式 |
否:默认为普通模式 ,详情见 2.1 ship_type 订单模式说明 |
| logistics_provider |
Object |
物流商信息 |
是 |
| - servicetype |
String |
快递物流服务类型,(new):见运输服务 |
是 |
| - code |
String |
指定物流编码,见运输服务 |
否 |
| - conformation |
String |
签名服务,见签名服务 ,不需要请放空 |
否 |
| - insurance_code |
String |
保险币种 |
否 |
| - insurance_value |
String |
保险金额 |
否 |
| - customer_number |
String |
参考单号 |
否 |
| - tracking_number |
String |
物流跟踪编号 |
否 |
| - label_url |
String |
面单路径,面单请使用“物流面单推送”接口推送 |
否 |
| - label_base64 |
String |
面单编码格式 |
否 |
| packages |
Object |
包裹信息 |
是 |
| - salesPlatform |
String |
销售平台 |
是 |
| - order_number |
String |
订单号(不允许带特殊字符) |
是 |
| - payment_method |
String |
付款方式 |
否 |
| receiver |
Object |
收件人信息 |
是 |
| - name |
String |
收件人姓名 |
是 |
| - company |
String |
收件人公司 |
否 |
| - address |
String |
收件人住址 |
是 |
| - address2 |
String |
收件人住址2 |
否 |
| - district |
String |
收件人地区 |
否 |
| - city |
String |
收件人城市 |
是 |
| - province |
String |
收件人省份 |
是 |
| - country_code |
String |
收件人国家代码,二字代码 |
是 |
| - post_code |
String |
收件人邮政编码 |
是 |
| - phone |
String |
收件人电话 |
是 |
| - email |
String |
收件人电子邮件 |
否 |
| items |
Array |
SKU 商品详情 |
是 |
| - sku |
String |
SUK 代码 |
是 |
| - qty |
int |
商品数量 |
是 |
| - unit_price |
double |
商品单价 |
否 |
| - third_party_account |
String |
货主自己提供的第三方物流账号 |
否 |
| - third_party_carrier |
String |
货主自己提供的第三方物流账号承运商 |
否 |
| - desc |
String |
备注 |
否 |
2.1 ship_type 订单模式说明
| 模式名称 |
值 |
说明 |
| 普通模式 |
1 |
订单包裹拣货前 生成面单,使用物流商(labelsday)提供的物流账号 |
| 后置打单模式 |
2 |
包裹打包称重后 请求物流商下单生成面单,使用物流商(labelsday)提供的物流账号 |
| 自有物流账号模式 |
3 |
订单包裹拣货前 生成面单,使用客户自己提供的物流账号, 选择此模式 third_party_account ,third_party_carrier 值参数必传 |
| 自有物流账号模式+后置打单模式 |
4 |
包裹打包称重后 请求物流商下单生成面单,使用客户自己提供的物流账号, 选择此模式 third_party_account ,third_party_carrier 值参数必传 |
3、请求示例
{ "centre_code": "CKMX", "client_code": "CK2023", "callback_foms_required": false, "ship_type": 2, "logistics_provider": { "servicetype":"Ground", "code": "DTPHPH000", "tracking_number": "KECWPH0001606116", "label_url": "https://spider.kec-app.com//package/b41da873-695b-2bca-b6dd-2ed9d8f5e668/label" }, "package": { "order_number": "SYT-PH02130005X-1", "platform_order_id": "SYT-PH02130005X", "declared_value": 10, "declared_value_currency": "PHP", "payment_method": "PP" }, "sender": { "name": "郑木松", "address": "Units 13-21 , SFB Laguna Technopark,", "city": "binan", "province": "laguna", "country_code": "PH", "post_code": "4024", "phone": "15625861935", "email": "479718175@qq.com" }, "receiver": { "name": "Ventura Jr. N. Orinion", "address": "Zone 3 Asan Norte, Sison, Pangasinan", "city": "Sison", "province": "Pangasinan", "country_code": "PH", "post_code": "2434", "phone": "9616271711", "email": "SYT-PH02130005X@placeholder.com" }, "items": [ { "sku": "-ALB-908", "description": "lp40pro白色耳机", "unit_price": 10, "currency": "PHP", "qty": 1, "platform_id": "10001", "line_item_id": "10001", "platform_name": "OPENAPI" } ], "two_order_labeling": 1, "two_logistics_type": 3, "third_party_account": "123", "third_party_carrier": "222", "desc":"测试备注"}
4、响应参数
| 名称 |
数据类型 |
说明 |
| code |
Integer |
响应 code |
| error code |
Integer |
错误代码 |
| msg |
String |
提示信息 |
| code |
说明 |
备注 |
| 200 |
操作成功 |
—————— |
| 201 |
创建/更新 成功 |
—————— |
| 400 |
参数错误 |
—————— |
| 401 |
|
—————— |
| 403 |
数据冲突/没有数据权限 |
—————— |
| 404 |
请求路径失败 |
—————— |
| 500 |
系统内部错误 |
—————— |
| error code |
说明 |
备注 |
| 1 |
其他错误 |
—————— |
| 2 |
订单重复创建 |
—————— |
5、响应示例
{ "code": 201, "data": {......}, "message": "success"}
重复下单相应:
{ "code": 403, "errorCode": 2, "message": "It has been operated and cannot be updated"}
备注