Consultas de Transação GET (Lista)
Os afiliados podem fazer consultas de transações individuais, verificar o status da consulta da transação, criar seus próprios relatórios e obter informações adicionais que podem ser compartilhadas entre afiliados e anunciantes via referência de clique (do afiliado para anunciante).
Quem pode utilizá-lo
Afiliados
Como chamá-lo
Como afiliado:
https://api.awin.com/publisher/%3CyourPublisherId%3E/transactionqueries?startDate=yyyy-MM-ddThh%3Amm%3Ass&endDate=yyyy-MM-ddThh%3Amm%3Ass&timezone=UTC&dateType=transactionDate&statuses=approved&advertiserId=%3CadvertiserIdForWhichToFilter%3E
Exemplo:
https://api.awin.com/publisher/154870/transactionqueries?startDate=2020-11-11T00:00:00&endDate=2020-11-13T23:59:59&timezone=UTC&dateType=transactionDate&statuses=approved&advertiserId=1001
Adicione o parâmetro accessToken para fornecer sua chave de acesso conforme descrito em autenticação e autorização API.
Favor observar: o intervalo máximo de datas entre startDate e endDate atualmente suportado é de 31 dias.
| parâmetro | formato | obrigatório/opcional |
| startDate | yyyyy-MM-ddThh:mm:ss | obrigatório |
| endDate | yyyyy-MM-ddThh:mm:ss | obrigatório |
| dateType | enquiryDate
transactionDate
validaçãoData
| opcional (volta para "transactionDate" se não estiver definido) |
| timezone | Europa/Berlim
Europa/Paris
Europa/Londres
Europa/Dublin
Canadá/Eastern
Canadá/Central
Canadá/Montanha
Canadá/Pacífico
US/Eastern
US/Central
US/Montanha
US/Pacífico
UTC
| obrigatório |
| publisherId | 12345 | obrigatório |
| advertiserId | 12345 ou 12345.67890 para múltiplos | opcional, disponível para os afiliados |
| status | pendente
aprovado
recusado
apagado ou pendente,recusado por múltiplos
| opcional |
| clickRefs | clickRef1 ou clickRef1 (valor2),clickRef1 (valor3 ) para múltiplos | opcional |
| pageNumber | 3 | opcional (Defaults to 1 se não fornecido) |
| pageSize | 20 | opcional (padrão até 100 se não fornecido) |
Como fica a resposta
[
{
"enquiryId": 44562,
"advertiserId": 100,
"advertiserName": "ExampleAdvertiser",
"enquiryDate": "2020-10-03T12:18:00",
"enquiryStatus": "approved",
"commissionAmount": {
"amount": 5.59,
"currency": "GBP"
},
"saleAmount": {
"amount": 55.96,
"currency": "GBP"
},
"orderRef": "14523698",
"clickRef": "customerClickId",
"enquiryType": "approved",
"transactionDate": "2020-10-01T11:45:00",
"validationDate": "2020-10-02T15:30:00",
"declineReason": "null",
"description": "approved",
},
{
.... Next transaction query data here .....
}
]
(...)
Mensagens de erro comuns
Alguns erros que aparecem quando valores API incorretos são analisados:
| Cenário de erro | Mensagem de erro |
| Data de início após a data final | endDate não pode ser antes do startDate |
| Data de início maior que 31 dias | Este ponto final suporta apenas um intervalo de datas de 31 dias. Por favor, ajuste sua data de início ou de término. |
| Usando tipo de data inválida | Tipo de dados errado para o parâmetro 'dateType'. |
| Usando status inválidos tipo | Tipo de dados errado para o parâmetro 'status'. |
