Envie pedidos do seu servidor

Se a sua loja não está numa plataforma de vendas conectada, o seu sistema envia cada venda ao Clakta pela API de pedidos. Veja o que enviar e os erros a evitar.

Se a sua loja roda na Shopify, no WooCommerce, no Stripe ou em outra plataforma de vendas conectada, você não precisa disto: a conexão envia as suas vendas por você. Este artigo é para lojas cujo sistema envia os pedidos por conta própria, e precisa de um desenvolvedor.

O script não consegue criar pedidos: as vendas só chegam ao Clakta pelo seu servidor, pela API de pedidos.

A requisição

Crie a chave em Configurações da equipe → Chaves de API e mantenha ela no seu servidor: ela pode gravar nos seus dados. Todas as opções estão na referência da API.

O que enviar

Campos principais

CampoO que é
projectIdO id ou slug do projeto a que o pedido pertence.
orderIdO id do pedido no seu sistema.
platformTexto livre, como shopify ou o nome do seu próprio checkout.
paymentMethodcredit_card, debit_card, pix, boleto, paypal, apple_pay, google_pay, samsung_pay, stripe_link ou other.
statuspaid, pending, rejected, refunded ou canceled.
currencyCódigo de três letras, como BRL. A moeda do projeto, se você não enviar.
totalPriceNúmero na unidade principal: 10.4 quer dizer R$ 10,40.
productsCada um com id, name, quantity e price.
createdAtData e hora do pedido. Agora, se você não enviar.
approvedDate, refundedAtDatas opcionais.

O objeto tracking

É ele que liga o pedido ao anúncio. Envie os valores que o seu site capturou quando o visitante chegou:

CampoO que é
clktO parâmetro do clique no anúncio, da primeira página. Sem ele o pedido nunca recebe crédito de um anúncio.
utm_*As UTMs da campanha, guardadas para os relatórios.
sessionIdA visita a que o pedido pertence. Ignorado em projetos amigáveis à privacidade.
domainO site onde a compra aconteceu. Obrigatório em projetos amigáveis à privacidade com mais de um domínio.

Guarde esses valores no carrinho ou no checkout quando o comprador começar o checkout, para o seu servidor ainda ter eles quando o pagamento for aprovado.

Projetos amigáveis à privacidade

O pedido é o mesmo, com uma regra rígida: o customer só pode ter ip e userAgent. Enviar id, name, email, phone, gender, dateOfBirth ou address faz o Clakta recusar o pedido.

O Clakta usa o IP, o navegador e o domínio para achar as visitas do mesmo dia. O sessionId é ignorado.

Atualizando um pedido

Reembolsos e mudanças de status usam um PATCH:

Você pode mudar status, paymentMethod, platform, currency, totalPrice, createdAt, approvedDate e refundedAt, e precisa enviar pelo menos um deles.

Dicas

Artigos relacionados