2.0info: 2.1.0 WMS-X Stock Validation description: Serviço Responsável por operações de validação de estoque do WMS-X x-senior-domain: Estoque WMS-X x-senior-domain-path: wmsx_stock x-senior-service-path: validation contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/wmsx_stocksecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /validation/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportWmsWarehouse: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportWmsOwner: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportSector: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportPlace: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportProduct: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportPacking: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportProductOwner: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportBatch: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportStock: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportValidateStockPreset: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportStockAvailableValidatedIncludedView: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportStockValidationRejectionDetail: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportAvailableStockAnalysisView: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/exportSeparationZone: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/undoStockValidation: post: description: Desfazer liberação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idValidation properties: idValidation: type: string description: Agrupador da validação idDocuments: type: array items: type: string description: Identificadores dos Documentos Relativos ao Preset responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicativo de sucesso ou não no processo de desfazer a validação errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/updateStockValidationSituationByDocument: post: description: Atualizar situação da validação de estoque pelo id do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocument – stockValidationSituation properties: idDocument: type: string description: Id do documento stockValidationSituation: type: string allOf: – #/definitions/enumStockValidationSituation description: Situação da validação responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicativo de sucesso da operação errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importWmsWarehouse: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importWmsOwner: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importSector: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importPlace: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importProduct: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importPacking: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importProductOwner: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importBatch: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importStock: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importValidateStockPreset: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importStockAvailableValidatedIncludedView: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importStockValidationRejectionDetail: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importAvailableStockAnalysisView: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/actions/importSeparationZone: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/signals/processStockValidation: post: description: Processar ValidateStockPreset(s) pendentes préviamente enviadas sob o agrupador idValidation informado tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idValidation properties: idValidation: type: string description: Agrupador da validação pid: type: string description: Identificador do processo que solicitou a validação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /validation/events/stockValidationFinished: post: description: Evento disparado ao finalizar o processamento de uma dada validação de estoque x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – stockValidationResult properties: stockValidationResult: type: object allOf: – #/definitions/stockValidationEventResult description: Resultado da validação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importWmsWarehouseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportWmsWarehouseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importWmsOwnerEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportWmsOwnerEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importSectorEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportSectorEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importPlaceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportPlaceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importProductEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportProductEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importPackingEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportPackingEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importProductOwnerEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportProductOwnerEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importBatchEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportBatchEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importStockEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportStockEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importValidateStockPresetEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportValidateStockPresetEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importStockAvailableValidatedIncludedViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportStockAvailableValidatedIncludedViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importStockValidationRejectionDetailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportStockValidationRejectionDetailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importAvailableStockAnalysisViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportAvailableStockAnalysisViewEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/importSeparationZoneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/events/exportSeparationZoneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /validation/entities/wmsWarehouse: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/wmsWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/wmsWarehouse/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wmsWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/wmsOwner: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/wmsOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/wmsOwner/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wmsOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/validateStockPreset: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/validateStockPreset responses: 200: description: The created resource schema: #/definitions/validateStockPreset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/validateStockPreset responses: 200: description: The created resource schema: #/definitions/validateStockPreset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/validateStockPreset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/validateStockPreset/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editValidateStockPreset responses: 200: description: Ok schema: #/definitions/editValidateStockPreset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/validateStockPreset responses: 200: description: Ok schema: #/definitions/validateStockPreset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/validateStockPreset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/validateStockPreset/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/validateStockPreset responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/stockAvailableValidatedIncludedView: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/stockAvailableValidatedIncludedView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/stockValidationRejectionDetail: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/stockValidationRejectionDetail responses: 200: description: The created resource schema: #/definitions/stockValidationRejectionDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/stockValidationRejectionDetail responses: 200: description: The created resource schema: #/definitions/stockValidationRejectionDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/stockValidationRejectionDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/stockValidationRejectionDetail/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editStockValidationRejectionDetail responses: 200: description: Ok schema: #/definitions/editStockValidationRejectionDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/stockValidationRejectionDetail responses: 200: description: Ok schema: #/definitions/stockValidationRejectionDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/stockValidationRejectionDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/stockValidationRejectionDetail/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/stockValidationRejectionDetail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /validation/entities/availableStockAnalysisView: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/availableStockAnalysisView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física enumTipMer: type: string enum: – VI – VE description: Tipo de mercado: * `VI` – Interno (Nacional) * `VE` – Externo (Exterior) enumSitReg: type: string enum: – VA – VI description: Situação do registro: * `VA` – Ativo * `VI` – Inativo enumRegime: type: string enum: – VF – VA – VG description: Regime de Armazenagem: * `VF` – Filial * `VA` – Armazém Geral * `VG` – GMB – Guia de Movimentação de Bens enumPlaceType: type: string enum: – PI – PB – PP – DC – BF description: Tipo de Local de Armzenagem: * `PI` – Picking * `PB` – Pulmão Blocado * `PP` – Pulmão Paletizado * `DC` – Doca * `BF` – Buffer enumTypeTerm: type: string enum: – VM – VD description: Tipo de prazo: * `VM` – Meses * `VD` – Dias enumControlShelfLife: type: string enum: – VN – VV – VF – VVF description: Controle de validade: * `VN` – Não controla * `VV` – Coleta vencimento * `VF` – Coleta fabricação * `VVF` – Coleta vencimento e fabricação enumPalletType: type: string enum: – COMPLETE – INCOMPLETE – LEFTOVER – UNIT description: Tipo do Lote Palete Gerado: * `COMPLETE` – Palete Completo * `INCOMPLETE` – Palete Incompleto * `LEFTOVER` – Palete Sobra * `UNIT` – Palete Unitário enumProductSituation: type: string enum: – GOOD – DAMAGED – EXPIRED – TRUNCATED description: Situação do Produto: * `GOOD` – Bom * `DAMAGED` – Danificado * `EXPIRED` – Vencido * `TRUNCATED` – Truncado enumInputOpertionType: type: string enum: – ORDER_RECEIVING – RELOCATION – STOCK_ENTRY_CORRECTION – INVENTORY description: Tipo de Operação de Entrada: * `ORDER_RECEIVING` – Ordem de Recebimento * `RELOCATION` – Remanejamento * `STOCK_ENTRY_CORRECTION` – Ajuste de Estoque de Entrada * `INVENTORY` – Inventário enumBatchOrigin: type: string enum: – OR – RE – IV – SC – MS description: Origem do Lote: * `OR` – Ordem de Recebimento * `RE` – Remanejamento * `IV` – Inventário * `SC` – Ajuste * `MS` – Mudança de Estado de Material enumStockValidationSituation: type: string enum: – CANCELED – PENDING – REJECTED – APPROVED – IN_WAVE – DISPATCHED description: Situação da validação de estoque: * `CANCELED` – Cancelada * `PENDING` – Pendente * `REJECTED` – Rejeitada * `APPROVED` – Aprovada * `IN_WAVE` – EM ONDA * `DISPATCHED` – EXPEDIDA userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim stockValidationEventResult: description: Payload de comunição do evento de processamento de conclusão de validação de estoque type: object required: – idValidation properties: idValidation: type: string description: Agrupador da validação hasRejectedValidation: type: boolean description: Indica se algum item solicitado na validação foi rejeitado default: false hasProcessErrors: type: boolean description: default: false processErrorMessage: type: string description: pid: type: string description: Id do processo que solicitou a validação wmsWarehouse: description: Armazém type: object properties: id: type: string format: uuid description: Id da entidade warehouseSituation: type: string allOf: – #/definitions/enumSitReg description: Situação do Armazém codPes: type: integer format: int64 description: Código nomPes: type: string description: Nome apePes: type: string description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string description: CNPJ/CPF numRge: type: string description: Número do RG datRge: type: string format: date description: Data de emissão do RG orgRge: type: string description: Órgão emissor do RG insEst: type: string description: Inscrição estadual insMun: type: string description: Inscrição municipal blockMask: type: string maxLength: 5 description: Máscara bloco streetMask: type: string maxLength: 5 description: Máscara rua buildingMask: type: string maxLength: 5 description: Máscara prédio floorMask: type: string maxLength: 5 description: Máscara andar apartmentMask: type: string maxLength: 5 description: Máscara apartamento code: type: string description: Código do Armazem para Integração excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: wmsOwner: description: Depositante type: object properties: id: type: string format: uuid description: Identificador único ownerSituation: type: string allOf: – #/definitions/enumSitReg description: Situação codPes: type: integer format: int64 description: Código nomPes: type: string description: Nome apePes: type: string description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string description: CNPJ/CPF numRge: type: string description: Número do RG datRge: type: string format: date description: Data de emissão do RG orgRge: type: string description: Órgão emissor do RG insEst: type: string description: Inscrição estadual insMun: type: string description: Inscrição municipal regime: type: string allOf: – #/definitions/enumRegime description: Regime de Armazenagem code: type: string description: Código do Depositante para Integração excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: sector: description: Setor type: object properties: id: type: string format: uuid description: Identificador único code: type: string maxLength: 20 description: Código description: type: string maxLength: 100 description: Descrição good: type: boolean description: Bom damaged: type: boolean description: Danificado expired: type: boolean description: Vencido truncated: type: boolean description: Truncado picking: type: boolean description: Picking bufferStock: type: boolean description: Pulmão buffer: type: boolean description: Buffer wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém situation: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: place: description: Local de Armazenagem type: object properties: id: type: string format: uuid description: Identificador único address: type: string description: Endereço formatedAddress: type: string description: Endereço block: type: string description: Bloco street: type: string description: Rua building: type: integer format: int64 description: Prédio floor: type: integer format: int64 description: Andar apartment: type: integer format: int64 description: Apartamento wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém type: type: string allOf: – #/definitions/enumPlaceType description: Tipo height: type: integer format: int64 description: Altura (mm) width: type: integer format: int64 description: Largura (mm) length: type: integer format: int64 description: Comprimento (mm) maneuverHeight: type: integer format: int64 description: Altura de Manobra (mm) maxWeight: type: integer format: int64 description: Peso Máximo (gr) situation: type: string allOf: – #/definitions/enumSitReg description: Situação sector: type: object allOf: – #/definitions/sector description: Setor separationZone: type: object allOf: – #/definitions/separationZone description: Zona de separação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: product: description: Produto type: object properties: id: type: string format: uuid description: Identificador único referenceCode: type: string description: Código Referência description: type: string description: Descrição cplDescription: type: string description: Descrição complementar situation: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: packing: description: Embalagem type: object properties: id: type: string format: uuid description: Identificador único product: type: object allOf: – #/definitions/product description: Produto code: type: string maxLength: 30 description: Código shortDescription: type: string description: Descrição Reduzida conversionFactor: type: number format: double description: Fator de Conversão height: type: integer format: int64 description: Altura (mm) width: type: integer format: int64 description: Largura (mm) length: type: integer format: int64 description: Comprimento (mm) grossWeight: type: integer format: int64 description: Peso Bruto (gr) netWeight: type: integer format: int64 description: Peso Líquido (gr) ballast: type: integer format: int64 description: Lastro layer: type: integer format: int64 description: Camada maximumStacking: type: integer format: int64 description: Empilhamento Máximo preRegistration: type: boolean description: Pré-cadastro situation: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: productOwner: description: Depositantes vinculados ao produto type: object properties: id: type: string format: uuid description: Id da entidade product: type: object allOf: – #/definitions/product description: Produto wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante code: type: string description: Código do produto description: type: string description: Descrição do produto situation: type: string allOf: – #/definitions/enumSitReg description: Situação do produto controlShelfLife: type: string allOf: – #/definitions/enumControlShelfLife description: Tipo de controle de validade typeTerm: type: string allOf: – #/definitions/enumTypeTerm description: Tipo de prazo shelfLife: type: integer format: int64 description: Prazo de validade marketingPeriod: type: integer format: int64 description: Prazo de comercialização criticalDeadline: type: integer format: int64 description: Prazo crítico controlIndustrialBatch: type: boolean description: Controlar lote indústria excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: batch: description: Lote de Armazenamento type: object required: – wmsWarehouse – originId – origin – palletNumber – palletType – productOwner – packing – productSituation – quantity – quantityUn – inputOperationType – inputOperationId properties: id: type: string format: uuid description: Identificador único wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém originId: type: string format: uuid description: Id da origem do lote origin: type: string allOf: – #/definitions/enumBatchOrigin description: Origem do lote palletNumber: type: integer format: int64 description: Número do palete palletType: type: string allOf: – #/definitions/enumPalletType description: Tipo do Lote productOwner: type: object allOf: – #/definitions/productOwner description: Produto Depositante packing: type: object allOf: – #/definitions/packing description: Embalagem productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto quantity: type: number format: double description: Quantidade total do lote no fator da embalagem quantityUn: type: number format: double description: Quantidade unitária total do lote industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data fabricação expirationDate: type: string format: date description: Data vencimento inputOperationType: type: string allOf: – #/definitions/enumInputOpertionType description: Tipo da operação de entrada inputOperationId: type: string format: uuid description: Id da operação de entrada inputOperationCode: type: string description: Código/Número da operação de entrada inputOperationDescription: type: string maxLength: 400 description: Descrição da operação de entrada blocked: type: boolean description: Bloqueado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: stock: description: Estoque type: object required: – wmsWarehouse – place – batch – productOwner properties: id: type: string format: uuid description: Identificador único wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém place: type: object allOf: – #/definitions/place description: Local batch: type: object allOf: – #/definitions/batch description: Lote productOwner: type: object allOf: – #/definitions/productOwner description: Produto/Depositante add: type: number format: double description: Adicionar default: 0.0 pendency: type: number format: double description: Pendência default: 0.0 stock: type: number format: double description: Estoque default: 0.0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: validateStockPreset: description: Preset de Alteração de Estoque type: object required: – idValidation – idDocument – wmsWarehouse – productOwner – packing – productSituation – quantityUn properties: id: type: string format: uuid description: Identificador único idValidation: type: string format: uuid description: Agrupador da validação idDocument: type: string format: uuid description: Identificador do Documento Relativo ao Preset wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém productOwner: type: object allOf: – #/definitions/productOwner description: Produto Depositante packing: type: object allOf: – #/definitions/packing description: Embalagem productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto quantityUn: type: number format: double description: Quantidade Unitária solicitada availableQtyUn: type: number format: double description: Quantidade Unitária disponível no momento da avaliação default: 0.0 industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data fabricação expirationDate: type: string format: date description: Data vencimento stockValidationSituation: type: string allOf: – #/definitions/enumStockValidationSituation description: Situação da validação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editValidateStockPreset: type: object required: – id allOf: – #/definitions/validateStockPreset stockAvailableValidatedIncludedView: description: View de Disponibilidade de Estoque considerando expedição já validada type: object required: – productOwner – wmsWarehouse – productSituation – quantityUn properties: id: type: integer format: int64 description: Identificador único productOwner: type: object allOf: – #/definitions/productOwner description: Produto Disponível wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém do Estoque productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto quantityUn: type: number format: double description: Quantidade Unitária Disponível industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data fabricação expirationDate: type: string format: date description: Data vencimento stockValidationRejectionDetail: description: Detalhe de Rejeição de Preset de Validação de Estoque type: object required: – documentId – productOwner – description – quantityUn – validationOrder properties: id: type: string format: uuid description: Identificador único documentId: type: string format: uuid description: Id do Documento productOwner: type: object allOf: – #/definitions/productOwner description: Produto Depositante description: type: string description: Descrição quantityUn: type: number format: double description: Quantidade validationOrder: type: integer format: int64 description: Ordem createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editStockValidationRejectionDetail: type: object required: – id allOf: – #/definitions/stockValidationRejectionDetail availableStockAnalysisView: description: Análise de Estoque Disponível – View type: object required: – wmsWarehouse – place – palletNumber – batchBlocked – productSituation – productOwner – available properties: id: type: string format: uuid description: Identificador único wmsWarehouse: type: string format: uuid description: Armazém sectorCode: type: string description: Código do Setor sectorDescription: type: string description: Descrição do Setor sectorSituation: type: string allOf: – #/definitions/enumSitReg description: Situação do Setor separationZoneCode: type: string description: Código da Zona de Separação separationZoneDescription: type: string description: Descrição da Zona de Separação place: type: string description: Local placeSituation: type: string allOf: – #/definitions/enumSitReg description: Situação do Local palletNumber: type: string description: Número do Palete batchBlocked: type: boolean description: Lote Bloqueado productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do Produto productOwner: type: string format: uuid description: Produto Depositante available: type: number format: double description: Quantidade Disponível separationZone: description: Zona de Separação type: object required: – wmsWarehouse – code – description – picking – bufferStock – buffer properties: id: type: string format: uuid description: Identificador único wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém code: type: string description: Código description: type: string description: Descrição picking: type: boolean description: Picking bufferStock: type: boolean description: Pulmão buffer: type: boolean description: Buffer excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage