--- updatedAt: 2026-08-27T02:31:45.000Z --- # 一件代发出库单(WMS)-分页查询 与OMP管理端一件代发出库单（WMS发货单）列表一致。 # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "【领星WMS】服务商内部系统对接文档（基于管理后台信息）", "version": "2.10.0", "description": "【领星WMS】服务商内部系统对接文档（基于管理后台信息）\n\nv2.3.0 更新：分页/详情 schema 与 OpenApi* VO 完全对齐，修正 quotationNo 字段名、补全费用/报价/产品/充值附件字段，补充 warehouseRentType/moduleType 等必填入参。\n\nv2.4.0 更新：新增全局订单/全局库存/仓租成本/充值统计/币种资产共31个查询接口（入参出参与OMP管理端页面口径一致）；v2.5.0 更新：新增全局工单6个查询接口（工单分页/详情/消息/附件/费用/增值服务）。\n\n【序列化说明】平台对null值有统一序列化行为：字符串/日期字段为null时返回空字符串\"\"，数值字段为null时可能返回空字符串\"\"或0，集合字段为null时返回空数组[]。对接时请做空值兼容处理。\n\nv2.6.0 更新：新增备货中转出库（分页/按箱详情/按产品详情/统计/OMS异常分页/成本费用调整详情）、直邮单（分页/详情/状态统计）、装箱单（分页/状态统计）、入库认领（分页/详情）、全局库存（产品库存分页，含主仓库存对比）、仓租明细（OMP链路）共15个查询接口，入参出参与OMP管理端页面口径一致。\n\nv2.7.0 更新：新增物流渠道4个查询接口（渠道分页/详情/绑定仓库/仓库绑定地址，tag=物流渠道）及业务费用2个调整接口（手动调整费用或成本/手动调整仓租费用或成本）。调整接口的明细列表须提交调整后的完整集合，详见接口说明。\n\nv2.8.0 更新：仓库列表查询（warehouse/page）出参新增16个字段：仓库名称（英文）、国家中文名称、国家英文名称、配对主仓名称、仓库状态、公司名称、州/省名称、城市名称、地址1、地址2、邮编、街道号、联系人、联系电话、邮箱、时区。\n\nv2.9.0 更新：新增批量创建产品接口（product/create）。租户级接口，一次调用可为多个客户创建产品（productList 内每条自带 customerCode），单次最多 200 条，同步返回逐 SKU 结果且支持部分成功。\n\nv2.10.0 更新：全局库存新增3个箱库存查询接口（箱库存总计 boxStock/boxTypeTotal、箱库存分页 boxStock/page、箱库存流水分页 boxStockCellBook/page），与OMP管理端箱库存页面口径一致，租户级接口。" }, "servers": [ { "url": "https://api.xlwms.com", "description": "生产环境" } ], "components": { "schemas": { "BaseRequest": { "type": "object", "required": [ "sign", "appKey", "timestamp" ], "properties": { "sign": { "type": "string", "description": "签名参数，根据签名算法生成", "minLength": 64, "maxLength": 64 }, "appKey": { "type": "string", "description": "租户身份标识（在管理后台-个人中心-API信息-自研系统获取）", "minLength": 32, "maxLength": 32 }, "timestamp": { "type": "string", "description": "请求时间，单位秒", "pattern": "^\\d{10}$" } } }, "BaseResponse": { "type": "object", "required": [ "code", "success", "msg" ], "properties": { "code": { "type": "integer", "description": "错误码" }, "success": { "type": "boolean", "description": "是否成功" }, "msg": { "type": "string", "description": "成功/异常信息" } } }, "ErrorResponse": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "200", "11002", "11003", "11004", "11005", "11006", "11007", "11008", "11010", "31001" ], "description": "错误码：\n200-请求成功\n11002-时间超时\n11003-时间戳不能为空\n11004-appKey不能为空\n11005-appKey有误\n11006-验签不通过\n11007-传入参数不能为空\n11008-无接口权限\n11010-sign不能为空\n31001-调用鉴权服务异常" }, "msg": { "type": "string", "description": "错误信息" } } }, "OpenApiDeliveryPageVO": { "type": "object", "properties": { "tenantCode": { "type": "string", "description": "租户编码" }, "deliveryNo": { "type": "string", "description": "发货单单号" }, "sourceNo": { "type": "string", "description": "（WMS）出库单号" }, "referOrderNo": { "type": "string", "description": "参考单号" }, "platformOrderNo": { "type": "string", "description": "平台单号" }, "customerCode": { "type": "string", "description": "客户编码" }, "customerName": { "type": "string", "description": "客户名称" }, "whCode": { "type": "string", "description": "仓库编码" }, "whCodeName": { "type": "string", "description": "仓库名称" }, "orderType": { "type": "integer", "description": "出库单类型" }, "varietyType": { "type": "integer", "description": "品种类型 1.单品单件 2.单品多件 3.多品混合" }, "status": { "type": "integer", "description": "单据状态 10-待处理、15-待拣货 20-待复核、25-待称重、30-待出库、100-已出库、99-已取消" }, "logisticsChannel": { "type": "string", "description": "物流渠道" }, "logisticsChannelName": { "type": "string", "description": "物流渠道名" }, "expressNo": { "type": "string", "description": "物流跟踪号，多个以,隔开" }, "channelGroupCode": { "type": "string", "description": "物流渠道组代码" }, "channelGroupName": { "type": "string", "description": "物流渠道组名称" }, "packageNum": { "type": "integer", "description": "包裹数量" }, "orderCreateTime": { "type": "string", "description": "新建时间" }, "outboundWay": { "type": "integer", "description": "出库方式:1- 按产品出库 2-按箱出库" }, "createWaveTime": { "type": "string", "description": "波次生成时间" }, "pickTime": { "type": "string", "description": "拣货时间" }, "recheckTime": { "type": "string", "description": "复核时间" }, "canceledTime": { "type": "string", "description": "取消时间" }, "createTime": { "type": "string", "description": "创建时间" }, "weighTime": { "type": "string", "description": "称重完成时间" }, "outboundTime": { "type": "string", "description": "出库时间" }, "requestDeliveryTime": { "type": "string", "description": "发货时限（北京时间）" }, "requestDeliveryTimeRecognizeStatus": { "type": "integer", "description": "发货时限识别状态：0无 1已识别 2未识别" }, "requestDeliveryTimeFailReason": { "type": "string", "description": "发货时限识别失败原因" }, "skuCount": { "type": "integer", "description": "sku总数" }, "productList": { "type": "array", "description": "产品列表 sku*数量", "items": { "type": "object", "properties": { "customerCode": { "type": "string", "description": "客户编码" }, "deliveryNo": { "type": "string", "description": "发货单单号" }, "productSku": { "type": "string", "description": "产品SKU" }, "fnsku": { "type": "string", "description": "fnsku" }, "productName": { "type": "string", "description": "商品名称" }, "qty": { "type": "integer", "description": "数量（支持两位小数）" } } } }, "productCateList": { "type": "array", "description": "产品分类列表 sku*产品分类", "items": { "type": "object", "properties": { "productSku": { "type": "string", "description": "产品SKU" }, "fullPathName": { "type": "string", "description": "品类全路径名" } } } }, "relatedReturnOrder": { "type": "integer", "description": "是否关联退件单 0-否，1-是" }, "returnNo": { "type": "string", "description": "退件单号" }, "unread": { "type": "integer", "description": "是否未读 0已读 1未读" }, "remark": { "type": "string", "description": "备注" }, "latestMessage": { "type": "object", "description": "最新留言", "properties": { "customerCode": { "type": "string", "description": "客户编码" }, "whCode": { "type": "string", "description": "仓库编码" }, "workNo": { "type": "string", "description": "工单号" }, "orderType": { "type": "string", "description": "出库单类型" }, "messageId": { "type": "string", "description": "消息ID" }, "source": { "type": "string", "description": "单据来源" }, "content": { "type": "string", "description": "消息内容" }, "attachType": { "type": "string", "description": "是否有附件（0-否 1-是）" }, "createTime": { "type": "string", "description": "创建时间" }, "loginAccount": { "type": "string", "description": "消息发送者" }, "wmsAppendixVoList": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApiAppendixVO" } } } }, "interceptFlag": { "type": "integer", "description": "截单标识：1-截单中" }, "adjustNo": { "type": "string", "description": "出库差异调整单号" }, "forecastStatus": { "type": "integer", "description": "面单请求状态：0-初始化；1-获取中；2-获取成功；3-获取异常" }, "forecastRemark": { "type": "string", "description": "面单获取备注、异常信息等" }, "agentDesc": { "type": "string", "description": "代理仓信息" }, "countryRegionCode": { "type": "string", "description": "国家/地区编码" }, "transitDay": { "type": "integer", "description": "运输天数" }, "lastEvent": { "type": "string", "description": "最新一条轨迹" }, "transitStatus": { "type": "integer", "description": "运输状态 0-待查询、2-等待揽收、3-运输途中、4-到达待取、5-投递失败、6-可能异常、7-签收成功、8-运输过久" }, "lastTrackingTime": { "type": "string", "description": "轨迹更新时间" }, "deliveredTime": { "type": "string", "description": "投递时间、妥投时间" }, "receiptTime": { "type": "string", "description": "上网时间、首次扫描时间、揽收时间" }, "agentThaw": { "type": "integer", "description": "代理订单是否已解锁 0:否 1：是" }, "orderSource": { "type": "integer", "description": "订单来源：1-手动创建，2-外部推送，3-平台拉单，-1=Temu合作仓" }, "addValueFlag": { "type": "integer", "description": "0:无增值服务费 1:有增值服务费" }, "currentSalesPeople": { "type": "string", "description": "当前销售代表账号" }, "currentSalesPeopleName": { "type": "string", "description": "当前销售代表账号名称" }, "currentCustomerPeople": { "type": "string", "description": "当前客服代表账号" }, "currentCustomerPeopleName": { "type": "string", "description": "当前客服代表账号名称" }, "platformType": { "type": "string", "description": "平台模式，枚举值配置在字典表里" }, "wmsAppendixList": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApiAppendixVO" }, "description": "附件列表" }, "storeName": { "type": "string", "description": "店铺名称" }, "salesPlatform": { "type": "string", "description": "销售平台" }, "salesPlatformStr": { "type": "string", "description": "销售平台" }, "orderExtensionTimeBO": { "type": "object", "description": "指定配送时间参数", "properties": { "deliveryDate": { "type": "string", "description": "指定配送日期" }, "deliveryTime": { "type": "string", "description": "交运时间" } } }, "returnTrackNo": { "type": "string", "description": "回邮单号" }, "reissueFlag": { "type": "integer", "description": "是否补发单：0-否，1-是" }, "relatedOutboundOrderNo": { "type": "string", "description": "补发直接关联的源出库单号" }, "useOriginalLabel": { "type": "string", "description": "是否使用原面单：0-否，1-是" }, "zone": { "type": "string", "description": "物流分区" } } }, "OpenApiAppendixVO": { "type": "object", "properties": { "bizCode": { "type": "string", "description": "业务编码" }, "bizName": { "type": "string", "description": "业务编码名称" }, "bizAppendixType": { "type": "integer", "description": "附件业务类型" }, "bizAppendixTypeName": { "type": "string", "description": "附件业务类型名称" }, "sourceAppendix": { "type": "string", "description": "附件来源，oms-客户上传、wms-仓库上传" }, "bizNo": { "type": "string", "description": "业务单据唯一编号" }, "url": { "type": "string", "description": "附件文件url" }, "originName": { "type": "string", "description": "附件文件原始名" }, "fileName": { "type": "string", "description": "附件文件名" }, "fileExt": { "type": "string", "description": "附件文件格式" }, "fileSize": { "type": "integer", "description": "附件大小" }, "fileKey": { "type": "string", "description": "文件唯一key" }, "uploadTime": { "type": "string", "description": "文件上传时间" }, "remark": { "type": "string", "description": "备注" } } } } }, "security": [], "paths": { "/openapi/v2/order/delivery/page": { "post": { "tags": [ "全局订单" ], "summary": "一件代发出库单(WMS)-分页查询", "description": "与OMP管理端一件代发出库单（WMS发货单）列表一致。", "security": [ { "ApiKeyAuth": [], "SignatureAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseRequest" }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "current": { "type": "integer", "description": "页码，默认1" }, "size": { "type": "integer", "description": "每页条数，默认10，最大1000" }, "customerCodes": { "type": "string", "description": "客户编码" }, "varietyType": { "type": "string", "description": "品种类型 1.单品单件 2.单品多件 3.多品混合" }, "timeType": { "type": "string", "description": "时间类型 创建时间-createTime,出库时间-outboundTime,生成波次时间-createWaveTime,拣货时间-pickTime," }, "startTime": { "type": "string", "description": "开始时间" }, "endTime": { "type": "string", "description": "结束时间" }, "requestDeliveryTimeStart": { "type": "string", "description": "发货时限筛选开始时间" }, "requestDeliveryTimeEnd": { "type": "string", "description": "发货时限筛选结束时间" }, "sourceNoLists": { "type": "array", "items": { "type": "string" }, "description": "出库单号 批量查询" }, "deliveryNo": { "type": "string", "description": "发货单单号" }, "platformOrderNoList": { "type": "array", "items": { "type": "string" }, "description": "平台单号 批量查询" }, "referOrderNoList": { "type": "array", "items": { "type": "string" }, "description": "参考单号 批量查询" }, "fbaReferNoList": { "type": "array", "items": { "type": "string" }, "description": "货件追踪码 批量查询" }, "fbaShipmentIdList": { "type": "array", "items": { "type": "string" }, "description": "fbaShipmentIdList 批量查询" }, "waveNoList": { "type": "array", "items": { "type": "string" }, "description": "波次单号 批量查询" }, "adjustNoList": { "type": "array", "items": { "type": "string" }, "description": "出库差异调整单号，支持批量查询" }, "barcode": { "type": "string", "description": "barcode/sku" }, "barcodeType": { "type": "string", "description": "条码类型：exactSku-SKU精确搜索" }, "productName": { "type": "string", "description": "productName" }, "logisticsChannel": { "type": "string", "description": "物流渠道" }, "channelGroupCode": { "type": "string", "description": "物流渠道组，多个使用逗号隔开" }, "expressNoList": { "type": "array", "items": { "type": "string" }, "description": "物流跟踪号 批量查询" }, "returnTrackNoList": { "type": "array", "items": { "type": "string" }, "description": "回邮单号 批量查询" }, "status": { "type": "integer", "description": "单据状态 9-待移库 10-待处理、15-待拣货 20-待复核、25-待称重、30-待出库、100-已出库、99-已取消" }, "sortName": { "type": "string", "description": "排序名称：createTime-创建时间，createWaveTime-生成波次时间，pickTime-拣货时间，recheckTime-复核时间，weighTime-称重时间，outboundTime-出库时间，requestDeliveryTime-发货时限" }, "sortOrder": { "type": "string", "description": "升序-asc，降序-desc" }, "salesPlatform": { "type": "string", "description": "销售平台" }, "receiver": { "type": "string", "description": "收件人/邮编" }, "logisticsCarrier": { "type": "string", "description": "物流承运商, 多个用逗号间隔" }, "expressFlag": { "type": "boolean", "description": "有无物流跟踪号， 有-true 无-false" }, "skuCountStart": { "type": "integer", "description": "订单产品数 开始值" }, "skuCountEnd": { "type": "integer", "description": "订单产品数 结束值" }, "weightCountStart": { "type": "number", "description": "订单总重量 开始值" }, "weightCountEnd": { "type": "number", "description": "订单总重量 结束值" }, "unitMark": { "type": "integer", "description": "0-公制 1-英制" }, "barcodeStart": { "type": "integer", "description": "Barcode 开始值" }, "barcodeEnd": { "type": "integer", "description": "Barcode 结束值" }, "sourceNoList": { "type": "array", "items": { "type": "string" }, "description": "出库单号列表，按勾选数据方式导出时填充改字段" }, "relatedReturnOrder": { "type": "integer", "description": "是否关联退件单 0-否，1-是" }, "categoryIdList": { "type": "array", "items": { "type": "string" }, "description": "品类id集合" }, "countryRegionCodes": { "type": "string", "description": "国家/地区编码，多个使用英文逗号分割" }, "forecastStatus": { "type": "string", "description": "物流下单状态：0-待下单；1-下单中；2-下单成功；3-下单异常" }, "postCode": { "type": "string", "description": "收件人邮编" }, "zoneList": { "type": "array", "items": { "type": "string" }, "description": "物流分区筛选（批量，上限200）" }, "transitStatusList": { "type": "array", "items": { "type": "integer" }, "description": "运输状态 0-待查询、2-等待揽收、3-运输途中、4-到达待取、5-投递失败、6-可能异常、7-签收成功、8-运输过久" }, "morePkgFlag": { "type": "integer", "description": "是否为一单多包：1-是；0-否" }, "appendixFlag": { "type": "integer", "description": "0:没有附件 1:有附件" }, "orderSourceList": { "type": "array", "items": { "type": "integer" }, "description": "前端傳值,1,手动创建2,外部推送3,平台拉单-1，TEMU合作仓" }, "withVas": { "type": "integer", "description": "含增值服务" }, "platformType": { "type": "integer", "description": "平台模式，枚举值配置在字典表里" }, "platformCode": { "type": "integer", "description": "平台代码，1：OMP，2：WMS" }, "storeName": { "type": "string", "description": "店铺名称" } } } } } ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "records": { "type": "array", "description": "数据列表", "items": { "$ref": "#/components/schemas/OpenApiDeliveryPageVO" } }, "total": { "type": "integer", "description": "总记录数" }, "size": { "type": "integer", "description": "每页条数" }, "current": { "type": "integer", "description": "当前页码" }, "pages": { "type": "integer", "description": "总页数" } } } } } ] } } } }, "400": { "description": "请求错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "未认证", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "未授权", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "服务器错误", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } } } ```