GET Transações (por ID)
Afiliados e anunciantes podem obter transações individuais, para verificar o status das transações, para criar relatórios próprios e para obter informações adicionais que podem ser compartilhadas entre afiliados e anunciantes via clickref (de afiliado para anunciante) e orderRef e parâmetros personalizados (de anunciante para afiliado). Além de obter transações por um determinado período de tempo, as transações também podem ser obtidas por suas identificações.
Quem pode utilizá-la?
Afiliados e anunciantes.
Como chamá-la
https://api.awin.com/publishers/<yourPublisherId>/transactions/?ids=<idOfTheTransaction>&timezone=UTCExample:https://api.awin.com/publishers/45628/transactions/?ids=1234567%2C7654321&timezone=UTCAdicione o parâmetro 'accessToken' para fornecer sua chave de acesso, conforme descrito em
Como posso gerar meu token de acesso API de Publisher?
| Parâmetro | Formato | Obrigatório/Opcional |
|---|
| IDs | numéricos, separados por vírgulas | obrigatório |
| timezone | Europa/Berlim Europa/Paris Europa/Londres Europa/Dublin Canadá/Estado Canadá/Central Canadá/Montanha Canadá/Pacífico EUA/Estado EUA/Central EUA/Montanha EUA/Pacífico UTC | opcional, o padrão é UTC |
| showBasketProducts | Conjunto JSON | opcional |
Como é a resposta
(por favor, veja "Dados condicionais" abaixo para restrições que possam se aplicar)
"[
{{
" id": 259630312,
http://www.publisher.com url": " " ,
"advertiserId": 7052,
"publisherId": 189069,
"commissionSharingPublisherId": 55555,
"commissionSharingSelectedRatePublisherId": 189069,
"campaign": "nome da campanha"
"siteName": "Publisher",
"commissionStatus": "pending",
"commissionAmount": {
"amount": 5.59,
"currency": "GBP"
} ,
"saleAmount": {
"amount": 55.96,
"currency": "GBP"
} ,
"ipHash": "-66667778889991112223",
"customerCountry": "GB",
"clickRefs": {
"clickRef": "12345",
"clickRef2": "22222",
"clickRef3": "33333",
"clickRef4": "44444",
"clickRef5": "55555",
"clickRef6": "66666"
} ,
"clickDate": "2017-01-23T12:18:00",
"transactionDate": "2017-02-20T22:04:00",
"validationDate": null,
"type": "Transação do grupo de comissão ",
"declineReason": null,
"voucherCodeUsed": true,
"voucherCode": "example123",
"lapseTime": 2454307,
"amended": false,
"amendReason": null,
"oldSaleAmount" : null,
"oldCommissionAmount": null,
"clickDevice": "Windows",
"transactionDevice": "Windows",
"publisherUrl": "http://www.publisher.com/search?query=dvds" ,
"advertiserCountry": "GB",
"orderRef": "111222333444",
"customParameters": [
{
"key": "1",
"value": "555666"
} ,
{
"key": "2",
"value": "example entry"
} ,
{
"key": "3",
"value": "LLLMMMNNN"
}
],
"transactionParts": [
{
"commissionGroupId": 12345,
"amount": 44,76,
"commissionAmount": 4,50,
"commissionGroupCode": "DEFAULT",
"commissionGroupName": "Default Commission",
"trackedParts": [
{
"code": "DEFAULT",
"amount": 44.76,
"currency": GBP
}
]
}
{
"commissionGroupId": 654321,
"amount": 11.20,
"commissionAmount": 1.50,
"commissionGroupCode": "EXISTING",
"commissionGroupName": "EXISTING",
" trackedParts": [
{
"code": "EXISTING",
"amount": 11.20,
"currency": GBP
}
]
}
],
"paidToPublisher": false,
"paymentId": 0,
"transactionQueryId": 0,
"originalSaleAmount": null
},
"basketProducts": null
}]
Note que o campo "lapseTime" é o tempo de conversão em segundos.
Produtos do carrinho
Se &showBasketProducts=true então os produtos enviados através do Rastreamento de Nível de Produto correspondente à transação podem ser visualizados (por favor, veja "Dados Condicionais" abaixo para restrições que possam se aplicar).
"basketProducts": [
{
"productId": "12345678",
"productName": "Product Name",
"unitPrice": 10.10,
"quantity": 1,
"skuCode": "98F65K37",
"commissionGroupCode": "DEFAULT",
"category": "Category Name"
}
]
Rendimentos de dados condicionais
Alguns campos de dados estão disponíveis apenas para afiliados ou anunciantes, ou dependem de configurações adicionais.
| Datafield | Disponível para os anunciantes | Disponível para os editores |
|---|
| orderRef | sim | Sim, se a editora for ativada para vê-la. |
| clickRef | sim | sim |
| clickRef2 - clickRef6 | não | sim |
| customParameters | sim | Sim, se o anunciante os compartilha com seus editores. |
| basketProducts | sim | Sim, se o anunciante os compartilha com seus editores. |