Enviar uma conversão
Quando acontece uma venda ou um registo, o seu servidor envia-o com a visita; mais tarde pode mudar o estado, por exemplo um reembolso.
A chamada
POST https://<your workspace address>/track/conversions
x-api-key: your API key
Content-Type: application/json
{
"hit": "h1.…",
"conversionTypeCode": "sale",
"externalId": "order-1042",
"amount": { "value": 49.90 },
"currency": "EUR"
}
| Campo | |
|---|---|
hit |
A visita assinada do cookie hitctrl (ou de uma visita do lado do servidor). |
conversionTypeCode |
Obrigatório. O código do tipo de conversão, por exemplo sale. |
externalId |
O seu ID de encomenda ou transação. O mesmo conta uma vez, por isso repetir é seguro. |
amount.value, currency |
O valor da venda; necessário para pagamentos em percentagem. Outra moeda é convertida à taxa do dia. |
exchangeRate |
A sua própria taxa para a moeda do workspace, se o seu workspace a aceitar. |
couponCodes |
Códigos de cupão usados; o parceiro de um cupão fica com a venda à frente da visita. |
externalClientId |
Um cliente que registou; a venda conta para o parceiro da visita desse cliente. |
country |
O país do comprador (duas letras); valoriza a venda por ele em vez do país da visita. |
customParams.advS1–advS5 |
Os seus próprios valores; grupos de pagamento e regras de fraude podem usá-los. |
status |
approved, pending ou test; omita-o para o que o objetivo da oferta definir. |
Um de hit, couponCodes ou externalClientId é obrigatório. A chamada também funciona como GET com os mesmos valores no endereço.
Mudar um estado mais tarde
POST https://<your workspace address>/track/conversions/status
{ "externalId": "order-1042", "status": "refunded" }
status é approved, pending, rejected ou refunded. Acrescente conversionTypeCode quando uma encomenda tem conversões de vários tipos.
Momentos de muito movimento
Envie o cabeçalho Prefer: respond-async: a resposta é 202 de imediato e a conversão é registada um instante depois.
Isto respondeu à sua pergunta?
Verificado na aplicação a 18 de outubro de 2026