Pedidos da mini-loja
Como o cliente acompanha, paga, cancela e repete pedidos na mini-loja do WhatsApp, e o mapa de todas as rotas pós-compra.
Depois do checkout, a mini-loja continua útil: é nela que o cliente reabre o Pix que perdeu, troca a forma de pagamento, anexa o comprovante, pede para cancelar, acompanha a entrega e compra de novo. Estas rotas servem a aba "Pedidos" e a tela de cada pedido, que o link das mensagens de WhatsApp abre.
Esta seção também reúne o que acontece em torno do pedido: a oferta de um clique logo depois da compra, a proposta de um representante que vira pedido e as assinaturas e compras agendadas.
Como funciona
A régua que decide o que o cliente pode fazer é a etapa (stage):
stage | Significa | Cancelar | Trocar pagamento |
|---|---|---|---|
incoming | A loja ainda não aceitou (inclui pagamento recusado). | Na hora, mesmo pago (com estorno). | Sim, se não estiver pago. |
preparing | A loja aceitou e está preparando. | Só como pedido à loja. | Sim, se não estiver pago. |
out | Enviado, em rota ou pronto para retirar. | Não. | Não. |
done | Entregue. | Não. | Não. |
closed | Cancelado ou estornado. | Não. | Não. |
- Acompanhar
GET /orders/{token}mostra a lista;GET /order/{token}/{orderID}mostra um pedido com itens, pagamento, linha do tempo e rastreio. - Pagar ou corrigir o pagamento
Se o Pix venceu ou o cartão foi recusado, o cliente troca a forma de pagamento ou tenta outro cartão. Para Pix manual, anexa o comprovante.
- Cancelar, se precisar
POST .../cancelcancela na hora ou registra o pedido de cancelamento, conforme a etapa. - Comprar de novo
POST .../reorderleva os itens do pedido para a sacola, revalidados.
Conceitos-chave
Quem é o dono do pedido
O dono é identificado pelo telefone do token e pela conta ligada a ele: pedidos feitos como convidado com aquele número, pedidos da conta do cliente e pedidos feitos antes em outro canal e ligados à mesma conta. Um visitante sem conta só vê, pelo detalhe, os pedidos feitos com o número do token. A lista exige conta identificada.
Status do pedido e do pagamento
Cada loja define o seu fluxo de status. O pedido traz status (a letra gravada), status_code (código estável, como pending ou shipped), status_name (o nome que a loja dá) e status_color. Decida pelo status_code e pelo stage, e exiba o status_name. O pagamento tem o seu próprio estado em payment.state: paid, pending, analysis, refused, refunded, invoiced ou on_delivery.
Pedido dividido
Em lojas com regras de pedido por tipo, uma sacola pode virar mais de um pedido (por exemplo, um físico e um virtual). Cada um tem o seu pagamento, e o checkout devolve a lista.
Avaliações
Avaliar os produtos de um pedido entregue é feito pelas rotas de Avaliações, na seção do catálogo. O campo can_review do detalhe diz quando o pedido já pode ser avaliado.
Endpoints
| Método | Rota | O que faz | Página |
|---|---|---|---|
| GET | /api/v1/storefront/wa-coex/orders/{token} | Lista os pedidos do cliente | Listar os pedidos |
| GET | /api/v1/storefront/wa-coex/order/{token}/{orderID} | Detalhe do pedido | Ver e acompanhar o pedido |
| GET | /api/v1/storefront/wa-coex/track/{token}/{orderID} | Rastreio na transportadora | Ver e acompanhar o pedido |
| POST | /api/v1/storefront/wa-coex/order/{token}/{orderID}/cancel | Cancela ou pede o cancelamento | Cancelar um pedido |
| POST | /api/v1/storefront/wa-coex/order/{token}/{orderID}/payment | Troca a forma de pagamento | Pagamento do pedido |
| GET | /api/v1/storefront/wa-coex/pay/{token}/status/{orderID} | Consulta se o pagamento caiu | Pagamento do pedido |
| POST | /api/v1/storefront/wa-coex/order/{token}/{orderID}/attachments | Envia um anexo | Anexos do pedido |
| GET | /api/v1/storefront/wa-coex/order/{token}/{orderID}/attachments | Lista os anexos | Anexos do pedido |
| GET | /api/v1/storefront/wa-coex/order/{token}/{orderID}/attachments/{attID} | Baixa um anexo | Anexos do pedido |
| POST | /api/v1/storefront/wa-coex/order/{token}/{orderID}/reorder | Leva os itens para a sacola | Pedir de novo |
| GET | /api/v1/storefront/wa-coex/order/{token}/{orderID}/post-purchase-offer | Lê a oferta pós-compra | Oferta pós-compra |
| POST | /api/v1/storefront/wa-coex/order/{token}/{orderID}/post-purchase-offer/accept | Aceita a oferta | Oferta pós-compra |
| POST | /api/v1/storefront/wa-coex/order/{token}/{orderID}/post-purchase-offer/decline | Recusa a oferta | Oferta pós-compra |
| GET | /api/v1/storefront/wa-coex/proposal/{token}/{code} | Abre a proposta do representante | Proposta do representante |
| POST | /api/v1/storefront/wa-coex/proposal/{token}/{code}/accept | Aceita a proposta | Proposta do representante |
| POST | /api/v1/storefront/wa-coex/proposal/{token}/{code}/changes | Pede alterações | Proposta do representante |
| GET | /api/v1/storefront/wa-coex/recurring/{token} | Lista assinaturas e agendadas | Assinaturas e compras agendadas |
| GET | /api/v1/storefront/wa-coex/recurring/{token}/product/{productID} | Ciclos de um produto | Assinaturas e compras agendadas |
| POST | /api/v1/storefront/wa-coex/recurring/{token} | Cria assinatura ou agendada | Assinaturas e compras agendadas |
| POST | /api/v1/storefront/wa-coex/recurring/{token}/{kind}/{id}/cancel | Cancela uma delas | Assinaturas e compras agendadas |
Erros comuns
- Mostrar "Pagar agora" para pedido recusado. O
statuspode continuar "aguardando pagamento" com o cartão recusado. Olhepayment.stateepayment_state. - Oferecer cancelar sem olhar a etapa. Use
can_cancelecancel_needs_store. Empreparingo cancelamento é um pedido à loja, não imediato. - Tratar
204como erro. O rastreio e a consulta de pagamento respondem204sem corpo quando não há o que mostrar, inclusive para pedido de outra pessoa. - Reenviar o checkout após um timeout. Consulte a lista de pedidos antes: o pedido pode ter sido criado.
- Enviar o anexo como JSON. O envio de anexo é
multipart/form-datae só aceita o tipocomprovante_pix, em lojas com Pix manual. - Esperar que a lista seja paginada. Ela devolve no máximo 30 pedidos, sem filtros.