WMS开放平台
Developer Guide
提供给合作伙伴及用户使用,用户可以方便的集成到网站或系统,实现信息无缝对接。
Provided for use by partners and users, users can easily integrate into websites or systems to achieve seamless information connection.
Provided for use by partners and users, users can easily integrate into websites or systems to achieve seamless information connection.
如何使用
How to use
1
|
首先您需要拥有系统账号,如果没请登录首页注册 First, you need to have a system account, if not, please log in to the home page to register |
2
|
进入用户中心>我的信息》API接口中,获取key,key格式:271bd87a-60bd-4ef8-b3bc-5192e2e72de3
Go to User Center>My Information>API interface, get the key, key format: 271bd87a-60bd-4ef8-b3bc-5192e2e72de3 |
3
|
接口服务请求的地址是本页面域名或IP。
The address requested by the interface service is the domain name or IP of this page. |
账户信息查询
Query User information
- GET /api-json/GetCustomer.aspx?UserName=59781287XX@qq.com&CusPsw=123456
请求示例
Request example
/api-json/GetCustomer.aspx?UserName=597812587@qq.com&CusPsw=123456
请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
UserName | string | 用户名 | username | 597812587@qq.com | |
CusPsw | string | 密码 | password | 123456 |
响应示例
Return example
{ "success": "success", "Code": "100", "CusCode": "10000", "AccountMoney": "88.36", "Key": "100" }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
类型 Type |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 代码 | code | 100即成功 |
CusCode | 客户ID | Customer ID | string |
AccountMoney | 账号余额 | Account balance | |
Key | 客户Key | Customer Key | string |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
产品创建
Create Product
- POST /api-json/CreateGoods.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
Query 请求参数
Query example
参数名 Parameter |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
key | String | 必需 | R | API 秘密 | API KEY | 271bd87a-60bd-4ef8-b3bc-5192e2e72de3 |
Body 请求示例
Body Request Example
{ "CustomerID":"10000", "SKU": "MZL0110701", "Barcode": "Other", "EnName": "phone case ", "CnName": "手机壳", "Remark": "phone case ", "Price": 0.1, "Weight": 5.00, "Length": 5.00, "Width": 5.00, "Height": 5.00, "HSCode": "000000", "Origin": "CN", "Brand": "品牌", "Battery": "0", "ExpectNum": 1 }
Body 请求参数
Body Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
CustomerID | String | R | 5 | 客户ID | Customer ID | 10000 |
SKU | String | R | 50 | SKU (not repeatable) | Customer ID | MZL0110701 |
Barcode | String | R | 50 | 产品条码(不可重复) | Product barcode (not repeatable) | MZL0110701 |
EnName | String | R | 200 | 英文名称 | English name | Pen |
CnName | String | R | 200 | 中文名称 | Chinese name | 钢笔 |
Remark | String | O | 500 | 描述 | describe | |
Price | float | R | 价值 | value | 8.5 | |
Weight | float | R | 重量 | weight | 8.5 | |
Length | float | R | 长度 | length | 8.5 | |
Width | float | R | 宽度 | width | 8.5 | |
Height | float | R | 高度 | Height | 8.5 | |
HSCode | String | O | 10 | 客户海关编码 | Customer Customs Code | 581000 |
Origin | String | O | 10 | 原产地 | country of origin | CN |
Brand | String | O | 10 | 品牌 | brand | |
Battery | String | R | 1 | 是否含电池,0不含,1含电池 | Whether it contains battery, 0 does not contain, 1 contains battery | 0 |
ExpectNum | int | R | 预警数量 | Number of warnings | 10 |
响应示例
Return example
{ "success":"success","code":"100","message":"成功","enmessage":"fails"}
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
success | 是否成功 | (success/failure) |
Code | 代码 | code:100 |
message | 提示描述 | Prompt description |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
产品查询
Query product
- GET /api-json/GetGoodsList.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
请求示例
Request example
/api-json/GetGoodsList.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000&page=1&Barcode=test001
请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | key | key | key | |
SKU | string | SKU | SKU | SKU001 | |
Barcode | string | 条码 | Bar code | 4000180754 | |
Page | int | 页数(每页查询50条数据),不填写默认查询第一页 | Number of pages (50 pieces of data are queried per page), do not fill in the default query first page | 1 |
响应示例
Return example
{ "success": "success", "Code": "100", "Count": "1", "data": [{ "count": "1", "SKU": "6925925700115", "Barcode": "6925925700115", "EnName": "Pen2", "CnName": "中文信息", "Remark": "", "Price": "1.00", "Weight": "1", "Length": "1", "Width": "1", "Height": "1", "HSCode": "000000", "Origin": "CN", "Brand": "", "Battery": "1", "ExpectNum": "", "CheckWeight": "", "CheckLength": "", "CheckWidth": "", "CheckHeight": "", "temprownumber": "1" }] }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
count | 总数量 | The total amount | 7 |
Code | 错误代码 | error code | 100即成功 |
count | 查询总个数 | Total number of queries | 1 |
SKU | SKU | SKU | MZL0110701 |
Barcode | 产品条码 | Product barcode | MZL0110701 |
EnName | 英文名称 | English name | Pen |
CnName | 中文名称 | Chinese name | 钢笔 |
Remark | 描述 | describe | |
Price | 价值 | Price | 8.5 |
Weight | 重量 | Weight | 8.5 |
Length | 长度 | Length | 8.5 |
Width | 宽度 | Width | 8.5 |
Height | 高度 | Height | 8.5 |
HSCode | 客户海关编码 | HSCode | 581000 |
Origin | 原产地 | country of origin | CN |
Brand | 品牌 | Brand | |
Battery | 是否含电池,0不含,1含电池 | Whether it contains battery, 0 does not contain, 1 contains battery | 0 |
ExpectNum | 预警数量 | Number of warnings | 10 |
CheckWeight | 质检重量 | Quality inspection weight | 8.5 |
CheckLength | 质检长度 | Quality inspection length | 8.5 |
CheckWidth | 质检宽度 | Quality inspection width | 8.5 |
CheckHeight | 质检高度 | Quality inspection height | 8.5 |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
创建入库单
Create Inbound
- POST /api-json/CreateASN.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
Query 请求参数
Query example
参数名 Parameter |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
key | String | 必需 | R | API 秘密 | API KEY | 271bd87a-60bd-4ef8-b3bc-5192e2e72de3 |
Body 请求示例
Body Request example
{ "ASNDetail": [{ "SKU": "test200-1", "Quantity": 100, "Boxno": 1, "WaybillNo": "YUNDAN003002" }, { "SKU": "test200-2", "Quantity": 100, "Boxno": 2, "WaybillNo": "YUNDAN003002" }, { "SKU": "6925925700115 ", "Quantity": 100, "Boxno": 3, "WaybillNo": "YUNDAN003003" }], "CustomerID": "10000", "Style": "CGRK", "ASNStatus": "0", "Type": "0", "WarehouseCode": "USW", "DeliveryStyle": "2", "WaybillNumber": "", "ReachStartTime": "", "ReferenceNo": "KJTH20180403000001", "OrderNo": "" }
Body 请求参数
Body Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
ASNStatus | String | R | 入库状态 0=草稿;1=未收货; | Inbound status 0=draft; 1=not received; | 0 |
Type | String | R | 入库分类 0=一件代发;1=转运; | Incoming classification 0 = drop shipping; 1 = transshipment; | 0 |
Style | String | R | 入库类型 CGRK=采购入库;THRK=退货入库;WTHRK=外仓退货入库; | Warehousing type CGRK=Purchase warehousing; THRK=Returned goods warehousing;WTHRK=External warehouse return warehousing; | CGRK |
CustomerID | String | R | 客户ID | Customer ID | 10000 |
WarehouseCode | String | R | 仓储代码 | Warehouse code | USW |
DeliveryStyle | String | R | 运输方式( 1 Express delivery(快递) 2 Their delivery(自行送货)) | Means of transportation (1 Express delivery (express) 2 Their delivery (self delivery)) | 2 |
WaybillNumber | String | O | 快递单号 | tracking number | YT20201154140 |
ReachStartTime | String | R | 预计到仓时间 | Estimated arrival time | 2020-07-01 |
ReferenceNo | String | O | 参考号 | Reference No | CSS2020301010 |
OrderNo | String | O | 退货单号(类型为THRK必填) | Return order number (required if the type is THRK) | M100000000123658 |
ASNDetail | JSON | R | 产品信息 | product information | 参数如下 The Parameters are as follows |
ASNDetail参数名 ASNDetail Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
SKU | String | R | 物品SKU | SKU | SKU1 |
Quantity | String | R | 物品1 数量 | Quantity | 10 |
Boxno | String | R | 箱号 | Case number | 1 |
WaybillNo | String | R | 箱运单号 | Container Waybill Number | 59632147410 |
响应示例
Return example
{ "success":"failure","code":"101","message":"箱数必需是从1开始的连续数字","enmessage":"fails","ASNNumber": "KJTH20180403000001"}
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
success | 是否成功 | (success/failure) |
Code | 代码 | code:100 |
message | 提示描述 | Prompt description |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
入库单查询
ASN Query
- GET /api-json/getGRNlist.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000<
请求示例
Request example
/api-json/getGRNlist.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000&ASNNumber=A100001903210001
请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | key | key | key | |
ASNNumber | string | 入库单号 | Inbound order number | A100001903210001 |
响应示例
Return example
{ "success":"success", "message":"", "ASNNumber":"A100001811290004", "ASNStatus":"已上架", "FullName":"**仓", "ReferenceNo":"123456789", "CreateTime":"2018-11-29 15:56:57", "sumSKU":"5", "data":[ { "SKU":"AB", "GoodsCode":"AB", "ShouldQuantity":"20", "OKQuantity":"20", "FactQuantity":"0", "Quantity":"20" }, { "SKU":"Cc", "GoodsCode":"Cc", "ShouldQuantity":"20", "OKQuantity":"20", "FactQuantity":"0", "Quantity":"20" }, { "SKU":"DF", "GoodsCode":"DF", "ShouldQuantity":"20", "OKQuantity":"20", "FactQuantity":"0", "Quantity":"20" }, { "SKU":"CD", "GoodsCode":"CD", "ShouldQuantity":"20", "OKQuantity":"20", "FactQuantity":"0", "Quantity":"20" }, { "SKU":"toi", "GoodsCode":"toi", "ShouldQuantity":"20", "OKQuantity":"20", "FactQuantity":"0", "Quantity":"20" } ] }
响应参数
Response Parameter
参数名 Parameter name |
类型 Type |
示例 e.g. |
中文描述 Chinese description |
英文描述 English description |
---|---|---|---|---|
ASNNumber | String | A100001810170003 | 入库单号 | Inbound order number |
ASNStatus | String | 已完成 | 入库单状态(1 未收货,2 已收货,3 已质检,4 已上架,(10 头程物流入库,11 头程物流出库 已作废),8 已完成) | Inbound order status (1 unreceived, 2 received, 3 quality inspected, 4 put on the shelf, 10 head logistics inbound, 11 head logistics out of storage, 8 completed) |
FullName | String | **仓 | 仓储名称 | Warehouse name |
ReferenceNo | String | 17215154036266959 | 参考号 | Reference No |
CreateTime | String | 2018-10-24 10:10:55 | 创建时间 | Creation time |
sumSKU | int | 10 | SKU种类数 | SKU Number of species |
子表名称 Detail name |
类型 Type |
示例 e.g. |
中文描述 Chinese description |
英文描述 English description |
---|---|---|---|---|
SKU | string | 100 | SKU | SKU |
GoodsCode | string | SKU001 | 条码 | Bar code |
ShouldQuantity | int | 100 | 预约总数量 | Total number of appointments |
OKQuantity | String | 90 | 合格数量 | Qualified quantity |
FactQuantity | String | 10 | 不合格数量 | Unqualified quantity |
Quantity | String | 10 | 上架数量 | Quantity on shelves |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
入库单取消
Cancel ASN
- POST /api-json/CancelASN.aspx?CustomerID=10011&Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
Query 请求参数
Query example
参数名 Parameter |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
Key | String | 必需 | R | API 秘密 | API KEY | 271bd87a-60bd-4ef8-b3bc-5192e2e72de3 |
CustomerID | String | 必需 | R | 客户ID | Customer ID | 10001 |
Body请求示例
Body Request example
{ "ASNNumber": "M100000000180722" }
Body 请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
ASNNumber | string | 入库单号 | ASN Number | A100000000180722 |
响应示例
Return example
{ "success": "success", "code": "100", "message": "成功" }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 错误代码 | error code | 100即成功 |
message | 提示信息 | Message | 成功 |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
创建出库单
Create Order
- POST /api-json/CreateOrder.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
Query 请求参数
Query example
参数名 Parameter |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
key | String | 必需 | R | API 秘密 | API KEY | 271bd87a-60bd-4ef8-b3bc-5192e2e72de3 |
Body 请求示例
Body Request example
{ "Style": 1, "CustomerID": "10000", "ShippingCode": "MZL", "ShipToName": "Rob Panes", "ShipToPhoneNumber": "8919266766", "ShipToMobileNumber": "8919266766", "ShipToCountry": "US", "ShipToState": "New Jersey", "ShipToCity": "Hobunken", "ShipToArea": "Hobunken", "ShipToAdress1": "xinxi", "ShipToAdress2": "", "ShipToHouseNo": "50", "ShipToZipCode": "12345", "ShipToCompanyName": "Express", "ShipToEmail": "", "OrderStatus": 3, "TrackingNo": "", "CusRemark": "", "CODType": 0, "CODMoney": 0, "IOSS":"NO00000001", "VATNo":"NO00000001", "IDCardNo": "", "CsRefNo": "123123", "WarehouseId": "USW", "CustWeight": "23.0", "FLength": "20", "FWidth": "30", "FHeight": "40", "Products": [{ "SKU": "test60001", "EnName": "Wristwatch", "CnName": "", "Quantity": 2, "Weight": 0.1, "Length":"20", "Width":"30", "Height":"10", "Price": 59, "ProducingArea": "CN", "HSCode": "00000" }] }
Body 请求参数
Body Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
Style | String | R | 订单类型(仓储订单或普通订购单)仓储订单为1,普通订单为2 | Order type (storage order or ordinary purchase order) storage order is 1, ordinary order is 2 | 2 | |
CustomerID | String | R | 客户ID | Customer ID | 10000 | |
ShippingCode | String | R | 服务代码 | Service code | ups | |
ShipToName | String | R | 100 | 收件人名称 | Recipient name | lemon |
ShipToPhoneNumber | String | O | 20 | 电话 | telephone | 180344345665 |
ShipToMobileNumber | String | O | 20 | 手机号 | phone number | 180344345665 |
ShipToCountry | String | R | 50 | 收件人国家 | Recipient country | US |
ShipToState | String | R | 100 | 州 | State | Vlaams Brabant |
ShipToCity | String | R | 100 | 城市 | city | Londerzeel |
ShipToArea | String | O | 100 | 区域 | area | longhuaqu |
ShipToAdress1 | String | R | 200 | 收件人地址行 1 | Recipient address line 1 | United States,,,MN.USA |
ShipToAdress2 | String | O | 200 | 收件人地址行 2 | Recipient address line 2 | United States,,,MN.USA |
ShipToHouseNo | String | O | 10 | 门牌号 | House number | 50 |
ShipToZipCode | String | O | 50 | 邮编 | Postcode | 2134342 |
ShipToCompanyName | String | O | 200 | 收件人公司 | Recipient company | xx公司 |
ShipToEmail | String | O | 100 | 收件人邮箱 | Recipient mailbox | 593268741@qq.com |
OrderStatus | String | R | 订单状态--(草稿=1),(确认=3) | Order status--(draft=1), (confirmation=3) | 1 | |
TrackingNo | String | O | 运单号 | Waybill number | RT209114500HK | |
CusRemark | String | O | 客户订单备注 | Customer order notes | Null | |
CODType | String | O | COD类型 | COD type | 0 | |
CODMoney | String | O | COD金额 | COD Amount | 120 | |
IOSS | String | O | IOSS | IOSS | 2020201001 | |
VATNo | String | O | VAT税号 | VAT Tax number | 2020201001 | |
IDCardNo | String | O | 身份证 | ID card | 420621199102147874 | |
CsRefNo | String | O | 客户参考号 | Customer reference number | 1122 | |
WarehouseId | String | O | 仓储订单所需的仓储代码(可以通过接口获得) | Warehousing code required for warehousing orders (available through the interface) | 589 | |
Products | JSON | R | 产品信息 | product information | 参数如下 | |
Products参数名 Parameter name |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
SKU | String | R | 50 | SKU 产品编码 | Item SKU | SKU1 |
Quantity | String | R | 产品数量 | Item quantity | 10 | |
EnName | String | O | 200 | 产品英文名 | Item Product English name | MP31232 |
CnName | String | O | 200 | 产品中文名 | Item Product Chinese name | MP31232 |
Weight | String | R | 产品 每个重量(KG) | Item Each weight | 10 | |
Length | string | O | 产品长度 | Length of item | 10 | |
Width | string | O | 产品宽度 | Width of item | 10 | |
Height | string | O | 产品高度 | Height of items | 10 | |
Price | Float | R | 产品每个单位价值 | Item Value per unit | 10.2 | |
Currency | String | R | 申报币种 USD GBP EUR | Reporting currency USD GBP EUR | USD | |
ProducingArea | String | O | 产品原产地,国家二字编码 | Item country of origin | CN | |
HSCode | String | O | 产品海关编码 | Article customs code | 000000 | |
Material | String | O | 材质 | Material | 材质 | |
Application | String | O | 用途 | application | 用途 | |
SalesAddress | String | O | 销售链接 | Sales link | www.baidu.com |
成功响应示例
successful return example
{ "success": "success", "Code": "100", "message": "订单保存并提交成功(Order saved and submitted successfully)!", "CsRefNo": "123123", "OrderNo": "M100010000957812", "TrackingNo": "", "TransferNo": "", "Enmessage": "" }
失败响应示例
Failed return example
{ "success": "failure", "Code": "108", "message": "客户参考号重复!存在的订单号(Customer reference number duplicate!The existing order number):M100000000177136 客户参考号(Customer reference number):1DAG120185001", "Enmessage": "fails" }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
success | 是否成功 | (success/failure) |
Code | 代码 | code:100 |
message | 提示描述 | Prompt description |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
出库单查询
Order Query
- GET /api-json/GetOrderList.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
请求示例
Request example
/api-json/GetOrderList.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000&page=1&CsRefNo=test001
请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | R | key | key | key |
OrderStatus | int | 状态(1草稿,3确认,4已付款待发货,5未付款待发货,6已发货,11处理中,8删除,12缺货) | Status (1 draft, 3 confirmation, 4 paid and pending delivery, 5 unpaid pending delivery, 6 shipped, 11 processing, 8 deleted, 12 out of stock) | 1 | |
OrderNo | string | 系统单号 | System tracking number | M100000000180754 | |
TrackingNo | string | 运单号 | Tracking No | 4000180754 | |
CsRefNo | string | 参考号 | Reference No | test2018001 | |
StartTime | string | 开始创建时间 | Start creation time | 2018-12-01 10:10:02 | |
EndTime | string | 结束创建时间 | End creation time | 2018-12-06 10:10:02 | |
page | int | 页数(每页查询20条数据),不填写默认查询第一页 | Number of pages (each page query 20 data), do not fill in the default query first page | 1 |
响应示例
Return example
{ "success": "success", "Code": "100", "count": "1", "data": [{ "ODR_OrderMainID": "180754", "OrderNo": "M100000000180754", "TrackingNo": "", "CsRefNo": "19251", "OrderStatus": "草稿(Draft)", "ChannelCode": "MZL", "Country": "United Kingdom", "TotalAmount": "0.000", "CreateTime": "2018-12-05 09:34:18", "number": "1" }] }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
类型 Type |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
count | 总数量 | The total amount | 7 |
Code | 错误代码 | error code | 100 |
ODR_OrderMainID | 订单ID | Order ID | string |
OrderNo | 系统单号 | System tracking number | string |
TrackingNo | 运单号 | Tracking No | string |
CsRefNo | 参考号 | Reference No | string |
OrderStatus | 订单状态 | Order Status | string |
ShippingCode | 运输服务 | Shipping Code | string |
Country | 国家 | Country | string |
TotalAmount | 费用 | TotalAmount | string |
CreateTime | 创建时间 | CreateTime | string |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
出库单详情查询
Query Order Details
- GET /api-json/GetOrderDetails.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
Request address: /api-json/GetOrderDetails.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
请求示例
Request example
/api-json/GetOrderDetails.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000&OrderNo=M100000000180754
请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | key | key | key | |
OrderNo | string | 系统单号 | System tracking number | M100000000180754 | |
TrackingNo | string | 运单号 | Waybill number | 4000180754 |
响应示例
Return example
{ "success": "success", "Code": "100", "Order": { "data": [{ "OrderMainID": "954244", "OrderNo": "M100000000954244", "TrackingNo": "09985052820210", "CsRefNo": "12345", "OrderStatus": "6", "ShippingCode": "MZL", "Country": "United States", "ConsigneeName": "aaaaa", "City": "cccccc", "State": "dddddd", "Area": "", "Address1": "bbbbbbbbbbbb", "Address2": "", "HouseNo": "", "Contact": "12345", "PhoneNumber": "", "Zipcode": "ffffffff", "CompanyName": "gggggggg", "IDCardNo": "555555", "RecipientEmail": "6666666", "CusRemark": "33333", "BillingWeight": "1", "Weight": "1", "TotalAmount": "10.500", "CreateTime": "2020/2/15 16:18:20", "InputTime": "2020/4/8 17:27:37", "DeliveryTime": "2020/4/8 17:32:30" }] }, "Details": { "data": [{ "SKU": "test998", "CnName": "123", "EnName": "1312", "Quantity": "1", "Weight": "1", "Price": "1.000", "HSCode": "", "Origin": "" }] } }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
类型 Type |
---|---|---|---|
success | 是否成功 | (success/failure) | (success/failure) |
count | 总数量 | The total amount | 7 |
Code | 错误代码 | error code | 100即成功 |
OrderMainID | 订单ID | Order ID | string |
OrderNo | 系统单号 | System tracking number | string |
TrackingNo | 运单号 | Tracking No | string |
CsRefNo | 参考号 | Reference No | string |
OrderStatus | 订单状态(1草稿,3确认,4已付款待发货,5未付款待发货,6已发货,11处理中,8删除,12缺货) | Order status (1 draft, 3 confirmation, 4 paid and pending delivery, 5 unpaid pending delivery, 6 shipped, 11 processing, 8 deleted, 12 out of stock) | string |
ShippingCode | 运输服务 | Shipping Code | string |
Country | 国家 | Country | string |
ConsigneeName | 收件人 | recipient | string |
City | 城市 | City | string |
State | 州 | State | string |
Area | 区域 | Area | string |
Address1 | 地址1 | Address1 | string |
Address2 | 地址2 | Address2 | string |
HouseNo | 门牌号 | House No | string |
Contact | 联系方式 | Contact information | string |
PhoneNumber | 电话 | telephone | string |
Zipcode | 邮编 | Postcode | string |
CompanyName | 公司名称 | Company Name | string |
IDCardNo | 身份证号码 | identification number | string |
RecipientEmail | 收件人邮箱 | Recipient mailbox | string |
CusRemark | 备注 | Remark | string |
BillingWeight | 计费重 | Billing weight | string |
Weight | 重量 | Weight | string |
TotalAmount | 费用 | cost | string |
CreateTime | 创建时间 | Create Time | string |
InputTime | 收货时间 | Input Time | string |
DeliveryTime | 发货时间 | Delivery Time | string |
订单产品参数名 Order product Parameter name |
中文描述 Chinese description |
英文描述 English description |
类型 Type |
SKU | SKU | SKU | string |
CnName | 中文名 | CnName | string |
EnName | 英文名 | EnName | string |
Quantity | 数量 | Quantity | int |
Weight | 重量 | Weight | string |
Price | 价值 | Price | string |
HSCode | 海关编码 | HSCode | string |
Origin | 原产地 | Origin | string |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
出库单取消
Order Cancel
- POST /api-json/InterceptOrder.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
Query 请求参数
Query example
参数名 Parameter |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
key | String | 必需 | R | API 秘密 | API KEY | 271bd87a-60bd-4ef8-b3bc-5192e2e72de3 |
Body请求示例
Body Request example
{ "OrderNo": "M100000000180722" }
Body 请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
OrderNo | string | 系统单号/运单号 | System tracking number / waybill number | M100000000180722 |
响应示例
Return example
{ "success": "success", "Code": "100", "message": "截单成功" }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 错误代码 | error code | 100 |
message | 提示信息 | Message | 成功 |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
出库单运单上传
Upload Label
- POST /api-json/UploadLabel.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
Query 请求参数
Query example
参数名 Parameter |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
key | String | 必需 | R | API 秘密 | API KEY | 271bd87a-60bd-4ef8-b3bc-5192e2e72de3 |
Body请求示例
Body Request example
{ "TrackingNo": "9200100000000000005935", "Url": "http://test.mzlsoft.com/pdf/9400111202509882855800.pdf" }
Body请求参数
Body Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | R | Key | Key | 271bd87a-60bd-4ef8-b3bc-5192e2e72de310000 |
TrackingNo | string | R | 系统运单号 必需存在且唯一 | System waybill number must exist and be unique | 9200100000000000005935 |
Url | string | R | 必需是有效的PDF的Url链接 | Must be a valid PDF URL link |
响应示例
Return example
{ "success":"success","code":"100","message":"9200100000000000005935Label上传成功","enmessage":""}
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 错误代码 | error code | 100即成功 |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
出库单运单打印
Print Waybill
- POST /api-json/GetLabelPDF.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
Query 请求参数
Query example
参数名 Parameter |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
key | String | 必需 | R | API 秘密 | API KEY | 271bd87a-60bd-4ef8-b3bc-5192e2e72de3 |
Body请求示例
Body Request example
{ "OrderNo": "M100000000180722", "Type": "0" }
Body请求参数
Body Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | Key | Key | 271bd87a-60bd-4ef8-b3bc-5192e2e72de310000 | |
OrderNo | string | 系统单号/运单号 | System tracking number / waybill number | M100000000180722 | |
Type | string | 标签类型0-Remington 1-A4 | Label type 0-Remington 1-A4 | 0 |
响应示例
Return example
{ "success": "true", "error": "", "OrderNo": "M100000000271864", "PDF": "https://oms.mzlsoft.com/pdf/20190313150658770.pdf" }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 错误代码 | error code | 100即成功 |
Status | 查询状态 | Check status | string |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
出库单派送查询
Tracking Parcel Shipping
- GET /api-json/GetTrackingInfo.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000&No=123456
Request address: /api-json/GetTrackingInfo.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000&No=123456
请求示例
Request example
/api-json/GetTrackingInfo.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000&No=123456
请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | Key | Key | 271bd87a-60bd-4ef8-b3bc-5192e2e72de310000 | |
No | string | 系统单号/运单号/转单号 | System tracking number / waybill number / transfer number | M100000000180722 |
响应示例
Return example
{ "success": "success", "Code": "100", "Status": 0, "data": [{ "OccurTime": "2018-06-16 09:39:16", "DetailDesc": "清关" }, { "OccurTime": "2018-06-16 10:39:16", "DetailDesc": "清关完成" }, { "OccurTime": "2018-06-23 21:17:24", "DetailDesc": "【广东惠州收寄中心】已收寄" }, { "OccurTime": "2018-06-23 22:12:00", "DetailDesc": "【广东惠州收寄中心】已封发" }, { "OccurTime": "2018-06-23 22:14:00", "DetailDesc": "已离开【广东惠州收寄中心】,下一站处理中心" }, { "OccurTime": "2018-06-24 10:14:07", "DetailDesc": "【广州】已出口开拆" }, { "OccurTime": "2018-06-24 12:45:28", "DetailDesc": "【广州处理中心】已出口直封" }, { "OccurTime": "2018-06-26 10:25:39", "DetailDesc": "【广州】已出口开拆" }, { "OccurTime": "2018-06-26 10:26:28", "DetailDesc": "【广州处理中心】已出口直封" }, { "OccurTime": "2018-06-26 13:01:33", "DetailDesc": "到达【广州处理中心】" }, { "OccurTime": "2018-06-26 13:06:32", "DetailDesc": "已交航空公司运输" }, { "OccurTime": "2018-06-27 07:24:04", "DetailDesc": "到达【广州处理中心】" }, { "OccurTime": "2018-06-27 07:31:02", "DetailDesc": "已交航空公司运输" }] }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 错误代码 | error code | 100即成功 |
Status | 查询状态 | Check status | string |
OccurTime | 时间 | time | 2018-06-16 10:39:16 |
DetailDesc | 描述 | describe | 到达【广州处理中心】 |
状态对应关系
State correspondence
代码 Code |
描述 describe |
---|---|
1 | 查询中(In query) |
7 | 查询不到(Query not to) |
0 | 运输途中(During transportation) |
6 | 运输过久(Transport too long) |
5 | 到达待取(Arrival to be picked up) |
4 | 可能异常(May be abnormal) |
2 | 投递失败(Delivery failed) |
3 | 成功签收(successfully signed in) |
未查询(No Query) |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
出库单运费计算
Query freight
- POST/api-json/GetPrice.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
Query 请求参数
Query example
参数名 Parameter |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
key | String | 必需 | R | API 秘密 | API KEY | 271bd87a-60bd-4ef8-b3bc-5192e2e72de3 |
Body 请求示例
Body Request Example
{ "Type": "0", "ShortName": "", "Country": "US", "CusCode": "10000", "ZipCode": "", "states": "", "Weight": 1, "Volume": 1, "Minimum ": true }
Body 请求参数
Body Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | R | Key | Key | 271bd87a-60bd-4ef8-b3bc-5192e2e72de310000 |
Type | string | R | 服务类型 | Service type | 1 |
ShortName | string | R | 仓储代码 | Warehouse code | SZCK |
Country | string | R | 国家代码 | country code | US |
CusCode | string | R | 客户ID | customer ID | 10000 |
ZipCode | string | O | 邮编 | postcode | |
states | string | O | 州/省 | province / State | |
Weight | float | R | 重量 | weight | 1.5 |
Volume | float | R | 体积 | volume | 1 |
Minimum | bool | 选填 | 是否只返回最少报价 | Whether to return only the least quotes | true |
响应示例
Return example
{ "success": "success", "code": "100", "data": [{ "Code": "SEDEX", "Name": "SEDEX", "Weight": "1", "Prices": "24.00000", "RefTime": "" }, { "Code": "MZL", "Name": "MZL", "Weight": "1", "Prices": "24.50000", "RefTime": "" }, { "Code": "YW", "Name": "YW", "Weight": "1", "Prices": "12.00000", "RefTime": "" }, { "Code": "EUB", "Name": "E邮宝", "Weight": "1", "Prices": "68.00000", "RefTime": "7-15" }, { "Code": "DMFA", "Name": "德美法专线", "Weight": "1", "Prices": "68.00000", "RefTime": "" }] }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 错误代码 | error code | 100即成功 |
Status | 查询状态 | Check status | string |
参数名 Parameter name |
类型 Type |
示例 e.g. |
中文描述 Chinese description |
英文描述 English description |
---|---|---|---|---|
Code | string | UPS | 服务代码 | Service code |
Name | string | 美国专线 | 服务名称 | service name |
Weight | string | 1.5 | 重量 | weight |
Prices | String | 90 | 总费用 | Total cost |
RefTime | String | 1-3 | 时效 | aging |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
库存查询
Query Inventory
- GET /api-json/getinventorylist.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
请求示例
Request example
/api-json/getinventorylist.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000&page=1&Storage=USCK&SKU=20190402001
请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | key | key | key | |
Storage | string | 仓库代码 | Warehouse code | USCK | |
SKU | string | SKU | SKU | 20190402001 | |
page | int | 页数(每页查询20条数据),不填写默认查询第一页 | Number of pages (each page query 20 data), do not fill in the default query first page | 1 |
响应示例
Return example
{ "success": "success", "Code": "100", "count": "1", "data": [{ "count": "1", "GoodsCode": "tes99883", "SKU": "tes99883", "TotalNumber": "2844360", "t_Length": "0", "t_Width": "0", "t_High": "0", "t_Weight": "10", "temprownumber": "1" }] }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 错误代码 | error code | 100即成功 |
count | 总数量 | The total amount | 7 |
GoodsCode | 产品条码 | Product barcode | string |
SKU | SKU | SKU | string |
TotalNumber | 可用库存 | Available inventory | int |
Number | 架上库存 | Shelf inventory | int |
t_Length | 质检长 | QC Length | float |
t_Width | 质检宽 | QC width | float |
t_High | 质检高 | QC High | float |
t_Weight | 质检重 | QC Weight | float |
temprownumber | 当前页第几条 | What is the current page | string |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
创建店铺订单
Create Shop Orders
- POST /api-json/ShopOrder.ashx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000&action=CreateShopOrder&ShopName=abc
请求示例
Request example
/api-json/ShopOrder.ashx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000&action=CreateShopOrder&ShopName=abc
Query 请求参数
Query example
参数名 Parameter |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
key | String | R | 50 | API 秘密 | API KEY | 271bd87a-60bd-4ef8-b3bc-5192e2e72de3 |
action | String | R | 30 | CreateShopOrder | CreateShopOrder | CreateShopOrder |
ShopName | String | R | 100 | 店铺名称 | Shop Name | abc |
Body 请求示例
Body Request example
{ "OrderNo": "T2024110700001", "OrderID": "63270", "ConsigneeName": "John Doe", "Country": "USA", "State": "CA", "City": "Los Angeles", "Address1": "123 Main St", "Address2": "Apt 4B", "Zipcode": "90001", "Phone": "555-1234", "CompanyName": "Example Corp", "Email": "john.doe@example.com", "Remark": "Handle with care", "Products": [ { "Sku": "SKU001", "Name": "Product 1", "Quantity": 2, "Price": 19.99, "ProductID": 1, "SpecId": "SPEC001", "Weight": 1.5 }, { "Sku": "SKU002", "Name": "Product 2", "Quantity": 1, "Price": 29.99, "ProductID": 2, "SpecId": "SPEC002", "Weight": 2.0 } ] }
Body 请求参数
Body Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|---|
OrderNo | String | R | 30 | 订单编号 | Order No | T2024110700001 |
OrderID | Int | R | 订单ID | Order ID | 63270 | |
ConsigneeName | String | R | 100 | 收货人姓名 | Full name of consignee | Jack Jonnson |
Phone | String | R | 20 | 收货人的联系电话 | Consignee's contact number | 16387933668 |
String | R | 50 | 收货人的电子邮箱 | Consignee's email address | test@gmail.com | |
Country | String | R | 20 | 收货人的所在的国家或地区 | Consignee's country or region | China |
State | String | R | 50 | 收货人的所在的省份 | Consignee's province | GuangDong |
City | String | R | 50 | 收货人的所在的市/县 | Consignee's city/county | HuiZhou |
Address1 | String | R | 500 | 收货人的详细地址1 | Consignee's detailed address1 | No. 1000 Dongfeng Road |
Address2 | String | 500 | 收货人的详细地址2 | Consignee's detailed address2 | 3rd Floor 301 | |
Zipcode | String | R | 50 | 收货人的的邮政编码 | Consignee's postal code | 514500 |
CompanyName | String | 200 | 收货人的公司名称 | Consignee's company name | XXX Company | |
Remark | String | 500 | 订单备注 | Order notes | Test remark... | |
Products | List`1 | R | 订单产品明细列表 | Order product details list | ||
Products参数名 Parameter name |
类型 Type |
必需 Required |
长度 Length |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
Sku | String | R | 50 | 产品SKU | Sku | 369872689 |
Name | String | R | 200 | 产品名称 | Product name | Dyson Hair Dryer Storage Bag for Dyson Hair Dryer Accessories Storage Dyson Curling Rod Protective Cover Leifen |
Quantity | Int32 | R | 产品数量 | Quantity | Quantity | |
Price | Decimal | R | 产品单价 | Unit price | 36.80 | |
ProductID | Int32 | R | 产品ID | Product ID | 36987563 | |
SpecId | String | R | 100 | 规格Id | Specification ID | {880895C8-397B-45DC-ABE9-19FFC7B2F0F6} |
Weight | Decimal | R | 重量 | Weight (unit KG) | 1.00 |
成功响应示例
successful return example
{ "success": "success", "Code": "100", "message": "订单提交成功(Order submitted successfully)!", "OrderID": "123456", "Enmessage": "" }
失败响应示例
Failed return example
{ "success": "failure", "Code": "101", "message": "以下订单号重复:T2024110700001(The following order number is repeated: T2024110700001)", "Enmessage": "fails" }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
success | 是否成功 | (success/failure) |
Code | 代码 | code:100 |
message | 提示描述 | Prompt description |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
基础数据
Basic data
API接口需要的基础数据信息查询接口。
The basic data information query interface required by the API interface.
The basic data information query interface required by the API interface.
查询国家
Country Lsit
- GET /api-json/GetCountryList.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
请求示例
Request example
/api-json/GetCountryList.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | key | key | 271bd87a-60bd-4ef8-b3bc-5192e2e72de310000 |
响应示例
Return example
{ "success": "success", "Code": "100", "data": [{ "CountryID": "233", "ShortName": "CN", "CnName": "中国", "EnName": "China" }] }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 错误代码 | error code | 100即成功 |
CountryID | 国家ID | Country ID | string |
ShortName | 国家简称 | Country abbreviation | string |
CnName | 国家中文名 | Country Chinese name | string |
EnName | 国家英文名 | Country English name | string |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
物流服务
Logistics Services
- GET /api-json/GetShippingList.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
请求示例
Request example
/api-json/GetShippingList.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | key | key | 271bd87a-60bd-4ef8-b3bc-5192e2e72de310000 |
响应示例
Return example
{ "success": "success", "Code": "100", "data": [{ "ShippingID": "268", "ShippingCode": "UPS", "CnName": "UPS", "EnName": "UPS" }] }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 错误代码 | error code | 100即成功 |
ShippingID | 服务ID | service ID | string |
ShippingCode | 服务代码 | Service code | string |
CnName | 中文名 | Chinese name | string |
EnName | 英文名 | English name | string |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |
仓储信息
Warehousing List
- GET /api-json/GetStorageList.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000<
请求示例
Request example
/api-json/GetStorageList.aspx?Key=271bd87a-60bd-4ef8-b3bc-5192e2e72de310000
请求参数
Request Parameter
参数名 Parameter name |
类型 Type |
必需 Required |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|---|---|
Key | string | key | key | 271bd87a-60bd-4ef8-b3bc-5192e2e72de310000 |
响应示例
Return example
{ "success": "success", "Code": "100", "data": [{ "StorageID": "268", "ShortName": "EW", "FullName": "美西仓" }] }
响应参数
Response Parameter
参数名 Parameter name |
中文描述 Chinese description |
英文描述 English description |
示例 e.g. |
---|---|---|---|
success | 是否成功 | whether succeed | (success/failure) |
Code | 错误代码 | error code | 100即成功 |
StorageID | 仓储ID | Warehouse ID | string |
ShortName | 仓储代码 | Warehouse code | string |
FullName | 仓储名 | Warehouse name | string |
错误代码
error code
代码 Code |
中文描述 Chinese description |
英文描述 English description |
---|---|---|
100 | 成功 | success |
101 | 失败 | fail |