Histórico da Página

Objetivo

Método de consulta de grupos de promoções cadastradas do tipo normal no ERP.

Chamada

GET [URLAPI]/PromocaoAPI/api/v1/GrupoPromocao/Promocao

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > API Promoções > API Promoções Normais do ERP

Image Added

Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome	Descrição	Tipo (Type)	Exigência
CnpjEmpresaCNPJ Empresa	CNPJ da empresa utilizada como filtro de informações das promoções	string	Opcional	Não há
Número EmpresaNroEmpresa	Número de Empresa para filtrar as promoções	integer($int32)	Opcional	Não há
SegmentoNroSegmento	Número do segmento de venda para filtrar as promoções	integer($int32)	Opcional	Não há
Status	A = ativo (somente produtos ativos), I = inativo (somente produtos inativos). Padrão, T = todos (produtos ativos e inativos). Status padrão: A.	string	Opcional	Não há
Vigente	Somente Promoções em vigor no momento	string	Opcional	Não há
SeqPromocaoCódigo Promoção	Filtro de promoção normal específica	integer($int32)	Opcional	Não há
DtaHoraAlteracao Data Hora de Alteração	Filtro para buscar promoções alteradas a partir de uma data (item / cabeçalho)	string($date-time)	Opcional	Não há
DataInicioData Início	Filtro para buscar promoções que tem início a partir de uma data	string($date-time)	Opcional	Não há
Fields	Campos	string	Não há	Valores aceitáveis: seqPromocao, descricao, dtaInicio, dtaFim, faixaAcrFinanceiro, seqGrupoPromoc, indUsaAcrescTabVenda, tipoMediaVda, inativaPromocaoCCAcord, dtaHoraInclusao, dtaHoraAlteracao
Order	Ordenação dos Campos	string	Não há	Valores aceitáveis: seqPromocao, descricao, dtaInicio, dtaFim, faixaAcrFinanceiro, seqGrupoPromoc, indUsaAcrescTabVenda, tipoMediaVda, inativaPromocaoCCAcord, dtaHoraInclusao, dtaHoraAlteracao
Page	Número da Página	integer($int32)	Não há	Não há
PageSize	Tamanho da Página	integer($int32)	Não há	Não há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso Recurso (Response Codes)

OK (200)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

PromocaoDtoIListDto

...

DescriçãoDescrição da promoçãoPromoções > Promoção (parte texto)Data Início da PromoçãoData inicial da promoçãoPromoções > Período > Data InicialData Fim da PromoçãoData final da promoçãoPromoções > Período > Data FinalFaixa de Acréscimo FinanceiroIndica a faixa de acréscimo para cálculo do preço de tabela, na venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão.Promoções > aba Promoção > Faixa de Acréscimo FinanceiroGrupo de PromoçãoIndica o código e descrição do grupo que a promoção pertenceInterno banco de dadosIndicador se Usa Acréscimo de Tabela de vendaIndica se aplica acréscimo de tabela de venda, ao calcular o preço de venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão.Interno banco de dadosTipo de Média de VendaIndica o tipo cálculo de média de venda em que deve se enquadrar as vendas dos produtos da promoção. P = Promoção / N = Normal.Gerenciador de Preços > Pesquisa de Promoções > coluna Média Vda.

Inativa Promoção sem Saldo de Acordo

Indica se inativa a promoção quando não houver saldo do conta corrente de acordo promocional vinculado.Interno banco de dadosData e hora de inclusãoData e hora em que a promoção foi incluída no ERPInterno banco de dadosData e hora de alteraçãoData e hora em que a promoção foi alterada no ERPInterno banco de dados

Informações de Resposta
Nome	Descrição		Tipo	Origem

Código da Promoção

seqPromocao

Número do código da promoção

integer($int32)

Código gerado internamente a cada promoção criada. Promoções > Promoção (parte numérica)

Descrição

descricao

Descrição da promoção

string

Promoções > Promoção (parte texto)

Data Início da Promoção

dtaInicio

Data inicial da promoção

string($date-time)

Promoções > Período > Data Inicial

Data Fim da Promoção

dtaFim

Data final da promoção

string($date-time)

Promoções > Período > Data Final

Faixa de Acréscimo Financeiro

faixaAcrFinanceiro

Indica a faixa de acréscimo para cálculo do preço de tabela, na venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão.

string

Promoções > aba Financeiro Promoção > Faixa de Acréscimo

Grupo de Promoção

seqGrupoPromoc

Indica o código e descrição do grupo que a promoção pertence

integer($int32)

Interno banco de dados

Indicador se Usa Acréscimo de Tabela de venda

indUsaAcrescTabVenda

Indica se aplica acréscimo de tabela de venda, ao calcular o preço de venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão.

string

Interno banco de dados

Tipo de Média de Venda

tipoMediaVda

Indica o tipo cálculo de média de venda em que deve se enquadrar as vendas dos produtos da promoção. P = Promoção / N = Normal.

string

Gerenciador de Preços > Pesquisa de Promoções > coluna Média Vda.

