Integração de pedidos

Como consultar, criar, alterar e excluir pedidos via integração de API.

A integração de pedidos do e-commerce com o ERP possibilita criar pedidos, acompanhar status, faturar pedidos, incluir informações de rastreio, alterar status e finalizar um pedido. Veja como realizar essa integração a seguir.

Para incluir um novo pedido via de ERP você pode integrar:

  • Via Webhook: para seu sistema receber passivamente as notificações sobre novas compras. Nesse tipo de integração, as notificações de pedidos são diferenciados pelo status do pedido.
  • Via API: realizando requisições para receber informações de pedidos.

📘

A Vnda cadastra eventos para integração, e diferente da consulta via API, por webhook todos os dados do pedido são enviados em um mesmo arquivo .json

Integração de pedidos via API

Para receber informações sobre pedidos da sua loja, você pode utilizar a API de Pedidos e a API de Pacotes. Com elas você consulta detalhes específicos de um pedido, como mostrado na tabela a seguir:

Ação Como fazer
Consultar um pedido específico Para consultar um pedido específico você pode utilizar o método GET /api/v2/orders/{code}.
Consultar uma lista de pedidos Utilize o método GET /api/v2/orders para consultar a listagem de pedidos.

Nesta consulta utilize filtros para refinar sua busca.

Consultar o endereço de entrega de um pedido Utilize método GET /api/v2/orders/{code}/shipping_address para buscar o endereço de entrega dos pedidos.
Consulta os status dos pacotes dos pedidos Consulte o status de um pedido pelo método GET /api/v2/orders/{code}/packages.
Captura de pedidos Para realizar uma captura utilize o método POST/api/v2/orders/{code}/capture.
Confirmação de pedidos Efetue a confirmação de um pedido com o método POST /api/v2/orders/{order_code}/confirm.
Cancelamento de pedidos É possível efetuar o cancelamento de pedidos através do método POST /api/v2/orders/{order_code}/cancel.
Inclusão de nota fiscal Adicione notas fiscais nos pedidos através do método POST /api/v2/orders/{order_code}/packages/{package_code}/invoices.
Inclusão de tracking code Inclua código de rastreamento nos pedidos através do método POST /api/v2/orders/{order_code}/packages/{package_code}/trackings.
Atualização Pedido Enviado Atualize um pedido que teve um pacote enviadoPATCH/api/v2/orders/{order_code}/packages/{package_code}/ship.
Atualização Pedido Entregue Atualize um pedido que teve um pacote entreguePATCH /api/v2/orders/{order_code}/packages/{package_code}/deliver.

🚧

A captura de um pedido ocorre antes da confirmação ou cancelamento de um pedido, e obrigatória para pedidos de cartão de crédito.

Em algumas requisições das APIs de pedidos e pacotes você precisará informar os códigos identificadores, e poderá também refinar sua consulta por um status específico. As instruções de como obter essas informações estão disponíveis a seguir.

Consulta por status

Para facilitar as consultas nas APIs você pode refinar uma consulta utilizando o parâmetro status. Nesse caso, há dois cenários:

Os status disponíveis para cada cenário são:

  • Pedidos:
    • Received: pedido recebido pela loja.
    • Confirmed: pedido confirmado.
    • Canceled: pedido cancelado.
  • Pacotes:
    • Delivered: pacote entregue.
    • Shipped: pacote enviado.

Quando um cliente finaliza um pedido na loja, o pedido é recebido e seu status é Received. Com a confirmação do pagamento (captura do pagamento) o status passa para Confirmed. À medida que o envio e entrega do pedido ocorre, os status dos pacotes são alterados respectivamente para Shipped e Deliverd.

Consulta de código de pacotes

Para realizar uma consulta de pacote você precisa utilizar o campo package_code. Esse código é obrigatório e pode ser obtido de duas formas:

  • Via Admin:
    1. Acesse o Admin > Pedidos.
    2. Selecione o pedido que deseja consultar os pacotes.
    3. Clique em Rastrear pacote.
    4. O código ficará disponível no campo Dados do pacote da janela Rastreamento de pacote.
  • Via API: no campo code dentro do array packages ao buscar ou receber um pedido via webhook.

📘

Note que os conceitos de pacote e pedido são diferentes. Um pedido pode ser composto por mais de um pacote, e por isso para acompanhar a entrega de um pedido você consulta o andamento das entregas dos seus pacotes.

Consulta de código de pedidos

Para obter o código de um pedido específico, você pode consultar:

  • Via Admin:
    1. Acesse Admin > Pedidos;
    2. Selecione o pedido desejado;
    3. Confira o número do pedido como na figura abaixo.
20602060

Consulta de código de pedido via Admin

  • Via API: utilize o método GET /api/v2/orders e confira o code do pedido desejado na resposta da requisição..

Did this page help you?