WMS-X Shipment Dispatch General (dispatch_general)

2.0info: 1.0.2 WMS-X Shipment Dispatch General description: Serviço Responsável pelas operações de coletas e expedição do WMS-X x-senior-domain: Expedição WMS-X x-senior-domain-path: wmsx_shipment x-senior-service-path: dispatch_general 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: /dispatch_general/queries/getWaveDocuments: post: description: Busca pedidos da onda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – waveId properties: waveId: type: string description: Id da onda offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 orderBy: type: string description: 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/recWaveDocument minimum: 1 description: Documentos da onda 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca pedidos da onda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: waveId description: Id da onda in: query required: true type: string – 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: orderBy description: 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/recWaveDocument minimum: 1 description: Documentos da onda 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/queries/getPlacesWithPendingSeparations: post: description: Consulta se locais possuem pendência de separação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – placeIds properties: placeIds: type: array items: type: string minimum: 1 description: Lista de IDs de locais responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/waveSeparationPendingPlace description: Lista de IDs de locais e ondas com separação pendente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/queries/exportWmsCarrying: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/queries/exportPickup: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/queries/exportOutBoundItem: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/queries/exportVolume: 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 /dispatch_general/queries/exportVolumeDetail: 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 /dispatch_general/queries/exportCheckinTask: 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 /dispatch_general/queries/exportOutBoundPickup: 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 /dispatch_general/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 /dispatch_general/queries/exportOutBoundRemovedWave: 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 /dispatch_general/queries/exportShipmentConfiguration: 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 /dispatch_general/queries/exportShipmentConfigurationInWave: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/actions/dispatchOutBounds: post: description: Expedir pedidos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – outBoundIds properties: outBoundIds: type: array items: type: string minimum: 1 description: Id dos pedidos responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Informa se houve sucesso na execução messageError: type: string description: Mensagem em caso erro da execução 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/actions/reverseOutBounds: post: description: Estornar pedidos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – outBoundIds properties: outBoundIds: type: array items: type: string minimum: 1 description: Id dos pedidos responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Informa se houve sucesso na execução messageError: type: string description: Mensagem em caso erro da execução 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/actions/releaseWave: post: description: Liberar 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 responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Informa se houve sucesso na execução 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/actions/importWmsCarrying: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/actions/importPickup: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/actions/importOutBoundItem: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/actions/importVolume: 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 /dispatch_general/actions/importVolumeDetail: 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 /dispatch_general/actions/importCheckinTask: 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 /dispatch_general/actions/importOutBoundPickup: 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 /dispatch_general/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 /dispatch_general/actions/importOutBoundRemovedWave: 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 /dispatch_general/actions/importShipmentConfiguration: 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 /dispatch_general/actions/importShipmentConfigurationInWave: 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 /dispatch_general/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 /dispatch_general/signals/createWaveByOutBounds: post: description: Criar onda por outbound tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – outBoundIds – shipmentConfiguration properties: outBoundIds: type: array items: type: string minimum: 1 description: Ids dos outbounds que irão gerar a onda description: type: string description: Descrição da onda destinationPlace: type: object allOf: – #/definitions/place description: Doca de destino shipmentConfiguration: type: object allOf: – #/definitions/shipmentConfiguration description: Configuração de Onda responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dispatch_general/signals/dispatchWave: post: description: Expedir onda tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – waveId properties: waveId: type: string description: Id da onda responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dispatch_general/signals/cancelWave: post: description: Cancelar onda tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – waveId properties: waveId: type: string description: Id da onda responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dispatch_general/signals/removeOutBoundWave: post: description: Remover pedido da onda tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – waveId – outBoundIds properties: waveId: type: string description: Id da onda outBoundIds: type: array items: type: string minimum: 1 description: Id dos pedidos de expedição responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dispatch_general/events/waveCreated: post: description: Sinaliza que uma onda foi criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/separationOperation responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dispatch_general/events/waveCanceled: post: description: Sinaliza que uma onda foi cancelada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/separationOperation responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dispatch_general/events/dispatchedWave: post: description: Evento para quando o processamento da onda é finalizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – waveId – wmsWarehouseId properties: waveId: type: string description: Id da onda wmsWarehouseId: type: string description: Id do Armazém responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/events/importWmsCarryingEvent: 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 /dispatch_general/events/exportWmsCarryingEvent: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/events/importPickupEvent: 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 /dispatch_general/events/exportPickupEvent: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/events/importOutBoundItemEvent: 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 /dispatch_general/events/exportOutBoundItemEvent: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/events/importVolumeEvent: 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 /dispatch_general/events/exportVolumeEvent: 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 /dispatch_general/events/importVolumeDetailEvent: 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 /dispatch_general/events/exportVolumeDetailEvent: 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 /dispatch_general/events/importCheckinTaskEvent: 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 /dispatch_general/events/exportCheckinTaskEvent: 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 /dispatch_general/events/importOutBoundPickupEvent: 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 /dispatch_general/events/exportOutBoundPickupEvent: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/events/importOutBoundRemovedWaveEvent: 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 /dispatch_general/events/exportOutBoundRemovedWaveEvent: 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 /dispatch_general/events/importShipmentConfigurationEvent: 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 /dispatch_general/events/exportShipmentConfigurationEvent: 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 /dispatch_general/events/importShipmentConfigurationInWaveEvent: 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 /dispatch_general/events/exportShipmentConfigurationInWaveEvent: 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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/entities/e001pes: 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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/e001pes/{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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/wmsWarehouse: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/wmsWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/wmsWarehouse/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wmsWarehouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/wmsOwner: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/wmsOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/wmsOwner/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/wmsOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/wmsCarrying: 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/wmsCarrying 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/wmsCarrying/{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/wmsCarrying 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/productOwner: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/productOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/productOwner/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/productOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/packing: 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/packing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/packing/{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/packing 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/product: 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/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/product/{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/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/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 /dispatch_general/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 /dispatch_general/entities/dispatchSeparationWave: 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/dispatchSeparationWave responses: 200: description: The created resource schema: #/definitions/dispatchSeparationWave 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/dispatchSeparationWave responses: 200: description: The created resource schema: #/definitions/dispatchSeparationWave 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/dispatchSeparationWave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/dispatchSeparationWave/{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/editDispatchSeparationWave responses: 200: description: Ok schema: #/definitions/editDispatchSeparationWave 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/dispatchSeparationWave responses: 200: description: Ok schema: #/definitions/dispatchSeparationWave 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/dispatchSeparationWave 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 /dispatch_general/entities/dispatchSeparationWave/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dispatchSeparationWave responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/entities/outBoundItem: 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/outBoundItem responses: 200: description: The created resource schema: #/definitions/outBoundItem 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/outBoundItem responses: 200: description: The created resource schema: #/definitions/outBoundItem 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/outBoundItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/outBoundItem/{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/editOutBoundItem responses: 200: description: Ok schema: #/definitions/editOutBoundItem 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/outBoundItem responses: 200: description: Ok schema: #/definitions/outBoundItem 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/outBoundItem 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 /dispatch_general/entities/outBoundItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/entities/checkinTask: 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/checkinTask responses: 200: description: The created resource schema: #/definitions/checkinTask 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/checkinTask responses: 200: description: The created resource schema: #/definitions/checkinTask 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/checkinTask 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/checkinTask/{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/editCheckinTask responses: 200: description: Ok schema: #/definitions/editCheckinTask 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/checkinTask responses: 200: description: Ok schema: #/definitions/checkinTask 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/checkinTask 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 /dispatch_general/entities/checkinTask/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checkinTask responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/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 /dispatch_general/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 /dispatch_general/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 /dispatch_general/entities/outBoundRemovedWave: 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/outBoundRemovedWave responses: 200: description: The created resource schema: #/definitions/outBoundRemovedWave 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/outBoundRemovedWave responses: 200: description: The created resource schema: #/definitions/outBoundRemovedWave 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/outBoundRemovedWave 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dispatch_general/entities/outBoundRemovedWave/{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/editOutBoundRemovedWave responses: 200: description: Ok schema: #/definitions/editOutBoundRemovedWave 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/outBoundRemovedWave responses: 200: description: Ok schema: #/definitions/outBoundRemovedWave 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/outBoundRemovedWave 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 /dispatch_general/entities/outBoundRemovedWave/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outBoundRemovedWave responses: 200: description: The bulk creation has created resources 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 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 enumOutBoundSituation: type: string enum: – PENDING – RELEASE_IN_PROGRESS – RELEASE_REJECTED – RELEASED – IN_SHIPMENT – IN_SEPARATION – SEPARATED – IN_CHECKIN – CHECKED – IN_PICKUP – FINISHED – CANCELED description: Situação do Pedido de Expedição: * `PENDING` – Pendente * `RELEASE_IN_PROGRESS` – Liberação em Andamento * `RELEASE_REJECTED` – Liberação Rejeitada * `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 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 enumPickupSituation: type: string enum: – CREATED – RELEASED – IN_SHIPMENT – FINISHED – IN_REVERSE – CANCELED description: Situação da coleta: * `CREATED` – Criada * `RELEASED` – Liberada * `IN_SHIPMENT` – Em expedição * `FINISHED` – Finalizada * `IN_REVERSE` – Em estorno * `CANCELED` – Cancelada enumPlaceType: type: string enum: – PI – PB – PP – DC – BF – PA description: Tipo de Local de Armzenagem: * `PI` – Picking * `PB` – Pulmão Blocado * `PP` – Pulmão Paletizado * `DC` – Doca * `BF` – Buffer * `PA` – Packing enumBatchOrigin: type: string enum: – OR – RE – IV – SC description: Origem do Lote: * `OR` – Ordem de Recebimento * `RE` – Remanejamento * `IV` – Inventário * `SC` – Ajuste 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 enumCheckinTaskSituation: type: string enum: – CREATED – IN_CHECKIN – CHECKED – CANCELED description: Situação da Tarefa de Conferência: * `CREATED` – Criada * `IN_CHECKIN` – Em conferência * `CHECKED` – Conferida * `CANCELED` – Cancelada enumOutBoundDocumentType: type: string enum: – ORDER – INVOICE description: Tipo de documento do Pedido de Expedição: * `ORDER` – Pedido de venda * `INVOICE` – Nota fiscal enumVolumeSituation: type: string enum: – CREATED – IN_PROGRESS – FINISHED – CANCELED description: Situação do volume: * `CREATED` – Criado * `IN_PROGRESS` – Em andamento * `FINISHED` – Finalizado * `CANCELED` – Cancelado 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 enumConsumptionTypeStock: type: string enum: – COMPLETE – BALLAST – CLOSED_BOX description: Tipo de Consumo de Estoque: * `COMPLETE` – Palete Completo * `BALLAST` – Lastro * `CLOSED_BOX` – Caixa Fechada enumOrderFIFOBy: type: string enum: – RECEIVING_DATE – STORAGE_DATE description: Tipo de Ordenação de FIFO: * `RECEIVING_DATE` – Data de Recebimento * `STORAGE_DATE` – Data de Armazenagem enumPlaceTypePriority: type: string enum: – PL – PI – BF – AL description: Prioridade de Tipo de Local: * `PL` – Pulmão * `PI` – Picking * `BF` – Buffer * `AL` – Todos enumProductVisualizationType: type: string enum: – NONE – ONLY_PRODUCT – PRODUCT_AND_QUANTITY description: Permitir visualização dos produtos esperados para conferência de Saida: * `NONE` – Nenhum * `ONLY_PRODUCT` – Somente Produtos * `PRODUCT_AND_QUANTITY` – Produto e quantidade enumOutboundOrigin: type: string enum: – MANUAL – INTEGRATION description: Origem do cadastro do Pedido de Expedição: * `MANUAL` – Cadastro via tela * `INTEGRATION` – Cadastro via integração 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 recCreateWaveByOutBoundsResponse: description: Record – Retorno da criação da onda do pedido de expedição type: object required: – outBoundWaves – stockReservationId – shipmentConfigurationInWave properties: outBoundWaves: type: array items: type: object allOf: – #/definitions/outBoundWave minimum: 1 description: Ondo de separação dos pedidos de expedição stockReservationId: type: string description: Id da reserva de estoque shipmentConfigurationInWave: type: object allOf: – #/definitions/shipmentConfigurationInWave description: Dados da Configuração de Expedição utilizada na onda recWaveDocument: description: Record – Documento da onda type: object required: – documentId – documentNumber – ownerName – situation properties: documentId: type: string description: Id do documento documentNumber: type: string description: Número do documento invoiceNumber: type: integer format: int64 description: Número da nota fiscal invoiceSeries: type: string description: Série da nota fiscal issueDate: type: string format: date description: Data de Emissão da Nota Fiscal ownerName: type: string description: Nome do depositante pickupNumber: type: integer format: int64 description: Número da Coleta boardingDate: type: string format: date description: Data de embarque shippingDate: type: string format: date-time description: Data de expedição situation: type: string allOf: – #/definitions/enumOutBoundSituation description: Situação do documento separationOperation: 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 waveSeparationPendingPlace: description: Modelo de dados de retorno da consulta de locais com separações pendentes type: object required: – waveNumber – placeId properties: waveNumber: type: integer format: int64 description: Número da onda placeId: type: string description: ID do local 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: 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: wmsCarrying: description: Transportadora type: object properties: id: type: string format: uuid description: Identificador único sitTra: type: string allOf: – #/definitions/enumSitReg description: Situação da transportadora 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 code: type: string description: Código 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: productOwner: description: Depositantes vinculados ao produto type: object properties: id: type: string format: uuid description: Id da entidade product: type: object allOf: – #/definitions/product description: Produto wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante code: type: string description: Código do produto description: type: string description: Descrição do produto situation: type: string allOf: – #/definitions/enumSitReg description: Situação do produto controlShelfLife: type: string allOf: – #/definitions/enumControlShelfLife description: Tipo de controle de validade typeTerm: type: string allOf: – #/definitions/enumTypeTerm description: Tipo de prazo shelfLife: type: integer format: int64 description: Prazo de validade marketingPeriod: type: integer format: int64 description: Prazo de comercialização criticalDeadline: type: integer format: int64 description: Prazo crítico controlIndustrialBatch: type: boolean description: Controlar lote indústria excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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: 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: 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 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: 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: pickup: description: Coleta type: object required: – wmsWarehouse – situation properties: id: type: string format: uuid description: Identificador único number: type: integer format: int64 description: Número wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém licensePlate: type: string description: Placa driver: type: object allOf: – #/definitions/e001pes description: Motorista dock: type: object allOf: – #/definitions/place description: Doca observation: type: string maxLength: 500 description: Observação situation: type: string allOf: – #/definitions/enumPickupSituation description: Situação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 wmsCarrying: type: object allOf: – #/definitions/wmsCarrying description: Transportadora separationTaskReportFileName: type: string description: Nome do arquivo do relatório de separação destinationPlace: type: object allOf: – #/definitions/place description: Doca de destino createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDispatchSeparationWave: type: object required: – id allOf: – #/definitions/dispatchSeparationWave outBound: description: Pedido de expedição type: object required: – wmsWarehouse – wmsOwner – sender – receiver – 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 wmsCarrying: type: object allOf: – #/definitions/wmsCarrying description: Transportadora 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 outboundOrigin: type: string allOf: – #/definitions/enumOutboundOrigin description: Origem do cadastro do pedido de expedição 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 outboundConfirmationSent: type: boolean description: Confirmação de separação padrão já emitida default: false 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 outBoundItem: description: Item do pedido de expedição type: object required: – outBound – productOwner – packing – quantity properties: id: type: string format: uuid description: Identificador único outBound: type: object allOf: – #/definitions/outBound description: Pedido de expedição itemNumber: type: integer format: int64 description: Número do item productOwner: type: object allOf: – #/definitions/productOwner description: Produto packing: type: object allOf: – #/definitions/packing description: Embalagem quantity: type: number format: double description: Quantidade createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOutBoundItem: type: object required: – id allOf: – #/definitions/outBoundItem 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 – outBound properties: id: type: string format: uuid description: Identificador único wave: type: object allOf: – #/definitions/dispatchSeparationWave description: Onda outBound: type: object allOf: – #/definitions/outBound description: Pedido 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 volume: description: Volumes do Pedido de Expedição type: object required: – outBound – wave – barCode – volumeNumber – situation properties: id: type: string format: uuid description: Identificador único outBound: type: object allOf: – #/definitions/outBound description: Pedido de expedição pickup: type: object allOf: – #/definitions/pickup description: Coleta wave: type: object allOf: – #/definitions/dispatchSeparationWave description: Onda de separação barCode: type: string description: Código de barras volumeNumber: type: integer format: int64 description: Número do volume situation: type: string allOf: – #/definitions/enumVolumeSituation description: Situação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: volumeDetail: description: Detalhes do volume type: object required: – volume – batch – productOwner – quantity properties: id: type: string format: uuid description: Identificador único volume: type: object allOf: – #/definitions/volume description: Volume batch: type: object allOf: – #/definitions/batch description: Lote productOwner: type: object allOf: – #/definitions/productOwner description: Produto/Depositante quantity: type: number format: double description: Quantidade createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: checkinTask: description: Tarefa de Conferência type: object required: – identifier – wave – wmsWarehouse – originPlace – batch – outBound – productOwner – packing – quantity – 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 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 checkedQuantityUn: type: number format: double description: Quantidade conferida (UN) default: 0.0 situation: type: string allOf: – #/definitions/enumCheckinTaskSituation description: Situação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCheckinTask: type: object required: – id allOf: – #/definitions/checkinTask outBoundPickup: description: Vinculo da coleta com os pedidos de expedição type: object required: – pickup – outBound properties: id: type: string format: uuid description: Identificador único pickup: type: object allOf: – #/definitions/pickup description: Coleta outBound: type: object allOf: – #/definitions/outBound description: Pedido 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: 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 outBoundRemovedWave: description: Documentos removidos da onda type: object required: – wave – outBound properties: id: type: string format: uuid description: Identificador único wave: type: object allOf: – #/definitions/dispatchSeparationWave description: Onda outBound: type: object allOf: – #/definitions/outBound description: Pedido 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: editOutBoundRemovedWave: type: object required: – id allOf: – #/definitions/outBoundRemovedWave shipmentConfiguration: description: Configurações de Expedição type: object required: – tasksBySeparationZone properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código da Configuração description: type: string description: Descrição situation: type: string allOf: – #/definitions/enumSitReg description: Situação requestDockWhenCreatingWave: type: boolean description: Solicitar Doca na Criação da Onda default: true enumOrderFIFOBy: type: string allOf: – #/definitions/enumOrderFIFOBy description: Ordenação de FIFO por allowsBufferSepWithStageStock: type: boolean description: Permite Separação de Pulmão em Buffer priorityPlaceTypeBufferSep: type: string allOf: – #/definitions/enumPlaceTypePriority description: Prioridade de Tipo de Local em Busca de Estoque para Separação em Pulmão consumptionTypeStockBufferSep: type: string allOf: – #/definitions/enumConsumptionTypeStock description: Tipo de Palete para Separação de Pulmão allowsPickingSepInStageStock: type: boolean description: Permite Separação de Picking em Buffer priorityPlaceTypePickingSep: type: string allOf: – #/definitions/enumPlaceTypePriority description: Prioridade de Tipo de Local em Busca de Estoque para Separação em Picking allowsReplenishWithStageStock: type: boolean description: Permite Reabastecer com Estoque de Buffer priorityPlaceTypeReplenish: type: string allOf: – #/definitions/enumPlaceTypePriority description: Prioridade de Tipo de Local em Busca de Estoque para Reabastecimento consumptionTypeStockReplenish: type: string allOf: – #/definitions/enumConsumptionTypeStock description: Tipo de Palete para busca de estoque para reabastecimento de picking productVisualizationType: type: string allOf: – #/definitions/enumProductVisualizationType description: Parâmetro para permitir visualização dos produtos de saida tasksBySeparationZone: type: boolean description: Tarefas por Zona 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: shipmentConfigurationInWave: description: Configurações de Expedição type: object required: – dispatchSeparationWave – shipmentConfiguration – tasksBySeparationZone properties: id: type: string format: uuid description: Identificador único dispatchSeparationWave: type: object allOf: – #/definitions/dispatchSeparationWave description: Onda shipmentConfiguration: type: object allOf: – #/definitions/shipmentConfiguration description: Configuração de Expedição code: type: integer format: int64 description: Código da Configuração description: type: string description: Descrição situation: type: string allOf: – #/definitions/enumSitReg description: Situação requestDockWhenCreatingWave: type: boolean description: Solicitar Doca na Criação da Onda default: true enumOrderFIFOBy: type: string allOf: – #/definitions/enumOrderFIFOBy description: Ordenação de FIFO por allowsBufferSepWithStageStock: type: boolean description: Permite Separação de Pulmão em Buffer priorityPlaceTypeBufferSep: type: string allOf: – #/definitions/enumPlaceTypePriority description: Prioridade de Tipo de Local em Busca de Estoque para Separação em Pulmão consumptionTypeStockBufferSep: type: string allOf: – #/definitions/enumConsumptionTypeStock description: Tipo de Palete para Separação de Pulmão allowsPickingSepInStageStock: type: boolean description: Permite Separação de Picking em Buffer priorityPlaceTypePickingSep: type: string allOf: – #/definitions/enumPlaceTypePriority description: Prioridade de Tipo de Local em Busca de Estoque para Separação em Picking allowsReplenishWithStageStock: type: boolean description: Permite Reabastecer com Estoque de Buffer priorityPlaceTypeReplenish: type: string allOf: – #/definitions/enumPlaceTypePriority description: Prioridade de Tipo de Local em Busca de Estoque para Reabastecimento consumptionTypeStockReplenish: type: string allOf: – #/definitions/enumConsumptionTypeStock description: Tipo de Palete para busca de estoque para reabastecimento de picking productVisualizationType: type: string allOf: – #/definitions/enumProductVisualizationType description: Parâmetro para permitir visualização dos produtos de saida tasksBySeparationZone: type: boolean description: Tarefas por Zona 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: 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