Início > Histórico de Títulos
Versão: 2.0
Histórico de Títulos
Última Atualização: 20/03/2024
Este serviço visa integrar os dados de histórico de títulos do fornecedor com a base de dados da plataforma.
Parâmetros da requisição
pagina: Integer.
Ex: 1
por_pagina: Integer.
Ex: 20
numero_pedido: Array de String.
Ex: ["4221", "4223"]
numero_nota: Array de String.
Ex: ["123456"]
cnpj: Array de String.
Ex: ["01234567000189", "98765432000101"]
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
O corpo desta requisição consiste em um Array contendo os dados da relação entre produto e grupo de produtos em formato JSON.
detail
Detalhes da requisição.
Tipo: JSON.
success
Identificador 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: Array de JSON.
id
Id do histórico de títulos.
Tipo: Integer.
cnpj_cliente
CNPJ do cliente.
Tipo: String.
codigo_barras
Código de barras do título.
Tipo: Integer.
data_pagamento_titulo
Dara de pagamento do título.
Tipo: String datetime.
data_pedido
Data em que o pedido foi realizado.
Tipo: String datetime.
data_vencimento_titulo
Data de vencimento do título.
Tipo: String datetime.
numero_nota_fiscal
Número da nota fiscal.
Tipo: Integer.
numero_pedido
Número do pedido.
Tipo: Integer.
valor_titulo
Valor do título.
Tipo: Float.
GET Histórico de Títulos
Última Atualização: 09/06/2025
Este endpoint retorna histórico de títulos cadastrados pelo fornecedor, com a possibilidade de busca paginada e com filtros por cnpj do cliente, número da nota fiscal e número do pedido.
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:
POST Histórico de Títulos
Última Atualização: 22/04/2024
O post trás uma lista com os títulos de pedidos de acordo com os dados passado no payload da requisição.
Endpoint POST
Elementos da Requisição
cnpj_cliente *
CNPJ do Cliente.
Tipo: String.
codigo _barras
Código de barras do boleto.
Tipo: String.
data_pagamento_titulo
Data do pagamento do título. Obrigatório termos o controle quando pago. Caso o cliente ainda não tenha efetuado o pagamento campo poderá estar vazio.
Tipo: String.
data_pedido *
Data do pedido.
TIpo: String
data_vencimento_titulo *
Data do vencimento do título.
Tipo: String
numero_nota_fiscal *
Nùmero da nota fiscal de venda
Tipo: String
numero_pedido *
Número do pedido
Tipo: String
valor_titulo *
Valor do título
Tipo: Float
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
success
IDs que deram certo na criação.
Tipo: Array.
failure
Tipo: Array.
error_type
Tipo do erro que pode ter acontecido durante a requisição.
Tipo: String
readable_message
Mensagem para explicar o tipo de erro dependendo do que possa aparecer no "error_type".
Tipo: String.
additional_data
Dados adicionais sobre o erro.
Tipo: Array.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
success
PUT Histórico de Títulos
Última Atualização: 07/03/2024
O put histórico de títulos permite que sejam atualizados os dados dos históricos de títulos.
Endpoint PUT
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:
Tipo: String
numero_pedido *
Número do pedido.
TIpo: String
valor_titulo *
Valor do título.
Tipo: Float
id *
ID do título para atualizar.
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á:
Elementos da Resposta
IDs dos calendários que foram criados.
Tipo: Array.
failure
Tipo: Array.
error_type
Tipo do erro que pode ter acontecido durante a requisição.
Tipo: String
readable_message
Mensagem para explicar o tipo de erro dependendo do que possa aparecer no "error_type".
Tipo: String.
additional_data
Dados adicionais sobre o erro.
Tipo: Array.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
Elementos da Requisição
cnpj_cliente *
CNPJ do Cliente.
Tipo: String.
codigo _barras
Código de barras do boleto.
Tipo: String.
data_pagamento_titulo
Data do pagamento do título. Obrigatório termos o controle quando pago. Caso o cliente ainda não tenha efetuado o pagamento campo poderá estar vazio.
Tipo: String.
data_pedido *
Data do pedido.
TIpo: String
data_vencimento_titulo *
Data do vencimento do título.
Tipo: String
numero_nota_fiscal *
Número da nota fiscal de venda.
DELETE Histórico de títulos
Endpoint para exclusão de títulos.
Endpoint DELETE
URL:
https://yandeh-seller-integration.yandeh.com.br/historico-titulos
Parâmetros da requisição
-
Tipo de requisição: DELETE .
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"id": "83534"
},
{
"id": "83667"
}
]
Exemplo
curl --location --request DELETE 'https://yandeh-seller-integration.yandeh.com.br/historico-titulos' \
--header 'Authorization: Bearer ...' \
--header 'Content-Type: application/json' \
--data '[
{
"id": "83534"
},
{
"id": "83667"
}
]'
Elementos da requisição
ID: Identificador (ID) do título.
-
Pode ser informado um ou mais títulos para exclusão.
Sintaxe da resposta
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.Exemplo de retorno:
{
"deletados": [
{
"id": 83534
},
{
"id": 83667
}
]
}