definitions:
|
constvar.BaseOperationType:
|
enum:
|
- 1
|
- 2
|
- 3
|
type: integer
|
x-enum-comments:
|
BaseOperationTypeIncoming: 收货
|
BaseOperationTypeInternal: 内部调拨
|
BaseOperationTypeOutgoing: 交货
|
x-enum-varnames:
|
- BaseOperationTypeIncoming
|
- BaseOperationTypeOutgoing
|
- BaseOperationTypeInternal
|
constvar.InvoicingStrategy:
|
enum:
|
- 1
|
- 2
|
- 3
|
- 4
|
- 5
|
type: integer
|
x-enum-comments:
|
BasedDeliverNumber: 基于交付数量
|
DeliverNumber: 交付数量
|
IndentNumber: 订购数量
|
Milestones: 基于里程碑
|
PrepaidPrice: 预付\固定价格
|
x-enum-varnames:
|
- IndentNumber
|
- DeliverNumber
|
- PrepaidPrice
|
- Milestones
|
- BasedDeliverNumber
|
constvar.LocationType:
|
enum:
|
- 1
|
- 2
|
- 3
|
- 4
|
- 5
|
- 6
|
- 7
|
type: integer
|
x-enum-comments:
|
LocationTypeCustomer: 客户位置
|
LocationTypeInternal: 内部位置
|
LocationTypeInventoryLoss: 库存损失
|
LocationTypeProduction: 生产
|
LocationTypeTransit: 中转位置
|
LocationTypeVendor: 供应商位置
|
LocationTypeView: 视图
|
x-enum-varnames:
|
- LocationTypeVendor
|
- LocationTypeView
|
- LocationTypeInternal
|
- LocationTypeCustomer
|
- LocationTypeInventoryLoss
|
- LocationTypeProduction
|
- LocationTypeTransit
|
constvar.OrderCreation:
|
enum:
|
- 1
|
- 2
|
- 3
|
- 4
|
type: integer
|
x-enum-comments:
|
Nothing: 不操作
|
Object: 项目
|
Task: 任务
|
TaskAndObject: 任务和项目
|
x-enum-varnames:
|
- Nothing
|
- Task
|
- Object
|
- TaskAndObject
|
constvar.ProductType:
|
enum:
|
- 1
|
- 2
|
- 3
|
type: integer
|
x-enum-comments:
|
Consumables: 消耗品
|
Server: 服务
|
StoredProduct: 可储存的产品
|
x-enum-varnames:
|
- Consumables
|
- Server
|
- StoredProduct
|
constvar.ReservationMethod:
|
enum:
|
- 1
|
- 2
|
- 3
|
type: integer
|
x-enum-comments:
|
ReservationMethodAtConfirm: 在确认时
|
ReservationMethodByDate: 在预定日期之前
|
ReservationMethodManual: 手动
|
x-enum-varnames:
|
- ReservationMethodAtConfirm
|
- ReservationMethodManual
|
- ReservationMethodByDate
|
constvar.WhetherType:
|
enum:
|
- 1
|
- 2
|
- 3
|
type: integer
|
x-enum-comments:
|
ReservationNever: 从不
|
WhetherTypeAlways: 总是
|
WhetherTypeAsk: 询问
|
x-enum-varnames:
|
- WhetherTypeAsk
|
- WhetherTypeAlways
|
- ReservationNever
|
models.Company:
|
properties:
|
createTime:
|
type: string
|
id:
|
type: integer
|
name:
|
description: 公司名称
|
type: string
|
updateTime:
|
type: string
|
type: object
|
models.Department:
|
properties:
|
children:
|
items:
|
$ref: '#/definitions/models.Department'
|
type: array
|
head:
|
description: 部门负责人
|
type: string
|
id:
|
type: integer
|
name:
|
description: 部门名称
|
type: string
|
number:
|
description: 部门编号
|
type: string
|
parentId:
|
description: 上级部门ID
|
type: integer
|
remark:
|
description: 备注
|
type: string
|
sort:
|
description: 排序
|
type: integer
|
type: object
|
models.Location:
|
properties:
|
company:
|
allOf:
|
- $ref: '#/definitions/models.Company'
|
description: 公司
|
companyId:
|
description: 公司id
|
type: integer
|
countFrequency:
|
description: 盘点频率（天）
|
type: integer
|
createTime:
|
type: string
|
id:
|
type: integer
|
isReturnLocation:
|
description: 是否退货位置
|
type: boolean
|
isScrapLocation:
|
description: 是否报废位置
|
type: boolean
|
name:
|
description: 位置名称
|
type: string
|
parentId:
|
description: 上级id
|
type: integer
|
replenishLocation:
|
description: 是否补充位置
|
type: boolean
|
type:
|
allOf:
|
- $ref: '#/definitions/constvar.LocationType'
|
description: 位置类型
|
updateTime:
|
type: string
|
type: object
|
models.OperationType:
|
properties:
|
ReservationDaysBeforePriority:
|
description: 在优先级的前几天
|
type: integer
|
baseOperationType:
|
allOf:
|
- $ref: '#/definitions/constvar.BaseOperationType'
|
description: 基础作业类型
|
company:
|
allOf:
|
- $ref: '#/definitions/models.Company'
|
description: 公司
|
companyId:
|
description: 公司id
|
type: integer
|
createBackorder:
|
allOf:
|
- $ref: '#/definitions/constvar.WhetherType'
|
description: 创建欠单
|
createTime:
|
type: string
|
defaultLocationDest:
|
allOf:
|
- $ref: '#/definitions/models.Location'
|
description: 默认目标位置
|
defaultLocationDestId:
|
description: 默认目标位置id
|
type: integer
|
defaultLocationSrc:
|
allOf:
|
- $ref: '#/definitions/models.Location'
|
description: 默认源位置
|
defaultLocationSrcId:
|
description: 默认源位置id
|
type: integer
|
id:
|
type: integer
|
name:
|
description: 仓库名称
|
type: string
|
printLabel:
|
description: 是否打印标签
|
type: boolean
|
reservationDaysBefore:
|
description: 收货前几天
|
type: integer
|
reservationMethod:
|
allOf:
|
- $ref: '#/definitions/constvar.ReservationMethod'
|
description: 保留方式
|
returnOperationType:
|
description: 退货类型名称
|
type: string
|
returnOperationTypeID:
|
description: 退货类型ID
|
type: integer
|
showOperations:
|
description: 显示作业详情
|
type: boolean
|
updateTime:
|
type: string
|
warehouse:
|
allOf:
|
- $ref: '#/definitions/models.Warehouse'
|
description: 仓库
|
warehouseId:
|
description: 仓库id
|
type: integer
|
type: object
|
models.Product:
|
properties:
|
HSCode:
|
type: string
|
barcode:
|
description: 条码
|
type: string
|
buyExplain:
|
type: string
|
canBePurchased:
|
description: 是否可采购
|
type: boolean
|
canBeSell:
|
description: 是否销售
|
type: boolean
|
categoryId:
|
description: 产品分类id
|
type: integer
|
companyId:
|
type: integer
|
companyName:
|
type: string
|
controlStrategy:
|
$ref: '#/definitions/constvar.InvoicingStrategy'
|
cost:
|
description: 成本
|
type: number
|
createTime:
|
type: string
|
currencyId:
|
type: integer
|
currencyName:
|
type: string
|
customerAdvanceTime:
|
type: number
|
customerTaxes:
|
description: 客户税百分比
|
type: number
|
deliveryAdvanceTime:
|
type: number
|
id:
|
type: integer
|
inStorageExplain:
|
type: string
|
internalNotes:
|
description: 内部说明
|
type: string
|
internalReference:
|
description: 内部参考
|
type: string
|
internalTransferExplain:
|
type: string
|
invoicingStrategy:
|
$ref: '#/definitions/constvar.InvoicingStrategy'
|
name:
|
description: 产品名称
|
type: string
|
objectTemplateId:
|
type: string
|
orderCreation:
|
$ref: '#/definitions/constvar.OrderCreation'
|
originCountryId:
|
type: integer
|
originCountryName:
|
type: string
|
outStorageExplain:
|
type: string
|
price:
|
type: number
|
principal:
|
description: 负责人
|
type: string
|
productTagId:
|
description: 产品标签
|
type: integer
|
productTagName:
|
type: string
|
salePrice:
|
description: 销售价格
|
type: number
|
selectProduct:
|
type: integer
|
sellExplain:
|
type: string
|
supplierId:
|
type: integer
|
supplierName:
|
type: string
|
type:
|
allOf:
|
- $ref: '#/definitions/constvar.ProductType'
|
description: 产品类型
|
updateTime:
|
type: string
|
volume:
|
description: 体积
|
type: number
|
weight:
|
description: 重量
|
type: number
|
type: object
|
models.Warehouse:
|
properties:
|
active:
|
description: 是否启用，传true就行
|
type: boolean
|
buyToResupply:
|
description: 是否购买补给，已购买产品能够发送到此仓库
|
type: boolean
|
code:
|
description: 仓库编码
|
maxLength: 5
|
minLength: 1
|
type: string
|
company:
|
$ref: '#/definitions/models.Company'
|
companyId:
|
type: integer
|
createTime:
|
type: string
|
id:
|
type: integer
|
name:
|
description: 仓库名称
|
type: string
|
partnerId:
|
description: 合作伙伴id
|
type: integer
|
resupplyWh:
|
description: 补给来源仓库
|
items:
|
$ref: '#/definitions/models.Warehouse'
|
type: array
|
resupplyWhIds:
|
description: 补给来源仓库ID
|
items:
|
type: string
|
type: array
|
updateTime:
|
type: string
|
required:
|
- code
|
type: object
|
request.AddCompany:
|
properties:
|
name:
|
description: 公司名称
|
type: string
|
type: object
|
request.AddDepartment:
|
properties:
|
name:
|
description: 部门名称
|
type: string
|
number:
|
description: 部门编号
|
type: string
|
parentId:
|
description: 上级部门ID 一级部门传0
|
type: integer
|
remark:
|
description: 备注
|
type: string
|
type: object
|
request.AddOperationType:
|
properties:
|
ReservationDaysBeforePriority:
|
description: 在优先级的前几天
|
type: integer
|
baseOperationType:
|
allOf:
|
- $ref: '#/definitions/constvar.BaseOperationType'
|
description: 基础作业类型
|
companyId:
|
description: 公司id
|
type: integer
|
createBackorder:
|
allOf:
|
- $ref: '#/definitions/constvar.WhetherType'
|
description: 创建欠单
|
defaultLocationDestId:
|
description: 默认目标位置id
|
type: integer
|
defaultLocationSrcId:
|
description: 默认源位置id
|
type: integer
|
id:
|
type: integer
|
name:
|
description: 仓库名称
|
type: string
|
printLabel:
|
description: 是否打印标签
|
type: boolean
|
reservationDaysBefore:
|
description: 收货前几天
|
type: integer
|
reservationMethod:
|
allOf:
|
- $ref: '#/definitions/constvar.ReservationMethod'
|
description: 保留方式
|
returnOperationTypeID:
|
description: 退货类型ID
|
type: integer
|
showOperations:
|
description: 显示作业详情
|
type: boolean
|
warehouseId:
|
description: 仓库id
|
type: integer
|
type: object
|
request.AddWarehouse:
|
properties:
|
active:
|
description: 是否启用，传true就行
|
type: boolean
|
buyToResupply:
|
description: 购买补给，已购买产品能够发送到此仓库
|
type: boolean
|
code:
|
description: 仓库编码
|
maxLength: 5
|
minLength: 1
|
type: string
|
name:
|
description: 仓库名称
|
type: string
|
partnerId:
|
description: 合作伙伴id
|
type: integer
|
resupplyWhIds:
|
description: 补给来源仓库ID
|
items:
|
type: string
|
type: array
|
required:
|
- code
|
type: object
|
request.UpdateCompany:
|
properties:
|
id:
|
type: integer
|
name:
|
description: 公司名称
|
type: string
|
type: object
|
request.UpdateDepartment:
|
properties:
|
id:
|
type: integer
|
name:
|
description: 部门名称
|
type: string
|
number:
|
description: 部门编号
|
type: string
|
parentId:
|
description: 上级部门ID 一级部门传0
|
type: integer
|
remark:
|
description: 备注
|
type: string
|
type: object
|
request.UpdateOperationType:
|
properties:
|
ReservationDaysBeforePriority:
|
description: 在优先级的前几天
|
type: integer
|
baseOperationType:
|
allOf:
|
- $ref: '#/definitions/constvar.BaseOperationType'
|
description: 基础作业类型
|
companyId:
|
description: 公司id
|
type: integer
|
createBackorder:
|
allOf:
|
- $ref: '#/definitions/constvar.WhetherType'
|
description: 创建欠单
|
defaultLocationDestId:
|
description: 默认目标位置id
|
type: integer
|
defaultLocationSrcId:
|
description: 默认源位置id
|
type: integer
|
id:
|
type: integer
|
name:
|
description: 仓库名称
|
type: string
|
printLabel:
|
description: 是否打印标签
|
type: boolean
|
reservationDaysBefore:
|
description: 收货前几天
|
type: integer
|
reservationMethod:
|
allOf:
|
- $ref: '#/definitions/constvar.ReservationMethod'
|
description: 保留方式
|
returnOperationTypeID:
|
description: 退货类型ID
|
type: integer
|
showOperations:
|
description: 显示作业详情
|
type: boolean
|
warehouseId:
|
description: 仓库id
|
type: integer
|
type: object
|
request.UpdateWarehouse:
|
properties:
|
active:
|
description: 是否启用，传true就行
|
type: boolean
|
buyToResupply:
|
description: 购买补给，已购买产品能够发送到此仓库
|
type: boolean
|
code:
|
description: 仓库编码
|
maxLength: 5
|
minLength: 1
|
type: string
|
id:
|
type: integer
|
name:
|
description: 仓库名称
|
type: string
|
partnerId:
|
description: 合作伙伴id
|
type: integer
|
resupplyWhIds:
|
description: 补给来源仓库ID
|
items:
|
type: string
|
type: array
|
required:
|
- code
|
type: object
|
util.Response:
|
properties:
|
code:
|
type: integer
|
data: {}
|
msg:
|
type: string
|
type: object
|
util.ResponseList:
|
properties:
|
code:
|
type: integer
|
data: {}
|
msg:
|
type: string
|
page:
|
type: integer
|
pageSize:
|
type: integer
|
total:
|
type: integer
|
type: object
|
info:
|
contact: {}
|
paths:
|
/api-s/v1/organize/department:
|
get:
|
parameters:
|
- description: 页码
|
in: query
|
name: page
|
type: integer
|
- description: 每页大小
|
in: query
|
name: pageSize
|
type: integer
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
allOf:
|
- $ref: '#/definitions/util.ResponseList'
|
- properties:
|
data:
|
items:
|
$ref: '#/definitions/models.Department'
|
type: array
|
type: object
|
summary: 查询部门信息列表
|
tags:
|
- 部门信息
|
post:
|
parameters:
|
- description: 部门信息信息
|
in: body
|
name: object
|
required: true
|
schema:
|
$ref: '#/definitions/request.AddDepartment'
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 添加部门信息
|
tags:
|
- 部门信息
|
/api-s/v1/organize/department/{id}:
|
delete:
|
parameters:
|
- description: 部门信息信息
|
in: body
|
name: object
|
required: true
|
schema:
|
$ref: '#/definitions/request.UpdateDepartment'
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 编辑部门信息
|
tags:
|
- 部门信息
|
put:
|
parameters:
|
- description: 部门信息信息
|
in: body
|
name: object
|
required: true
|
schema:
|
$ref: '#/definitions/request.UpdateDepartment'
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 编辑部门信息
|
tags:
|
- 部门信息
|
/api-wms/v1/company/company:
|
get:
|
parameters:
|
- in: query
|
name: keyword
|
type: string
|
- description: 页码
|
in: query
|
name: page
|
type: integer
|
- description: 每页大小
|
in: query
|
name: pageSize
|
type: integer
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
allOf:
|
- $ref: '#/definitions/util.ResponseList'
|
- properties:
|
data:
|
items:
|
$ref: '#/definitions/models.Company'
|
type: array
|
type: object
|
summary: 查询公司列表
|
tags:
|
- 公司
|
post:
|
parameters:
|
- description: 公司信息
|
in: body
|
name: object
|
required: true
|
schema:
|
$ref: '#/definitions/request.AddCompany'
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 添加公司
|
tags:
|
- 公司
|
/api-wms/v1/company/company/{id}:
|
delete:
|
parameters:
|
- description: 公司id
|
in: path
|
name: id
|
required: true
|
type: string
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 删除公司
|
tags:
|
- 公司
|
put:
|
parameters:
|
- description: 公司信息
|
in: body
|
name: object
|
required: true
|
schema:
|
$ref: '#/definitions/request.UpdateCompany'
|
- description: 公司id
|
in: path
|
name: id
|
required: true
|
type: string
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 编辑公司
|
tags:
|
- 公司
|
/api-wms/v1/product/addProduct:
|
post:
|
parameters:
|
- description: 产品信息
|
in: body
|
name: object
|
required: true
|
schema:
|
$ref: '#/definitions/models.Product'
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 添加产品
|
tags:
|
- 产品
|
/api-wms/v1/warehouse/operationType:
|
get:
|
parameters:
|
- in: query
|
name: keyword
|
type: string
|
- description: 页码
|
in: query
|
name: page
|
type: integer
|
- description: 每页大小
|
in: query
|
name: pageSize
|
type: integer
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
allOf:
|
- $ref: '#/definitions/util.ResponseList'
|
- properties:
|
data:
|
items:
|
$ref: '#/definitions/models.OperationType'
|
type: array
|
type: object
|
summary: 查询作业类型列表
|
tags:
|
- 作业类型
|
post:
|
parameters:
|
- description: 作业类型信息
|
in: body
|
name: object
|
required: true
|
schema:
|
$ref: '#/definitions/request.AddOperationType'
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 添加作业类型
|
tags:
|
- 作业类型
|
/api-wms/v1/warehouse/operationType/{id}:
|
delete:
|
parameters:
|
- description: 作业类型id
|
in: path
|
name: id
|
required: true
|
type: string
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 删除作业类型
|
tags:
|
- 作业类型
|
put:
|
parameters:
|
- description: 作业类型信息
|
in: body
|
name: object
|
required: true
|
schema:
|
$ref: '#/definitions/request.UpdateOperationType'
|
- description: 作业类型id
|
in: path
|
name: id
|
required: true
|
type: string
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 编辑作业类型
|
tags:
|
- 作业类型
|
/api-wms/v1/warehouse/warehouse:
|
get:
|
parameters:
|
- in: query
|
name: keyword
|
type: string
|
- description: 页码
|
in: query
|
name: page
|
type: integer
|
- description: 每页大小
|
in: query
|
name: pageSize
|
type: integer
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
allOf:
|
- $ref: '#/definitions/util.ResponseList'
|
- properties:
|
data:
|
items:
|
$ref: '#/definitions/models.Warehouse'
|
type: array
|
type: object
|
summary: 查询仓库列表
|
tags:
|
- 仓库
|
post:
|
parameters:
|
- description: 仓库信息
|
in: body
|
name: object
|
required: true
|
schema:
|
$ref: '#/definitions/request.AddWarehouse'
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 添加仓库
|
tags:
|
- 仓库
|
/api-wms/v1/warehouse/warehouse/{id}:
|
delete:
|
parameters:
|
- description: 仓库id
|
in: path
|
name: id
|
required: true
|
type: string
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 删除仓库
|
tags:
|
- 仓库
|
put:
|
parameters:
|
- description: 仓库信息
|
in: body
|
name: object
|
required: true
|
schema:
|
$ref: '#/definitions/request.UpdateWarehouse'
|
- description: 仓库id
|
in: path
|
name: id
|
required: true
|
type: string
|
produces:
|
- application/json
|
responses:
|
"200":
|
description: 成功
|
schema:
|
$ref: '#/definitions/util.Response'
|
summary: 编辑仓库
|
tags:
|
- 仓库
|
swagger: "2.0"
|
