VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

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.

Pontos-chave
  • O pedido é do telefone/conta do token. Cada rota confere a posse. Pedido de outra pessoa responde 404 order_not_found, igual a um pedido inexistente, para ninguém descobrir ids alheios. Algumas rotas respondem 204 sem corpo pelo mesmo motivo.
  • A etapa (stage) manda no que o cliente pode fazer. Cancelar, trocar pagamento e avaliar dependem dela, e ela segue a rotina da loja, não o pagamento.
  • O estado do pagamento vem do registro de pagamento (payment.state), nunca é deduzido do status do pedido. Um pedido com cartão recusado pode continuar "aguardando pagamento" no status.
  • Dinheiro em centavos, ids UUID, datas em RFC 3339 ou em segundos Unix (*_unix). Textos message já vêm em português.
  • Nenhuma destas rotas usa Authorization: a credencial é o token da mini-loja no caminho (veja Mini-loja do WhatsApp).

Como funciona

Pedido criado→Pagar→Loja aceita→Enviado→Entregue→Avaliar

A régua que decide o que o cliente pode fazer é a etapa (stage):

stageSignificaCancelarTrocar pagamento
incomingA loja ainda não aceitou (inclui pagamento recusado).Na hora, mesmo pago (com estorno).Sim, se não estiver pago.
preparingA loja aceitou e está preparando.Só como pedido à loja.Sim, se não estiver pago.
outEnviado, em rota ou pronto para retirar.Não.Não.
doneEntregue.Não.Não.
closedCancelado ou estornado.Não.Não.
  1. Acompanhar

    GET /orders/{token} mostra a lista; GET /order/{token}/{orderID} mostra um pedido com itens, pagamento, linha do tempo e rastreio.

  2. 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.

  3. Cancelar, se precisar

    POST .../cancel cancela na hora ou registra o pedido de cancelamento, conforme a etapa.

  4. Comprar de novo

    POST .../reorder leva 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étodoRotaO que fazPágina
GET/api/v1/storefront/wa-coex/orders/{token}Lista os pedidos do clienteListar os pedidos
GET/api/v1/storefront/wa-coex/order/{token}/{orderID}Detalhe do pedidoVer e acompanhar o pedido
GET/api/v1/storefront/wa-coex/track/{token}/{orderID}Rastreio na transportadoraVer e acompanhar o pedido
POST/api/v1/storefront/wa-coex/order/{token}/{orderID}/cancelCancela ou pede o cancelamentoCancelar um pedido
POST/api/v1/storefront/wa-coex/order/{token}/{orderID}/paymentTroca a forma de pagamentoPagamento do pedido
GET/api/v1/storefront/wa-coex/pay/{token}/status/{orderID}Consulta se o pagamento caiuPagamento do pedido
POST/api/v1/storefront/wa-coex/order/{token}/{orderID}/attachmentsEnvia um anexoAnexos do pedido
GET/api/v1/storefront/wa-coex/order/{token}/{orderID}/attachmentsLista os anexosAnexos do pedido
GET/api/v1/storefront/wa-coex/order/{token}/{orderID}/attachments/{attID}Baixa um anexoAnexos do pedido
POST/api/v1/storefront/wa-coex/order/{token}/{orderID}/reorderLeva os itens para a sacolaPedir de novo
GET/api/v1/storefront/wa-coex/order/{token}/{orderID}/post-purchase-offerLê a oferta pós-compraOferta pós-compra
POST/api/v1/storefront/wa-coex/order/{token}/{orderID}/post-purchase-offer/acceptAceita a ofertaOferta pós-compra
POST/api/v1/storefront/wa-coex/order/{token}/{orderID}/post-purchase-offer/declineRecusa a ofertaOferta pós-compra
GET/api/v1/storefront/wa-coex/proposal/{token}/{code}Abre a proposta do representanteProposta do representante
POST/api/v1/storefront/wa-coex/proposal/{token}/{code}/acceptAceita a propostaProposta do representante
POST/api/v1/storefront/wa-coex/proposal/{token}/{code}/changesPede alteraçõesProposta do representante
GET/api/v1/storefront/wa-coex/recurring/{token}Lista assinaturas e agendadasAssinaturas e compras agendadas
GET/api/v1/storefront/wa-coex/recurring/{token}/product/{productID}Ciclos de um produtoAssinaturas e compras agendadas
POST/api/v1/storefront/wa-coex/recurring/{token}Cria assinatura ou agendadaAssinaturas e compras agendadas
POST/api/v1/storefront/wa-coex/recurring/{token}/{kind}/{id}/cancelCancela uma delasAssinaturas e compras agendadas

Erros comuns

  • Mostrar "Pagar agora" para pedido recusado. O status pode continuar "aguardando pagamento" com o cartão recusado. Olhe payment.state e payment_state.
  • Oferecer cancelar sem olhar a etapa. Use can_cancel e cancel_needs_store. Em preparing o cancelamento é um pedido à loja, não imediato.
  • Tratar 204 como erro. O rastreio e a consulta de pagamento respondem 204 sem 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-data e só aceita o tipo comprovante_pix, em lojas com Pix manual.
  • Esperar que a lista seja paginada. Ela devolve no máximo 30 pedidos, sem filtros.

Próximos passos

Ver e acompanhar o pedido
Itens, pagamento, linha do tempo e rastreio.
Pagamento do pedido
Trocar a forma de pagar e consultar o status.
Cancelar um pedido
Na hora ou como pedido à loja.
Atendimento e assistente
Falar com a loja e abrir reclamações.
Anterior
Cartões salvos
Próxima
Listar os pedidos
Nesta página
  • Como funciona
  • Conceitos-chave
  • Quem é o dono do pedido
  • Status do pedido e do pagamento
  • Pedido dividido
  • Avaliações
  • Endpoints
  • Erros comuns
  • Próximos passos