Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

A finalidade deste método é, possibilitar a consulta dos combos promocionais

Chamada

GET api/v1/CombosPromocionais

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
Cnpj

CNPJ da empresa utilizada como filtro de informações das promoções

StringOpcional.
NroEmpresaNúmero de Empresa para filtrar as promoçõesIntegerOpcional.
StatusA = ativo (somente produtos ativos), I = inativo (somente produtos inativos). Padrão: A.StringOpcional
Vigente

Somente Promoções em vigor no momento. Opções: T = Todas; S = Somente Vigentes (valor padrão); F = Vigentes e Futuras.

StringOpcional.
SeqPromocaoPdv

Filtro por código de promoção combinada específica

IntegerOpcional.
DataHoraAlteracaoFiltro para buscar promoções alteradas a partir de uma dataDateOpcional.
DataInicio

Filtro para buscar promoções que tem início a partir de uma data

DateOpcional.
DataTermino

Filtro para buscar promoções que finalizam em uma determinada data

DateOpcional.
_pageNo
integerOpcional.
_pageSize
integerOpcional.

Parâmetros do Corpo (Body Parameters)

Não há.

Formatos de Resposta (Response Formats)

application/json, text/json


Nome

Descrição

Tipo

seqPromocaoPdv

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

Integer

descricao

Descrição da promoção combinada

String
statusSituação da promoção. A = Ativo ou I = Inativo.String

dataInicio

Data inicial da promoção

Datetime

dataFim

Data final da promoção

Datetime

tipoPromocao

Indica o tipo de configuração da promoção. Opções: Nulo ou I = Item e G = Grupo.

String

tipoQuantidade

Indica o tipo de verificação de quantidade para aplicação da ação promocional na venda. Opções: Nulo ou I = Itens Distintos e T = Total Itens Grupo. Informado apenas quando o tipo de Promoção é igual a G (Grupo).

String

tipoQtdeCargaPdv

Indica o tipo de ação do combo promocional. Utilizado para integração com algumas frentes de caixa. Opções: M = “Múltiplos”, L = “Leve X Pague Y” e A = “Acima de / A partir de”

String
controlaVerbaPdv

Indica se a promoção faz o controle de verba nas vendas por PDV, para posterior apuração e geração de acordo promocional com fornecedores. Opções: S = Sim / N ou Nulo = Não.

String

baixaQtdeVerbaBonif

Indica se baixa verba, somente dos produtos e quantidades bonificados. Opções: S = Sim / N ou Nulo = Não (padrão).

String
descricaoEtiqueta

Indica a descrição a ser emitida em etiquetas ou cartazes de divulgação da promoção.

String

codParceiro

Indica se a promoção possui integração com algum parceiro de CRM, e seu respectivo código de referência.

Integer
usuAlteracaoUsuário que realizou a alteração.Datetime
dtaAlteracaoData em que a alteração foi realizada.Datetime

















itens















seqProdutoCódigo sequencial do produto no ERPInteger
codBarrasCódigo de barras do produto (GTIN – EAN ou DUN) de acordo com a embalagem da promoção. Quando existir mais de um código cadastrado, retorna o maior.String
qtdEmbalagemQuantidade da Embalagem do produto para a promoçãoInteger
quantidadeIndica a quantidade a ser vendida do produto, para estar apto à ação promocional. Quantidade de acordo com a embalagem definida.Integer
tipoItemIndica o tipo de verificação da venda do item no combo. Opções: N = Normal ou P = Promoção.String
precoItemValor do preço do item promocional, em R$. Será considerado somente para as linhas em que o Tipo Item é igual a P (Promoção). Quando Tipo Item é igual a N, retorna valor zero.Integer
percentualDescontoPercentual de desconto a ser aplicado no item promocional. Será considerado somente para as linhas em que o Tipo Item é igual a P (Promoção). Quando Tipo Item é igual a N, retorna valor zero.Integer
validoFamiliaIndica se a promoção é válida para os demais produtos da mesma família do item informado. Opções: S = Sim ou N = Não.String
valorRefAcordoPromocIndica o tipo de valor que será usado como referência para a geração do acordo promocional, na apuração das vendas, quando se controla Verba em vendas por PDV. Opções: 1 = Preço Promocional; nulo ou 2 = Preço Atual de Venda; 3 = Custo Líquido; 4 = Custo Bruto; 5 = Custo da Última Entrada; 6 = Livre. Campo considerado apenas em itens do tipo P (Promoção).Integer
valorLivreRefAcordoPromocValor que será usado como referência para a geração do acordo promocional, na apuração das vendas, quando se controla Verba em vendas por PDV. Somente será informado quando o tipo de Valor Referência Acordo Promocional é igual a 6. Campo considerado apenas em itens do tipo P (Promoção).Integer
statusSituação do item na promoção. A = Ativo ou I = Inativo.String
seqFamiliaCódigo sequencial da família.Integer
promocaoPorFamiliaPromoção por famíliaString
familiaLista os dados das famílias.
seqFamiliaCódigo sequencial da família no ERPInteger
descricaoDescrição da famíliaString
produtoLista os dados dos produtos.
seqProdutoCódigo sequencial do produto no ERPInteger
descricaoReduzidaDescrição reduzida do produtoString
listaPrecoAPartirDeLista as condições dos preçosInteger
valorDescontoValor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 3 = Valor do DescontoInteger
percentualDescontoPercentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 2 = Percentual DescontoInteger
precoPromocaoValor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. Quando Tipo Desconto é igual a 1 = Preço de VendaInteger
tipoDescontoDefine o tipo de ação promocional configurada para o item. Opções: 1 = Preço de Venda; 2 = Percentual Desconto; 3 = Valor do Desconto.String
qtdApartirDeDefine a quantidade mínima de venda do grupo para aplicar a promoçãoInteger
empresaLista os dados das empresas.
numeroEmpresaNúmero da empresa participante da promoçãoInteger
nomeReduzidoNome reduzido da empresa participanteString
cnpjCNPJ da empresa participante da promoçãoString
statusSituação da empresa na promoção. A = Ativa ou I = Inativa.String























