麦哲伦WMS海外仓系统 API 接口请求路径与功能详细说明
所有接口的调用均需在请求头（header Parameters）中携带客户ID (customerId) 和 API密钥 (API Key) 进行身份验证。接口响应遵循统一格式，其中 code 为200表示成功。
{"code": 0, "data": {}, "message": "string", "taskid": "string"}
一、 基础信息接口
- 获取仓库列表
- 功能描述： 查询当前账户下所有可用的海外仓库信息。
- 请求路径/接口：
Warehouse - 请求方式： 根据上下文推断，通常为
GET。 - 主要参数： 认证信息置于请求头。
- 返回数据 (
data): 仓库信息列表。
- 获取运输服务
- 功能描述： 根据指定的仓库代码，查询该仓库支持的所有物流运输服务（如快递、邮政、专线等）。
- 请求路径/接口：
ShippingService - 请求方式： 推断为
GET。 - 查询参数 (
query Parameters):
WarehouseCode(必填): 目标仓库的代码。
- 返回数据 (
data): 可用的运输服务列表。
二、 入库管理 (Inbound)
- 查询入库单
- 功能描述： 根据入库单号查询特定入库单的详细信息及状态。
- 请求路径/接口：
Inbound > Retrieves - 请求方式：
GET。 - 查询参数 (
query Parameters):
Number(必填): 入库单号 (Inbound Number)。
- 返回数据 (
data): 入库单详情。
- 创建入库单
- 功能描述： 向WMS系统提交一个新的入库计划，创建入库单。
- 请求路径/接口：
Inbound > Create - 请求方式：
POST。 - 请求体 (
Payload): 需提交包含商品明细、预报数量等信息的JSON对象。 - 返回数据 (
data): 包含系统生成的入库单号{"Number": "string"}。
- 取消入库单
- 功能描述： 取消一个已创建但尚未完成收货的入库单。
- 请求路径/接口：
Inbound > Cancel - 请求方式：
POST。 - 请求体 (
Payload):{"Number": "string"}，其中Number为要取消的入库单号。 - 返回数据 (
data): 操作结果。
- 获取箱标
- 功能描述： 获取指定入库单的箱唛/箱标文件，用于打印并粘贴在入库货物的外箱上。
- 请求路径/接口：
Inbound > BoxLabel - 请求方式：
GET。 - 查询参数 (
query Parameters):
Number(必填): 入库单号 (Inbound Number)。
- 返回数据 (
data): 箱标文件信息（通常为PDF的URL或Base64编码数据）。
三、 库存管理 (Inventory)
- 查询库存
- 功能描述： 查询库存信息，支持多种查询方式。
- 请求路径/接口：
Inventory > Retrieves - 请求方式：
GET。用于简单查询，参数可能通过查询字符串传递。 - 返回数据 (
data): 库存信息。
- 查询库存列表（分页）
- 功能描述： 以分页形式查询所有商品的库存列表，支持条件筛选。
- 请求路径/接口：
Inventory > Retrieves(查询列表) - 请求方式：
POST。 - 请求体 (
Payload): 可包含分页参数（如PageNumber,PageSize）及其他筛选条件。 - 返回数据 (
data): 分页格式的库存列表，结构为{"PageItems": [...], "PageNumber": 0, "PageSize": 0, "TotalNumber": 0}。
- 查询库存详情
- 功能描述： 查询更详细的库存信息，可能包括批次、库位等。
- 请求路径/接口：
Inventory > Retrieves Detail - 请求方式：
GET。 - 返回数据 (
data): 详细的库存记录列表。
四、 出库管理 (Outbound)
- 查询出库单
- 功能描述： 根据出库单号或客户参考号查询出库单详情。
- 请求路径/接口：
Outbound > Retrieves - 请求方式：
GET。 - 查询参数 (
query Parameters):
Number(必填): 出库单号或客户参考号。
- 返回数据 (
data): 出库单详情。
- 创建出库单
- 功能描述： 创建新的出库订单（发货单）。根据货物类型分为“小货”和“大货”两种创建方式，其请求参数结构可能不同。
- 请求路径/接口：
Outbound > Create(新建 小货)Outbound > Create(新建 大货)
- 请求方式：
POST。 - 请求体 (
Payload): 需提交包含收货信息、商品明细、物流服务等信息的JSON对象。 - 返回数据 (
data): 包含系统生成的出库单号{"Number": "string"}。
- 取消出库单
- 功能描述： 取消一个已创建但尚未开始处理的出库单。
- 请求路径/接口：
Outbound > Cancel - 请求方式：
POST。 - 请求体 (
Payload):{"Number": "string", "ReferenceNo": "string"}，需同时提供系统单号和客户参考号。 - 返回数据 (
data): 操作结果。
- 查询取消状态
- 功能描述： 查询出库单的取消申请处理状态。
- 请求路径/接口：
Outbound > GetCancel - 请求方式：
POST。 - 请求体 (
Payload):{"Number": "string", "ReferenceNo": "string"}。 - 返回数据 (
data): 取消任务的状态信息。
- 上传运单
- 功能描述： 将由物流商提供的面单（运单）文件上传至WMS系统，用于仓库贴单发货。
- 请求路径/接口：
Outbound > UpdateShippingLabel - 请求方式：
POST。 - 请求体 (
Payload):
Number: 出库单号。TrackingNo: 物流跟踪号。Base64Pdf: 运单PDF文件经过Base64编码后的字符串。
- 返回数据 (
data): 上传结果。
- 物流追踪查询
- 功能描述： 根据运单号或出库单号查询包裹的物流轨迹信息。
- 请求路径/接口：
Outbound > Tracking - 请求方式：
GET。 - 查询参数 (
query Parameters):
Number(必填): 运单号或出库单号。
- 返回数据 (
data): 物流追踪信息列表。
- 查询运输服务费率
- 功能描述： 获取各物流运输服务的资费标准。
- 请求路径/接口：
Outbound > Shipping Service Rate - 请求方式：
POST。 - 请求体 (
Payload): 可能包含查询条件（如仓库、目的地、重量等）。 - 返回数据 (
data): 运输服务及其费率的列表。
五、 商品管理 (Product)
- 查询商品（按SKU）
- 功能描述： 根据唯一的商品SKU编码查询单个商品的详细信息。
- 请求路径/接口：
Product > Retrieves - 请求方式：
GET。 - 查询参数 (
query Parameters):
Sku(必填): 商品SKU。
- 返回数据 (
data): 商品详情。
- 创建商品
- 功能描述： 在WMS系统中新建一个商品档案，用于后续的入库和库存管理。
- 请求路径/接口：
Product > Create - 请求方式：
POST。 - 请求体 (
Payload): 需提交包含SKU、名称、规格、条码等商品信息的JSON对象。 - 返回数据 (
data): 包含系统新生成的商品ID{"Id": 0}。
- 查询商品列表（分页）
- 功能描述： 以分页形式查询系统中的商品列表，支持按SKU、条码等条件筛选。
- 请求路径/接口：
Product > Retrieves(查询列表) - 请求方式：
POST。 - 请求体 (
Payload):
Sku: 商品SKU（可选）。Barcode: 商品条码（可选）。PageNumber: 页码。PageSize: 每页数量。
- 返回数据 (
data): 分页格式的商品列表，结构为{"PageItems": [...], "PageNumber": 0, "PageSize": 0, "TotalNumber": 0}。
三、 对接流程建议
- 获取认证信息： 登录麦哲伦WMS海外仓系统系统，获取
customerId和API Key。 - 环境准备： 确保您的系统能发起HTTPS/HTTP请求并处理JSON数据。
- 接口调试：
- 建议从
Warehouse(获取仓库) 等基础查询接口开始，验证认证是否成功。 - 使用
Product > Create 创建测试商品。 - 逐步测试核心业务流程：创建入库单 -> 查询库存 -> 创建出库单 -> 查询跟踪。
- 异常处理： 密切关注接口返回的
code和message字段，非0时表示操作异常或失败。 - 上线核对： 正式上线前，请完成所有业务场景的接口联调，并确保数据传输的准确性与完整性。
