Verba pedido bonificado
Endpoints responsáveis pelo gerenciamento das verbas dos vendedores para criação dos pedidos bonificados.
Início > Verba pedido bonificado
Versão: 2.0
GET Verba pedido bonificado
Endpoint GET
Endpoint para consulta das verbas de bonificação dos vendedores.
URL:
https://yandeh-seller-integration.yandeh.com.br/verba-pedido-bonificado
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta das verbas.
vendedor_email: email do vendedor.
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/verba-pedido-bonificado?vendedor_email=vendedor@40exemplo.com' \
--header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os pedidos com status code 200.
Exemplo de retorno:
{
"message": "Extrato de conta obtido com sucesso",
"data": {
"saldoAtual": 500,
"saldoDebitado": 0,
"saldoBloqueado": 0,
"saldoDisponivel": 500
}
}
Elementos da Resposta
saldoAtual: Saldo atual do vendedor.
Tipo: Float.
saldoDebitado: Saldo já utilizado pelo vendedor.
Tipo: Float.
saldoBloqueado: Saldo bloqueado do vendedor. Pedido aguardando processamento.
Tipo: Float.
saldoDisponivel: Saldo disponível para uso
Tipo: Float.
PATCH Verba pedido bonificado
Endpoint para cadastro e atualização da verba de bonificação dos vendedores.
Endpoint PATCH
URL:
https://yandeh-seller-integration.yandeh.com.br/verba-pedido-bonificado
Sintaxe da requisição
-
Tipo de requisição: PATCH.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição :
Envio do JSON de acordo com o cadastro/atualização da verba:
Exemplo:
curl --location --request PATCH 'https://yandeh-seller-integration.yandeh.com.br/verba-pedido-bonificado' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '{
"vendedor_email": "vendedor@exemplo.com",
"valor": 500.0
}'
Elementos da requisição
vendedor_email: Email do vendedor.
-
Deve ser informado um email válido, de um vendedor cadastrado.
valor: Valor da verba disponível
-
Aceita números positivos e negativos.
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os pedidos com status code 200.
Exemplo de retorno:
{
"message": "Créditos sincronizados com sucesso"
}
Resposta para erros
Status code 400 Bad Request:
Vendedor não encontrado (não cadastrado)
{
"error": {
"status": 400,
"message": "Vendedor não encontrado",
"errors": [
{
"type": "seller_not_found",
"details": {
"actorEmail": "vendedor@exemplo.com"
}
}
]
}
}
Status code 401 Unauthorized:
Token inválido
{
"sucesso": false,
"erro": "Não autorizado",
"detalhes": "Token de acesso inválido ou expirado"
}
Status code 500 Internal Server Error:
Erro interno
{
"sucesso": false,
"erro": "Erro interno do servidor",
"detalhes": "Entre em contato com o suporte técnico"
}