APIs Auxiliares - Detalhes da Venda e Cancelamento de Venda

O objetivo principal das APIs Auxiliares é permitir visualizar detalhes de uma venda e realizar o cancelamento de uma venda por API de maneira automatizada, evitando a necessidade de fazer essa tarefa manualmente.

A API Detalhes da Venda possibilita visualizar o status e todas as informações relativas a uma única venda, sem necessitar do uso do parâmetro data ou saber se esta venda é ou não split. Para isso o campo id_venda presente no retorno da API Movimento de Vendas é utilizado, em breve o campo está também disponível na API Movimento de Vendas Split.

A API Cancelamento de Venda permitir cancelar de maneira automatizada uma venda. Para isso o campo id_venda presente no retorno da API Movimento de Vendas é utilizado, em breve o campo está também disponível na API Movimento de Vendas Split. Além disso, cada tipo de venda possui um prazo máximo para cancelamento que deve ser observado ao realizar o cancelamento.

As APIs Liquidações (Antecipações, Débito e Crédito) devem ser utilizadas em conjunto para ser a visibilidade total da conciliação de vendas Blu.

Orientações

  • É necessário um token para ter acesso aos dados.

Esse token é disponibilizado pelo time de Integração da Blu, quando solicitado pelo executivo de contas. Além dele, outros campos podem ser preenchidos opcionalmente no header.

API

Fique atento! para visualizar os exemplos de retornos da API, clique no botão > para abrir o campo de leitura

Detalhes da Venda

GET https://api.blu.com.br/b2b/sales/details/{id_venda}

Esta API é responsável por retornar os detalhes de uma venda utilizando o id_venda.

Objetivo

Possibilitar aos varejistas verificar todos os dados atualizados relativos a uma cobrança.

Headers

Name
Type
Description

Authorization*

String

Token de operação

{
    "data": {
        "data_ocorrencia": "AAAA-MM-DD HH:MM:SS",
        "tipo_da_venda": "tipos_de_venda",
        "status": "confirmed",
        "valor_venda_total_bruto": 00.00,
        "valor_venda_total_liquido": 00.00,
        "taxas": 00.00,
        "via_de_venda": "via de venda",
        "parcelas": "0",
        "adquirente": "Adquirente",
        "bandeira": "Bandeira",
        "numero_cartao": "000000******0000",
        "cod_autorizacao": "000000",
        "cv_nsu": "000000000000"
    },
    "split": null
}

O retorno desta consulta é um arquivo JSON, contendo os dados da venda buscada. Abaixo vemos todos os campos que serão retornados:

Campos da transação
Descrição

data_ocorrencia

Data de ocorrência da transação no formato AAAA-MM-DD.

tipo_da_venda

Tipo de venda da transação, sendo débito ou crédito.

status

Status da transação.

valor_venda_total_bruto

Valor bruto original da venda.

valor_total_liquido

Valor líquido original da venda.

taxas

Valor total de taxas da venda.

via_de_venda

Via que a transação foi realizada.

parcelas

Número total de parcelas da transação.

adquirente

Adquirente envolvida na transação

bandeira

Bandeira do cartão que efetuou a transação.

numero_cartao

Número do cartão que efetuou a transação.

cod_autorizacao

Código de autorização da transação.

cv_nsu

NSU da transação.

nome_loja

Razão social daquele que realizou a venda.

percentual_divisao

percentual da venda splitada.

valor_dividido

Valor splitado bruto da venda.

minha_taxa

Valor da taxa de quem está realizando a consulta da transação.

taxa_vendedor

Valor da taxa daquele que realizou a venda

taxa_total

Valor total das taxas pagas.

valor_taxa

Valor o qual o cálculo da taxa total se baseou.

O retorno desta consulta é um arquivo JSON com transações do período informado. Abaixo vemos um exemplo de retorno da API para uma venda com split:

{
    "data": {
        "data_ocorrencia": "AAAA-MM-DD HH:MM:SS",
        "tipo_da_venda": "tipos_de_venda",
        "status": "confirmed",
        "valor_venda_total_bruto": 00.00,
        "valor_venda_total_liquido": 00.00,
        "taxas": 00.00,
        "via_de_venda": "via de venda",
        "parcelas": "0",
        "adquirente": "Adquirente",
        "bandeira": "Bandeira",
        "numero_cartao": "000000******0000",
        "cod_autorizacao": "000000",
        "cv_nsu": "000000000000"
    },
    "split": [
        {
            "nome_loja": "Nome da Loja",
            "percentual_divisao": 00,
            "valor_dividido": 00.00,
            "minha_taxa": 00.00,
            "taxa_do_vendedor": 00.00,
            "taxa_total": 00.00,
            "valor_taxa": 00.00
        }
    ]
}

O cURL para executar a consulta é o exibido abaixo, a collection está no final da página em conjunto com a API de Cancelamento de Venda.

curl --location 'https://api.blu.com.br/b2b/sales/details/{id_venda}' \
--header 'authorization: XXXXXXXXXXXXXXXX' \
--header 'content-type: application/json' \

Cancelamento de Venda

DELETE https://api.blu.com.br/b2b/sales/{id_venda}

Esta API é responsável por realizar o cancelamento uma venda utilizando o id_venda.

ATENÇÃO! Cada tipo de venda possui um tempo máximo para ser cancelado, sendo eles:

  • Débito - até 6 meses após a realização da venda

  • Crédito à vista - até 11 meses após a realização da venda

  • Crédito parcelado até 36 meses após a realização da venda

Objetivo

Possibilitar aos varejistas cancelar uma venda de maneira integrada, respeitando o tempo máximo para cancelamento de cada tipo de venda.

Headers

Name
Type
Description

Authorization*

String

Token de operação

{
    "message":"Solicitação de cancelamento enviada com sucesso"
}

O cURL para executar o cancelamento da é o exibido abaixo, a collection está no final da página em conjunto com a API de Detalhes da Venda.

curl --location --request DELETE 'https://api.blu.com.br/b2b/sales/fca6c56c-955d-4267-9cb2-35d823823' \
--header 'authorization: PK4PsTMxh9bmAYz2FwyNM7k' \
--header 'content-type: application/json'
2KB
APIs Auxiliares Varejo.postman_collection.json
PreviousAPI ExtratoNextAPI Criação de Clientes

Last updated

Was this helpful?