API名称 | 提交订单 |
描述 | 提交小包发货订单 |
URL | http://www.mgoship.com/api.php?op=storage&mod=tms_orders&action=add_tms_order |
接口测试 | http://test.mgoship.com//api.php?op=storage&mod=tms_orders&action=add_tms_order |
数据格式 | JSON |
方法 | HTTP POST |
请求参数
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
params | Array | 是 | |
-| consignee | Array | 是 | 收件人信息 |
--| address | String(200) | 是 | 详细地址(日文) |
--| buyerid | String(50) | 否 | 买家ID |
String(50) | 否 | 邮箱 | |
--| mobile | String(15) | 否 | 手机号 |
--| name | String(50) | 是 | 收件人姓名(日文) |
--| phone | String(11) | 是 | 联系电话(0开头10或11位) |
--| postcode | String(8) | 是 | 邮政编码(例:901-1515) |
--| region | String(15) | 是 | 收货地区(例:秋田県)(日文) |
-| declare | Array | 是 | 海关申报品,申报品最多2个 |
--| cnname | String(60) | 是 | 中&日文品名 |
--| enname | String(50) | 是 | 英文品名 |
--| material | String(50) | 是 | 产品材质(英文) |
--| note | String(50) | 否 | 配货备注(便于拣货) |
--| pickupname | String(30) | 否 | 配货SKU |
--| qty | int | 是 | 数量 |
--| unitprice | int | 是 | 售卖单价(JPY),例如:4500 |
--| url | String(200) | 是 | 销售链接 |
-| order | Array | 是 | 基本信息 |
--| channel | int | 是 | 头段渠道, 1:海运小包,2:空运小包 |
--| customerno | String(30) | 否 | 自定义单号 |
--| hasbattery | String | 是 | 是否带电池,Y:是,N:否 |
--| height | float | 是 | 高(cm),例如:21.5(小数点后一位) |
--| insurance | String | 是 | 如购买保险,NO:不购买,5Y:5元每票,6P:0.6%保费 |
--| insvalue | float | 否 | 保价金额(元)。如选择购买保险,此字段必填,例如:500.00 |
--| length | float | 是 | 长(cm),例如:50.5(小数点后一位) |
--| shipmenttype | int | 是 | 货物类型, 1:礼品,2:文件,3:商品货样,4:其他 |
--| weight | float | 是 | 重量(kg),例如:0.585(小数点后三位) |
--| width | float | 是 | 宽(cm),例如:38.5(小数点后一位) |
请求示例
{
"appid": "M10001",
"sign": "2316C5417F87090C4DEE13F965613214DB698045",
"version": "1.0",
"params": {
"consignee": {
"address": "秋田市八橋本町3-14-14",
"buyerid": "buyername",
"email": "test@mgoship.com",
"mobile": "",
"name": "田中 裕美",
"phone": "0188646322",
"postcode": "103-4520",
"region": "秋田県"
},
"declare": [
{
"cnname": "WiFi放大器",
"enname": "WiFi Amplifier",
"material": "Metal,Plastic",
"note": "",
"pickupname": "",
"qty": 1,
"unitprice": "3800",
"url": "https://www.amazon.co.jp/dp/B0BG519SAJ"
},
{
"cnname": "耳机",
"enname": "EARPHONE",
"material": "Metal,Plastic",
"note": "",
"pickupname": "",
"qty": 1,
"unitprice": "5200",
"url": "https://www.amazon.co.jp/dp/B09TZDFG63"
}
],
"order": {
"channel": "1",
"customerno": "A000091906080D9A",
"hasbattery": "N",
"height": "30",
"insurance": "NO",
"insvalue": "",
"length": "60",
"shipmenttype": "4",
"weight": "0.351",
"width": "40"
}
}
}
返回结果
名称 | 说明 | |
---|---|---|
status 状态参数 | ||
code | API访问状态编码,如果成功返回"OK",并返回结果字段,如果失败返回错误编码"ERROR",并返回错误说明 | |
msg | 返回状态说明 | |
data 数据参数 | ||
status | 订单状态:1.草稿 2.已预报 3.仓库作业中 4.运输中 5.派送中 6.问题件 7.已派送 8.已完成 | |
orderNo | 订单号 | |
labelValue | 小包面单PDF,base64encoded |
结果示例
{
"status": {
"code": "OK",
"msg": "小包订单提交成功"
},
"data": {
"status": 2,
"orderNo": "100014293700",
"labelValue": "JVBERi0xLjcKJeLjz9MKNyAwIG9iago8PCAvVHlwZSAvUGFnZSAvUGFyZW50IDEgMCBSIC9MYXN0TW9kaWZpZWQg......"
}
}