grupos

seqGrupoNúmero de código do grupoInteger
descricaoDescrição do grupo de produtos para promoçãoString
qtdItemGrupoDefine a quantidade de venda necessária, de itens pertencentes ao grupo, conforme verificação do parâmetro Tipo Quantidade, sendo em itens distintos, ou quantidade total entre os itensInteger
statusSituação do grupo na promoção. A = Ativo ou I = Inativo.String
listaGrupoPrecoAPartirDeDefine a quantidade mínima de venda do grupo para aplicar a promoção
valorDescontoValor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 3 = Valor do DescontoInteger
percentualDescontoPercentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 2 = Percentual DescontoInteger
precoPromocaoValor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. Quando Tipo Desconto é igual a 1 = Preço de VendaInteger
qtdApartirDeDefine a quantidade mínima de venda do grupo para aplicar a promoçãoInteger
itensLista os dados dos produtos
seqProdutoCódigo sequencial do produto no ERPInteger
codBarrasCódigo de barras EAN ou DUN do produto. Será considerada a embalagem em que o código informado está cadastrado.String
qtdEmbalagemQuantidade da Embalagem do produto para a promoçãoInteger
quantidadeIndica a quantidade a ser vendida do produto, para estar apto à ação promocional. Quantidade de acordo com a embalagem definida.Integer
tipoItemIndica o tipo de verificação da venda do item no combo. Opções: N = Normal ou P = Promoção.String
precoItemValor do preço do item promocional, em R$. Será considerado somente para as linhas em que o Tipo Item é igual a P (Promoção). Quando Tipo Item é igual a N, retorna valor zero.Integer
percentualDescontoPercentual de desconto a ser aplicado no item promocional. Será considerado somente para as linhas em que o Tipo Item é igual a P (Promoção). Quando Tipo Item é igual a N, retorna valor zero.Integer
validoFamiliaIndica se a promoção é válida para os demais produtos da mesma família do item informado. Opções: S = Sim ou N = Não.String
valorRefAcordoPromocIndica o tipo de valor que será usado como referência para a geração do acordo promocional, na apuração das vendas, quando se controla Verba em vendas por PDV. Opções: 1 = Preço Promocional; nulo ou 2 = Preço Atual de Venda; 3 = Custo Líquido; 4 = Custo Bruto; 5 = Custo da Última Entrada; 6 = Livre. Campo considerado apenas em itens do tipo P (Promoção).Integer
valorLivreRefAcordoPromocValor que será usado como referência para a geração do acordo promocional, na apuração das vendas, quando se controla Verba em vendas por PDV. Somente será informado quando o tipo de Valor Referência Acordo Promocional é igual a 6. Campo considerado apenas em itens do tipo P (Promoção).Integer
statusSituação do item na promoção. A = Ativo ou I = Inativo.String
seqFamiliaCódigo sequencial da famíliaInteger
promocaoPorFamiliaPromoção por famíliaString
familiaLista os dados das famílias.
seqFamiliaCódigo sequencial da família no ERPInteger
descricaoDescrição da famíliaString
produtoLista os dados dos produtos.
seqProdutoCódigo sequencial do produto no ERPInteger
descricaoReduzidaDescrição reduzida do produtoString
listaPrecoAPartirDeLista as condições dos preços
valorDescontoValor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 3 = Valor do DescontoInteger
percentualDescontoPercentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 2 = Percentual DescontoInteger
precoPromocaoValor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. Quando Tipo Desconto é igual a 1 = Preço de VendaInteger
tipoDescontoDefine o tipo de ação promocional configurada para o item. Opções: 1 = Preço de Venda; 2 = Percentual Desconto; 3 = Valor do Desconto.String
qtdApartirDeDefine a quantidade mínima de venda do grupo para aplicar a promoçãoInteger
empresaLista os dados das empresas.
numeroEmpresaNúmero da empresa participante da promoçãoInteger
nomeReduzidoNome reduzido da empresa participanteString
cnpjCNPJ da empresa participante da promoçãoString
statusSituação da empresa na promoção. A = Ativa ou I = Inativa.String



