Á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)
CnpjCNPJ da empresaStringNão há.
DataInicioData início da promoçãoDateNão há.
DataTerminoData término da promoçãoDateNão há.
SeqPromocaoPdvSequencial da promoçãoIntegerNão há
NroEmpresaNúmero da empresaIntegerNão há
StatusStatus da promoçãoStringDeve ser "A" para ativo ou "I" para inativo
VigenteOpção de vigênciaStringOpção de vigência. (T - Todas, S - Somente Vigentes, F - Vigentes Futuras)
DataHoraAlteracaoData e hora da alteraçãoDateNão há
_pageNo
integerNão há.
_pageSize
integerNão há.

Parâmetros do Corpo (Body Parameters)

Não há.

Formatos de Resposta (Response Formats)

application/json, text/json


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