2.0info: 1.12.0 WMS-X Stock Database description: Serviço de Migração da base de dados WMSX_STOCK do Tenant x-senior-domain: Estoque WMS-X x-senior-domain-path: wmsx_stock x-senior-service-path: database 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: /database/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 /database/queries/exportAnalyticsStock: 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 /database/queries/exportAnalyticsStockHistory: 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 /database/queries/exportAnalyticsSectorOccupation: 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 /database/queries/exportAnalyticsPlaceOccupation: 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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/queries/exportReasonOccurrence: 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 /database/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 /database/queries/exportLpnType: 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 /database/queries/exportLpn: 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 /database/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 /database/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 /database/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/actions/datasetVolumeByMovementType: post: description: Retorna o volume da movimentação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId – movementType – groupType – startDate – endDate properties: wmsWarehouseId: type: string description: Armazém movementType: type: string allOf: – #/definitions/enumMovementType description: Tipo de movimentação groupType: type: string allOf: – #/definitions/enumGroupType description: Tipo agrupamento startDate: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data início endDate: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data fim responses: 200: description: Ok schema: type: object required: – volumes properties: volumes: type: array items: type: object allOf: – #/definitions/volumeMovementGrouped minimum: 1 description: Volume da movimentação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/actions/datasetCurrentBalance: post: description: Retorna o saldo atual tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId properties: wmsWarehouseId: type: string description: Armazém responses: 200: description: Ok schema: type: object required: – balance properties: balance: type: number format: double description: Saldo atual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/actions/datasetVolumeMovementByStockOperationType: post: description: Retorna o volume de movimentação por tipo de operação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId – startDate – endDate properties: wmsWarehouseId: type: string description: Armazém startDate: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data início endDate: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data fim responses: 200: description: Ok schema: type: object required: – volumeGrouped properties: volumeGrouped: type: array items: type: object allOf: – #/definitions/volumeMovementGrouped minimum: 1 description: Ordens de Recebimento agrupas por situação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/actions/datasetStockGrouped: post: description: Retorna o volume de movimentação por tipo de operação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId properties: wmsWarehouseId: type: string description: Armazém offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 sort: type: string description: Ordenação por campos order: type: string description: Direção da ordenação do campos responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/analyticsStock minimum: 1 description: Lista de Stock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/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 /database/actions/importAnalyticsStock: 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 /database/actions/importAnalyticsStockHistory: 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 /database/actions/importAnalyticsSectorOccupation: 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 /database/actions/importAnalyticsPlaceOccupation: 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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/actions/importReasonOccurrence: 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 /database/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 /database/actions/importLpnType: 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 /database/actions/importLpn: 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 /database/events/importAnalyticsStockEvent: 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 /database/events/exportAnalyticsStockEvent: 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 /database/events/importAnalyticsStockHistoryEvent: 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 /database/events/exportAnalyticsStockHistoryEvent: 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 /database/events/importAnalyticsSectorOccupationEvent: 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 /database/events/exportAnalyticsSectorOccupationEvent: 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 /database/events/importAnalyticsPlaceOccupationEvent: 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 /database/events/exportAnalyticsPlaceOccupationEvent: 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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/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 /database/events/importReasonOccurrenceEvent: 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 /database/events/exportReasonOccurrenceEvent: 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 /database/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 /database/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 /database/events/importLpnTypeEvent: 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 /database/events/exportLpnTypeEvent: 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 /database/events/importLpnEvent: 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 /database/events/exportLpnEvent: 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 /database/entities/analyticsStock: 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/analyticsStock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/analyticsStockHistory: 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/analyticsStockHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/analyticsSectorOccupation: 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/analyticsSectorOccupation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/analyticsPlaceOccupation: 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/analyticsPlaceOccupation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/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 /database/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 /database/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 /database/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 /database/entities/sector: 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/sector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/sector/{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/sector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/place: 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/place 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/place/{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/place 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/productOwner: 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/productOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/productOwner/{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/productOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/reasonOccurrence: 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/reasonOccurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/reasonOccurrence/{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/reasonOccurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumMovementType: type: string enum: – ALL – ENTRY – OUT – ENTRY_OUT description: Tipo de Movimentação: * `ALL` – Todos * `ENTRY` – Entrada * `OUT` – Saída * `ENTRY_OUT` – Entrada e Saída enumGroupType: type: string enum: – NONE – DAY – MONTH – YEAR description: Tipo de Agrupamento: * `NONE` – Nenhum * `DAY` – Dia * `MONTH` – Mês * `YEAR` – Ano enumStockOperationType: type: string enum: – ALLOCATION – RELOCATION – STOCK_ENTRY_CORRECTION – STOCK_OUT_CORRECTION – DISPATCH – SEPARATION – CKECKOUT – VOLUME – STOCK_OUT – INVENTORY – MATERIAL_STATE_CORRECTION – REVERSE_DISPATCH – REVERSE_ALLOCATION – CHARACTERISTICS_CHANGE – BATCH_BLOCK – BATCH_UNBLOCK description: Tipo de Operação de Estoque: * `ALLOCATION` – Alocação * `RELOCATION` – Remanejamento * `STOCK_ENTRY_CORRECTION` – Ajuste de Estoque de Entrada * `STOCK_OUT_CORRECTION` – Ajuste de Estoque de Saída * `DISPATCH` – Expedição * `SEPARATION` – Separação * `CKECKOUT` – Conferência Saída * `VOLUME` – Volume * `STOCK_OUT` – Baixa de Estoque * `INVENTORY` – Inventário * `MATERIAL_STATE_CORRECTION` – Ajuste de Estado de Material * `REVERSE_DISPATCH` – Estorno da Expedição * `REVERSE_ALLOCATION` – Estorno Alocação * `CHARACTERISTICS_CHANGE` – Alteração de características de lote * `BATCH_BLOCK` – Bloqueio de lote * `BATCH_UNBLOCK` – Desbloqueio de lote enumPlaceType: type: string enum: – PI – PB – PP – DC – BF – PA description: Tipo de Local de Armazenagem: * `PI` – Picking * `PB` – Pulmão Blocado * `PP` – Pulmão Paletizado * `DC` – Doca * `BF` – Buffer * `PA` – Packing enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física 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 enumSideBuildingType: type: string enum: – ALL – EVEN – ODD description: Tipo do Lado de Prédio: * `ALL` – Todos os lados * `EVEN` – Lados pares * `ODD` – Lados ímpares enumPlaceBlockOperation: type: string enum: – MB – GI description: Operações de bloqueio de local: * `MB` – Bloqueio manual * `GI` – Inventário Geral 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 enumPickingType: type: string enum: – DYNAMIC – FIXED description: Tipo de Picking: * `DYNAMIC` – Dinamico * `FIXED` – Fixo enumLpnStatus: type: string enum: – RELEASED – IN_USE description: Status do LPN: * `RELEASED` – Liberado * `IN_USE` – Em uso 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 volumeMovementGrouped: description: Volume de movimentação agrupao por dia type: object required: – volumeEntry – volumeOut properties: data: type: string format: date description: Data volumeEntry: type: number format: double description: Volume de entrada volumeOut: type: number format: double description: volume de saída stockOperationType: type: string allOf: – #/definitions/enumStockOperationType description: Tipo de operaçãp analyticsStock: description: Analytics do Histórico type: object required: – wmsWarehouse – product – ownerName – ownerCnpCpf – stock properties: id: type: string format: uuid description: Identificador único da entidade wmsWarehouse: type: string format: uuid description: Armazém product: type: string description: Produto ownerName: type: string description: Depositante ownerCnpCpf: type: string description: CNPJ/CPF do Depositante stock: type: number format: double description: Quantidade em estoque analyticsStockHistory: description: Analytics do Histórico do Estoque type: object required: – wmsWarehouse – stockDate – stockDateTime – stockOperationType – stockOperationCode – stock properties: id: type: string format: uuid description: Identificador único da entidade wmsWarehouse: type: string format: uuid description: Armazém stockDate: type: string format: date description: Data stockDateTime: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data/hora stockOperationType: type: string allOf: – #/definitions/enumStockOperationType description: Tipo de operação stockOperationCode: type: string description: Código da operação stock: type: number format: double description: Quantidade em estoque analyticsSectorOccupation: description: Analytics da Ocupação do Setor type: object required: – wmsWarehouse – totalStock – sectorStock – occupiedPlace – sectorPlace properties: id: type: integer format: int64 description: Identificador único da entidade wmsWarehouse: type: string format: uuid description: Armazém sector: type: string description: Setor totalStock: type: number format: double description: Total em estoque sectorStock: type: number format: double description: Estoque do setor occupiedPlace: type: integer format: int64 description: Quantidade de locais ocupados sectorPlace: type: integer format: int64 description: Quantidade de locais do setor analyticsPlaceOccupation: description: Analytics da Ocupação do Local type: object required: – wmsWarehouse – addressType – totalStock – placeStock – totalVolume – placeVolume – totalWeight – placeWeight properties: id: type: integer format: int64 description: Identificador único da entidade wmsWarehouse: type: string format: uuid description: Armazém addressType: type: string allOf: – #/definitions/enumPlaceType description: Tipo do local totalStock: type: number format: double description: Total em estoque placeStock: type: number format: double description: Estoque do local totalVolume: type: number format: double description: Total em volume placeVolume: type: number format: double description: Volume do local totalWeight: type: number format: double description: Total em peso placeWeight: type: number format: double description: Peso do local wmsWarehouse: description: Armazém – Replicação wmsx-fnd 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 – Replicação wmsx-fnd 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 – Replicação wmsx-fnd type: object properties: id: type: string format: uuid description: Identificador único code: type: string maxLength: 20 description: Código integrationCode: type: string description: Código de integração 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 – Replicação wmsx-fnd 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 sideBuildingType: type: string allOf: – #/definitions/enumSideBuildingType description: Tipo do lado do prédio blockOperation: type: string allOf: – #/definitions/enumPlaceBlockOperation description: Operação que solicitou o bloqueio do local 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 – Replicação wmsx-fnd 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 – Replicação wmsx-fnd 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 – Replicação wmsx-fnd 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 requestDayInDates: type: boolean description: Solicitar dia ao informar data de vencimento e fabricação pickingType: type: string allOf: – #/definitions/enumPickingType description: Tipo de Picking 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: reasonOccurrence: description: Motivo de Ocorrência – Replicação wmsx-fnd type: object required: – inventory properties: id: type: string format: uuid description: Identificador único code: type: string description: Código description: type: string description: Descrição situation: type: string allOf: – #/definitions/enumSitReg description: Situação batchUnlock: type: boolean description: Desbloqueio de lote batchBlocking: type: boolean description: Bloqueio de lote physicalCut: type: boolean description: Corte físico stockEntryCorrection: type: boolean description: Ajuste de movimentação de entrada stockOutCorrection: type: boolean description: Ajuste de movimentação de saída materialStateCorrection: type: boolean description: Ajuste de estado de material releaseConferenceWithDivergence: type: boolean description: Liberação de conferência com divergência inventory: type: boolean description: Controle de Inventário 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: separationZone: description: Zona de Separação – Replicação wmsx-fnd type: object 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: lpnType: description: Tipo de LPN – Replicação wmsx-fnd type: object properties: id: type: string format: uuid description: Identificador único code: type: string maxLength: 255 description: Código description: type: string maxLength: 255 description: Descrição situation: type: string allOf: – #/definitions/enumSitReg description: Situaçã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) maxWeight: type: integer format: int64 description: Peso Máximo (gr) lpnWeight: type: integer format: int64 description: Peso LPN (gr) receiving: type: boolean description: Recebimento separation: type: boolean description: Separação checking: type: boolean description: Conferência generateVolume: type: boolean description: Gerar Volumes maxPalletQty: type: integer format: int64 description: Quantidade máxima de paletes minimum: 0 uniqueIndustrialBatch: type: boolean description: Lote Indústria Único uniqueSku: type: boolean description: SKU Único receivingBuffer: type: boolean description: Buffer de Recebimento picking: type: boolean description: Picking blockedBufferStock: type: boolean description: Pulmão blocado palletizedBufferStock: type: boolean description: Pulmão Paletizado packing: type: boolean description: Packing dock: type: boolean description: Doca 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: lpn: description: LPN – Replicação wmsx-fnd type: object properties: id: type: string format: uuid description: Id da entidade lpnType: type: object allOf: – #/definitions/lpnType description: Tipo de LPN code: type: string maxLength: 255 description: Código do LPN situation: type: string allOf: – #/definitions/enumSitReg description: Situação status: type: string allOf: – #/definitions/enumLpnStatus description: Status labelTargetId: type: string maxLength: 255 description: Target Id da etiqueta labelFileName: type: string maxLength: 255 description: Nome do arquivo da etiqueta no S3 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