API éditeur : GET transactions (list)

Proposez-vous un appel d’API pour extraire des transactions dans une liste ?

« panierProduits »: [
      {
        "productId": "12345678",
        "productName": "Product Name",
        "unitPrice": 10.10,
        "quantity": 1,
        "skuCode": "98F65K37",
        "commissionGroupCode": "DEFAULT",
        "category": "Category Name"
      }
    ]

 

GET transactions (list)

Les éditeurs et les annonceurs peuvent extraire des transactions individuelles, vérifier l'état des transactions, créer leurs propres rapports et extraire des informations supplémentaires qui peuvent être partagées entre les éditeurs et les annonceurs via clickref (de l'éditeur à l'annonceur) et orderRef (numéro de commande) et des paramètres personnalisés (de l'annonceur à l'éditeur).
 

Qui peut l’utiliser

Éditeurs et annonceurs.
 

Comment l’appeler

https://api.awin.com/publishers/<votreIDéditeur>/transactions/?
startDate=aaaa-MM-jjThh%3Amm%3Ass&endDate=aaaa-MM-jjThh%3Amm%3Ass&fuseau horaire=UTC&
dateType=transaction&status=pending&advertiserId=<IDannonceur>

Exemple:
https://api.awin.com/publishers/45628/transactions/?startDate=2017-02-20T00%3A00%3A00&endDate=2017-02-21T01%3A59%3A59&timezone=UTC (en tant qu’éditeur)
Ajoutez le paramètre 'accessToken' pour fournir votre clé d’accès comme décrit dans Authentification et autorisation de l’API.


Remarque : la plage de dates maximale entre startDate et endDate actuellement prise en charge est de 31 jours.
 

Paramètre	Format	Obligatoire/Facultatif
startDate	aaaa-MM-ddThh:mm:ss	obligatoire
endDate	aaaa-MM-ddThh:mm:ss	obligatoire
dateType	transaction validation	optionnel (revient à « transaction » s’il n’est pas défini)
timezone	Europe/Berlin  Europe/Paris  Europe/London  Europe/Dublin  Canada/Eastern  Canada/Central  Canada/Mountain  Canada/Pacific  US/Eastern  US/Central  US/Mountain  US/Pacific  UTC	obligatoire
publisherId	12345 ou 12345,67890 pour plusieurs	optionnel, disponible pour les annonceurs
advertiserId	12345 ou 12345,67890 pour plusieurs	optionnel, disponible pour les éditeurs
status	pending approved declined deleted	optionnel
showBasketProduits	Tableau JSON	optionnel

 

À quoi ressemble la réponse

(veuillez consulter la section « Champs de données conditionnels » ci-dessous pour connaître les restrictions qui pourraient s’appliquer)

[
  {
    "id": 259630312,
    "url": "http://www.publisher.com",
    "advertiserId": 7052,
    "publisherId": 189069,
    "commissionSharingPublisherId": 55555,
    "commissionSharingSelectedRatePublisherId": 189069,
    "campaign": "campaign name"
    "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": "Commission group transaction",
    "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
},
 
(...)

Notez que le champ « lapseTime » est le temps de conversion en secondes
 

Produits du panier d'achat

Si &showBasketProducts=true, les produits envoyés via le Product Level Tracking correspondant à la transaction peuvent être visualisés (voir "Champs de données conditionnels" ci-dessous pour les restrictions qui peuvent s'appliquer).

"basketProducts": [
      {
        "productId": "12345678",
        "productName": "Product Name",
        "unitPrice": 10.10,
        "quantity": 1,
        "skuCode": "98F65K37",
        "commissionGroupCode": "DEFAULT",
        "category": "Category Name"
      }
    ]

 

Champs de données conditionnels

Certains champs de données ne sont disponibles que pour les éditeurs ou les annonceurs, ou dépendent de paramètres supplémentaires.
 

Champ de données	Disponible pour les annonceurs	Disponible pour les éditeurs
orderRef	oui	oui, si l’éditeur est activé pour le voir
clickRef	oui	oui
clickRef2 - clickRef6	Non	oui
customParameters	oui	oui, si l’annonceur les partage avec ses éditeurs
basketProducts	oui	oui, si l’annonceur les partage avec ses éditeurs