Introdução

Este documento descreve o conjunto de APIs de Pedidos, o qual suporta a consulta e gerenciamento de pedidos e entegas dos vendedores.

Essa ferramenta visa fornecer aos sellers (vendedores) controle sobre os dados de seus pedidos e entregas, ajudando-os a gerenciar as informações no processo de gestão de pedidos.

É necessário o consentimento dos usuários, para isso implemente o processo de autenticação e autorização.

Se você não possui integração com as APIs, basta seguir o processo de solicitação de criação de aplicação.

Funcionalidades das APIs de Pedidos

As APIs de Pedidos oferecem funcionalidades distintas dependendo da opção de entrega escolhida pelo comprador. Esses recursos se dividem entre funcionalidades comuns e específicas para cada tipo de entrega.

1. Recursos Comuns

Os recursos comuns são utilizados para a recuperação de informações de pedidos e dados de entrega, proporcionando uma visão geral dos pedidos e suas respectivas entregas.

2. Recursos Específicos por Tipo de Entrega

2.1. Entrega via “Eu Preciso Entregas”

Caso o comprador opte pelo serviço “Eu Preciso Entregas”, o vendedor terá a capacidade de gerenciar todas as etapas relacionadas ao envio. Entre as funcionalidades disponíveis, destacam-se:

• Pontos de coleta - Permite a consulta de pontos de coleta para expedição de etiquetas;
• Expedição de Etiquetas: Possibilita a geração de etiquetas de envio para cada pedido, ocasião em que deverá ser incluída a nota fiscal associada ao pedido.

A gestão completa da entrega será realizada pela solução “Eu Preciso” em parceria com o serviço de logística “Melhor Envio”.

2.2. Entrega “A Combinar”

No caso de pedidos com a opção de “Entrega a combinar”, o vendedor terá à disposição funcionalidades para personalizar e atualizar os dados de entrega. Entre os recursos, incluem-se:

• Atualização de Status: Possibilita a alteração do status de entrega e outros detalhes relevantes;
• Gestão de Notas Fiscais: Permite a inclusão de notas fiscais associadas ao pedido.

Escopos requeridos

Para a utilização das APIs os seguintes escopos poderão ser necessários:

Etapas de Gestão de Ordens

Para compreender o processo de gestão de pedidos no sistema Eu Preciso, é essencial considerar a modalidade de entrega escolhida pelo comprador. Abaixo, detalhamos as etapas para cada tipo de entrega:

1. Entrega via “Eu Preciso Entregas”

1. Escolha do Frete pelo Comprador: O comprador seleciona uma das opções de frete disponíveis na plataforma Eu Preciso.
2. Notificação de Novo Pedido: O vendedor recebe um webhook notificando um novo pedido, contendo o campo delivery_type com o valor “eu_preciso_entregas” e as informações da transportadora escolhida.
3. Consulta dos Pontos de Coleta: O vendedor pode consultar e selecionar um ponto de coleta preferido ou permitir que o sistema Eu Preciso escolha automaticamente o ponto mais próximo ao gerar a etiqueta de envio.
4. Geração da Etiqueta de Envio: O vendedor gera a etiqueta de envio, associando a nota fiscal ao pedido e informando o ponto de coleta selecionado.
5. Preparação e Entrega do Produto: O vendedor embala o produto, aplica a etiqueta e realiza a entrega no ponto de coleta indicado.
6. Atualização e Notificações: A plataforma Eu Preciso se encarrega de atualizar o comprador sobre o andamento do pedido e o status da entrega. O vendedor é mantido informado por meio de webhooks.

2. Entrega “A Combinar”

1. Escolha da Entrega pelo Comprador: O comprador opta pela modalidade de entrega “A Combinar”.
2. Notificação de Novo Pedido: O vendedor recebe um webhook notificando um novo pedido, com o campo delivery_type definido como “a_combinar”.
3. Negociação da Entrega: O vendedor negocia diretamente com o comprador os detalhes da entrega, como prazos e local de retirada ou entrega.
4. Atualização do Status de Entrega: O vendedor atualiza o status de entrega na plataforma, incluindo a nota fiscal associada ao pedido.
5. Notificações ao Comprador: A plataforma Eu Preciso envia atualizações sobre o andamento do pedido com base nas informações fornecidas pelo vendedor, notificando o vendedor via webhooks sempre que houver uma atualização relevante.