2.0info: 2.0.0 WMS-X Shipment Separation description: Serviço Responsável pela separação de expedição do WMS-X x-senior-domain: Expedição WMS-X x-senior-domain-path: wmsx_shipment x-senior-service-path: separation 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_shipmentsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /separation/queries/listSeparationQueryView: post: description: Consulta de Separações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsWarehouseId properties: wmsWarehouseId: type: string description: Id do armazém wmsOwnerId: type: string description: Id do depositante waveNumber: type: integer format: int64 description: Número da onda documentNumber: type: string description: Número do documento invoiceNumber: type: string description: Número da nota fiscal invoiceSeries: type: string description: Série da nota fiscal outBoundCreatedDateStart: type: string format: date description: Data início do pedido outBoundCreatedDateEnd: type: string format: date description: Data final do pedido boardingDateStart: type: string format: date description: Data esperada de embarque boardingDateEnd: type: string format: date description: Data esperada de embarque receiverName: type: string description: Nome do destinatário wmsCarryingId: type: string description: Id da transportadora outBoundSituation: type: string allOf: – #/definitions/enumOutBoundSituation description: Situação do pedido taskIdentifier: type: integer format: int64 description: Identificador da tarefa de separação separationSituation: type: string allOf: – #/definitions/enumSeparationTaskSituation description: Situação da separação originSectorId: type: string description: Id do setor de origem separationZoneId: type: string description: Id da zona de separação originPlaceAddress: type: string description: Endereço do local de origem destinationPlaceAddress: type: string description: Endereço do local de destino productCode: type: string description: Código do produto/depositante industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data de fabricação expirationDate: type: string format: date description: Data de validade 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/separationQueryView minimum: 1 description: Lista de Separações – View 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de Separações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: wmsWarehouseId description: Id do armazém in: query required: true type: string – name: wmsOwnerId description: Id do depositante in: query type: string – name: waveNumber description: Número da onda in: query type: integer format: int64 – name: documentNumber description: Número do documento in: query type: string – name: invoiceNumber description: Número da nota fiscal in: query type: string – name: invoiceSeries description: Série da nota fiscal in: query type: string – name: outBoundCreatedDateStart description: Data início do pedido in: query type: string format: date – name: outBoundCreatedDateEnd description: Data final do pedido in: query type: string format: date – name: boardingDateStart description: Data esperada de embarque in: query type: string format: date – name: boardingDateEnd description: Data esperada de embarque in: query type: string format: date – name: receiverName description: Nome do destinatário in: query type: string – name: wmsCarryingId description: Id da transportadora in: query type: string – name: outBoundSituation description: Situação do pedido in: query type: string allOf: – #/definitions/enumOutBoundSituation – name: taskIdentifier description: Identificador da tarefa de separação in: query type: integer format: int64 – name: separationSituation description: Situação da separação in: query type: string allOf: – #/definitions/enumSeparationTaskSituation – name: originSectorId description: Id do setor de origem in: query type: string – name: separationZoneId description: Id da zona de separação in: query type: string – name: originPlaceAddress description: Endereço do local de origem in: query type: string – name: destinationPlaceAddress description: Endereço do local de destino in: query type: string – name: productCode description: Código do produto/depositante in: query type: string – name: industrialBatch description: Lote indústria in: query type: string – name: fabricationDate description: Data de fabricação in: query type: string format: date – name: expirationDate description: Data de validade in: query type: string format: date – name: offset description: Numero da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: sort description: Ordenação por campos in: query type: string – name: order description: Direção da ordenação do campos in: query type: string 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/separationQueryView minimum: 1 description: Lista de Separações – View 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/queries/batchesInShipment: post: description: Retornar se os lotes estão em expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – batchIds properties: batchIds: type: array items: type: string minimum: 1 description: Id dos lotes responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/recBatchesInShipment minimum: 1 description: Identifica se os lotes estão em expedição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/queries/getDestinationPlaceByOutBound: post: description: Retornar o local de destino do pedido de expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – outBoundId properties: outBoundId: type: string description: Id do pedido de expedição responses: 200: description: Ok schema: type: object required: – destinationPlace properties: destinationPlace: type: object allOf: – #/definitions/place description: Local de destino 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retornar o local de destino do pedido de expedição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: outBoundId description: Id do pedido de expedição in: query required: true type: string responses: 200: description: Ok schema: type: object required: – destinationPlace properties: destinationPlace: type: object allOf: – #/definitions/place description: Local de destino 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/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 /separation/queries/exportE001pes: 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 /separation/queries/exportE001end: 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 /separation/queries/exportE006pai: 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 /separation/queries/exportE007ufs: 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 /separation/queries/exportE008rai: 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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/queries/exportOutBound: 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 /separation/queries/exportOutBoundReference: 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 /separation/queries/exportOutBoundWave: 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 /separation/queries/exportSeparationTask: 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 /separation/queries/exportDispatchSeparationWave: 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 /separation/queries/exportSkipSeparationTask: 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 /separation/queries/exportSeparationTaskView: 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 /separation/queries/exportSeparationTaskDetailView: 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 /separation/queries/exportSeparationQueryView: 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 /separation/queries/exportSeparationTaskGroupedView: 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 /separation/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 /separation/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 /separation/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 /separation/actions/executeSeparation: post: description: Executar separação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: identifier: type: integer format: int64 description: Identificador da tarefa de separação waveId: type: string description: Id da onda outBoundId: type: string description: Id do pedido de expedição responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Identifica se houve sucesso na operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/actions/startSeparationByIdentifier: post: description: Iniciar separação por identificador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identifier – wmsWarehouseId properties: identifier: type: integer format: int64 description: Identificador da tarefa de separação wmsWarehouseId: type: string description: Id do armazém responses: 200: description: Ok schema: type: object required: – finished properties: finished: type: boolean description: Identifica se finalizou as separações hasSeparateTasks: type: boolean description: Identifica se existem tarefas já separadas default: false currentSeparationTask: type: object allOf: – #/definitions/recSeparationTask description: Tarefa de separação atual definida pela ordem da tarefa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/actions/deleteSeparationTaskByWave: post: description: Deletar tarefa de separação pela onda tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – waveId properties: waveId: type: string description: Id da onda de separação responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Identifica se houve sucesso na operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/actions/printSeparationTaskReport: post: description: Imprimir tarefa de separação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – waveId – printType properties: waveId: type: string description: Id da onda de separação regionId: type: string description: Id da região printType: type: string allOf: – #/definitions/enumPrintTypeSeparationTask description: Tipo de Impressão responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download do relatório 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/actions/executePartialSeparation: post: description: Divide a tarefa para separação parcial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identifier – wmsWarehouseId properties: identifier: type: integer format: int64 description: Identificador da tarefa de separação wmsWarehouseId: type: string description: Id do Armazem responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Identifica se houve sucesso na operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/actions/registerSeparation: post: description: Registra a alteração de uma tarefa de separação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – separationTaskId – separateQuantity properties: separationTaskId: type: string description: Id da tarefa de separação separateQuantity: type: number format: double description: Quantidade separada responses: 200: description: Ok schema: type: object required: – finished properties: finished: type: boolean description: Identifica se finalizou as separações hasSeparateTasks: type: boolean description: Identifica se existem tarefas já separadas default: false currentSeparationTask: type: object allOf: – #/definitions/recSeparationTask description: Tarefa de separação atual definida pela ordem da tarefa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/actions/updateSeparationsToInDelivery: post: description: Atualiza as separações para em entrega e retorna o local de destino tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identifier – wmsWarehouseId properties: identifier: type: integer format: int64 description: Identificador da tarefa de separação wmsWarehouseId: type: string description: Id do Armazem responses: 200: description: Ok schema: type: object required: – success – destinationPlace properties: success: type: boolean description: Identifica se houve sucesso na operação destinationPlace: type: object allOf: – #/definitions/place description: Local de destino 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/actions/finishSeparations: post: description: Finalizar separação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identifier – destinationPlace – wmsWarehouseId properties: identifier: type: integer format: int64 description: Identificador da tarefa de separação destinationPlace: type: object allOf: – #/definitions/place description: Endereço de destino wmsWarehouseId: type: string description: Id do Armazem waveId: type: string description: Id da onda responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Identifica se houve sucesso na operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/actions/skipSeparation: post: description: Pula a separação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – separationTaskId – wmsWarehouseId properties: separationTaskId: type: string description: Id da tarefa de separação wmsWarehouseId: type: string description: Id do Armazem proceedWithDivergence: type: boolean description: Prosseguir com divergencia default: false responses: 200: description: Ok schema: type: object required: – resultCode properties: resultCode: type: integer format: int64 description: Código do retorno currentSeparationTask: type: object allOf: – #/definitions/recSeparationTask description: Tarefa de separação atual definida pela ordem da tarefa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/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 /separation/actions/importE001pes: 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 /separation/actions/importE001end: 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 /separation/actions/importE006pai: 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 /separation/actions/importE007ufs: 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 /separation/actions/importE008rai: 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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/actions/importOutBound: 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 /separation/actions/importOutBoundReference: 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 /separation/actions/importOutBoundWave: 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 /separation/actions/importSeparationTask: 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 /separation/actions/importDispatchSeparationWave: 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 /separation/actions/importSkipSeparationTask: 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 /separation/actions/importSeparationTaskView: 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 /separation/actions/importSeparationTaskDetailView: 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 /separation/actions/importSeparationQueryView: 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 /separation/actions/importSeparationTaskGroupedView: 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 /separation/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 /separation/events/pickingFinished: post: description: Sinaliza uma separação foi finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pickingOperation responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /separation/events/importE001pesEvent: 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 /separation/events/exportE001pesEvent: 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 /separation/events/importE001endEvent: 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 /separation/events/exportE001endEvent: 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 /separation/events/importE006paiEvent: 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 /separation/events/exportE006paiEvent: 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 /separation/events/importE007ufsEvent: 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 /separation/events/exportE007ufsEvent: 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 /separation/events/importE008raiEvent: 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 /separation/events/exportE008raiEvent: 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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/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 /separation/events/importOutBoundEvent: 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 /separation/events/exportOutBoundEvent: 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 /separation/events/importOutBoundReferenceEvent: 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 /separation/events/exportOutBoundReferenceEvent: 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 /separation/events/importOutBoundWaveEvent: 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 /separation/events/exportOutBoundWaveEvent: 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 /separation/events/importSeparationTaskEvent: 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 /separation/events/exportSeparationTaskEvent: 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 /separation/events/importDispatchSeparationWaveEvent: 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 /separation/events/exportDispatchSeparationWaveEvent: 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 /separation/events/importSkipSeparationTaskEvent: 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 /separation/events/exportSkipSeparationTaskEvent: 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 /separation/events/importSeparationTaskViewEvent: 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 /separation/events/exportSeparationTaskViewEvent: 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 /separation/events/importSeparationTaskDetailViewEvent: 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 /separation/events/exportSeparationTaskDetailViewEvent: 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 /separation/events/importSeparationQueryViewEvent: 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 /separation/events/exportSeparationQueryViewEvent: 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 /separation/events/importSeparationTaskGroupedViewEvent: 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 /separation/events/exportSeparationTaskGroupedViewEvent: 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 /separation/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 /separation/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 /separation/entities/e001end: 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/e001end 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/e001end/{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/e001end 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/e006pai: 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/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/e006pai/{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/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/e007ufs: 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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/e007ufs/{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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/e008rai: 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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/e008rai/{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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/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 /separation/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 /separation/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 /separation/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 /separation/entities/outBound: 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/outBound responses: 200: description: The created resource schema: #/definitions/outBound 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/outBound responses: 200: description: The created resource schema: #/definitions/outBound 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/outBound 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/outBound/{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/editOutBound responses: 200: description: Ok schema: #/definitions/editOutBound 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/outBound responses: 200: description: Ok schema: #/definitions/outBound 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/outBound 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 /separation/entities/outBound/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBound responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/outBoundReference: 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/outBoundReference responses: 200: description: The created resource schema: #/definitions/outBoundReference 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/outBoundReference responses: 200: description: The created resource schema: #/definitions/outBoundReference 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/outBoundReference 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/outBoundReference/{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/editOutBoundReference responses: 200: description: Ok schema: #/definitions/editOutBoundReference 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/outBoundReference responses: 200: description: Ok schema: #/definitions/outBoundReference 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/outBoundReference 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 /separation/entities/outBound/{parentId}/outBoundReference: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/outBoundReference responses: 200: description: The created resources schema: type: array items: #/definitions/outBoundReference 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/outBoundReference responses: 200: description: The created resources schema: type: array items: #/definitions/outBoundReference 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: parentId in: path required: true type: string – 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/outBoundReference 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/outBound/{parentId}/outBoundReference/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutBoundReference responses: 200: description: Ok schema: #/definitions/editOutBoundReference 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outBoundReference responses: 200: description: Ok schema: #/definitions/outBoundReference 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outBoundReference 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/outBoundReference/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundReference responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/outBoundWave: 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/outBoundWave responses: 200: description: The created resource schema: #/definitions/outBoundWave 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/outBoundWave responses: 200: description: The created resource schema: #/definitions/outBoundWave 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/outBoundWave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/outBoundWave/{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/editOutBoundWave responses: 200: description: Ok schema: #/definitions/editOutBoundWave 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/outBoundWave responses: 200: description: Ok schema: #/definitions/outBoundWave 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/outBoundWave 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 /separation/entities/outBoundWave/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundWave responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/separationTask: 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/separationTask responses: 200: description: The created resource schema: #/definitions/separationTask 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/separationTask responses: 200: description: The created resource schema: #/definitions/separationTask 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/separationTask 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/separationTask/{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/editSeparationTask responses: 200: description: Ok schema: #/definitions/editSeparationTask 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/separationTask responses: 200: description: Ok schema: #/definitions/separationTask 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/separationTask 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 /separation/entities/separationTask/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/separationTask responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/skipSeparationTask: 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/skipSeparationTask responses: 200: description: The created resource schema: #/definitions/skipSeparationTask 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/skipSeparationTask responses: 200: description: The created resource schema: #/definitions/skipSeparationTask 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/skipSeparationTask 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/skipSeparationTask/{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/editSkipSeparationTask responses: 200: description: Ok schema: #/definitions/editSkipSeparationTask 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/skipSeparationTask responses: 200: description: Ok schema: #/definitions/skipSeparationTask 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/skipSeparationTask 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 /separation/entities/skipSeparationTask/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/skipSeparationTask responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /separation/entities/separationTaskGroupedView: 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/separationTaskGroupedView 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 – PA description: Tipo de Local de Armazenagem: * `PI` – Picking * `PB` – Pulmão Blocado * `PP` – Pulmão Paletizado * `DC` – Doca * `BF` – Buffer * `PA` – Packing 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 enumTypeTerm: type: string enum: – VM – VD description: Tipo de prazo: * `VM` – Meses * `VD` – Dias 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 description: Origem do Lote: * `OR` – Ordem de Recebimento * `RE` – Remanejamento * `IV` – Inventário * `SC` – Ajuste enumOutBoundSituation: type: string enum: – PENDING – RELEASED – IN_SHIPMENT – IN_SEPARATION – SEPARATED – IN_CHECKIN – CHECKED – IN_PICKUP – FINISHED – CANCELED description: Situação do Pedido de Expedição: * `PENDING` – Pendente * `RELEASED` – Liberado * `IN_SHIPMENT` – Em Expedição * `IN_SEPARATION` – Em Separação * `SEPARATED` – Separado * `IN_CHECKIN` – Em Conferência * `CHECKED` – Conferido * `IN_PICKUP` – Em Coleta * `FINISHED` – Processado * `CANCELED` – Cancelada enumSeparationTaskSituation: type: string enum: – CREATED – IN_SEPARATION – IN_DELIVERY – SEPARATED – CANCELED description: Situação da Tarefa de Separação: * `CREATED` – Criada * `IN_SEPARATION` – Em separação * `IN_DELIVERY` – Em entrega * `SEPARATED` – Separado * `CANCELED` – Cancelada enumSeparationWaveSituation: type: string enum: – FORMED – RELEASED – EXECUTING – FINISHED – CANCELED description: Situação da onda de separação: * `FORMED` – Formada * `RELEASED` – Liberada * `EXECUTING` – Em execução * `FINISHED` – Finalizada * `CANCELED` – Cancelada enumPrintTypeSeparationTask: type: string enum: – NO_CONTENT_ALL_REGIONS – NO_CONTENT_BREAK_REGIONS – NO_CONTENT_BY_REGION – WITH_CONTENT_ALL_REGIONS – WITH_CONTENT_BREAK_REGIONS – WITH_CONTENT_BY_REGION description: Tipo de impressão da tarefa de separação: * `NO_CONTENT_ALL_REGIONS` – Sem Conteúdo – Todas as Regiões * `NO_CONTENT_BREAK_REGIONS` – Sem Conteúdo – Quebra de Regiões * `NO_CONTENT_BY_REGION` – Sem Conteúdo – Por Região * `WITH_CONTENT_ALL_REGIONS` – Com Conteúdo – Todas as Regiões * `WITH_CONTENT_BREAK_REGIONS` – Com Conteúdo – Quebra de Regiões * `WITH_CONTENT_BY_REGION` – Com Conteúdo – Por Região enumTipEnd: type: string enum: – V3 – V4 description: Tipo de endereço: * `V3` – Comercial * `V4` – Residencial enumOutBoundDocumentType: type: string enum: – ORDER – INVOICE description: Tipo de documento do Pedido de Expedição: * `ORDER` – Pedido de venda * `INVOICE` – Nota fiscal enumOutboundReferenceKey: type: string enum: – INVOICE_DATE – INVOICE_NUMBER – INVOICE_SERIES – INVOICE_ACCESS_KEY description: Chave com campos de Referencia para Outbound: * `INVOICE_DATE` – Data de Emissão da Nota Fiscal * `INVOICE_NUMBER` – Número da Nota Fiscal * `INVOICE_SERIES` – Serie da Nota Fiscal * `INVOICE_ACCESS_KEY` – Chave da Nota Fiscal 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 recSeparationTask: description: Tarefa de Separação – Record type: object required: – id – identifier – originAddressId – originAddress – formattedOriginAddress – destinationAddressId – destinationAddress – formattedDestinationAddress – ownerId – ownerName – outBoundId – quantity – remainingQuantity – packingCode – packingShortDescription – documentNumber – waveDescription – allowsPartialSeparation properties: id: type: string description: Id da tarefa identifier: type: integer format: int64 description: Identificador da tarefa de separação originAddressId: type: string description: Id do endereço de origem originAddress: type: string description: Endereço de origem formattedOriginAddress: type: string description: Endereço de origem formatado destinationAddressId: type: string description: Id do endereço de destino destinationAddress: type: string description: Endereço de destino formattedDestinationAddress: type: string description: Endereço de destino formatado ownerId: type: string description: Id do depositante ownerName: type: string description: Nome do depositante productDescription: type: string description: Descrição do produto outBoundId: type: string description: Id do pedido de expedição quantity: type: number format: double description: Quantidade remainingQuantity: type: number format: double description: Quantidade restante a separar packingCode: type: string description: Código da embalagem packingShortDescription: type: string description: Descrição reduzida documentNumber: type: string description: Número do documento waveDescription: type: string description: Descrição da onda allowsPartialSeparation: type: boolean description: Depositante permite separação parcial controlIndustrialBatch: type: boolean description: Controlar lote indústria industrialBatch: type: string description: Lote indústria controlShelfLife: type: string allOf: – #/definitions/enumControlShelfLife description: Tipo de controle de validade fabricationDate: type: string format: date description: Data fabricação expirationDate: type: string format: date description: Data vencimento order: type: integer format: int64 description: Fator de ordenação recSeparationTaskViewDataSource: description: Modelo de dados para o datasource do jasper para impressão das tarefas de separação type: object required: – tasks properties: tasks: type: array items: type: object allOf: – #/definitions/separationTaskView minimum: 1 description: Tarefas de Separação recSeparationTaskDetailViewDataSource: description: Modelo de dados para o datasource do jasper para impressão das tarefas de separação com conteúdo type: object required: – tasks properties: tasks: type: array items: type: object allOf: – #/definitions/separationTaskDetailView minimum: 1 description: Tarefas de Separação recBatchesInShipment: description: Lotes em expedição – Record type: object required: – batchId – inShipment properties: batchId: type: string description: Id do lote inShipment: type: boolean description: Identifica se o lote está em expedição recPartialSeparation: description: Executar separação parcial – Record type: object required: – separationTaskId – separateQuantity properties: separationTaskId: type: string description: Identificadores das tarefas de separação separateQuantity: type: number format: double description: Quantidade separada pickingOperation: description: Modelo de dados para eventos de operação de separação type: object required: – warehouseId – ownerId – operationId – waveNumber – userName properties: warehouseId: type: string description: ID do armazem ownerId: type: string description: ID do depositante operationId: type: string description: ID da Onda waveNumber: type: integer format: int64 description: Número da Onda userName: type: string description: Usuário / Operador e001pes: description: Pessoa – Replicação type: object required: – codPes – nomPes – apePes – tipPes – tipMer properties: id: type: string format: uuid description: Identificador único codPes: type: integer format: int64 description: Código nomPes: type: string maxLength: 100 description: Nome apePes: type: string maxLength: 80 description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string maxLength: 14 description: CNPJ/CPF numRge: type: string maxLength: 15 description: Número do RG datRge: type: string format: date description: Data de emissão do RG orgRge: type: string maxLength: 6 description: Órgão emissor do RG insEst: type: string maxLength: 25 description: Inscrição estadual insMun: type: string maxLength: 16 description: Inscrição municipal tipMer: type: string allOf: – #/definitions/enumTipMer description: Tipo de mercado do cliente 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: e001end: description: Endereço da pessoa – Replicação type: object properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa indEnt: type: boolean description: Indicativo se o endereço é utilizado para entrega default: true indCob: type: boolean description: Indicativo se o endereço é utilizado para cobrança default: false indCol: type: boolean description: Indica se o endereço é utilizado para coleta default: false indFis: type: boolean description: Indicativo se o endereço é utilizado para endereço fiscal default: false postalCode: type: string maxLength: 20 description: Código Postal endPes: type: string maxLength: 100 description: Endereço nenEnd: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento baiEnd: type: string maxLength: 75 description: Bairro prxEnd: type: string maxLength: 200 description: Ponto de referência e006pai: type: object allOf: – #/definitions/e006pai description: Pais e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e008rai: type: object allOf: – #/definitions/e008rai description: Cidade tipLoc: type: string allOf: – #/definitions/enumTipEnd description: Tipo do local nomRes: type: string maxLength: 50 description: Nome do responsável tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string maxLength: 14 description: CNPJ/CPF insEst: type: string maxLength: 25 description: Inscrição estadual fonRes: type: string maxLength: 21 description: Telefone celRes: type: string maxLength: 22 description: Celular faxRes: type: string maxLength: 20 description: Fax emaRes: type: string maxLength: 100 description: E-mail sitEnd: 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: e006pai: description: País – Replicação type: object required: – codPai – nomPai – merSul – visEnt properties: id: type: string format: uuid description: Id da entidade codPai: type: string maxLength: 4 description: Código nomPai: type: string maxLength: 150 description: Nome merSul: type: boolean description: Mercosul visEnt: type: boolean description: Visto entrada paiDir: type: integer format: int64 description: Código do país na DIRF minimum: 0 maximum: 999 paiSis: type: integer format: int64 description: País Siscomex/Siscoserv minimum: 0 maximum: 999 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: e007ufs: description: Estado – Replicação type: object required: – sigUfs – nomUfs – e006pai properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome e006pai: type: object allOf: – #/definitions/e006pai description: País 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: e008rai: description: Cidade – Replicação type: object required: – codRai – nomCid – e007ufs – cepMin – cepMax properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado popCid: type: integer format: int64 description: População minimum: 0 maximum: 999999999 potAlf: type: number format: double description: Potencial consumo minimum: 0.00 maximum: 99.999 locGeo: type: string maxLength: 6 description: Localização geográfica cepMin: type: integer format: int64 description: CEP inicial minimum: 0 maximum: 99999999 cepMax: type: integer format: int64 description: CEP final minimum: 0 maximum: 99999999 codFis: type: integer format: int64 description: Código fiscal município minimum: 0 maximum: 9999999 codIbg: type: integer format: int64 description: Código IBGE município minimum: 0 maximum: 9999999 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: 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 allowsPartialSeparation: type: boolean description: Permite separação parcial 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 required: – requestDayInDates 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 showFabDateInCollector: type: boolean description: Exibir data de fabricação nas operações do coletor default: true showExpDateInCollector: type: boolean description: Exibir data de vencimento nas operações do coletor default: true 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 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 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: outBound: description: Pedido de expedição type: object required: – wmsWarehouse – wmsOwner – sender – receiver – receiverAddress – documentNumber – productSituation – situation properties: id: type: string format: uuid description: Identificador único wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante sender: type: object allOf: – #/definitions/e001pes description: Remetente receiver: type: object allOf: – #/definitions/e001pes description: Destinatário receiverAddress: type: object allOf: – #/definitions/e001end description: Endereço do Destinatário documentNumber: type: string description: Número do documento shippingDate: type: string format: date-time description: Data de expedição shippingUser: type: string description: Usuário expedição boardingDate: type: string format: date description: Data de embarque productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do Produto comments: type: string description: Descrição situation: type: string allOf: – #/definitions/enumOutBoundSituation description: Situação outBoundReference: type: array items: type: object allOf: – #/definitions/outBoundReference description: Dados de Referência do pedido de expedição outboundAuthorized: type: boolean description: Expedição Autorizada default: false authorizationUser: type: string description: Usuário de autorização da expedição authorizationDate: type: string format: date description: Data de autorização da expedição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBound: type: object required: – id allOf: – #/definitions/outBound outBoundReference: description: Dados de Referência para Outbound type: object required: – key – value properties: id: type: string format: uuid description: Identificador único outBound: type: object allOf: – #/definitions/outBound description: Pedido de Expedição key: type: string allOf: – #/definitions/enumOutboundReferenceKey description: Chave do Campo value: type: string description: Valor do Campo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBoundReference: type: object required: – id allOf: – #/definitions/outBoundReference outBoundWave: description: Vinculo da onda com os pedidos de expedição type: object required: – wave – outBounds properties: id: type: string format: uuid description: Identificador único wave: type: object allOf: – #/definitions/dispatchSeparationWave description: Onda outBounds: type: array items: type: object allOf: – #/definitions/outBound minimum: 1 description: Pedidos de expedição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBoundWave: type: object required: – id allOf: – #/definitions/outBoundWave separationTask: description: Tarefa de Separação type: object required: – identifier – wave – wmsWarehouse – originPlace – destinationPlace – batch – outBound – productOwner – packing – quantity – quantityUn – situation properties: id: type: string format: uuid description: Identificador único identifier: type: integer format: int64 description: Identificador da Tarefa wave: type: object allOf: – #/definitions/dispatchSeparationWave description: Onda wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém originPlace: type: object allOf: – #/definitions/place description: Local de origem destinationPlace: type: object allOf: – #/definitions/place description: Local de destino batch: type: object allOf: – #/definitions/batch description: Lote outBound: type: object allOf: – #/definitions/outBound description: Pedido de expedição productOwner: type: object allOf: – #/definitions/productOwner description: Produto/Depositante packing: type: object allOf: – #/definitions/packing description: Embalagem solicitada quantity: type: number format: double description: Quantidade solicitada quantityUn: type: number format: double description: Quantidade solicitada (UN) separateQuantityUn: type: number format: double description: Quantidade separada (UN) default: 0.0 situation: type: string allOf: – #/definitions/enumSeparationTaskSituation description: Situação separatedBy: type: string description: Separado por taskOrder: type: integer format: int64 description: Fator de ordenação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSeparationTask: type: object required: – id allOf: – #/definitions/separationTask dispatchSeparationWave: description: Onda de separação para expedição type: object required: – wmsWarehouse – situation – description properties: id: type: string format: uuid description: Identificador único wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém number: type: integer format: int64 description: Número da onda situation: type: string allOf: – #/definitions/enumSeparationWaveSituation description: Situação description: type: string description: Descrição separated: type: boolean description: Separada checked: type: boolean description: Conferida separationTaskReportFileName: type: string description: Nome do arquivo do relatório de separação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: skipSeparationTask: description: Pular tarefa de separação type: object required: – wave – separationTask – separationAddress – productOwner – skipQuantity properties: id: type: string format: uuid description: Identificador único wave: type: object allOf: – #/definitions/dispatchSeparationWave description: Onda separationTask: type: object allOf: – #/definitions/separationTask description: Tarefa separationAddress: type: object allOf: – #/definitions/place description: Endereço da separação productOwner: type: object allOf: – #/definitions/productOwner description: Produto em separação skipQuantity: type: integer format: int64 description: Quantidade pulada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSkipSeparationTask: type: object required: – id allOf: – #/definitions/skipSeparationTask separationTaskView: description: View de Relatório de Tarefa type: object required: – id – waveId – waveDescription – waveNumber – documentNumber – carryingName – taskIdentifier – taskCreatedDate – itemsQuantity – placesQuantity – cubage – weight properties: id: type: integer format: int64 description: Identificador waveId: type: string format: uuid description: Identificador da onda de separação waveDescription: type: string description: Descrição da onda de separação waveNumber: type: integer format: int64 description: Número da onda de separação documentNumber: type: string description: Número do outbound carryingName: type: string description: Nome da transportadora do pedido taskIdentifier: type: integer format: int64 description: Identificador da tarefa de separação taskCreatedDate: type: string format: date description: Data de criação da tarefa itemsQuantity: type: number format: double description: Quantidade de Peças placesQuantity: type: integer format: int64 description: Quantidade de Endereços cubage: type: number format: double description: Cubagem weight: type: number format: double description: Peso separationTaskDetailView: description: View de Relatório de Tarefa com Conteúdo type: object required: – id – waveId – waveDescription – waveNumber – documentNumber – documentComments – carryingName – taskIdentifier – address – productCode – productDescription – itemsQuantity properties: id: type: integer format: int64 description: Identificador waveId: type: string format: uuid description: Identificador da onda de separação waveDescription: type: string description: Descrição da onda de separação waveNumber: type: integer format: int64 description: Número da onda de separação documentNumber: type: string description: Número do outbound documentComments: type: string description: Observação do outbound carryingName: type: string description: Nome da transportadora do pedido taskIdentifier: type: integer format: int64 description: Identificador da tarefa de separação address: type: string description: Local de origem productCode: type: string description: Código do produto productDescription: type: string description: Descrição do produto itemsQuantity: type: number format: double description: Quantidade de Peças separationQueryView: description: Consulta de Separação – View type: object required: – wmsWarehouseId – wmsOwnerId – ownerCode – ownerName – waveId – outBoundId – outBoundCreatedDate – outBoundSituation – receiverId – productOwnerId – productCode – productDescription – separationQuantityPlanned – separateQuantity – checkinQuantity – completePallet – originSectorId – originSector – originPlaceId – originPlaceType – originPlace – destinationPlaceId – destinationPlaceType – destinationPlace properties: id: type: integer format: int64 description: Identificador wmsWarehouseId: type: string format: uuid description: Id do armaém wmsOwnerId: type: string format: uuid description: Id do depositante ownerCode: type: integer format: int64 description: Código do depositante ownerName: type: string description: Nome do depositante waveId: type: string format: uuid description: Id da onda waveNumber: type: integer format: int64 description: Número da onda outBoundId: type: string format: uuid description: Id do pedido documentNumber: type: string description: Número do documento invoiceNumber: type: string description: Número da nota fiscal invoiceSeries: type: string description: Série da nota fiscal boardingDate: type: string format: date description: Data esperada de embarque outBoundCreatedDate: type: string format: date description: Data criação do pedido outBoundSituation: type: string allOf: – #/definitions/enumOutBoundSituation description: Situação do pedido taskIdentifier: type: integer format: int64 description: Identificador da tarefa de separação separationSituation: type: string allOf: – #/definitions/enumSeparationTaskSituation description: Situação da separação receiverId: type: string format: uuid description: Id do destinatário receiverCode: type: integer format: int64 description: Código do destinatário receiverName: type: string description: Nome do destinatário wmsCarryingId: type: string format: uuid description: Id da transportadora carryingCode: type: integer format: int64 description: Código da transportadora carryingName: type: string description: Nome da transportadora productOwnerId: type: string format: uuid description: Id do produto/depositante productCode: type: string description: Código do produto productDescription: type: string description: Descrição do produto industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data de fabricação expirationDate: type: string format: date description: Data de validade separationQuantityPlanned: type: number format: double description: Quantidade planejada de separação separateQuantity: type: number format: double description: Quantidade separada checkinQuantity: type: number format: double description: Quantidade conferida completePallet: type: boolean description: Palete completo originSectorId: type: string format: uuid description: Id do setor de origem originSector: type: string description: Setor de origem separationZoneId: type: string format: uuid description: Id da zona de separação separationZoneCode: type: string description: Código da zona de separação separationZoneDescription: type: string description: Descrição da zona de separação originPlaceId: type: string format: uuid description: Id do local de origem originPlaceType: type: string allOf: – #/definitions/enumPlaceType description: Tipo do local de origem originPlace: type: string description: Local de origem destinationPlaceId: type: string format: uuid description: Id do local de destino destinationPlaceType: type: string allOf: – #/definitions/enumPlaceType description: Tipo do local de destino destinationPlace: type: string description: Local de destino separationDate: type: string format: date-time description: Data da separação checkinDate: type: string format: date-time description: Data da conferência pickupDate: type: string format: date-time description: Data da coleta shippingDate: type: string format: date-time description: Data de expedição separationUser: type: string description: Usuário da separação checkinUser: type: string description: Usuário da conferência pickupUser: type: string description: Usuário da coleta shippingUser: type: string description: Usuário da expedição separationTaskGroupedView: description: Consulta de tarefa de separação agrupada – View type: object required: – id – wmsWarehouseId – identifier – situation – createdDate – waveSituation – waveNumber – documentNumber properties: id: type: string format: uuid description: Id da primeira tarefa de separação agrupada wmsWarehouseId: type: string format: uuid description: Id do armazém identifier: type: integer format: int64 description: Identificador da tarefa de separação situation: type: string allOf: – #/definitions/enumSeparationTaskSituation description: Situação da tarefa de separação separatedBy: type: string description: Separado por createdDate: type: string format: date-time description: Data de criação waveSituation: type: string allOf: – #/definitions/enumSeparationWaveSituation description: Situação da onda waveNumber: type: integer format: int64 description: Número da onda documentNumber: type: string description: Número do pedido separationZone: description: Zona de Separação type: object required: – wmsWarehouse – code – description 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 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