top of page

Início > Ação de Vendas > Get Escalonada

Versão: 1.0

Get Escalonada

Última atualização: 21/03/2024

Este endpoint tem como objetivo coletar campanhas com determinado status e nome. Por exemplo: Campanhas de Ação de Venda com status ativo.

O endpoint get possui as seguintes características para que seja utilizado:

Endpoint Get

Sintaxe da requisição

Para que a requisição do método Post seja bem-sucedida, é necessário que

seja passado os seguintes valores dentro de um JSON:

nome

Nome da campanha

Tipo: String

status

Filtragem de itens por status da campanha, pode receber mais de um status.

Tipo: Array de String

Sintaxe da resposta

Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:

Elementos da requisição

data

Lista de ações e venda.

Tipo: Array de JSON.

id

Identificador único da ação de venda

Tipo: Integer.

nome

Nome da ação de venda

Tipo: String.

tipo_acao

Tipo da ação de venda

Tipo: String.

total_lojas

Quantidade total de lojas que possuem esta ação de venda

Tipo: Integer.

adesoes

Quantidade de adesões.

Tipo: Integer.

data_inicio

Data inicial da ação de venda

Tipo: Datetime.

data_fim

Data final da ação de venda

Tipo: Datetime.

operador

.

Tipo: String.

created_at

Data de criação da ação de venda

Tipo: Datetime.

status

Status da campanha.

Tipo: String.

codigo_campanha_fornecedor

Código de campanha do fornecedor

Tipo: String.

fornecedor

Identificador único do fornecedor na base

Tipo: Integer.

total

Quantidade de ações.

Tipo: Integer.

Respostas para erros

Caso ocorra algum erro durante a requisição, os possíveis erros são:

422 Validation Error

bottom of page