2.0info: 3.4.1 Gestão de demandas description: Gestão de demandas x-senior-domain: Demanda x-senior-domain-path: erp_dem x-senior-service-path: gde_gestaodemandas contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_demsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /gde_gestaodemandas/queries/pesquisarPessoa: post: description: retorna a lista de pessoa de um determinado tipo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoPessoa – paginacao properties: tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa filtro: type: string description: pesquisar pelo codigo, nome ou fantasia codigo: type: integer format: int64 description: pesquisar pelo codigo paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno – pessoa properties: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados da paginação pessoa: type: array items: type: object allOf: – #/definitions/recPessoa minimum: 1 description: Pessoa default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarFilial: post: description: retorna a lista de filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – paginacao properties: filtro: type: string description: pesquisar pelo codigo, nome ou fantasia empresaId: type: integer format: int64 description: Id da empresa paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno – pessoa properties: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados da paginação pessoa: type: array items: type: object allOf: – #/definitions/recPessoa minimum: 1 description: Pessoa default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/buscarPessoa: post: description: retorna dados de pessoa por id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – tipoPessoa properties: id: type: integer format: int64 description: Id de pessoa tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo da pessoa responses: 200: description: Ok schema: type: object required: – pessoa properties: pessoa: type: object allOf: – #/definitions/recPessoa description: Pessoa default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarFamilia: post: description: retorna lista de familias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo properties: empresaCodigo: type: integer format: int64 description: Código da empresa filtro: type: string description: permite filtro pelos campos de código ou descrição paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno – familias properties: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados da paginação familias: type: array items: type: object allOf: – #/definitions/familia minimum: 1 description: Famílias default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarSku: post: description: retorna a lista de sku cadastrados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – paginacao properties: empresaCodigo: type: integer format: int64 description: Código da empresa codigo: type: string description: Código do SKU descricao: type: string description: Descrição do SKU tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo do SKU familiaId: type: integer format: int64 description: ID da familia tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição do SKU tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidade description: Tipo de qualidade do SKU filtro: type: string description: opcional – permite filtrar por código ou descrição paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – skus – paginacaoRetorno properties: skus: type: array items: type: object allOf: – #/definitions/recSku minimum: 1 description: SKUs paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados da paginação default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarSkuParametrosAtendimento: post: description: pesquisar parametros de antedimento do sku tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – paginacao properties: empresaCodigo: type: integer format: int64 description: Código da empresa skuId: type: integer format: int64 description: Identificador do sku tipoDemanda: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda tipoAtendimento: type: string allOf: – #/definitions/enumTipoAtendimento description: Tipo de atendimento paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno – skuParametros properties: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados da paginação skuParametros: type: array items: type: object allOf: – #/definitions/recSkuParametrosAtendimento minimum: 1 description: Parametros do SKU default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarSkuParametrosAtendimentoGrupo: post: description: pesquisar parametros de antedimento do grupo de sku tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – paginacao properties: empresaCodigo: type: integer format: int64 description: Código da empresa tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo do produto tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição familiaId: type: integer format: int64 description: Identificador da família tipoDemanda: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda tipoAtendimento: type: string allOf: – #/definitions/enumTipoAtendimento description: Tipo de atendimento paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno – skuParametros properties: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados da paginação skuParametros: type: array items: type: object allOf: – #/definitions/recSkuParametrosAtendimentoGrupo minimum: 1 description: Parametros do SKU default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarDemanda: post: description: retorna lista de demandas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – paginacao properties: empresaCodigo: type: integer format: int64 description: Código da empresa numeroDocumento: type: string maxLength: 32 description: Número do documento tipo: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda skuId: type: integer format: int64 description: Identificador do sku situacao: type: string allOf: – #/definitions/enumSituacaoDemanda description: Situação da demanda paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno – demanda properties: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados da paginação demanda: type: array items: type: object allOf: – #/definitions/recDemanda minimum: 1 description: Demanda default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarNecessidade: post: description: retorna lista de necessidades e atendimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – paginacao properties: id: type: integer format: int64 description: id da necessidade empresaCodigo: type: integer format: int64 description: Código da empresa demandaId: type: integer format: int64 description: número do documento da demanda tipo: type: string allOf: – #/definitions/enumTipoDemanda description: tipo da demanda situacao: type: array items: type: string allOf: – #/definitions/enumSituacaoNecessidade description: situacao da demanda skuId: type: integer format: int64 description: sku da necessidade paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno – necessidades properties: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados da paginação necessidades: type: array items: type: object allOf: – #/definitions/recNecessidadeBase minimum: 1 description: Necessidade default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarSaldoEstoque: post: description: pesquisar saldo em estoque – para atendimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – sku – documentoOrigemDescricao properties: empresaCodigo: type: integer format: int64 description: Código da empresa filialCodigo: type: integer format: int64 description: Opcional – código da filial sku: type: object allOf: – #/definitions/recSku description: Dados do sku documentoOrigemDescricao: type: string description: Descrição do documento de origem responses: 200: description: Ok schema: type: object required: – estoque properties: estoque: type: array items: type: object allOf: – #/definitions/recEstoque minimum: 1 description: Saldos de estoque default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarSaldoEstoqueComPaginacao: post: description: pesquisar saldo em estoque – para atendimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – sku – paginacao properties: empresaCodigo: type: integer format: int64 description: Código da empresa filialCodigo: type: integer format: int64 description: Opcional – código da filial sku: type: object allOf: – #/definitions/recSku description: Dados do sku paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginacao responses: 200: description: Ok schema: type: object required: – estoque – paginacaoRetorno properties: estoque: type: array items: type: object allOf: – #/definitions/recEstoque minimum: 1 description: Saldos de estoque paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Paginacao de retorno default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarSaldoProducao: post: description: pesquisa saldo em ordens de producao – para atendimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – sku – paginacao properties: empresaCodigo: type: integer format: int64 description: Código da empresa sku: type: string description: Código do produto ordemProducaoId: type: integer format: int64 description: Identificador da Ordem de Produção paginacao: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – paginacaoRetorno – producao properties: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados da paginação producao: type: array items: type: object allOf: – #/definitions/recOrdemProducao minimum: 1 description: Ordem de produção default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/pesquisarAtendimentoProduto: post: description: Retorna lista de atendimentos para uma ou mais ordens de produção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaCodigo – documentoOrigem properties: empresaCodigo: type: integer format: int64 description: Código da empresa documentoOrigem: type: array items: type: string minimum: 1 description: Documento de origem responses: 200: description: Ok schema: type: object required: – atendimento properties: atendimento: type: array items: type: object allOf: – #/definitions/recAtendimento minimum: 1 description: Atendimento default: description: Error response schema: #/definitions/genericError get: description: Retorna lista de atendimentos para uma ou mais ordens de produção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaCodigo description: Código da empresa in: query required: true type: integer format: int64 – name: documentoOrigem description: Documento de origem in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – atendimento properties: atendimento: type: array items: type: object allOf: – #/definitions/recAtendimento minimum: 1 description: Atendimento default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/listSalesOrder: post: description: Listar os pedidos de venda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – branchIds – initialDeliveryDate – finalDeliveryDate – pagination properties: companyId: type: integer format: int64 description: Identificador único da empresa branchIds: type: array items: type: integer format: int64 minimum: 1 description: Lista – Identificador único da filial salesOrderNumbers: type: array items: type: integer format: int64 description: (Opcional) Lista – Número de pedido salesOrderIds: type: array items: type: string description: (Opcional) Lista – Identificador único do pedido clientIds: type: array items: type: integer format: int64 description: (Opcional) Identificador único do cliente skuIds: type: array items: type: integer format: int64 description: (Opcional) Identificador único do sku initialDeliveryDate: type: string format: date description: Data inicial do período previsto para a entrega finalDeliveryDate: type: string format: date description: Data final do período previsto para a entrega situations: type: array items: type: string allOf: – #/definitions/enumSalesOrderSituation description: (Opcional) Lista – Situação do pedido noDemands: type: boolean description: Opcional(padrão: true) – Apresentar somente os pedidos que ainda não geraram demanda e estão aptos default: true pagination: type: object allOf: – #/definitions/recPaginacao description: Paginação responses: 200: description: Ok schema: type: object required: – returnPage properties: salesOrders: type: array items: type: object allOf: – #/definitions/recSalesOrder description: Pedidos de venda returnPage: type: object allOf: – #/definitions/recPaginacaoRetorno description: Dados de paginação default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/listNeedReservation: post: description: Lista as necessidades e seus respectivos atendimentos com reserva de estoque tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – originDocumentServices properties: originDocumentServices: type: array items: type: string minimum: 1 description: Lista – Código do documento de origem do atendimento da necessidade origem responses: 200: description: Ok schema: type: object required: – needs properties: needs: type: array items: type: object allOf: – #/definitions/recNeedReservation minimum: 1 description: Lista de necessidades e seus respectivos atendimentos com reserva de estoque default: description: Error response schema: #/definitions/genericError get: description: Lista as necessidades e seus respectivos atendimentos com reserva de estoque tags: – Queries x-senior-visibility: PRIVATE parameters: – name: originDocumentServices description: Lista – Código do documento de origem do atendimento da necessidade origem in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – needs properties: needs: type: array items: type: object allOf: – #/definitions/recNeedReservation minimum: 1 description: Lista de necessidades e seus respectivos atendimentos com reserva de estoque default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/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: 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/exportEmpresa: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/exportEntSku: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/exportEntSkuParametrosAtendimento: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/exportEntSkuParametrosAtendimentoGrupo: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/exportFamilia: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/exportUnidadeMedida: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/exportSkuVersao: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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 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: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/incluirDemanda: post: description: Inclúi uma demanda tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – skuId – quantidade – dataEntregaPrevista – tipo – empresaCodigo properties: skuId: type: integer format: int64 description: Identificador do sku quantidade: type: string description: Quantidade dataEntregaPrevista: type: string format: date-time description: Data prevista para entrega tipo: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda numeroDocumento: type: string maxLength: 32 description: Número do documento empresaCodigo: type: integer format: int64 description: Código da empresa responses: 200: description: Ok schema: type: object required: – demanda properties: demanda: type: object allOf: – #/definitions/recDemanda description: Demanda default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/cancelarDemanda: post: description: Cancela a demanda tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – demandaId properties: demandaId: type: integer format: int64 description: Identificador da demanda responses: 200: description: Ok schema: type: object required: – demanda properties: demanda: type: object allOf: – #/definitions/recDemanda description: Demanda default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/alterarLeadtime: post: description: Altera o LeadTime tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – skuId – leadtime properties: skuId: type: integer format: int64 description: Identificador do sku leadtime: type: integer format: int64 description: LeadTime responses: 200: description: Ok schema: type: object required: – sku properties: sku: type: object allOf: – #/definitions/entSku description: SKU default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/calcularNecessidades: post: description: Calcular necessidades tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – demandaId properties: demandaId: type: integer format: int64 description: Identificador da demanda responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Dummy default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/cancelarAtendimentoNecessidade: post: description: Cancelar atendimento necessidade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – atendimentoId properties: atendimentoId: type: integer format: int64 description: Identificador do atendimento responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Dummy default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/atenderNecessidadeProduzir: post: description: atende uma necessidade com o saldo de uma ordem de produção ou gera uma novaOP tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – necessidadeId properties: necessidadeId: type: integer format: int64 description: Identificador da necessidade ordemProducaoId: type: integer format: int64 description: Identificador da Ordem de Produção quantidade: type: string description: Quantidade responses: 200: description: Ok schema: type: object required: – atendimento properties: atendimento: type: array items: type: object allOf: – #/definitions/recAtendimento minimum: 1 description: Atendimento default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/atenderNecessidadesDemanda: post: description: Atende as necessidades de uma demanda tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – demandaId properties: demandaId: type: integer format: int64 description: Identificador da demanda responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Dummy default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/alterarNecessidadeQuantidadePlanejada: post: description: Altera a quantidade planejada de uma necessidade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – necessidadeId – quantidade properties: necessidadeId: type: integer format: int64 description: Id da necessidade quantidade: type: string description: Novo valor para a quantidade planejada da necessidade responses: 200: description: Ok schema: type: object required: – necessidade properties: necessidade: type: object allOf: – #/definitions/recNecessidade description: Retorna o registro da necessidade atualizado default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/finalizarDemanda: post: description: Finaliza uma demanda e as necessidades relacionadas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – demandaId properties: demandaId: type: integer format: int64 description: Id da demanda responses: 200: description: Ok schema: type: object required: – demanda properties: demanda: type: object allOf: – #/definitions/recDemanda description: Retorna o registro da demanda atualizado default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/finalizarNecessidades: post: description: Finaliza uma lista de necessidades, caso todas as necessidades da demanda relacionada estiverem finalizadas ou canceladas, finaliza a demanda também tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – necessidadesId properties: necessidadesId: type: array items: type: integer format: int64 minimum: 1 description: Lista de Ids de necessidades responses: 200: description: Ok schema: type: object required: – necessidades properties: necessidades: type: array items: type: object allOf: – #/definitions/recNecessidade minimum: 1 description: Retorna a lista de necessidades atualizado default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/alterarDemandaIndependente: post: description: permite alterar registro de demanda independente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – demandaId – skuId – quantidade – dataEntregaPrevista properties: demandaId: type: integer format: int64 description: identificador único da demanda skuId: type: integer format: int64 description: identificador único do sku quantidade: type: string description: quantidade dataEntregaPrevista: type: string format: date-time description: data de entrega prevista responses: 200: description: Ok schema: type: object required: – demanda properties: demanda: type: object allOf: – #/definitions/recDemanda description: registro de demanda atualizado default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/atenderNecessidadeEstoque: post: description: Atende uma necessidade com reserva de estoque tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – necessidadeId – filialCodigo – quantidade – deposito properties: necessidadeId: type: integer format: int64 description: Identificador único da necessidade filialCodigo: type: integer format: int64 description: Filial do estoque quantidade: type: string description: Quantidade a ser reservada deposito: type: string description: Código do depósito loteSeries: type: array items: type: object allOf: – #/definitions/recAtendimentoLoteSerie description: Lista de lotes e/ou séries – Opcional: deve ser informado quando o SKU da necessidade possuir controle por lote e/ou série responses: 200: description: Ok schema: type: object required: – atendimentos properties: atendimentos: type: array items: type: object allOf: – #/definitions/recAtendimento minimum: 1 description: Lista de atendimentos gerados default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/recalcularNecessidade: post: description: Recalcula uma necessidade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – necessidadeId – atendimentoId – tipoAtendimento properties: necessidadeId: type: integer format: int64 description: Identificador único da necessidade atendimentoId: type: integer format: int64 description: Identificador único do atendimento tipoAtendimento: type: string allOf: – #/definitions/enumTipoAtendimento description: Tipo do atendimento responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: Dummy default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/incluirEAtenderDemanda: post: description: Realiza a inclusão e o atendimento da demanda tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – skuId – quantidade – dataEntregaPrevista – tipo – empresaCodigo properties: skuId: type: integer format: int64 description: Identificador do sku quantidade: type: string description: Quantidade dataEntregaPrevista: type: string format: date-time description: Data prevista para entrega tipo: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda numeroDocumento: type: string maxLength: 32 description: Número do documento empresaCodigo: type: integer format: int64 description: Código da empresa identificadorDocumento: type: string description: Identificador de documento UUID, este valor não será gravado responses: 200: description: Ok schema: type: object required: – demanda properties: demanda: type: object allOf: – #/definitions/recDemanda description: Demanda default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/generateDemandSalesOrder: post: description: Gerar demandas conforme os pedidos de vendas informados – O processo de geração é executado assincronamente,\n neste caso somente as execeções serão lançadas como retorno. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – salesOrderIds properties: salesOrderIds: type: array items: type: string minimum: 1 description: Lista – Identificar único do pedido responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/importEmpresa: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/importEntSku: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/importEntSkuParametrosAtendimento: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/importEntSkuParametrosAtendimentoGrupo: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/importFamilia: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/importUnidadeMedida: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/actions/importSkuVersao: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/empresa: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/empresa default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/empresa/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/empresa default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/empresa/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/empresa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/entSku: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entSku responses: 200: description: The created resource schema: #/definitions/entSku default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entSku responses: 200: description: The created resource schema: #/definitions/entSku default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entSku default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/entSku/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entSku responses: 200: description: Ok schema: #/definitions/entSku default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entSku responses: 200: description: Ok schema: #/definitions/entSku default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entSku default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/entSku/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entSku responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/entSkuParametrosAtendimento: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entSkuParametrosAtendimento responses: 200: description: The created resource schema: #/definitions/entSkuParametrosAtendimento default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entSkuParametrosAtendimento responses: 200: description: The created resource schema: #/definitions/entSkuParametrosAtendimento default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entSkuParametrosAtendimento default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/entSkuParametrosAtendimento/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entSkuParametrosAtendimento responses: 200: description: Ok schema: #/definitions/entSkuParametrosAtendimento default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entSkuParametrosAtendimento responses: 200: description: Ok schema: #/definitions/entSkuParametrosAtendimento default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entSkuParametrosAtendimento default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/entSkuParametrosAtendimento/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entSkuParametrosAtendimento responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/entSkuParametrosAtendimentoGrupo: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entSkuParametrosAtendimentoGrupo responses: 200: description: The created resource schema: #/definitions/entSkuParametrosAtendimentoGrupo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entSkuParametrosAtendimentoGrupo responses: 200: description: The created resource schema: #/definitions/entSkuParametrosAtendimentoGrupo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entSkuParametrosAtendimentoGrupo default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/entSkuParametrosAtendimentoGrupo/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entSkuParametrosAtendimentoGrupo responses: 200: description: Ok schema: #/definitions/entSkuParametrosAtendimentoGrupo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entSkuParametrosAtendimentoGrupo responses: 200: description: Ok schema: #/definitions/entSkuParametrosAtendimentoGrupo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entSkuParametrosAtendimentoGrupo default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/entSkuParametrosAtendimentoGrupo/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entSkuParametrosAtendimentoGrupo responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/familia: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familia responses: 200: description: The created resource schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familia responses: 200: description: The created resource schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/familia default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/familia/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familia responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familia responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/familia/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/familia responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/unidadeMedida: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/unidadeMedida responses: 200: description: The created resource schema: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/unidadeMedida responses: 200: description: The created resource schema: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/unidadeMedida/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/unidadeMedida responses: 200: description: Ok schema: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/unidadeMedida responses: 200: description: Ok schema: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/unidadeMedida default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/unidadeMedida/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/unidadeMedida responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/skuVersao: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/skuVersao responses: 200: description: The created resource schema: #/definitions/skuVersao default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/skuVersao responses: 200: description: The created resource schema: #/definitions/skuVersao default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/skuVersao default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/skuVersao/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/skuVersao responses: 200: description: Ok schema: #/definitions/skuVersao default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/skuVersao responses: 200: description: Ok schema: #/definitions/skuVersao default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/skuVersao default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /gde_gestaodemandas/entities/skuVersao/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/skuVersao responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumTipoOrdenacao: description: Tipo de ordenação de uma página type: string enum: – Asc – Desc enumTipoPessoa: description: Tipo de pessoa type: string enum: – Empresa – Filial – Fornecedor – Cliente enumTipoReposicao: description: Tipo de reposição type: string enum: – Produzido – Comprado – Servico enumTipoQualidade: description: Tipo de qualidade do produto type: string enum: – Normal – Refugo – SegundaQualidade – TerceiraQualidade enumSituacaoSku: description: Situação do SKU type: string enum: – Inativo – Ativo – Bloqueado enumTipoProduto: description: Tipo do produto type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufaturado – EmFabricacao – SubProduto – UsoConsumo – AtivoImobilizado – Servico – OutrosInsumos – Outros enumTipoDemanda: description: Tipo da demanda type: string enum: – DemandaIndependente – PedidoVenda – AnaliseReposicao enumSituacaoDemanda: description: Situação da demanda type: string enum: – Gerada – AguardandoAtendimento – EmAtendimento – Finalizada – Cancelada enumSituacaoNecessidade: description: Situação da necessidade type: string enum: – Gerada – EmAtendimento – Finalizada – Cancelada enumSituacaoAtedimento: description: Situação do atendimento type: string enum: – EmAtendimento – Finalizado – EmCancelamento enumTipoAtendimento: description: Tipo de atendimento type: string enum: – ReservarEstoque – Produzir – Comprar enumSituacaoVersao: description: Situação da versão type: string enum: – Transitoria – Aprovada – Liberada – Substituida enumTipoOrdemProducao: description: Tipo de Ordem de Produção type: string enum: – Normal – Reprocesso enumSituacaoOrdemProducao: description: Situação da Ordem de Produção type: string enum: – Programada – Liberada – Iniciada – Finalizada – Cancelada – Parada enumSalesOrderType: description: Tipo do pedido de venda type: string enum: – Normal – Automatico – Rascunho – Orcamento – Previsao – ProntaEntrega – AproveitamentoPedidoProntaEntrega – AssistenciaTecnica – Reposicao enumSalesOrderOrigin: description: Procedência do pedido de venda type: string enum: – DigitadoNormal – ViaInternet – ViaImportacao – ViaAutomacao – DigitadoDistribuicao – ViaProcessoAutomaticoOrdemCompra – ViaProcessoAutomaticoGerais – ViaContratoLicitacao – ViaIntegracaoVarejo – ViaDevolucaoQuantidadeExcedente enumSalesOrderSituation: description: Situação do pedido de venda type: string enum: – AbertoTotal – AbertoParcial – Suspenso – Liquidado – Cancelado – AguardandoIntegracaoWMS – EmTransmissao – PreparacaoAnalise – NaoFechado enumGeneratesNeed: description: Indicativo geração de necessidade type: string enum: – NaoInformado – FaltaGerarNecessidade – GerouNecessidadePedido – GerouNecessidadeProduto – NaoGeraNecessidades – NecessidadeCanceladaPCP – GerouManual – AtendidoPorPrevisao – Produzido upDown: description: Up or down type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR recPaginacao: description: Paginação type: object required: – pagina – numeroRegistrosPagina – listaOrdenacao properties: pagina: type: integer format: int64 description: Número da página numeroRegistrosPagina: type: integer format: int64 description: Quantidade de registros na página listaOrdenacao: type: array items: type: object allOf: – #/definitions/recListaOrdenacao minimum: 1 description: Lista de ordenação da página recListaOrdenacao: description: Lista de ordenação de uma página type: object required: – campo – ordenacao properties: campo: type: string description: Valor do campo ordenacao: type: string allOf: – #/definitions/enumTipoOrdenacao description: Tipo de ordenação recPaginacaoRetorno: description: Paginação de retorno type: object required: – pagina – numeroRegistrosPagina – registrosEncontrados properties: pagina: type: integer format: int64 description: Número da página numeroRegistrosPagina: type: integer format: int64 description: Quantidade de registros na página registrosEncontrados: type: integer format: int64 description: Quantidade total de registros recPessoa: description: Pessoa type: object required: – id – codigo – nome – fantasia – tipo properties: id: type: integer format: int64 description: Identificador codigo: type: integer format: int64 description: Código nome: type: string description: Nome fantasia: type: string description: Nome fantasía tipo: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração dataAlteracao: type: string format: date-time description: Data de alteração usuarioAlteracao: type: string description: Usuário de alteração recSku: description: SKU type: object required: – id – codigo – descricao – empresaCodigo – tipoProduto – tipoReposicao – tipoQualidade – situacao – leadTime – familia properties: id: type: integer format: int64 description: Identificador codigo: type: string description: Código descricao: type: string description: Descrição descricaoComplementar: type: string description: Descrição complementar empresaCodigo: type: integer format: int64 description: Código da empresa tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo do produto tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidade description: Tipo de qualidade unidadeMedidaEstoque: type: object allOf: – #/definitions/unidadeMedida description: Unidade de medida do estoque situacao: type: string allOf: – #/definitions/enumSituacaoSku description: Situação leadTime: type: integer format: int64 description: Leadtime familia: type: object allOf: – #/definitions/familia description: Família dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração dataAlteracao: type: string format: date-time description: Data de alteração usuarioAlteracao: type: string description: Usuário de alteração recSkuBase: description: Dados básico do SKU type: object required: – id – codigo – descricao – empresaCodigo – tipoReposicao – unidadeMedidaEstoque properties: id: type: integer format: int64 description: Identificador único do SKU codigo: type: string description: Código descricao: type: string description: Descrição empresaCodigo: type: integer format: int64 description: Código da empresa tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição unidadeMedidaEstoque: type: object allOf: – #/definitions/unidadeMedida description: Unidade de medida do estoque recDemandaBase: description: Dados básicos da demanda type: object required: – id – empresaCodigo – tipo – sku – quantidade – dataEntregaPrevista – situacao properties: id: type: integer format: int64 description: Identificador único da demanda empresaCodigo: type: integer format: int64 description: Código da empresa tipo: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda numeroDocumento: type: string maxLength: 32 description: número do documento de origem de acordo com o tipo: item da requisição, item do pedido… sku: type: object allOf: – #/definitions/recSkuBase description: SKU quantidade: type: string description: Quantidade dataEntregaPrevista: type: string format: date-time description: Data prevista da entrega situacao: type: string allOf: – #/definitions/enumSituacaoDemanda description: Situação da demanda recDemanda: description: Demanda type: object required: – empresaCodigo – tipo – sku – quantidade – dataEntregaPrevista – situacao properties: id: type: integer format: int64 description: Identificador empresaCodigo: type: integer format: int64 description: Código da empresa tipo: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda numeroDocumento: type: string maxLength: 32 description: número do documento de origem de acordo com o tipo: item da requisição, item do pedido… sku: type: object allOf: – #/definitions/recSku description: SKU quantidade: type: string description: Quantidade dataEntregaPrevista: type: string format: date-time description: Data prevista da entrega situacao: type: string allOf: – #/definitions/enumSituacaoDemanda description: Situação da demanda dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração dataAlteracao: type: string format: date-time description: Data de alteração usuarioAlteracao: type: string description: Usuário de alteração recAtendimentoBase: description: Dados básicos do Atendimento type: object required: – documentoOrigem – tipo – sku – quantidade – situacao properties: id: type: integer format: int64 description: Identificador único do Atendimento documentoOrigem: type: string maxLength: 32 description: Documento de origem tipo: type: string allOf: – #/definitions/enumTipoAtendimento description: Tipo de atendimento sku: type: object allOf: – #/definitions/recSkuBase description: SKU versaoSequencia: type: integer format: int64 description: Versão da sequencia quantidade: type: string description: Quantidade situacao: type: string allOf: – #/definitions/enumSituacaoAtedimento description: Situação do atendimento loteSeries: type: array items: type: object allOf: – #/definitions/recAtendimentoLoteSerie description: Lista de lotes e/ou séries quando o SKU for controlado por lote e/ou série recAtendimento: description: Atendimento type: object required: – necessidadeId – tipo – documentoOrigem – sku – quantidade – situacao properties: id: type: integer format: int64 description: Identificador necessidadeId: type: integer format: int64 description: Identificador da necessidade tipo: type: string allOf: – #/definitions/enumTipoAtendimento description: Tipo de atendimento documentoOrigem: type: string maxLength: 32 description: Documento de origem sku: type: object allOf: – #/definitions/recSku description: SKU versaoSequencia: type: integer format: int64 description: Versão da sequencia quantidade: type: string description: Quantidade situacao: type: string allOf: – #/definitions/enumSituacaoAtedimento description: Situação do atendimento loteSeries: type: array items: type: object allOf: – #/definitions/recAtendimentoLoteSerie description: Lista de lotes e/ou séries quando o SKU for controlado por lote e/ou série dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração recNecessidadeBase: description: Dados básicos da necessidade type: object required: – sku – demanda – sequencia – quantidadeOriginal – quantidadePlanejada – quantidadeAtendimento – dataEntregaPrevista – situacao properties: id: type: integer format: int64 description: Identificador único da necessidade sku: type: object allOf: – #/definitions/recSkuBase description: Dados do SKU demanda: type: object allOf: – #/definitions/recDemandaBase description: Dados da demanda sequencia: type: integer format: int64 description: Sequência da estrutura de composição versaoSequencia: type: integer format: int64 description: Sequência da versão quantidadeOriginal: type: string description: Quantidade original quantidadePlanejada: type: string description: Quantidade planejada quantidadeAtendimento: type: string description: Quantidade em atendimento dataEntregaPrevista: type: string format: date-time description: Data prevista para entrega situacao: type: string allOf: – #/definitions/enumSituacaoNecessidade description: Situação da necessidade atendimentos: type: array items: type: object allOf: – #/definitions/recAtendimentoBase description: Atendimentos da necessidade recNecessidade: description: Necessidade type: object required: – sku – demanda – sequencia – quantidadeOriginal – quantidadePlanejada – quantidadeAtendimento – dataEntregaPrevista – situacao properties: id: type: integer format: int64 description: Identificador sku: type: object allOf: – #/definitions/recSku description: SKU versaoSequencia: type: integer format: int64 description: Versão da sequência demanda: type: object allOf: – #/definitions/recDemanda description: Demanda sequencia: type: integer format: int64 description: Sequência da estrutura de composição quantidadeOriginal: type: string description: Quantidade original quantidadePlanejada: type: string description: Quantidade planejada quantidadeAtendimento: type: string description: Quantidade em atendimento dataEntregaPrevista: type: string format: date-time description: Data prevista para entrega situacao: type: string allOf: – #/definitions/enumSituacaoNecessidade description: Situação da necessidade atendimento: type: array items: type: object allOf: – #/definitions/recAtendimento description: Atendimento dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração dataAlteracao: type: string format: date-time description: Data de alteração usuarioAlteracao: type: string description: Usuário de alteração recEstoque: description: Estoque type: object required: – empresaCodigo – sku – deposito – quantidadeTotal – quantidadeDisponivel properties: empresaCodigo: type: integer format: int64 description: Código da empresa sku: type: object allOf: – #/definitions/recSku description: SKU deposito: type: string description: Depósito lote: type: string description: Lote serie: type: string description: Série filial: type: object allOf: – #/definitions/recPessoa description: Filial quantidadeTotal: type: string description: Quantidade total quantidadeDisponivel: type: string description: Quantidade disponível recSkuParametrosAtendimento: description: SKU parametros por atendimento type: object required: – sku – tipoDemanda – tipoAtendimento – atendeAutomatico properties: id: type: integer format: int64 description: Identificador sku: type: object allOf: – #/definitions/recSku description: SKU tipoDemanda: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda tipoAtendimento: type: string allOf: – #/definitions/enumTipoAtendimento description: Tipo de atendimento atendeAutomatico: type: boolean description: Atende automaticamente dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração recSkuParametrosAtendimentoGrupo: description: SKU parametros por atendimento por grupo type: object required: – tipoProduto – tipoReposicao – tipoDemanda – tipoAtendimento – atendeAutomatico properties: id: type: integer format: int64 description: Identificador tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo do produto tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição familia: type: object allOf: – #/definitions/familia description: Família tipoDemanda: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda tipoAtendimento: type: string allOf: – #/definitions/enumTipoAtendimento description: Tipo de atendimento atendeAutomatico: type: boolean description: Atende automaticamente dataGeracao: type: string format: date-time description: Data de geração usuarioGeracao: type: string description: Usuário de geração recOrdemProducao: description: Ordem de produção type: object required: – id – empresaCodigo – sku – versaoId – filial – tipo – situacao – bloqueada – quantidadeProgramada – quantidadeDisponivel properties: id: type: integer format: int64 description: Identificador empresaCodigo: type: integer format: int64 description: Código da empresa sku: type: object allOf: – #/definitions/recSku description: SKU versaoId: type: integer format: int64 description: Identificador da versão filial: type: object allOf: – #/definitions/recPessoa description: Família tipo: type: string allOf: – #/definitions/enumTipoOrdemProducao description: Tipo de Ordem de Produção situacao: type: string allOf: – #/definitions/enumSituacaoOrdemProducao description: Situação da Ordem de Produção bloqueada: type: boolean description: Bloqueada skuRefugo: type: object allOf: – #/definitions/recSku description: SKU de refugo dataEntregaPrevista: type: string format: date-time description: Data prevista para entrega quantidadeProgramada: type: string description: Quantidade programada quantidadeDisponivel: type: string description: Quantidade disponível recBasePerson: description: Registro com as informações básicas da pessoa type: object required: – id – code – name – type properties: id: type: integer format: int64 description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Nome type: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo originPersonId: type: integer format: int64 description: Identificar único da pessoa origem recBaseUnitMeasure: description: Registro com as informações básicas da unidade de medida type: object required: – id – code – decimalsNumber properties: id: type: integer format: int64 description: Identificador único code: type: string maxLength: 3 description: Código decimalsNumber: type: integer format: int64 description: Quantidade de decimais recBaseSku: description: Registro com as informações básicas do SKU type: object required: – id – companyId – code – description – unitMeasure properties: id: type: integer format: int64 description: Identificador único companyId: type: integer format: int64 description: Empresa code: type: string maxLength: 23 description: Código description: type: string maxLength: 100 description: Descrição unitMeasure: type: object allOf: – #/definitions/recBaseUnitMeasure description: Unidade de medida recBaseSalesOrder: description: Registro com as informações básicas do pedido de venda discriminator: _discriminator type: object required: – id – company – branch – number – client – type – origin – situation – generationDate – blocked – _discriminator properties: id: type: string description: Identificador único pedido de venda company: type: object allOf: – #/definitions/recBasePerson description: Informações da empresa branch: type: object allOf: – #/definitions/recBasePerson description: Informações da filial number: type: integer format: int64 description: Número client: type: object allOf: – #/definitions/recBasePerson description: Informações do cliente type: type: string allOf: – #/definitions/enumSalesOrderType description: Tipo origin: type: string allOf: – #/definitions/enumSalesOrderOrigin description: Procedência situation: type: string allOf: – #/definitions/enumSalesOrderSituation description: Situação generationDate: type: string format: date-time description: Data de geração closingDate: type: string format: date-time description: Data fechamento emissionDate: type: string format: date-time description: Data de emissão deliveryDate: type: string format: date-time description: Data de previsão de entrega blocked: type: boolean description: Bloqueado _discriminator: type: string description: recBaseSalesOrderItems: description: Registro com as informações básicas dos itens do pedido de venda discriminator: _discriminator type: object required: – id – sequenceSku – sku – quantity – openQuantity – unitMeasure – situation – _discriminator properties: id: type: string description: Identificador único sequenceSku: type: integer format: int64 description: Sequência do item sku: type: object allOf: – #/definitions/recBaseSku description: SKU quantity: type: string description: Quantidade openQuantity: type: string description: Quantidade aberta unitMeasure: type: object allOf: – #/definitions/recBaseUnitMeasure description: Unidade de medida situation: type: string allOf: – #/definitions/enumSalesOrderSituation description: Situação _discriminator: type: string description: recSalesOrderItems: description: Registro com as informações dos itens do pedido de venda allOf: – #/definitions/recBaseSalesOrderItems – type: object required: – generatesNeed properties: generatesNeed: type: string allOf: – #/definitions/enumGeneratesNeed description: Indicativo da geração de necessidade recSalesOrder: description: Registro com as informações do pedido de venda allOf: – #/definitions/recBaseSalesOrder – type: object properties: note: type: string maxLength: 999 description: Observação items: type: array items: type: object allOf: – #/definitions/recSalesOrderItems description: Itens recBaseNeed: description: Registro com as informações básicas da necessidade discriminator: _discriminator type: object required: – id – sku – demandId – originNeedId – sequence – situation – _discriminator properties: id: type: integer format: int64 description: Identificador único sku: type: object allOf: – #/definitions/recBaseSku description: SKU demandId: type: integer format: int64 description: Identificador único da demanda originNeedId: type: integer format: int64 description: Necessidade de origem sequence: type: integer format: int64 description: Sequência da necessidade dentro da demanda situation: type: string allOf: – #/definitions/enumSituacaoNecessidade description: Situacao da necessidade _discriminator: type: string description: recBaseService: description: Registro com as informações básicas do atendimento type: object required: – id – need – typeOfService – originDocument – amount – situation properties: id: type: integer format: int64 description: Identificador único need: type: object allOf: – #/definitions/recBaseNeed description: Dados da necessidade typeOfService: type: string allOf: – #/definitions/enumTipoAtendimento description: Tipo do atendimento realizado originDocument: type: string maxLength: 32 description: Documento origem amount: type: string description: Quantidade situation: type: string allOf: – #/definitions/enumSituacaoAtedimento description: Situação recNeedReservation: description: Registro com as necessidades e os respectivos atendimentos allOf: – #/definitions/recBaseNeed – type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/recBaseService minimum: 1 description: Atendimento da necessidade checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recAtendimentoLoteSerie: description: Dados do lote/série para atendimento type: object required: – quantidade properties: id: type: string description: Identificador único codigoLote: type: string maxLength: 50 description: Código do lote codigoSerie: type: string maxLength: 50 description: Código da série quantidade: type: string description: Quantidade do lote/série empresa: description: Empresa type: object required: – id – codigo properties: id: type: integer format: int64 description: Identificador codigo: type: integer format: int64 description: Codigo usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entSku: description: SKU type: object required: – empresa – codigo – descricao – tipoProduto – tipoReposicao – tipoQualidade – unidadeMedidaEstoque – situacao – leadTime properties: id: type: integer format: int64 description: Identificador empresa: type: object allOf: – #/definitions/empresa description: Empresa codigo: type: string description: Código descricao: type: string description: Descrição descricaoComplementar: type: string description: Descrição complementar tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo do produto tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidade description: Tipo de qualidade unidadeMedidaEstoque: type: object allOf: – #/definitions/unidadeMedida description: Unidade de medida do estoque situacao: type: string allOf: – #/definitions/enumSituacaoSku description: Situação do SKU leadTime: type: integer format: int64 description: LeadTime familia: type: object allOf: – #/definitions/familia description: Família usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entSkuParametrosAtendimento: description: SKU Parâmetros atendimento type: object required: – sku – empresa – tipoDemanda – tipoAtendimento – atendeAutomatico properties: id: type: integer format: int64 description: Identificador sku: type: object allOf: – #/definitions/entSku description: SKU empresa: type: object allOf: – #/definitions/empresa description: Empresa tipoDemanda: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda tipoAtendimento: type: string allOf: – #/definitions/enumTipoAtendimento description: Tipo de atendimento atendeAutomatico: type: boolean description: Atende automaticamente usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entSkuParametrosAtendimentoGrupo: description: SKU Parâmetros atendimento por grupo type: object required: – empresa – tipoProduto – tipoReposicao – tipoDemanda – tipoAtendimento – atendeAutomatico properties: id: type: integer format: int64 description: Identificador empresa: type: object allOf: – #/definitions/empresa description: Empresa tipoProduto: type: string allOf: – #/definitions/enumTipoProduto description: Tipo do produto tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição familia: type: object allOf: – #/definitions/familia description: Família tipoDemanda: type: string allOf: – #/definitions/enumTipoDemanda description: Tipo da demanda tipoAtendimento: type: string allOf: – #/definitions/enumTipoAtendimento description: Tipo de atendimento atendeAutomatico: type: boolean description: Atende automaticamente usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: familia: description: Família type: object required: – empresa – codigo – descricao – tipoReposicao – controlaLote – controlaSerie properties: id: type: integer format: int64 description: Identificador empresa: type: object allOf: – #/definitions/empresa description: Empresa codigo: type: string description: Código descricao: type: string description: Descrição tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição controlaLote: type: boolean description: Controla lote controlaSerie: type: boolean description: Controla série usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: unidadeMedida: description: Unidade de medida type: object required: – id – codigo – descricao – quantidadeDecimais properties: id: type: integer format: int64 description: Identificador codigo: type: string description: Código descricao: type: string description: Descrição quantidadeDecimais: type: integer format: int64 description: Quantidade de casas decimais usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: skuVersao: description: Versão do SKU type: object required: – skuId – sequencia – situacao – descricao properties: id: type: integer format: int64 description: Identificador skuId: type: integer format: int64 description: Identificador do sku sequencia: type: integer format: int64 description: Sequencia situacao: type: string allOf: – #/definitions/enumSituacaoVersao description: Situação descricao: type: string description: Descrição usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: 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 genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE