erp_mer

gme_painelmercado

14 views 22/10/2018 06/11/2018 integrador 0

2.0info: 0.1.1 gme_painelmercado x-senior-domain: erp_mer x-senior-domain-path: erp_mer x-senior-service-path: gme_painelmercado 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_mersecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /gme_painelmercado/queries/buscarTicketsMediosFaturamento: post: description: Retorna os valores de Tícket médio e Faturamentos dos últimos 3 meses tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – ticketMedioFaturamento properties: ticketMedioFaturamento: type: string description: Valores do Tícket médio e valores de faturamento default: description: Error response schema: #/definitions/genericError get: description: Retorna os valores de Tícket médio e Faturamentos dos últimos 3 meses tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – ticketMedioFaturamento properties: ticketMedioFaturamento: type: string description: Valores do Tícket médio e valores de faturamento default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/buscarValoresFaturamentoAcumulados: post: description: Retorna o valor do faturamento acumulado do ano corrente tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – faturamentoAcumulado properties: faturamentoAcumulado: type: string description: Valores do faturamento acumulado default: description: Error response schema: #/definitions/genericError get: description: Retorna o valor do faturamento acumulado do ano corrente tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – faturamentoAcumulado properties: faturamentoAcumulado: type: string description: Valores do faturamento acumulado default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/buscarPedidosEmAberto: post: description: Retorna a quantidade e valor dos pedidos em aberto no mês selecionado e também do mês anterior tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – pedidosEmAberto properties: pedidosEmAberto: type: string description: Quantidades e Valores dos pedidos em aberto default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade e valor dos pedidos em aberto no mês selecionado e também do mês anterior tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – pedidosEmAberto properties: pedidosEmAberto: type: string description: Quantidades e Valores dos pedidos em aberto default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/buscarPedidosMes: post: description: Retorna a quantidade e valor dos pedidos do mês selecionado e também do mês anterior tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – pedidosMes properties: pedidosMes: type: string description: Quantidades e Valores dos pedidos do mês default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade e valor dos pedidos do mês selecionado e também do mês anterior tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – pedidosMes properties: pedidosMes: type: string description: Quantidades e Valores dos pedidos do mês default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/buscarEntregasPrazo: post: description: Retorna a percentual de entregas no prazo e percentual de entregas em atraso dos últimos 3 meses tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – entregasPrazo properties: entregasPrazo: type: string description: Percentuais de entregas no prazo e em atraso default: description: Error response schema: #/definitions/genericError get: description: Retorna a percentual de entregas no prazo e percentual de entregas em atraso dos últimos 3 meses tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – entregasPrazo properties: entregasPrazo: type: string description: Percentuais de entregas no prazo e em atraso default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/buscarCrescimentosCarteira: post: description: Retorna a quantidade de novos clientes e total do mês, adicionalmente retorna o quantidade de novos clientes e total do mês anterior tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – crescimentoCarteira properties: crescimentoCarteira: type: string description: Quantidades e Valores dos pedidos do mês default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de novos clientes e total do mês, adicionalmente retorna o quantidade de novos clientes e total do mês anterior tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – crescimentoCarteira properties: crescimentoCarteira: type: string description: Quantidades e Valores dos pedidos do mês default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/buscarTemposCiclosEntregas: post: description: Retorna a média de dias que leva para um pedido ser atendido dos últimos 3 meses tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tempoCicloEntregas properties: tempoCicloEntregas: type: string description: Média de dias de entrega dos pedidos default: description: Error response schema: #/definitions/genericError get: description: Retorna a média de dias que leva para um pedido ser atendido dos últimos 3 meses tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tempoCicloEntregas properties: tempoCicloEntregas: type: string description: Média de dias de entrega dos pedidos default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/pesquisarEmpresa: post: description: Retorna empresas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Retorna uma lista de empresas default: description: Error response schema: #/definitions/genericError get: description: Retorna empresas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Retorna uma lista de empresas default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/pesquisarFilial: post: description: Retorna filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Recebe uma lista de empresas responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retorna uma lista de filiais default: description: Error response schema: #/definitions/genericError get: description: Retorna filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresas in: query required: true type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Retorna uma lista de filiais default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/pesquisarRegiaoVenda: post: description: Retorna regiões de venda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Recebe uma lista de empresas responses: 200: description: Ok schema: type: object required: – regioesVenda properties: regioesVenda: type: array items: type: object allOf: – #/definitions/recRegiaoVenda minimum: 1 description: Retorna uma lista de regiões de venda default: description: Error response schema: #/definitions/genericError get: description: Retorna regiões de venda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresas in: query required: true type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 responses: 200: description: Ok schema: type: object required: – regioesVenda properties: regioesVenda: type: array items: type: object allOf: – #/definitions/recRegiaoVenda minimum: 1 description: Retorna uma lista de regiões de venda default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/pesquisarRepresentante: post: description: Retorna representantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresas – regioesVenda properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Recebe uma lista de empresas regioesVenda: type: array items: type: object allOf: – #/definitions/recRegiaoVenda minimum: 1 description: Recebe uma lista de regiões de venda responses: 200: description: Ok schema: type: object required: – representantes properties: representantes: type: array items: type: object allOf: – #/definitions/recRepresentante minimum: 1 description: Retorna uma lista de representantes default: description: Error response schema: #/definitions/genericError get: description: Retorna representantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresas in: query required: true type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 – name: regioesVenda in: query required: true type: array items: type: object allOf: – #/definitions/recRegiaoVenda minimum: 1 responses: 200: description: Ok schema: type: object required: – representantes properties: representantes: type: array items: type: object allOf: – #/definitions/recRepresentante minimum: 1 description: Retorna uma lista de representantes default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/pesquisarSuperiorImediato: post: description: Retorna superior imediato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresas – regioesVenda – representantes properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Recebe uma lista de empresas regioesVenda: type: array items: type: object allOf: – #/definitions/recRegiaoVenda minimum: 1 description: Recebe uma lista de regiões de venda representantes: type: array items: type: object allOf: – #/definitions/recRepresentante minimum: 1 description: Recebe uma lista de representantes responses: 200: description: Ok schema: type: object required: – superioresImediatos properties: superioresImediatos: type: array items: type: object allOf: – #/definitions/recSuperiorImediato minimum: 1 description: Retorna uma lista de superiores imediatos default: description: Error response schema: #/definitions/genericError get: description: Retorna superior imediato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresas in: query required: true type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 – name: regioesVenda in: query required: true type: array items: type: object allOf: – #/definitions/recRegiaoVenda minimum: 1 – name: representantes in: query required: true type: array items: type: object allOf: – #/definitions/recRepresentante minimum: 1 responses: 200: description: Ok schema: type: object required: – superioresImediatos properties: superioresImediatos: type: array items: type: object allOf: – #/definitions/recSuperiorImediato minimum: 1 description: Retorna uma lista de superiores imediatos default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/pesquisarOrigem: post: description: Retorna origens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Recebe uma lista de empresas responses: 200: description: Ok schema: type: object required: – origens properties: origens: type: array items: type: object allOf: – #/definitions/recOrigem minimum: 1 description: Retorna uma lista de origens default: description: Error response schema: #/definitions/genericError get: description: Retorna origens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresas in: query required: true type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 responses: 200: description: Ok schema: type: object required: – origens properties: origens: type: array items: type: object allOf: – #/definitions/recOrigem minimum: 1 description: Retorna uma lista de origens default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/pesquisarFamilia: post: description: Retorna familias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresas – origens properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Recebe uma lista de empresas origens: type: array items: type: object allOf: – #/definitions/recOrigem minimum: 1 description: Recebe uma lista de origens responses: 200: description: Ok schema: type: object required: – familias properties: familias: type: array items: type: object allOf: – #/definitions/recFamilia minimum: 1 description: Retorna uma lista de famílias default: description: Error response schema: #/definitions/genericError get: description: Retorna familias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresas in: query required: true type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 – name: origens in: query required: true type: array items: type: object allOf: – #/definitions/recOrigem minimum: 1 responses: 200: description: Ok schema: type: object required: – familias properties: familias: type: array items: type: object allOf: – #/definitions/recFamilia minimum: 1 description: Retorna uma lista de famílias default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/pesquisarTransacao: post: description: Retorna transações de entrada ou saída tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Recebe uma lista de empresas responses: 200: description: Ok schema: type: object required: – transacoes properties: transacoes: type: array items: type: object allOf: – #/definitions/recTransacao minimum: 1 description: Retorna uma lista de transações default: description: Error response schema: #/definitions/genericError get: description: Retorna transações de entrada ou saída tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresas in: query required: true type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 responses: 200: description: Ok schema: type: object required: – transacoes properties: transacoes: type: array items: type: object allOf: – #/definitions/recTransacao minimum: 1 description: Retorna uma lista de transações default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/buscarParametros: post: description: Retorna os parâmetros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nomeParametro properties: nomeParametro: type: string description: Nome do parâmetro responses: 200: description: Ok schema: type: object required: – idParametro – parametros properties: idParametro: type: integer format: int64 description: Id da parametrização parametros: type: string description: Parâmetros para consulta default: description: Error response schema: #/definitions/genericError get: description: Retorna os parâmetros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nomeParametro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – idParametro – parametros properties: idParametro: type: integer format: int64 description: Id da parametrização parametros: type: string description: Parâmetros para consulta default: description: Error response schema: #/definitions/genericError /gme_painelmercado/queries/buscarDatasUltimaConsolidacao: post: description: Retorna a data de início e conclusão da última consolidação para a parametrização do usuário e competência selecionados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dataInicioConsolidacao – dataConclusaoConsolidacao properties: dataInicioConsolidacao: type: string format: date-time description: Data de início da consolidação dataConclusaoConsolidacao: type: string format: date-time description: Data de conclusão da consolidação default: description: Error response schema: #/definitions/genericError get: description: Retorna a data de início e conclusão da última consolidação para a parametrização do usuário e competência selecionados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dataInicioConsolidacao – dataConclusaoConsolidacao properties: dataInicioConsolidacao: type: string format: date-time description: Data de início da consolidação dataConclusaoConsolidacao: type: string format: date-time description: Data de conclusão da consolidação default: description: Error response schema: #/definitions/genericError /gme_painelmercado/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 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 /gme_painelmercado/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 /gme_painelmercado/actions/incluirParametros: post: description: Incluir parâmetros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nomeParametro – parametros properties: nomeParametro: type: string description: Nome do parâmetro nomeVisao: type: string description: Nome da visão do parâmetro parametros: type: string description: Parâmetros de consulta responses: 200: description: Ok schema: type: object required: – idParametro – dummy properties: idParametro: type: integer format: int64 description: Id da parametrização incluída dummy: type: boolean description: (Parâmetro obsoleto) default: description: Error response schema: #/definitions/genericError /gme_painelmercado/actions/alterarParametros: post: description: Alterar parâmetros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idParametro – parametros properties: idParametro: type: integer format: int64 description: Id da parametrização nomeParametro: type: string description: Nome do parâmetro nomeVisao: type: string description: Nome da visão do parâmetro parametros: type: string description: Parâmetros de consulta responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: (Parâmetro obsoleto) default: description: Error response schema: #/definitions/genericError /gme_painelmercado/actions/excluirParametros: post: description: Excluir parâmetros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idParametro properties: idParametro: type: integer format: int64 description: Parâmetros de entrada para consulta responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: boolean description: (Parâmetro obsoleto) default: description: Error response schema: #/definitions/genericError definitions: 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 recEmpresa: description: Estrutura de empresas type: object required: – codigoEmpresa – descricaoEmpresa properties: codigoEmpresa: type: integer format: int64 description: descricaoEmpresa: type: string description: recFilial: description: Estrutura de filiais type: object required: – codigoEmpresa – codigoFilial – descricaoFilial properties: codigoEmpresa: type: integer format: int64 description: codigoFilial: type: integer format: int64 description: descricaoFilial: type: string description: recRegiaoVenda: description: Estrutura de região de vendas type: object required: – codigoEmpresa – codigoRegiaoVendas – descricaoRegiaoVendas properties: codigoEmpresa: type: integer format: int64 description: codigoRegiaoVendas: type: string description: descricaoRegiaoVendas: type: string description: recRepresentante: description: Estrutura de representante type: object required: – codigoEmpresa – codigoRegiaoVendas – codigoRepresentante – nomeRepresentante properties: codigoEmpresa: type: integer format: int64 description: codigoRegiaoVendas: type: string description: codigoRepresentante: type: integer format: int64 description: nomeRepresentante: type: string description: recSuperiorImediato: description: Estrutura de superior imediato type: object required: – codigoEmpresa – codigoRegiaoVendas – codigoSuperiorImediato – descricaoSuperiorImediato properties: codigoEmpresa: type: integer format: int64 description: codigoRegiaoVendas: type: string description: codigoSuperiorImediato: type: integer format: int64 description: descricaoSuperiorImediato: type: string description: recFamilia: description: Estrutura de dados da família type: object required: – codigoEmpresa – codigoFamilia – descricaoFamilia properties: codigoEmpresa: type: integer format: int64 description: codigoFamilia: type: string description: descricaoFamilia: type: string description: recOrigem: description: Estrutura de dados da origem type: object required: – codigoEmpresa – codigoOrigem – descricaoOrigem – nivelOrigem properties: codigoEmpresa: type: integer format: int64 description: codigoOrigem: type: string description: descricaoOrigem: type: string description: nivelOrigem: type: integer format: int64 description: recTransacao: description: Estrutura de dados da transação type: object required: – codigoEmpresa – codigoTransacao – descricaoTransacao – moduloTransacao properties: codigoEmpresa: type: integer format: int64 description: codigoTransacao: type: string description: descricaoTransacao: type: string description: moduloTransacao: type: string description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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 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

Este artigo foi útil para você?

Leave A Comment