Salesforce

API éditeur : GET transactions (by ID)

« Go Back
Information
API éditeur : GET transactions (by ID)
Toutes les informations sur l’appel d’API des transactions GET (par ID)
Publisher-API-GET-transactions-byID
Details
Proposez-vous un appel d’API pour extraire des transactions par ID pendant un certain laps de temps ?

GET transactions (par ID)

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 et des paramètres personnalisés (de l'annonceur à l'éditeur). Outre l'extraction des transactions pour une période donnée, les transactions peuvent également être extraites en fonction de leur ID.

Qui peut l’utiliser

Éditeurs et annonceurs.
 

Comment l’appeler

https://api.awin.com/publishers/<"votreIDéditeur">/transactions/?ids=<idOfTheTransaction>&timezone=UTC

Exemple:
https://api.awin.com/publishers/45628/transactions/?ids=1234567%2C7654321&timezone=UTC


Ajoutez le paramètre 'accessToken' pour fournir votre clé d’accès comme décrit dans Comment puis-je générer ma clé d'accès à l'API éditeur ?
 
ParamètreFormatObligatoire/Facultatif
IDsnumérique, séparé par des virgules obligatoire
timezoneEurope/Berlin
Europe/Paris
Europe/Londres
Europe/Dublin
Canada/Eastern
Canada/Central
Canada/Mountain
Canada/Pacific
US/Eastern
US/Central
US/Mountain
US/Pacific

UTC
 optionnel, la valeur par défaut est UTC
showBasketProduitsTableau 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 (veuillez consulter la section "Champs de données conditionnels" ci-dessous pour connaître 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éesDisponible pour les annonceursDisponible pour les éditeurs
orderRefouioui, si l’éditeur est activé pour le voir
clickRefouioui
clickRef2 - clickRef6Nonoui
customParametersouioui, si l’annonceur les partage avec ses éditeurs
basketProductsouioui, si l’annonceur les partage avec ses éditeurs
Version Info
 
Needs Review
Published
Not Checked
French
Main Article Info
21/02/2022, 15:49
15/12/2022, 10:50
18,806
21/02/2022, 15:43
Translation Info
System info
Smartling
Jesús Iglesias Berenguer

Powered by