Inativa Promoção sem Saldo de Acordo

inativaPromocaoCCAcord

Indica se inativa a promoção quando não houver saldo do conta corrente de acordo promocional vinculado.

string

Interno banco de dados

Data e hora de inclusão

dtaHoraInclusao

Data e hora em que a promoção foi incluída no ERP

string($date-time)

Interno banco de dados

Data e hora de alteração

dtaHoraAlteracao

Data e hora em que a promoção foi alterada no ERP

string($date-time)

Interno banco de dados

Lista de Empresas da Promoção

empresas (EmpresaRetornoDto)

nroEmpresa

Número da Empresa

Número da empresa participante da promoção

string

Promoções > aba Promoção > Nro (grid Empresas)

CNPJ Empresa

cnpjEmpresa

CNPJ da empresa participante da promoção

integer($int32)

Interno banco de dados

Lista de Segmentos de Venda da Promoção

segmentos (SegmentoRetornoDto)

nroSegmento

Segmento de Venda

Número do Segmento de Venda

integer($int32)

Promoções > aba Itens da Promoção > Segmento

Descrição

descSegmento

Descrição do Segmento de Venda

string

Módulo Parâmetros > menu Dealer > Manutenção de Segmentos de Venda

Lista de Produtos incluídos na promoção

Código Sequencial do Produto


produtos (PromocaoItemDto)	seqPromocao	Código sequencial da promoção no ERP	integer($int32)
	seqProduto	Código sequencial do produto no ERP	integer($int32)	Promoções > aba Itens da Promoção > Código
	descricaoCompleta

Código de Barras do Produto

Descrição completa do produto	string	Não há.
codAcesso	Código de barras do produto (GTIN) de acordo com a embalagem da promoção. Quando existir mais de um código cadastrado, retorna o maior.	string	Cadastro de Produtos > aba Códigos

Embalagem de Venda

qtdEmbalagem

Embalagem do produto para promoção

number($double)

Promoções > aba Itens da Promoção > Embalagem

Status

status

Situação do produto na promoção. A = Ativo ou I = Inativo.

string

Interno banco de dados

Preço Promocional

precoPromocional

Valor do preço de promoção do produto

number($double)

Promoções > aba Itens da Promoção > Preço

Data e hora de inclusão

dtaHoraInclusao

Data e hora em que o produto foi incluído na promoção

string($date-time)

Interno banco de dados

Data e hora de alteração

dtaHoraAlteracao

Data e hora em que houve alteração do produto na promoção

string($date-time)

Interno banco de dados

Empresas

empresas (EmpresaPromocaoItemDto)

nroEmpresa

Conjunto das empresas em promoção para o produto. Número Empresa.

integer($int32)

Promoções > aba Promoção > Nro (grid Empresas)

Segmento de Venda

segmentos (SegmentoPromocaoItemDto)

nroSegmento

Conjunto dos segmentos de venda que se aplica a promoção para o produto. Número de segmento.

integer($int32)

Promoções > aba Itens da Promoção > Segmento

Bloco de código

language	actionscript3

{
  "hasNext": true,
  "items": [
    {
      "seqPromocao": 0,
      "descricao": "string",
      "dtaInicio": "2020-12-22T13:14:54.266Z",
      "dtaFim": "2020-12-22T13:14:54.266Z",
      "faixaAcrFinanceiro": "string",
      "seqGrupoPromoc": 0,
      "indUsaAcrescTabVenda": "string",
      "tipoMediaVda": "string",
      "inativaPromocaoCCAcord": "string",
      "dtaHoraInclusao": "2020-12-22T13:14:54.266Z",
      "dtaHoraAlteracao": "2020-12-22T13:14:54.266Z",
      "empresas": [
        {
          "nroEmpresa": 0,
          "cnpjEmpresa": "string"
        }
      ],
      "segmentos": [
        {
          "nroSegmento": 0,
          "descSegmento": "string"
        }
      ],
      "produtos": [
        {
          "seqPromocao": 0,
          "seqProduto": 0,
		  "descricaoCompleta": "string",
          "codAcesso": "string",
          "qtdEmbalagem": 0,
          "status": "string",
          "precoPromocional": 0,
          "dtaHoraInclusao": "2020-12-22T13:14:54.266Z",
          "dtaHoraAlteracao": "2020-12-22T13:14:54.266Z",
          "empresas": [
            {
              "nroEmpresa": 0
            }
          ],
          "segmentos": [
            {
              "nroSegmento": 0
            }
          ]
        }
      ],
      "_expandables": [
        "string"
      ]
    }
  ]
}

application/json, text/json

CODE 400 - BAD

Bloco de código

language	actionscript3

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "code": "string",
      "message": "string",
      "detailedMessage": "string"
    }
  ]
}

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão Atual

Chave

Objetivo

Chamada

Permissionamento

Assuntos Relacionados

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Informações para Resposta (Response Information)

Códigos do Recurso Recurso (Response Codes)

Formatos de Resposta (Response Formats)

application/json, text/json