WMS-X Receiving General (general)

2.0info: 1.1.0 WMS-X Receiving General description: Serviço Foundation recebimento do WMS-X x-senior-domain: Recebimento WMS-X x-senior-domain-path: wmsx_receiving x-senior-service-path: 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_receivingsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /general/queries/listLinkSectorReceivingType: post: description: Listar o vinculo do tipo de recebimento ao setor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sectorId properties: sectorId: type: string description: Id do Setor receivingTypeDescription: type: string description: Descrição do tipo de recebimento globalFilter: type: string description: Filtro de pesquisa global offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 sort: type: string description: Ordenação por campos order: type: string description: Direção da ordenação do campos responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/sectorReceivingType minimum: 1 description: Lista de Tipos de Recebimento Vinculados ou não ao Setor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar o vinculo do tipo de recebimento ao setor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: sectorId description: Id do Setor in: query required: true type: string – name: receivingTypeDescription description: Descrição do tipo de recebimento in: query type: string – name: globalFilter description: Filtro de pesquisa global in: query 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: sort description: Ordenação por campos in: query type: string – name: order description: Direção da ordenação do campos in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/sectorReceivingType minimum: 1 description: Lista de Tipos de Recebimento Vinculados ou não ao Setor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listLinkReceivingTypeOwner: post: description: Listar vínculos de tipo de recebimento com depositante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – receivingTypeId properties: receivingTypeId: type: string description: Id do Tipo de Recebimento ownerPersonCnpCpf: type: string description: CNPJ/CPF do depositante ownerPersonName: type: string description: Nome fantasia do depositante globalFilter: type: string description: Filtro de pesquisa global offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 sort: type: string description: Ordenação por campos order: type: string description: Direção da ordenação do campos responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/receivingTypeOwner minimum: 1 description: Lista de Depositantes vinculados ou não ao Tipo de Recebimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar vínculos de tipo de recebimento com depositante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: receivingTypeId description: Id do Tipo de Recebimento in: query required: true type: string – name: ownerPersonCnpCpf description: CNPJ/CPF do depositante in: query type: string – name: ownerPersonName description: Nome fantasia do depositante in: query type: string – name: globalFilter description: Filtro de pesquisa global in: query 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: sort description: Ordenação por campos in: query type: string – name: order description: Direção da ordenação do campos in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/receivingTypeOwner minimum: 1 description: Lista de Depositantes vinculados ou não ao Tipo de Recebimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listReceivingTypeByWmsOwner: post: description: Lista tipos de recebimento vinculados ao depositante informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – wmsOwnerId properties: wmsOwnerId: type: string description: Id do depositante description: type: string description: Descrição do tipo de recebimento offset: type: integer format: int64 description: Numero da página default: 0 sort: type: string description: Ordenação por campos order: type: string description: Direção da ordenação do campos responses: 200: description: Ok schema: type: object required: – totalElements – totalPages 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/receivingType description: Lista de Depositantes vinculados ao Tipo de Recebimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista tipos de recebimento vinculados ao depositante informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: wmsOwnerId description: Id do depositante in: query required: true type: string – name: description description: Descrição do tipo de recebimento in: query type: string – name: offset description: Numero da página in: query type: integer format: int64 – name: sort description: Ordenação por campos in: query type: string – name: order description: Direção da ordenação do campos in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – totalPages 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/receivingType description: Lista de Depositantes vinculados ao Tipo de Recebimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getOrderReceiving: post: description: Obter a Ordem de Recebimento para edição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingId properties: orderReceivingId: type: string description: Id da Ordem de Recebimento responses: 200: description: Ok schema: type: object required: – orderReceiving properties: orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento documents: type: array items: type: object allOf: – #/definitions/recReceivingDocument description: Documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter a Ordem de Recebimento para edição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: orderReceivingId description: Id da Ordem de Recebimento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – orderReceiving properties: orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento documents: type: array items: type: object allOf: – #/definitions/recReceivingDocument description: Documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getOrderReceivingManagerRecords: post: description: Obter registros para Gerenciador de Ordem de Recebimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtro de pesquisa offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 sort: type: string description: Ordenação por campos order: type: string description: Direção da ordenação do campos responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/orderReceivingTableRecord minimum: 1 description: Dados para apresentação na table do Gerenciador de Or 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter registros para Gerenciador de Ordem de Recebimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtro de pesquisa in: query 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: sort description: Ordenação por campos in: query type: string – name: order description: Direção da ordenação do campos in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/orderReceivingTableRecord minimum: 1 description: Dados para apresentação na table do Gerenciador de Or 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getOrderReceivingManagerDocumentsRecords: post: description: Obter Documentos vinculados à Ordem de Recebimento informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingID properties: orderReceivingID: type: string description: Filtro de pesquisa 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 por 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/recReceivingDocument minimum: 1 description: Dados para apresentação na table do Documentos viculados à Or 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter Documentos vinculados à Ordem de Recebimento informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: orderReceivingID description: Filtro de pesquisa 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 por 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/recReceivingDocument minimum: 1 description: Dados para apresentação na table do Documentos viculados à Or 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getOrderReceivingManagerSummaryRecords: post: description: Obter Resumo da OR para Ordem de Recebimento informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingID properties: orderReceivingID: type: string description: Filtro de pesquisa 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 por 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/recCheckinResume minimum: 1 description: Dados para apresentação na table do Documentos viculados à Or 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter Resumo da OR para Ordem de Recebimento informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: orderReceivingID description: Filtro de pesquisa 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 por 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/recCheckinResume minimum: 1 description: Dados para apresentação na table do Documentos viculados à Or 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listOrderReceivingDetails: post: description: Lista detalhes da OR com detalhes dos documentos associados a conferência e lotes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingNumbers properties: orderReceivingNumbers: type: array items: type: integer format: int64 minimum: 1 description: Filtro por Número de Recebimento responses: 200: description: Ok schema: type: object required: – totalElements properties: totalElements: type: integer format: int64 description: Número de elementos na lista contents: type: array items: type: object allOf: – #/definitions/recOrderReceivingDetails description: Dados para apresentação na table do Documentos viculados à Or 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/listReceivingDocuments: post: description: Lista documentos de entrada vinculados ou não a recebimentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – warehouseId properties: warehouseId: type: string description: Armazém wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante number: type: string description: Número do Documento sequence: type: string description: Série accessKey: type: string description: Chave da Nota Fiscal wmsVendor: type: object allOf: – #/definitions/wmsVendor description: Fornecedor documentDate: type: string format: date description: Data do Documento situation: type: string allOf: – #/definitions/enumDocumentSituation description: Situação do Documento processingDate: type: string format: date description: Data de Processamento orderReceivingNumber: type: integer format: int64 description: Ordem de Recebimento documentOrigin: type: string allOf: – #/definitions/enumDocumentOrigin description: Tipo de Entrada do Documento offset: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 sort: type: string description: Ordenação por campos order: type: string description: Direção da ordenação do campos responses: 200: description: Ok schema: type: object required: – totalElements – totalPages 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/recReceivingDocumentSummary description: Dados para apresentação na tabela de listagem de documentos de entrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getReceivingDocumentRecord: post: description: Endpoint para buscar o documento de entrada junto com os itens associados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – receivingDocumentId properties: receivingDocumentId: type: string description: ID do documento de entrada responses: 200: description: Ok schema: type: object properties: document: type: object allOf: – #/definitions/recReceivingDocument description: Documento de entrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint para buscar o documento de entrada junto com os itens associados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: receivingDocumentId description: ID do documento de entrada in: query required: true type: string responses: 200: description: Ok schema: type: object properties: document: type: object allOf: – #/definitions/recReceivingDocument description: Documento de entrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/getReceivingDocumentsOrigin: post: description: Endpoint para retornar os tipos de cadastro dos documentos de uma OR tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingId properties: orderReceivingId: type: string description: Id da ordem de recebimento responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/recReceivingDocumentOrigin description: Dados do tipo de cadastro dos documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint para retornar os tipos de cadastro dos documentos de uma OR tags: – Queries x-senior-visibility: PRIVATE parameters: – name: orderReceivingId description: Id da ordem de recebimento in: query required: true type: string responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/recReceivingDocumentOrigin description: Dados do tipo de cadastro dos documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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 /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 /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 /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 /general/queries/exportWmsVendor: 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 /general/queries/exportSector: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/queries/exportReceivingType: 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 /general/queries/exportReceivingTypeOwner: 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 /general/queries/exportSectorReceivingType: 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 /general/queries/exportOrderReceiving: 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 /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 /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 /general/queries/exportReceivingDocument: 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 /general/queries/exportReceivingDocumentItem: 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 /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 /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 /general/queries/exportCheckin: 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 /general/queries/exportCheckinItem: 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 /general/queries/exportCheckinResume: 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 /general/queries/exportAllocationBatch: 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 /general/queries/exportReceivingOrderDetailsView: 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 /general/queries/exportSectorOwner: 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 /general/queries/exportSectorProduct: 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 /general/queries/exportOrderReceivingView: 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 /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 /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 /general/actions/saveOrderReceiving: post: description: Cadastrar Ordem de Recebimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceiving properties: orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento documents: type: array items: type: object allOf: – #/definitions/recReceivingDocument description: Documentos documentsIdToRemove: type: array items: type: string description: Documentos para remover itemsIdToRemove: type: array items: type: string description: Itens para remover responses: 200: description: Ok schema: type: object required: – orderReceiving properties: orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/cancelOrderReceiving: post: description: Cancelar Ordem de Recebimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingId properties: orderReceivingId: type: string description: Id da Ordem de Recebimento responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorna se houve sucesso ao cancelar a OR message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/printStorageBatchLabel: post: description: Imprimir etiqueta de lotes de armazenagem tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingId properties: orderReceivingId: type: string description: Id da Ordem de Recebimento responses: 200: description: Ok schema: type: object required: – success – message – url properties: success: type: boolean description: Retorna se houve sucesso ao imprimir a etiqueta message: type: string description: Mensagem url: type: string description: URL para download da etiqueta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/integrateOrderReceiving: post: description: Integrar Ordem Recebimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – warehouse – shipmentType – owner properties: warehouse: type: string description: Código do Armazém receivingDate: type: string format: date description: Data do Recebimento ou data atual se não informada shipmentType: type: string description: Código do Tipo Recebimento owner: type: string description: Código Depositante unloadingDock: type: string description: Endereço da Doca modal: type: string allOf: – #/definitions/enumTransportModel description: Modal de Transporte (Caso não informado, assume o default (Rodoviário) licensePlate: type: string description: Placa do Veículo do WMS a ser utilizado na OR carrying: type: string description: Código da Transportadora observation: type: string maxLength: 500 description: Comentários da Ordem Recebimento documents: type: array items: type: object allOf: – #/definitions/recIntegrateDocument description: Lista de Documentos a serem cadastrados e atribuídos à OR responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/unlinkDocumentsFromOr: post: description: Desvincula uma lista de documentos de uma OR tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – orderReceivingId – receivingDocumentIds properties: orderReceivingId: type: string description: Id da Ordem de Recebimento receivingDocumentIds: type: array items: type: string minimum: 1 description: Lista de documentos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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 /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 /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 /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 /general/actions/importWmsVendor: 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 /general/actions/importSector: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/actions/importReceivingType: 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 /general/actions/importReceivingTypeOwner: 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 /general/actions/importSectorReceivingType: 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 /general/actions/importOrderReceiving: 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 /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 /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 /general/actions/importReceivingDocument: 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 /general/actions/importReceivingDocumentItem: 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 /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 /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 /general/actions/importCheckin: 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 /general/actions/importCheckinItem: 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 /general/actions/importCheckinResume: 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 /general/actions/importAllocationBatch: 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 /general/actions/importReceivingOrderDetailsView: 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 /general/actions/importSectorOwner: 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 /general/actions/importSectorProduct: 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 /general/actions/importOrderReceivingView: 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 /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 /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 /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 /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 /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 /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 /general/events/importWmsVendorEvent: 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 /general/events/exportWmsVendorEvent: 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 /general/events/importSectorEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/exportSectorEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /general/events/importReceivingTypeEvent: 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 /general/events/exportReceivingTypeEvent: 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 /general/events/importReceivingTypeOwnerEvent: 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 /general/events/exportReceivingTypeOwnerEvent: 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 /general/events/importSectorReceivingTypeEvent: 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 /general/events/exportSectorReceivingTypeEvent: 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 /general/events/importOrderReceivingEvent: 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 /general/events/exportOrderReceivingEvent: 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 /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 /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 /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 /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 /general/events/importReceivingDocumentEvent: 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 /general/events/exportReceivingDocumentEvent: 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 /general/events/importReceivingDocumentItemEvent: 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 /general/events/exportReceivingDocumentItemEvent: 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 /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 /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 /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 /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 /general/events/importCheckinEvent: 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 /general/events/exportCheckinEvent: 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 /general/events/importCheckinItemEvent: 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 /general/events/exportCheckinItemEvent: 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 /general/events/importCheckinResumeEvent: 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 /general/events/exportCheckinResumeEvent: 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 /general/events/importAllocationBatchEvent: 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 /general/events/exportAllocationBatchEvent: 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 /general/events/importReceivingOrderDetailsViewEvent: 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 /general/events/exportReceivingOrderDetailsViewEvent: 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 /general/events/importSectorOwnerEvent: 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 /general/events/exportSectorOwnerEvent: 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 /general/events/importSectorProductEvent: 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 /general/events/exportSectorProductEvent: 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 /general/events/importOrderReceivingViewEvent: 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 /general/events/exportOrderReceivingViewEvent: 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 /general/apis/linkSectorReceivingType: post: description: Vincular Setor aos Tipos de Recebimento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/linkSectorReceivingTypeFacade responses: 200: description: Ok schema: #/definitions/linkSectorReceivingTypeFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/linkReceivingTypeOwner: post: description: Vincular Tipo de Recebimento ao Depositante tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/linkReceivingTypeOwnerFacade responses: 200: description: Ok schema: #/definitions/linkReceivingTypeOwnerFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/apis/importReceivingDocument: post: description: Importação Documento de Entrada tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/importReceivingDocumentFacadeInput responses: 200: description: Ok schema: #/definitions/importReceivingDocumentFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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 /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 /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 /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 /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 /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 /general/entities/wmsVendor: 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/wmsVendor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/wmsVendor/{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/wmsVendor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/sector: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/sector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/sector/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sector 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/receivingType: 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/receivingType responses: 200: description: The created resource schema: #/definitions/receivingType 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/receivingType responses: 200: description: The created resource schema: #/definitions/receivingType 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/receivingType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/receivingType/{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/editReceivingType responses: 200: description: Ok schema: #/definitions/editReceivingType 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/receivingType responses: 200: description: Ok schema: #/definitions/receivingType 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/receivingType 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 /general/entities/receivingType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/receivingType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/receivingTypeOwner: 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/receivingTypeOwner responses: 200: description: The created resource schema: #/definitions/receivingTypeOwner 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/receivingTypeOwner responses: 200: description: The created resource schema: #/definitions/receivingTypeOwner 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/receivingTypeOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/receivingTypeOwner/{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/editReceivingTypeOwner responses: 200: description: Ok schema: #/definitions/editReceivingTypeOwner 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/receivingTypeOwner responses: 200: description: Ok schema: #/definitions/receivingTypeOwner 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/receivingTypeOwner 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 /general/entities/receivingTypeOwner/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/receivingTypeOwner responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/sectorReceivingType: 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/sectorReceivingType responses: 200: description: The created resource schema: #/definitions/sectorReceivingType 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/sectorReceivingType responses: 200: description: The created resource schema: #/definitions/sectorReceivingType 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/sectorReceivingType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/sectorReceivingType/{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/editSectorReceivingType responses: 200: description: Ok schema: #/definitions/editSectorReceivingType 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/sectorReceivingType responses: 200: description: Ok schema: #/definitions/sectorReceivingType 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/sectorReceivingType 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 /general/entities/sectorReceivingType/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sectorReceivingType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/orderReceiving: 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/orderReceiving responses: 200: description: The created resource schema: #/definitions/orderReceiving 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/orderReceiving responses: 200: description: The created resource schema: #/definitions/orderReceiving 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/orderReceiving 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/orderReceiving/{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/editOrderReceiving responses: 200: description: Ok schema: #/definitions/editOrderReceiving 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/orderReceiving responses: 200: description: Ok schema: #/definitions/orderReceiving 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/orderReceiving 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 /general/entities/orderReceiving/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/orderReceiving responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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 /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 /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 /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 /general/entities/receivingDocument: 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/receivingDocument responses: 200: description: The created resource schema: #/definitions/receivingDocument 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/receivingDocument responses: 200: description: The created resource schema: #/definitions/receivingDocument 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/receivingDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/receivingDocument/{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/editReceivingDocument responses: 200: description: Ok schema: #/definitions/editReceivingDocument 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/receivingDocument responses: 200: description: Ok schema: #/definitions/receivingDocument 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/receivingDocument 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 /general/entities/receivingDocument/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/receivingDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/receivingDocumentItem: 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/receivingDocumentItem responses: 200: description: The created resource schema: #/definitions/receivingDocumentItem 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/receivingDocumentItem responses: 200: description: The created resource schema: #/definitions/receivingDocumentItem 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/receivingDocumentItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/receivingDocumentItem/{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/editReceivingDocumentItem responses: 200: description: Ok schema: #/definitions/editReceivingDocumentItem 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/receivingDocumentItem responses: 200: description: Ok schema: #/definitions/receivingDocumentItem 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/receivingDocumentItem 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 /general/entities/receivingDocumentItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/receivingDocumentItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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 /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 /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 /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 /general/entities/allocationBatch: 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/allocationBatch responses: 200: description: The created resource schema: #/definitions/allocationBatch 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/allocationBatch responses: 200: description: The created resource schema: #/definitions/allocationBatch 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/allocationBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/allocationBatch/{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/editAllocationBatch responses: 200: description: Ok schema: #/definitions/editAllocationBatch 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/allocationBatch responses: 200: description: Ok schema: #/definitions/allocationBatch 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/allocationBatch 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 /general/entities/allocationBatch/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/allocationBatch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/sectorOwner: 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/sectorOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/sectorOwner/{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/sectorOwner 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/sectorProduct: 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/sectorProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/sectorProduct/{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/sectorProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /general/entities/orderReceivingView: 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/orderReceivingView 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 enumTransportModel: type: string enum: – ROAD – RAILWAY – AIR description: Modelo de Trasnsporte: * `ROAD` – Rodoviário * `RAILWAY` – Ferroviário * `AIR` – Aéreo enumTypeTerm: type: string enum: – VM – VD description: Tipo de prazo: * `VM` – Meses * `VD` – Dias enumControlShelfLife: type: string enum: – VN – VV – VF – VVF description: Controle de validade: * `VN` – Não controla * `VV` – Coleta vencimento * `VF` – Coleta fabricação * `VVF` – Coleta vencimento e fabricação enumOrderReceivingSituation: type: string enum: – CREATED – CHECKIN_IN_PROGRESS – CHECKIN_COMPLETED – CHECKIN_COMPLETED_WITH_DIVERGENCE – GENERATED_BATCH – AWAITING_ALLOCATION – COMPLETED_ALLOCATION – CANCELED description: Status da Ordem de Recebimento: * `CREATED` – Criada * `CHECKIN_IN_PROGRESS` – Em Conferência * `CHECKIN_COMPLETED` – Conferência Concluída * `CHECKIN_COMPLETED_WITH_DIVERGENCE` – Conferência Concluída com Divergência * `GENERATED_BATCH` – Lote Gerado * `AWAITING_ALLOCATION` – Aguardando Alocação * `COMPLETED_ALLOCATION` – Alocação Concluída * `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 enumDocumentSituation: type: string enum: – CREATED – IN_ORDER_RECEIVING – CANCELED description: Situação do Documento de Entrada: * `CREATED` – Criado * `IN_ORDER_RECEIVING` – Em Ordem de Recebimento * `CANCELED` – Cancelado enumProductSituation: type: string enum: – GOOD – DAMAGED – EXPIRED – TRUNCATED description: Situação do Produto: * `GOOD` – Bom * `DAMAGED` – Danificado * `EXPIRED` – Vencido * `TRUNCATED` – Truncado enumQuantityCheckinType: type: string enum: – QUANTITY – BALLAST_AND_LAYER description: Tipo de Conferência: * `QUANTITY` – Quantidade * `BALLAST_AND_LAYER` – Lastro e Camada 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 enumReceivingBlockRule: type: string enum: – ALLOW – BLOCK_ON_CHECKIN – BLOCK_ON_CHECKIN_RELEASE description: Regra de bloqueio de recebimento: * `ALLOW` – Permite o recebimento * `BLOCK_ON_CHECKIN` – Bloqueia na conferência * `BLOCK_ON_CHECKIN_RELEASE` – Bloqueia na liberação da conferência enumCheckinSituation: type: string enum: – IN_PROGRESS – COMPLETED description: Situação da Conferência: * `IN_PROGRESS` – Em andamento * `COMPLETED` – Finalizada enumCheckinItemSituation: type: string enum: – NOT_RELEASED – RELEASED – IGNORED description: Situação do Item da Conferência: * `NOT_RELEASED` – Não Liberada * `RELEASED` – Liberada * `IGNORED` – Ignorada enumDocumentOrigin: type: string enum: – MANUAL – MANUAL_OR – XML – INTEGRATION description: Tipo de cadastro/origem do documento de entrada: * `MANUAL` – Cadastro Manual * `MANUAL_OR` – Cadastro via OR * `XML` – XML Danfe * `INTEGRATION` – Integração enumSideBuildingType: type: string enum: – ALL – EVEN – ODD description: Tipo do Lado de Prédio: * `ALL` – Todos os lados * `EVEN` – Lados pares * `ODD` – Lados ímpares enumPlaceBlockOperation: type: string enum: – MB – GI description: Operações de bloqueio de local: * `MB` – Bloqueio manual * `GI` – Inventário Geral 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 orderReceivingTableRecord: description: Modelo de dados para exibição no Gerenciador de OR type: object required: – orderReceivingId – orderReceivingNumber – orderReceivingSituation – orderReceivingWmsOwner – orderReceivingReceivingTypeDescription – orderReceivingReceivingDate – orderReceivingWmsCarrying – orderReceivingDock – orderReceivingDocuments properties: orderReceivingId: type: string description: Id da Ordem de Recebimento orderReceivingNumber: type: integer format: int64 description: Número da Ordem de Recebimento orderReceivingSituation: type: string allOf: – #/definitions/enumOrderReceivingSituation description: Status da Ordem de Recebimento orderReceivingWmsOwner: type: string description: Depositante da Ordem de Recebimento orderReceivingReceivingTypeDescription: type: string description: Descrição do tipo de recebimento da Ordem de Recebimento orderReceivingReceivingDate: type: string format: date description: Data de recebimento da Ordem de Recebimento orderReceivingWmsCarrying: type: string description: Transportadora da Ordem de Recebimento orderReceivingDock: type: string description: Doca de recebimento da Ordem de Recebimento orderReceivingDocuments: type: string description: Documentos vinculados à Ordem de Recebimento exportConfirmationOrderReceiving: type: boolean description: Confirmação de exportação da ordem de recebimento recReceivingDocument: description: Documento Ordem de Recebimento – Record type: object required: – document properties: document: type: object allOf: – #/definitions/receivingDocument description: Documento items: type: array items: type: object allOf: – #/definitions/receivingDocumentItem description: Itens recCheckinResume: description: Modelo de dados para exibição de Detalhes de OR no Gerenciador de OR type: object required: – orderReceiving – productOwner – packing – expectedQuantity – checkedQuantity – goodQuantity – damagedQuantity – expiredQuantity – truncatedQuantity properties: orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento productOwner: type: object allOf: – #/definitions/productOwner description: Produto Depositante packing: type: object allOf: – #/definitions/packing description: Embalagem expectedQuantity: type: number format: double description: Quantidade Esperada checkedQuantity: type: number format: double description: Quantidade Conferida goodQuantity: type: number format: double description: Quantidade Boa damagedQuantity: type: number format: double description: Quantidade Danificada expiredQuantity: type: number format: double description: Quantidade Vencida truncatedQuantity: type: number format: double description: Quantidade Truncada recIntegrateDocument: description: Modelo de dados para integração de documentos de uma OR type: object required: – supplier – documentId – documentDate properties: supplier: type: string description: Código do Fornecedor productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto documentId: type: string description: ID Documento documentSeries: type: string description: Serie Documento documentDate: type: string format: date description: Data do Documento items: type: array items: type: object allOf: – #/definitions/recIntegrateDocumentItem description: Items do Documento recIntegrateDocumentItem: description: Modelo de dados para integração de documentos de uma OR type: object required: – product – expectedQuantity properties: product: type: string description: Código do Produto productPackaging: type: string description: Emabalagem do Produto, quando não informado pega qualquer barra com fator 1 uom: type: string description: Unidade de Medida Ex: UN, PC, KG, etc expectedQuantity: type: integer format: int64 description: Quantidade esperada na embalagem do produto minimum: 0 recOrderReceivingDetails: description: Detalhes da ordem de recebimento type: object required: – orderReceivingId – orderReceivingNumber – warehouseId – warehouseCode – ownerId – ownerCode – orderSituation properties: orderReceivingId: type: string description: Ordem de Recebimento orderReceivingNumber: type: integer format: int64 description: Número da Ordem de Recebimento warehouseId: type: string description: Identificador do Armazém warehouseCode: type: string description: Código de Integração do Armazém ownerId: type: string description: Identificador do Depositante ownerCode: type: string description: Código de Integração do Depositante orderSituation: type: string allOf: – #/definitions/enumOrderReceivingSituation description: Situação do OR documents: type: array items: type: object allOf: – #/definitions/recOrderReceivingDetailsDocument description: Documentos da OR recOrderReceivingDetailsDocument: description: Detalhes da ordem de recebimento – Documentos type: object required: – documentNumber – documentSerie – vendorId – vendorCode properties: documentNumber: type: string description: Número do Documento documentSerie: type: string description: Série do Documento vendorId: type: string description: ID do Fornecedor vendorCode: type: string description: Código Integração do Fornecedor items: type: array items: type: object allOf: – #/definitions/recOrderReceivingDetailsDocumentItem description: Itens do Documento recOrderReceivingDetailsDocumentItem: description: Detalhes da ordem de recebimento – Item do Documento type: object required: – productId – productDescription – productCode – productSituation – quantity – weight properties: documentItem: type: integer format: int64 description: Número Item do Documento se associado productId: type: string description: Id do produto productDescription: type: string description: Descrição do Produto productCode: type: string description: Código do produto para sistema externo productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do Produto ex: GOOD, DAMAGE, EXPIRED, etc industrialBatch: type: string description: Lote industria expirationDate: type: string format: date description: Data de expiração fabricationDate: type: string format: date description: Data de Fabricação quantity: type: number format: double description: Quantidade weight: type: integer format: int64 description: Peso Total recReceivingDocumentSummary: description: Modelo de dados para listagem de documentos de entrada type: object required: – id – number – situation – documentDate – wmsOwner – wmsVendor – documentOrigin – quantityItems – quantityLines properties: id: type: string description: ID do documento number: type: string description: Número do documento sequence: type: string description: Série situation: type: string allOf: – #/definitions/enumDocumentSituation description: Situação do Documento documentDate: type: string format: date description: Data do Documento processingDate: type: string format: date description: Data de Processamento processingUser: type: string description: Usuário do Processamento wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante wmsVendor: type: object allOf: – #/definitions/wmsVendor description: Fornecedor accessKey: type: string description: Chave da Nota Fiscal documentOrigin: type: string allOf: – #/definitions/enumDocumentOrigin description: Tipo de Cadastro quantityItems: type: integer format: int64 description: Quantidade de Itens quantityLines: type: integer format: int64 description: Quantidade de Linhas orderReceivingNumber: type: integer format: int64 description: Número da OR orderReceivingSituation: type: string allOf: – #/definitions/enumOrderReceivingSituation description: Situação da OR recReceivingDocumentOrigin: description: Modelo de dados que identifica o tipo de cadastro de um documento de entrada type: object required: – id – documentOrigin properties: id: type: string description: Id do documento documentOrigin: type: string allOf: – #/definitions/enumDocumentOrigin description: Tipo de cadastro wmsWarehouse: description: Armazém type: object required: – warehouseSituation 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 required: – ownerSituation properties: id: type: string format: uuid description: Identificador único ownerSituation: type: string allOf: – #/definitions/enumSitReg description: Situação codPes: type: integer format: int64 description: Código nomPes: type: string description: Nome apePes: type: string description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string description: CNPJ/CPF numRge: type: string description: Número do RG datRge: type: string format: date description: Data de emissão do RG orgRge: type: string description: Órgão emissor do RG insEst: type: string description: Inscrição estadual insMun: type: string description: Inscrição municipal regime: type: string allOf: – #/definitions/enumRegime description: Regime de Armazenagem code: type: string description: Código do Depositante para Integração excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: wmsCarrying: description: Transportadora type: object required: – sitTra 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: wmsVendor: description: Fornecedor type: object required: – sitFor properties: id: type: string format: uuid description: Identificador único sitFor: type: string allOf: – #/definitions/enumSitReg description: Situação do fornecedor 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: sector: description: Setor type: object required: – situation properties: id: type: string format: uuid description: Identificador único code: type: string maxLength: 20 description: Código integrationCode: type: string description: Código de integração description: type: string maxLength: 100 description: Descrição good: type: boolean description: Bom damaged: type: boolean description: Danificado expired: type: boolean description: Vencido truncated: type: boolean description: Truncado picking: type: boolean description: Picking bufferStock: type: boolean description: Pulmão buffer: type: boolean description: Buffer wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém situation: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: receivingType: description: Tipo de Recebimento type: object required: – description – supervisorAuthDivergence – situation – maxCheckIn – receivingBufferAllocation – quantityCheckinType – allowOverReceiving – allowUnderReceiving – allowUnexpectedProduct properties: id: type: string format: uuid description: Id code: type: string description: Código Recebimento description: type: string description: Descrição supervisorAuthDivergence: type: boolean description: Apenas o supervisor pode liberar contagens divergentes situation: type: string allOf: – #/definitions/enumSitReg description: Situação maxCheckIn: type: integer format: int64 description: Máximo de Conferência de Entrada receivingBufferAllocation: type: boolean description: Alocação em buffer de recebimento quantityCheckinType: type: string allOf: – #/definitions/enumQuantityCheckinType description: Tipo de Conferência allowOverReceiving: type: string allOf: – #/definitions/enumReceivingBlockRule description: Permite recebimento a maior allowUnderReceiving: type: string allOf: – #/definitions/enumReceivingBlockRule description: Permite recebimento a menor allowUnexpectedProduct: type: string allOf: – #/definitions/enumReceivingBlockRule description: Permite recebimento de produto não esperado startWorkflowProcessAfterConfirmation: type: boolean description: Iniciar um Fluxo de Processo BPM após confirmação do recebimento workflowProcessId: type: integer format: int64 description: Identificação do Fluxo BPM workflowRequestTitle: type: string maxLength: 255 description: Título da Solicitação Processo Workflow createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editReceivingType: type: object required: – id allOf: – #/definitions/receivingType receivingTypeOwner: description: Depositantes vinculados ao tipo de recebimento type: object required: – receivingType – wmsOwner properties: id: type: string format: uuid description: Id da entidade receivingType: type: object allOf: – #/definitions/receivingType description: Tipo de recebimento wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editReceivingTypeOwner: type: object required: – id allOf: – #/definitions/receivingTypeOwner sectorReceivingType: description: Tipos de Recebimento Vinculados ao Setor type: object required: – sector – receivingType properties: id: type: string format: uuid description: Id da entidade sector: type: object allOf: – #/definitions/sector description: Setor receivingType: type: object allOf: – #/definitions/receivingType description: Tipo de Recebimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editSectorReceivingType: type: object required: – id allOf: – #/definitions/sectorReceivingType orderReceiving: description: Ordem de Recebimento type: object required: – wmsWarehouse – receivingType – receivingDate – situation – wmsOwner – dock – violatedProduct – openProduct – brokenProduct properties: id: type: string format: uuid description: Identificador único number: type: integer format: int64 description: Número da OR wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém receivingType: type: object allOf: – #/definitions/receivingType description: Tipo de recebimento receivingDate: type: string format: date description: Data de recebimento situation: type: string allOf: – #/definitions/enumOrderReceivingSituation description: Situação wmsCarrying: type: object allOf: – #/definitions/wmsCarrying description: Transportadora wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante dock: type: object allOf: – #/definitions/place description: Doca licensePlate: type: string description: Placa modal: type: string allOf: – #/definitions/enumTransportModel description: Modal de transporte observation: type: string maxLength: 500 description: Observação violatedProduct: type: boolean description: Produto violado openProduct: type: boolean description: Produto aberto brokenProduct: type: boolean description: Produto quebrado hasDivergence: type: boolean description: Existe divergência na conferência releasedWithDivergenceBy: type: string description: Liberado por releasedWithDivergenceDate: type: string format: date-time description: Liberado em storageBatchLabelFileName: type: string description: Nome do arquivo da etiqueta de lote de armazenagem no S3 exportConfirmationOrderReceiving: type: boolean description: Confirmação de exportação da ordem de recebimento exportConfirmationOrderReceivingDate: type: string format: date-time description: Data de confirmação da exportação da ordem de recebimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOrderReceiving: type: object required: – id allOf: – #/definitions/orderReceiving product: description: Produto type: object properties: id: type: string format: uuid description: Identificador único referenceCode: type: string description: Código Referência description: type: string description: Descrição cplDescription: type: string description: Descrição complementar situation: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: packing: description: Embalagem type: object properties: id: type: string format: uuid description: Identificador único product: type: object allOf: – #/definitions/product description: Produto code: type: string maxLength: 30 description: Código shortDescription: type: string description: Descrição Reduzida conversionFactor: type: number format: double description: Fator de Conversão height: type: integer format: int64 description: Altura (mm) width: type: integer format: int64 description: Largura (mm) length: type: integer format: int64 description: Comprimento (mm) grossWeight: type: integer format: int64 description: Peso Bruto (gr) netWeight: type: integer format: int64 description: Peso Líquido (gr) ballast: type: integer format: int64 description: Lastro layer: type: integer format: int64 description: Camada maximumStacking: type: integer format: int64 description: Empilhamento Máximo preRegistration: type: boolean description: Pré-cadastro situation: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: receivingDocument: description: Documento de Entrada type: object required: – number – documentDate – wmsVendor – situation – productSituation properties: id: type: string format: uuid description: Identificador único orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento number: type: string description: Número sequence: type: string description: Sequência accessKey: type: string description: Chave da Nota Fiscal documentOrigin: type: string allOf: – #/definitions/enumDocumentOrigin description: Tipo de cadastro do documento documentDate: type: string format: date description: Data processingDate: type: string format: date description: Data de processamento processingUser: type: string description: Usuário de processamento wmsVendor: type: object allOf: – #/definitions/wmsVendor description: Fornecedor wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante situation: type: string allOf: – #/definitions/enumDocumentSituation description: Situação productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editReceivingDocument: type: object required: – id allOf: – #/definitions/receivingDocument receivingDocumentItem: description: Item do Documento de Entrada type: object required: – productOwner – packing – quantity properties: id: type: string format: uuid description: Identificador único receivingDocument: type: object allOf: – #/definitions/receivingDocument description: Documento de Entrada item: type: integer format: int64 description: Item productOwner: type: object allOf: – #/definitions/productOwner description: Produto packing: type: object allOf: – #/definitions/packing description: Embalagem quantity: type: integer format: int64 description: Quantidade createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editReceivingDocumentItem: type: object required: – id allOf: – #/definitions/receivingDocumentItem 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: place: description: Local de Armazenagem type: object properties: id: type: string format: uuid description: Identificador único address: type: string description: Endereço formatedAddress: type: string description: Endereço block: type: string description: Bloco street: type: string description: Rua building: type: integer format: int64 description: Prédio floor: type: integer format: int64 description: Andar apartment: type: integer format: int64 description: Apartamento wmsWarehouse: type: object allOf: – #/definitions/wmsWarehouse description: Armazém type: type: string allOf: – #/definitions/enumPlaceType description: Tipo height: type: integer format: int64 description: Altura (mm) width: type: integer format: int64 description: Largura (mm) length: type: integer format: int64 description: Comprimento (mm) maneuverHeight: type: integer format: int64 description: Altura de Manobra (mm) maxWeight: type: integer format: int64 description: Peso Máximo (gr) situation: type: string allOf: – #/definitions/enumSitReg description: Situação sector: type: object allOf: – #/definitions/sector description: Setor sideBuildingType: type: string allOf: – #/definitions/enumSideBuildingType description: Tipo do lado do prédio blockOperation: type: string allOf: – #/definitions/enumPlaceBlockOperation description: Operação que solicitou o bloqueio do local excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: checkin: description: Conferência do Documento de Entrada type: object required: – orderReceiving – situation properties: id: type: string format: uuid description: Identificador único number: type: integer format: int64 description: Número da Conferência orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento situation: type: string allOf: – #/definitions/enumCheckinSituation 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: checkinItem: description: Conferência do item do Documento de Entrada type: object required: – checkin – productOwner – packing – quantity – productSituation – situation properties: id: type: string format: uuid description: Identificador único checkin: type: object allOf: – #/definitions/checkin description: Conferência do Documento de Entrada productOwner: type: object allOf: – #/definitions/productOwner description: Produto Depositante packing: type: object allOf: – #/definitions/packing description: Embalagem quantity: type: number format: double description: Quantidade ballast: type: integer format: int64 description: Lastro layer: type: integer format: int64 description: Camada incompleteLayer: type: integer format: int64 description: Camada incompleta productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto situation: type: string allOf: – #/definitions/enumCheckinItemSituation description: Situação industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data fabricação expirationDate: type: string format: date description: Data vencimento ignoredBy: type: string description: Usuário que ignorou ignoredDate: type: string format: date-time description: Data que ignorou createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: checkinResume: description: Resumo da Conferência type: object required: – orderReceiving – productOwner – packing – goodQuantity – damagedQuantity – expiredQuantity – truncatedQuantity properties: id: type: string format: uuid description: Identificador único orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento productOwner: type: object allOf: – #/definitions/productOwner description: Produto Depositante packing: type: object allOf: – #/definitions/packing description: Embalagem goodQuantity: type: number format: double description: Quantidade Boa damagedQuantity: type: number format: double description: Quantidade Danificada expiredQuantity: type: number format: double description: Quantidade Vencida truncatedQuantity: type: number format: double description: Quantidade Truncada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: allocationBatch: description: Lote de Alocação type: object required: – orderReceiving – palletType – productOwner – packing – productSituation – quantity – quantityUn – palletNumber properties: id: type: string format: uuid description: Identificador único orderReceiving: type: object allOf: – #/definitions/orderReceiving description: Ordem de Recebimento 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 industrialBatch: type: string description: Lote indústria fabricationDate: type: string format: date description: Data fabricação expirationDate: type: string format: date description: Data vencimento 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 palletNumber: type: integer format: int64 description: Número do Palete createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAllocationBatch: type: object required: – id allOf: – #/definitions/allocationBatch receivingOrderDetailsView: description: Detalhes da Ordem de Recebimento – View type: object required: – orderReceivingId – orderReceivingNumber – warehouseId – warehouseCode – ownerId – ownerCode – orderSituation – documentNumber – documentSequence – documentItem – productId – productCode – productDescription – productSituation – quantity – weight properties: id: type: string format: uuid description: Identificador único orderReceivingId: type: string format: uuid description: Id da Ordem de Recebimento orderReceivingNumber: type: integer format: int64 description: Número da Ordem de Recebimento warehouseId: type: string format: uuid description: Id do Armazém warehouseCode: type: string description: Código de Integração do Armazém ownerId: type: string format: uuid description: Id do Depositante ownerCode: type: string description: Código de Integração do Depositante orderSituation: type: string allOf: – #/definitions/enumOrderReceivingSituation description: Situação da Ordem de Recebimento vendorId: type: string format: uuid description: Id do Fornecedor vendorCode: type: string description: Código do Fornecedor documentNumber: type: string description: Número do Documento documentSequence: type: string description: Série do Documento documentItem: type: integer format: int64 description: Número Item do Documento productId: type: string format: uuid description: Id do Produto productCode: type: string description: Código do Produto productDescription: type: string description: Descrição do Produto productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do Produto industrialBatch: type: string description: Lote industria expirationDate: type: string format: date description: Data de expiração fabricationDate: type: string format: date description: Data de Fabricação quantity: type: number format: double description: Quantidade weight: type: integer format: int64 description: Peso Total sectorOwner: description: Depositantes vinculados ao Setor type: object properties: id: type: string format: uuid description: Id da entidade sector: type: object allOf: – #/definitions/sector description: Setor wmsOwner: type: object allOf: – #/definitions/wmsOwner description: Depositante 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: sectorProduct: description: Produtos Vinculados ao Setor type: object properties: id: type: string format: uuid description: Id da entidade sector: type: object allOf: – #/definitions/sector description: Setor product: type: object allOf: – #/definitions/product description: Produto 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: orderReceivingView: description: Listagem Ordem de Recebimento – View type: object required: – wmsWarehouse – receivingType – receivingTypeName – receivingDate – situation – wmsOwner – wmsOwnerName – dock – dockName properties: id: type: string format: uuid description: Identificador único number: type: integer format: int64 description: Número da OR wmsWarehouse: type: string format: uuid description: Armazém receivingType: type: string format: uuid description: Tipo de recebimento receivingTypeName: type: string description: Nome do Tipo de recebimento receivingDate: type: string format: date description: Data de recebimento situation: type: string allOf: – #/definitions/enumOrderReceivingSituation description: Situação wmsCarrying: type: string format: uuid description: Transportadora wmsCarryingName: type: string description: Nome fantasia da Transportadora wmsOwner: type: string format: uuid description: Depositante wmsOwnerName: type: string description: nome do Depositante dock: type: string format: uuid description: Doca dockName: type: string description: Nome da doca documents: type: string description: Documentos exportConfirmationOrderReceiving: type: boolean description: Confirmação de exportação da ordem de recebimento 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 linkSectorReceivingTypeFacade: description: Vincular Setor aos Tipos de Recebimento type: object required: – sectorId properties: id: type: string format: uuid description: Identificador único sectorId: type: string format: uuid description: Id do Setor receivingTypeIds: type: array items: type: string format: uuid description: Lista de Ids de Tipo de recebimento a serem adicionados removedIds: type: array items: type: string format: uuid description: Lista de Ids removidos linkReceivingTypeOwnerFacade: description: Vincular Tipo de Recebimento ao Depositante type: object required: – receivingTypeId properties: id: type: string format: uuid description: Identificador único receivingTypeId: type: string format: uuid description: Id do Tipo de Recebimento ownerIds: type: array items: type: string format: uuid description: Lista de Ids de depositantes a serem adicionados removedIds: type: array items: type: string format: uuid description: Lista de Ids removidos importReceivingDocumentFacadeInput: description: Importação Documento de Entrada type: object required: – number – documentDate – vendorCode properties: number: type: string description: Número do Documento sequence: type: string description: Sequencia do Documento documentDate: type: string format: date description: Data de emissão accessKey: type: string description: Chave da Nota Fiscal vendorCode: type: string description: Código do Fornecedor para integração productSituation: type: string allOf: – #/definitions/enumProductSituation description: Situação do produto, se não informado considera Bom warehouseCode: type: string description: Código do Armazém para integração, opcional se for único para o usuário ownerCode: type: string description: Código do Depositante para integração, opcional se for único para o usuário items: type: array items: type: object allOf: – #/definitions/recIntegrateDocumentItem description: Items do Documento importReceivingDocumentFacadeOutput: description: Importação Documento de Entrada type: object required: – id properties: id: type: string maxLength: 36 description: Identificador único do registro criada/alterado. 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