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


seqPromocaoPdv

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

descricao

Descrição da promoção combinada

status

dataInicio

Data inicial da promoção

dataFim

Data final da promoção

tipoPromocao

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

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).

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”

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.

baixaQtdeVerbaBonif

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

descricaoEtiqueta

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

codParceiro

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

usuAlteracao
dtaAlteracao
itensseqProduto

codBarras

qtdEmbalagem

quantidade

tipoItem

precoItem








































  {
   "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"
         ]
      }
   ]
}