Operações e Consultas

Conheça as principais operações e consultas disponíveis de uma Venda

Operações


Após ser criada, uma Venda pode receber diferentes operações ao longo do seu ciclo, de acordo com seu status e com o fluxo utilizado.

As principais operações disponíveis são:


AçãoDescrição
Pagar uma Venda em abertoRealiza uma nova tentativa de pagamento quando ainda existe um valor pendente na Venda. Uma nova Transação é associada à Venda.
EditarPermite alterar determinadas informações da Venda enquanto ela ainda estiver em uma situação que permita modificações.
InvalidarEncerra uma Venda que não deve mais receber pagamentos, quando seu estado atual permitir a operação.
Adicionar SplitDefine a distribuição dos valores da Venda entre os vendedores ou recebedores envolvidos, quando esse recurso estiver disponível para a operação.
📘

Disponibilidade das operações

Nem todas as operações estão disponíveis em todos os momentos. As ações permitidas podem variar de acordo com o status da Venda, o tipo de Venda e o fluxo de pagamento utilizado.

Consultas


As ações de consultas permitem localizar e acompanhar as Vendas registradas na plataforma.

É possível consultar uma Venda específica ou localizar um conjunto de Vendas para acompanhamento operacional e conciliação.

ConsultaPara que serve
Consultar uma VendaExibe as informações e a situação atual de uma Venda específica.
Listar VendasPermite localizar um conjunto de Vendas para acompanhamento e consulta.
Consultar SplitPermite verificar como os valores de uma Venda estão distribuídos entre os participantes do Split.
Consultar atividadesPermite acompanhar o histórico de ações e alterações relacionadas à Venda.
📘

Integração via API

Filtros, parâmetros, paginação e formatos de resposta estão detalhados na Referência da API.


Did this page help you?