Início > Escalonada
Versão: 2.0
Escalonada
Última Atualização: 04/02/2025
Esta integração permite que sejam gerenciadas campanhas do tipo escalonada.
Endpoint GET
https://yandeh-seller-integration.yandeh.com.br/v2/acao_venda/escalonada
Parâmetros da requisição
id: Integer
Id da campanha.
Ex: 159
status: String
Observação: O status será desconsiderado caso seja enviado em conjunto com o Id.
Opções: ativo, ativo_mkt, ativo_app, inativo, finalizado e rascunho.
Ex: ativo
Sintaxe da resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
acoes_venda
Corpo da ação de venda retornada.
Tipo: JSON.
data
Dados retornados pela API.
Tipo: Lista de JSON.
id
Id da campanha.
Tipo: Integer.
nome
Nome da campanha.
Tipo: String.
seller
Seller da campanha.
Tipo: String.
status
Status da campanha.
Opções: ativo, ativo_mkt, ativo_app, inativo, finalizado e rascunho.
Tipo: String.
criador
Nome do usuário criador.
Tipo: String.
data_fim
Data de finalização da campanha.
Tipo: Datetime.
descricao
Descrição da campanha.
Tipo: String.
tipo_acao
Tipo de campanha. Para está integração, o valor será "escalonada".
Tipo: String.
ids_filhos
Ids de campanhas filhas.
Tipo: Lista de Integer.
plataforma
Plataforma onde a campanha será exibida.
Opções: "marketplace", "smartforce" e "marketplace+smartforce".
Tipo: String.
data_inicio
Data de inicio da campanha.
Tipo: Datetime.
cross_sellers
Ids de outros sellers incluídos na campanha.
Tipo: Lista de Integer.
is_cross_seller
Verificador booleano para campanhas cross seller.
Tipo: Boolean.
nome_integracao
Nome da integração.
Tipo: String.
total
Total de campanhas.
Tipo: Integer.
GET Escalonada
Última Atualização: 04/02/2025
Este endpoint irá listar campanhas escalonada cadastradas pelo fornecedor.
Neste endpoint, existem duas formas de configurar o público-alvo, pelo campo "publico_alvo" com os cnpjs dos clientes ou pelo campo "grupo_cliente" com os ids de grupos de clientes.
As duas formas representadas por um json com as informações da respectiva configuração.
A regra para isso, é de que não possam ser enviadas informações de público-alvo e grupo de clientes simuntaneamente.
Público-alvo
Elementos da Requisição
nome
Nome para a campanha.
Tipo: String.
tipo_acao
Nome do tipo de ação. Informar "escalonada" para esta integração.
Tipo: String.
plataforma
Plataforma de exibição da campanha.
Tipo: String.
nome_interno
Nome para a campanha internamente.
Tipo: String.
valor_maximo
Valor máximo que a campanha pode atingir.
Tipo: Float.
volume_maximo
Volume máximo de itens para a campanha.
Tipo: Float.
data_inicio
Data de inicio da campanha.
Tipo: Datetime.
data_fim
Data do fim da campanha.
Tipo: Datetime.
descricao
Descrição da campanha.
Tipo: String.
descricao_integracao
Descrição para a integração da campanha.
Tipo: String.
banner_campanha
URL para a imagem do banner da tela de campanha.
Tipo: String.
banner_home
URL para a imagem de banner para a home.
Tipo: String.
banner_mobile
URL para o banner mobile.
Tipo: String.
produtos_escalonada
Produtos da campanha.
Tipo: Lista de JSON.
familia
Familia dos produtos.
Tipo: String.
limite
Limite de produtos para a familia.
Tipo: String.
produtos
Produtos da campanha.
Tipo: Lista de JSON.
ean_ou_dun
Código ean ou dun do produto.
Tipo: String.
origem_verba
Origem verba.
Tipo: String.
ordem
Posição na ordem dos produtos.
Tipo: Integer.
status
Status de produto "ativo" ou "inativo".
Tipo: String.
nome_produto
Nome do produto.
Tipo: String.
nome_fornecedor
Nome do fornecedor do produto.
Tipo: String.
cnpj_fornecedor
Cnpj do fornecedor.
Tipo: String.
limite_produto_total
Limite para este produto.
Tipo: Integer.
isencao_encargos
Indicador booleano de isenção de encargos.
Tipo: Boolean.
niveis
Níveis de escalonamento da meta.
Tipo: JSON.
meta_01 (meta_02, meta_03...)
Numero da meta.
Tipo: Integer.
beneficio_01
Beneficio da meta.
Tipo: Integer.
publico_alvo
Nome do publico alvo do produto.
Tipo: String.
publico_alvo
Configuração de clientes para o público-alvo.
Tipo: Lista de JSON.
nome
Nome do público-alvo
Tipo: String.
banner
Configuração do banner.
Tipo: JSON.
descricao
Descrição do banner.
Tipo: String.
descricao_integracao
Descrição da integração.
Tipo: String.
exibir_banner
Booleano para a exibição do banner.
Tipo: Boolean.
banner_home
URL para o banner da home.
Tipo: String.
banner_campanha
URL para o banner da campanha.
Tipo: String.
banner_mobile
URL para o banner mobile.
Tipo: String.
auto_upload_banner
Booleano para o auto-upload do banner.
Tipo: Boolean.
publico_alvo
Lista de clientes para o publico alvo.
Tipo: Lista de JSON.
cnpj
Cnpj do cliente.
Tipo: String.
status
Status do cliente.
Opções: "ativo" ou "inativo".
Tipo: String.
todos_clientes
Booleano para considerar ou não todos os clientes.
Tipo: Boolean.
auto_upload_bunner
Booleano para o auto upload do banner.
Tipo: Boolean.
exibir_banner
Booleano para a exibição do banner.
Tipo: Boolean.
limite_uso_cliente
Booleano para permitir ou não o limite de uso para o cliente.
Tipo: Boolean.
tipo_meta
Tipo utilizado para aferir a meta.
Opção: "valor".
Tipo: String.
tipo_beneficio
Tipo de beneficio empregado a campanha.
Opções: desconto_percentual, valor_fixo.
Tipo: String.
Grupo de clientes
Para realizar o envio da campanha para grupos de clientes, é necessário informa-los como o exemplo a seguir:
Com a remoção do campo "publico_alvo" deve ser adicionado o seguinte campo:
grupo_cliente
Lista de grupos de clientes.
Tipo: Lista de Integer.
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 Resposta
status
Verificador booleano de sucesso ou falha na requisição.
Tipo: Boolean.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
acao_id
Id da ação de vendas criada.
Tipo: Integer.
errors
Erros ocorridos na requisição.
Tipo: Lista.
Caso as metas sejam enviadas com valores regressivos.
POST Escalonada
Última Atualização: 04/02/2025
Este método cadastra campanhas escalonada na plataforma da abastece shop.
Endpoint POST
https://yandeh-seller-integration.yandeh.com.br/v2/acao_venda/escalonada
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:
PUT Escalonada
Última Atualização: 04/02/2025
Este método modifica campanhas escalonada do fornecedor.
Endpoint PUT
Id ação e venda inválido.
https://yandeh-seller-integration.yandeh.com.br/v2/acao_venda/escalonada/{id_campanha}
Parâmetros da requisição
id *: Integer
Obs: Id da campanha.
Ex: 1.
Sintaxe da Requisição
Para que a requisição do método Put seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da Requisição
data_inicio
Data de início da campanha.
Tipo: Datetime.
data_fim
Data de finalização da campanha.
Tipo: Datetime.
status
Status "inativo" para inativar campanhas.
Caso não seja enviado, apenas a vigência da campanhas será alterada.
Tipo: String.
produtos
Produtos com limitação de quantidade para a campanha.
Tipo: Array de JSON.
ean_ou_dun
Código ean ou dun do produto.
Tipo: String.
limite_produto_total
Quantidade limite do produtos para a campanha.
Tipo: Integer.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
404 Not found
publico_alvo
Público alvo cadastrado na campanha
Tipo: Array de JSON
nome
Nome do público alvo cadastrado na campanha
Tipo: String
publico_alvo
Público alvo que vai ser alterado
Tipo: Array de JSON
grupo_cliente
Grupo de cliente que vai ser alterado
Tipo: Array de JSON
publico_alvo
Público alvo que vai ser alterado
Tipo: String
id
ID do grupo de cliente que vai ser alterado
Tipo: Integer
acao
Ação que deseja alterar o grupo de cliente
Tipo: String
cnpj
CNPJ do cliente que vai ser alterado
Tipo: String
status
Status que deseja alterar do cliente
Tipo: String
Exemplo: "ativo" ou "inativo"
Exemplo: "incluir" ou "excluir"