empresas

numeroEmpresaNúmero da empresa participante da promoçãoInteger
nomeReduzidoNome reduzido da empresa participanteString
cnpjCNPJ da empresa participante da promoçãoString
statusSituação da empresa na promoção. A = Ativa ou I = Inativa.String
_expandables_expandablesPropriedade para expandir os campos.String
Bloco de código
languageactionscript3
  {
   "hasNext":true,
   "items":[
      {
         "seqPromocaoPdv":0,
         "descricao":"string",
         "status":"string",
         "dataInicio":"2021-05-17T19:28:16.916Z",
         "dataFim":"2021-05-17T19:28:16.916Z",
         "tipoPromocao":"string",
         "tipoQuantidade":"string",
         "tipoQtdeCargaPdv":"string",
         "controlaVerbaPdv":"string",
         "baixaQtdeVerbaBonif":"string",
         "descricaoEtiqueta":"string",
         "codParceiro":0,
         "usuAlteracao":"string",
         "dtaAlteracao":"2021-05-17T19:28:16.916Z",
         "itens":[
            {
               "seqProduto":0,
               "codBarras":"string",
               "qtdEmbalagem":0,
               "quantidade":0,
               "tipoItem":"string",
               "precoItem":0,
               "percentualDesconto":0,
               "validoFamilia":"string",
               "valorRefAcordoPromoc":0,
               "valorLivreRefAcordoPromoc":0,
               "status":"string",
               "seqFamilia":0,
               "promocaoPorFamilia":"string",
               "familia":{
                  "seqFamilia":0,
                  "descricao":"string"
               },
               "produto":{
                  "seqProduto":0,
                  "descricaoReduzida":"string"
               },
               "listaPrecoAPartirDe":[
                  {
                     "valorDesconto":0,
                     "percentualDesconto":0,
                     "precoPromocao":0,
                     "tipoDesconto":"string",
                     "qtdApartirDe":0,
                     "empresa":{
                        "numeroEmpresa":0,
                        "nomeReduzido":"string",
                        "cnpj":"string",
                        "status":"string"
                     }
                  }
               ]
            }
         ],
         "grupos":[
            {
               "seqGrupo":0,
               "descricao":"string",
               "qtdItemGrupo":0,
               "status":"string",
               "listaGrupoPrecoAPartirDe":[
                  {
                     "valorDesconto":0,
                     "percentualDesconto":0,
                     "precoPromocao":0,
                     "qtdApartirDe":0
                  }
               ],
               "itens":[
                  {
                     "seqProduto":0,
                     "codBarras":"string",
                     "qtdEmbalagem":0,
                     "quantidade":0,
                     "tipoItem":"string",
                     "precoItem":0,
                     "percentualDesconto":0,
                     "validoFamilia":"string",
                     "valorRefAcordoPromoc":0,
                     "valorLivreRefAcordoPromoc":0,
                     "status":"string",
                     "seqFamilia":0,
                     "promocaoPorFamilia":"string",
                     "familia":{
                        "seqFamilia":0,
                        "descricao":"string"
                     },
                     "produto":{
                        "seqProduto":0,
                        "descricaoReduzida":"string"
                     },
                     "listaPrecoAPartirDe":[
                        {
                           "valorDesconto":0,
                           "percentualDesconto":0,
                           "precoPromocao":0,
                           "tipoDesconto":"string",
                           "qtdApartirDe":0,
                           "empresa":{
                              "numeroEmpresa":0,
                              "nomeReduzido":"string",
                              "cnpj":"string",
                              "status":"string"
                           }
                        }
                     ]
                  }
               ]
            }
         ],
         "empresas":[
            {
               "numeroEmpresa":0,
               "nomeReduzido":"string",
               "cnpj":"string",
               "status":"string"
            }
         ],
         "_expandables":[
            "string"
         ]
      }
   ]
}