Endpoints destinados à gestão de trocas, incluindo o cadastro das trocas e o controle dos valores de verba para vendedor e cliente.
Início > Gestão de trocas
Versão: 2.0
Gestão de trocas
GET Gestão de trocas
Endpoint responsável pela consulta das trocas de mercadorias.
Endpoint GET
URL:
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta das verbas.
status: Status da troca.
-
Status disponíveis: "aguardando_integracao", "pendente", "aprovado" e "recusado".
-
Não obrigatório
vendedor_email: Email do vendedor
-
Não obrigatório
cliente_cnpj: CNPJ do cliente.
-
Não obrigatório
pagina: Página a ser exibida.
-
Página inicial 1
-
Não obrigatório. Default 1
por_pagina: Quantidade por página ser exibida.
-
Não obrigatório. Default 10
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/gestao-troca?status=aguardando_integracao&status=pendente&vendedor_email=exemplo%40email.com&pagina=1&por_pagina=100' \ --header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará as trocas com o status code 200.
Exemplo de retorno:
{
"detail": {
"success": true,
"message": "Gestao de troca encontrada com sucesso"
},
"data": [
{
"id": 321,
"vendedor_external_id": 1212,
"vendedor_email": "exemplo@email.com",
"cliente_external_id": 1313,
"cliente_cnpj": "12345678912121",
"company_id": 1234,
"status": "aguardando_integracao",
"valor_total": 100.5,
"data_solicitacao": "2025-01-01T00:00:00.000+00:00",
"data_resolucao": "2025-01-02T00:00:00.000+00:00",
"aprovacao_id": 212,
"itens": [
{
"id": 317,
"embalagem": 200123,
"quantidade": 1,
"pedido_id": 42222,
"preco": 100.5,
"motivo": "Vencimento",
"lote": "MG70A12",
"validade": "2025-01-01",
"lacre": "125898",
"ean_ou_dun": "7899916906628",
"associated_ean": null,
"pallet_multiplo_dun": 0
}
]
}
]
}
Elementos da Resposta
vendedor_external_id: ID do vendedor na Yandeh.
Tipo: Integer.
vendedor_email: Email do vendedor.
Tipo: String.
cliente_external_id: ID do cliente na Yandeh.
Tipo: Integer.
cliente_cnpj: CNPJ do cliente.
Tipo: String.
company_id: ID do fornecedor na Yandeh.
Tipo: Integer.
status: Status da troca.
Tipo: String.
valor_total: Valor total da troca
Tipo: float.
data_solicitacao: Data da abertura da troca.
Tipo: String.
data_resolucao: Data do fechamento da troca.
Tipo: String.
aprovacao_id: ID da aprovação.
Tipo: Integer.
Itens: Itens da troca
id: ID do produto na Yandeh.
Tipo: Integer.
embalagem: ID da embalagem do produto.
Tipo: Integer.
quantidade: Quantidade do produto para troca.
Tipo: Integer.
pedido_id: Id do pedido Yandeh de venda correspondente ao produto.
Tipo: Integer.
preco: Valor do produto.
Tipo: float.
motivo: Informações do motivo da troca.
Tipo: String.
lote: Lote do produto de troca.
Tipo: String.
validade: Validade do produto de troca.
Tipo: String.
lacre: Número do lacre inserido no produto de troca.
Tipo: String..
ean_ou_dun: Código ean ou dun do produto.
Tipo: String.
associated_ean: Código ean associado ao produto.
Tipo: String.
pallet_multiplo_dun: Múltiplo de venda para comercialização da embalagem.
Tipo: String.
{
"detail": {
"success": false,
"message": "Status inválido. Os status válidos devem ser enviados em string ou dentro de um array:aguardando_integracao, pendente, aprovado, recusado"
},
"data": {}
}
Endpoint responsável pel cadastro e atualização das trocas.
Endpoint PUT
URL:
Sintaxe da Requisição
-
Tipo de requisição: PUT.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
{
"status": "aprovado",
"aprovacao_id": 753,
"status_fornecedor": "aprovado"
}
Exemplo:
curl --location --request PUT 'https://yandeh-seller-integration.yandeh.com.br/gestao-troca' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '{
"status": "aprovado", "aprovacao_id": 692, "status_fornecedor": "aprovado"
}'
Elementos da Requisição
status: Status Yandeh
Opções disponíveis : "aguardando_integracao", "pendente", "aprovado", "recusado"
Tipo: String.
aprovacao_id: ID da aprovação
Tipo: String
status_fornecedor: Status da troca no fornecedor
Tipo: String
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará a mensagem de sucesso com status code 200.
Exemplo de retorno:
{
"detail": {
"success": true,
"message": "Gestao de troca atualizada com sucesso"
},
"data": {
"success": true,
"message": "Solicitação aprovado com sucesso.",
"approvalRequestId": 123,
"status": "aprovado",
"approverId": 753
}
}
Respostas para erros
400 Bad Request
Atualizar o status em uma sequencia inválida:
{
"detail": {
"success": false,
"message": [
{
"success": false,
"message": "Não é possível alterar o status de 'aprovado' para 'pendente'. Progressão inválida."
}
]
},
"data": {}
}
Informar a aprovação ID incorreta:
{
"detail": {
"success": false,
"message": [
{
"success": false,
"message": "Solicitação não encontrada."
}
]
},
"data": {}
}
PUT Gestão de trocas
GET Gestão de trocas - Verba
Endpoint responsável por retornar as informações relacionadas às verbas disponíveis e utilizadas por vendedores e clientes no contexto da gestão de trocas.
Endpoint GET
URL:
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta das verbas.
vendedor_email: Email do vendedor.
-
Campo obrigatório
cliente_cnpj: CNPJ do cliente.
-
Não obrigatório
pagina: Página de consulta.
-
Não obrigatório
por_pagina: Quantidade por página.
-
Não obrigatório
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/verba-gestao-troca?vendedor_email=vendedor@40exemplo.com&pagina=1&por_pagina=100' \
--header 'Authorization: Bearer ...'
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
detail
Detalhes do retorno.
Tipo: JSON.
success
Indicador booleano do sucesso da requisição.
Tipo: Boolean.
message
Mensagem de retorno da API.
Tipo: String.
data
Dados retornados pela API.
Tipo: Array de JSON.
saldoAtual
Saldo atual do vendedor em verba.
Tipo: Double.
saldoDebitado
Saldo debitado.
Tipo: Double.
saldoBloqueado
Saldo bloqueado.
Tipo: Double.
saldoDisponivel
Saldo disponível.
Tipo: Double.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Caso não seja enviado um campo obrigatório:
400 Bad Request
Caso seja enviado um e-mail inválido.
Sintaxe da Requisição
Para que a requisição do método PATCH seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Exemplo:
curl --location --request PATCH 'https://yandeh-seller-integration.yandeh.com.br/verba-gestao-troca' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data-raw '{
"vendedor_email": "exemplo@email.com", "valor": 30.02
}'
Elementos da Requisição
status
Status Yandeh.
Opções: "aguardando_integracao", "pendente", "aprovado", "recusado"
Tipo: String.
aprovacao_id
Id de aprovação.
Tipo: Integer.
status_fornecedor
Status do pedido no fornecedor. O valor deste campo é de escolha do fornecedor.
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á:
detail
Detalhes da requisição.
Tipo: JSON.
success
Indicador booleano de sucesso da requisição.
Tipo: Boolean.
message
Mensagem de sucesso ou falha da requisição.
Tipo: String.
data
Dados de retorno da requisição.
Tipo: JSON.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Em caso de e-mail inválido:
PATCH Gestão de trocas - Verba
Este PUT tem o objetivo de permitir alterações em verbas de vendedores em trocas cadastradas na plataforma.