Home TOTVS Varejo Supermercados

Árvore de páginas

  • Criado por Usuário desconhecido (eliezer.jose) em 02 set, 2020

Objetivo

A finalidade deste método é possibilitar a consulta de promoções por um período de no máximo 31 dias.

Chamada

GET /api/v1/Promocoes/obter-por-periodo

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 empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000stringNão há
DataInicioData início que deseja filtrar.stringNão há
DataTerminoData final que deseja filtrar.stringNão há
QuantidadePorPaginaQuantidade de resultados por páginaintegerNão há
PaginaAtualPágina atualintegerNão há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "seqPromocaoPdv": 0,
    "descricao": "string",
    "status": "string",
    "dataInicio": "2020-09-02T17:44:04.410Z",
    "dataFim": "2020-09-02T17:44:04.410Z",
    "tipoPromocao": "string",
    "descricaoEtiqueta": "string",
    "itens": [
      {
        "seqProduto": 0,
        "qtdEmbalagem": 0,
        "quantidade": 0,
        "precoItem": 0,
        "percentualDesconto": 0,
        "status": "string",
        "seqFamilia": 0,
        "promocaoPorFamilia": "string",
        "familia": {
          "seqFamilia": 0,
          "descricao": "string"
        },
        "produto": {
          "seqProduto": 0,
          "descricaoReduzida": "string"
        },
        "listaPrecoAPartirDe": [
          {
            "valorDesconto": 0,
            "percentualDesconto": 0,
            "precoPromocao": 0,
            "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,
            "qtdEmbalagem": 0,
            "quantidade": 0,
            "precoItem": 0,
            "percentualDesconto": 0,
            "status": "string",
            "seqFamilia": 0,
            "promocaoPorFamilia": "string",
            "familia": {
              "seqFamilia": 0,
              "descricao": "string"
            },
            "produto": {
              "seqProduto": 0,
              "descricaoReduzida": "string"
            },
            "listaPrecoAPartirDe": [
              {
                "valorDesconto": 0,
                "percentualDesconto": 0,
                "precoPromocao": 0,
                "qtdApartirDe": 0,
                "empresa": {
                  "numeroEmpresa": 0,
                  "nomeReduzido": "string",
                  "cnpj": "string",
                  "status": "string"
                }
              }
            ]
          }
        ]
      }
    ],
    "empresas": [
      {
        "numeroEmpresa": 0,
        "nomeReduzido": "string",
        "cnpj": "string",
        "status": "string"
      }
    ]
  }
]