Liste des commandes (méthode API orders)

Méthode API

Méthode orders te permet de lire la liste des commandes à commission.

Endpoint

GET

URL: https://api.wedos.as/partner/orders
Remarque: Liste des commandes avec les statuts et les commissions pour le partenaire.

Ce que tu obtiens : dans l’élément results un tableau d’enregistrements (commandes).

Statuts de commande possibles

pending – en cours de traitement
done – traitée
canceled – annulée
honoured – créditée
refused – refusée

pending – en attente de paiement ou de traitement
done – traitée, commission pas encore créditée
cancelled – commande annulée (client ou fournisseur)
honoured – la commission est déjà créditée sur le compte de commissions
refused – refusée pour non-respect des conditions

Informations sur la commande

Explication des différentes informations indiquées pour une commande :

ID – ID de la commande
advertiserId – ID de l’annonceur
orderNum – numéro de commande attribué par l’annonceur
createdDate – date et heure de création de la commande
textCampaignId – ID de la campagne texte
boardId – ID de l’espace publicitaire

entryId – ID de l’arrivée (du clic)
customId – ID utilisateur
status – statut de la commande
amount – montant de la commande
currency – devise de la commande
partnerCommission – commission pour le partenaire (dans la devise du partenaire)
partnerCurrency – devise du partenaire
doneDate – date et heure du traitement de la commande
honouredDate – date et heure du crédit de la commission sur le compte de commissions

Paramètres d’entrée (GET)

Les paramètres d’entrée permettent de filtrer et de paginer les enregistrements.

Filtrage

ID
advertiserId
textCampaignId
boardId
entryId
customId
status

lastID ne renvoie que les enregistrements dont l’ID est supérieur à la valeur indiquée.

Pagination

page
count

Astuce : si tu veux ne récupérer que les nouveautés, combine lastID + une valeur raisonnable de count.

Données de sortie

La méthode renvoie dans l’élément results un tableau d’enregistrements de commandes.

Exemple de réponse (abrégé)

{
  "results": [
    {
      "ID": 500895,
      "advertiserId": 2,
      "createdDate": "2017-05-23 10:35:27",
      "entryId": 50000272,
      "textCampaignId": 300000,
      "boardId": null,
      "customId": null,
      "orderNum": "8011700019",
      "amount": 14,
      "currency": "CZK",
      "partnerCommission": 3.5,
      "partnerCurrency": "CZK",
      "status": "canceled",
      "doneDate": null,
      "honouredDate": null
    },
    {
      "ID": 500894,
      "advertiserId": 2,
      "createdDate": "2017-05-19 14:50:33",
      "entryId": 50000271,
      "textCampaignId": 300000,
      "boardId": null,
      "customId": null,
      "orderNum": "8151700025",
      "amount": 4445,
      "currency": "CZK",
      "partnerCommission": 1422.4,
      "partnerCurrency": "CZK",
      "status": "honoured",
      "doneDate": "2017-05-19 14:51:08",
      "honouredDate": "2017-05-22 11:31:57"
    }
  ],
  "page": 1,
  "count": 100,
  "filteredCount": 624,
  "totalCount": 624,
  "requestId": "1495624713.2655.11284"
}

Exemples de requêtes

Toutes les commandes (les 100 premières)

https://api.wedos.as/partner/orders

Commandes au statut pending

https://api.wedos.as/partner/orders?status=pending

Commandes dont l’ID est supérieur à 1234

https://api.wedos.as/partner/orders?lastID=1234

Si tu as un problème ou une question sur le système de commissions, écris à affiliate@wedos.com.