Início > Clientes
Versão: 2.0
Clientes
Última Atualização: 15/05/2024
Nossa API de Cadastro de Clientes permite aos fornecedores registrarem novos clientes diretamente na plataforma do Abastece Shop. Essa funcionalidade possibilita uma integração eficiente entre os sistemas dos fornecedores e a nossa plataforma, garantindo uma experiência contínua para os clientes finais.
Parâmetros da requisição
status: String
Ex: "ativado", "desativado" ou "cadastrado"
pagina: Integer
Ex: 1
quantidade_pagina: Integer
Ex: 10
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
total
Quantidade total de clientes encontrada.
Tipo: Integer.
restantes
Quantidade de clientes que restam na páginação.
Tipo: Integer.
data
Lista de clientes.
Tipo: Array de JSON.
cnpj
CNPJ do cliente.
Tipo: String
Email do cliente.
Tipo: String
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
Ex: ["12345678000195", "12345678000192"]
clientes: Array de Strings
GET Clientes
Última Atualização: 15/05/2024
Este endpoint coleta os clientes cadastrados do fornecedor.
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:
Elementos da requisição
razao_social
Razão social do cliente.
Tipo: String.
cnpj
CNPJ do cliente.
Tipo: String.
Email do cliente.
Tipo: String.
inscricao_estadual
Inscrição estadual.
Tipo: String.
telefone
Telefone do cliente.
Tipo: String.
website
Website.
Tipo: 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á:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
POST Clientes
Última Atualização: 15/05/2024
O post de cliente adiciona novos clientes para o fornecedor.
Endpoint POST
Parâmetros da Requisição
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
id: Integer
Ex: 1
Sintaxe da Resposta
Elementos da Resposta
status
Status do cliente na base da Yandeh.
Tipo: String.
created
Data de criação do cliente.
Tipo: String.
updated
Data de atualização dos status.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
GET Cliente Status
Última Atualização: 15/05/2024
Este endpoint é utilizado para consultar os status do cliente utilizando o id do cliente_status.
Endpoint GET
Parâmetros da requisição
status: String - Status atual do cliente.
Ex: "ativado", "desativado" ou "cadastrado"
pagina: Integer - Número da página que deseja a consulta
Ex: 1
quantidade_pagina: Integer - Quantidade limite de clientes retornados por página. Por default e o limite máximo que poderá ser retornado é 500.
Ex: 10
clientes: Array de Strings - Array de cnpj dos clientes que desejam no retorno da consulta.
Ex via Postman: "12345678901232" - (Um em cada linha no query_parms).
Ex via API: ["12341251235123", "12341235134123"]
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
total
Quantidade total de clientes encontrada.
Tipo: Integer.
restantes
Quantidade de clientes que restam na páginação.
Tipo: Integer.
data
Lista de clientes.
Tipo: Array de JSON.
cnpj
CNPJ do cliente.
Tipo: String
Email do cliente.
Tipo: String
status
Status do cliente na base de dados Yandeh.
Tipo: String
GET Clientes v3
Última Atualização: 02/06/2025
Este endpoint coleta todos os clientes cadastrados não deletados da base, podendo passar opções de filtros com os exemplos abaixo.
Endpoint GET
cnpj: CNPJ cliente.
Ex: "12345678000195".
Ex: "2025-02-01"
end_date: String (data)
Ex: "2025-01-01"
created_at: String (data)
cnpj
CNPJ do cliente.
Tipo: String
nome
Nome do cliente.
Tipo: String
razao_social
Razão social do cliente.
Tipo: String
Parâmetros da requisição
status: String
Ex: "ativado", "desativado" ou "cadastrado"
pagina: Integer
Ex: 1
por_pagina: Integer
Ex: 10
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
clientes
Lista de clientes retornados.
Tipo: Array de JSON.
created_at
Data de criação.
Tipo: String (Datetime).
status
Status do cliente.
Tipo: String (Datetime).
Email do cliente.
Tipo: String
atributos
Atributos do cliente.
Tipo: String
total
Total de clientes
Tipo: Integer
pagina
Pagina atual.
Tipo: Integer.
limite
Limite de clientes por página.
Tipo: Integer.
total
Total de clientes demonstrados.
restante
Tipo: Integer.
Quantidade de clientes restantes para a busca.
Tipo: Integer.
GET Onboarding clientes
Última Atualização: 02/06/2025
Este endpoint coleta os clientes cadastrados do fornecedor com opções de paginação e filtros.
Endpoint GET
PUT Clientes - Atributos
Endpoint responsável por cadastrar atributos dos clientes.
Endpoint PUT
URL
Sintaxe da Requisição
-
Tipo de requisição: POST .
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"cnpj": "01479971000111",
"chave": "cluster12",
"valor": "Originalidade"
}
]
Exemplo:
curl --location --request PUT 'https://yandeh-seller-integration.yandeh.com.br/clientes/atributos' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw ' [
{
"cnpj": "01479971000129",
"chave": "cluster12",
"valor": "Originalidade"
}
]'
Elementos da Requisição
cnpj: Cadastro Nacional da Pessoa Jurídica (CNPJ) do cliente.
-
Campo obrigatório.
Tipo: String
chave: Chave para o atributo.
-
Campo obrigatório.
Tipo: String
valor: Valor do atributo.
-
Campo obrigatório.
Tipo String.
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados
com status code 200.Exemplo de retorno:
[{}]
Respostas para erros
400 Bad Request - Tentativa de cadastro com um CNPJ inválido
{
"mensagem": "Erro ao processar atualização de atributos de clientes",
"detalhes": {
"processados": 11,
"sucessos": 0,
"falhas": 1,
"erros": [
{
"indice": 1,
"statusCode": 500,
"erro": "{}"
}
]
}
}
DELETE Clientes - Atributos
Endpoint responsável por deletar atributos dos clientes.
Endpoint DELETE
URL
Sintaxe da Requisição
-
Tipo de requisição: POST .
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"cnpj": "01479971000111",
"chave": "cluster12"
}
]
Exemplo:
curl --location --request DELETE 'https://yandeh-seller-integration.yandeh.com.br/clientes/atributos' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw ' [
{
"cnpj": "01479971000129",
"chave": "cluster12"
}
]'
Elementos da Requisição
cnpj: Cadastro Nacional da Pessoa Jurídica (CNPJ) do cliente.
-
Campo obrigatório.
Tipo: String
chave: Chave para o atributo.
-
Campo obrigatório.
Tipo: String
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados
com status code 200.Exemplo de retorno:
[{}]
Respostas para erros
400 Bad Request - Tentativa de cadastro com um CNPJ inválido
{
"mensagem": "Erro ao processar deleção de atributos de clientes",
"detalhes": {
"processados": 11,
"sucessos": 0,
"falhas": 1,
"erros": [
{
"indice": 1,
"statusCode": 500,
"erro": "{}"
}
]
}
}