Árvore de páginas

Versões comparadas

Chave

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

Objetivo

Método de consulta e gerenciamento das promoções personalizadas.

Chamada

GET /api/v1/PromocaoPersonalizadaParceiro

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
CnpjEmpresaCNPJ da empresa utilizada como filtro de informações. stringOpcional. Formato: 00000000000000
NroEmpresaNúmero de Empresa utilizada como filtro de informações. 

integer($int32)

Opcional
NroSegmentoNúmero do segmento de venda para filtrar aspromoções. integer($int32)Opcional
StatusA = ativo (somente registros ativos), I = inativo (somente registros inativos). Padrão: A. OpcionalstringOpcional
SeqpromocpersonalizadaFiltro de promoção específica. integer($int32)Opcional
DescricaoFiltro por descrição.stringOpcional
DtaHorAlteracaoFiltro para buscar promoções alteradas a partir de uma data.

string($date-time)

Opcional
IndTipoPromocaoFiltro para buscar promoções de um determinado tipo (mecânica).stringOpcional
DtaInicioFiltro para buscar promoções que tem início a partir de uma data.string($date-time)Opcional
FieldsCamposstringNão há.
OrderOrdenaçãostringNão há.
PageNúmero de página

integer($int32)

Não há.
PageSizeTamanho de página

integer($int32)

Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

Bloco de código
languageactionscript3
{
  "hasNext": true,
  "items": [
    {
      "seqPromocPersonalizada": 0,
      "descricao": "string",
      "textoLegal": "string",
      "dtaInicial": "2020-11-18T20:11:52.914Z",
      "dtaFinal": "2020-11-18T20:11:52.914Z",
      "indTipoPromocao": "string",
      "indExigeIdenficacaoCliente": "string",
      "indExigeRegistroCompleto": "string",
      "indExigeAtivacaoOferta": "string",
      "qtdTotalAlocada": 0,
      "status": "string",
      "qtdLimiteCliente": 0,
      "vlrTicketMedioMinimo": 0,
      "vlrTicketMedioMaximo": 0,
      "vlrMinimoCompra": 0,
      "vlrDesconto": 0,
      "dtaHorInclusao": "2020-11-18T20:11:52.914Z",
      "dtaHorAlteracao": "2020-11-18T20:11:52.914Z",
      "empresas": [
        {
          "seqPromocPersonalizada": 0,
          "nroEmpresa": 0,
          "cnpj": "string",
          "status": "string",
          "dtaHorInclusao": "2020-11-18T20:11:52.914Z",
          "dtaHorAlteracao": "2020-11-18T20:11:52.914Z"
        }
      ],
      "produtos": [
        {
          "seqPromocPersonalizada": 0,
          "seqProduto": 0,
          "qtdEmbalagem": 0,
          "status": "string",
          "nroSegmento": 0,
          "vlrPrecoAtual": 0,
          "vlrPrecoPromocional": 0,
          "vlrDesconto": 0,
          "percDesconto": 0,
          "qtdTotalAlocada": 0,
          "qtdLimiteCliente": 0,
          "dtaHorInclusao": "2020-11-18T20:11:52.914Z",
          "dtaHorAlteracao": "2020-11-18T20:11:52.914Z"
        }
      ]
    }
  ]
}

...