List of orders (API method orders)

API method

The orders method allows you to read the list of commission orders.

Endpoint

GET

URL: https://api.wedos.as/partner/orders
Note: List of orders including statuses and commissions for the partner.

What you get: in the results field, a list of records (orders).

Possible order statuses

pending – being processed
done – completed
canceled – canceled
honored – credited
refused – refused

pending – awaiting payment or processing
done – processed, commission not yet credited
cancelled – order canceled (customer or supplier)
honored – commission already credited to commission account
refused – rejected due to violation of terms and conditions

Order details

Explanation of individual details listed in the order:

ID – Order ID
advertiserId – advertiser ID
orderNum – order number assigned by the advertiser
createdDate – date and time of order creation
textCampaignId – Text campaign ID
boardId – Advertising space ID

entryId – Entry ID (click)
customId – user ID
status – order status
amount – order amount
currency – currency of the order
partnerCommission – commission for the partner (in the partner's currency)
partnerCurrency – partner's currency
doneDate – date and time of order completion
honoredDate – date and time when the commission was credited to the commission account

Input parameters (GET)

You can use input parameters to filter and paginate records.

Filtering

ID
advertiserId
textCampaignId
boardId
entryId
customId
status

lastID returns only records whose ID is greater than the specified value.

Pagination

page
count

Tip: if you only want to pull news items, combine lastID + a reasonable count.

Output data

The method returns an array of order records in the results item.

Example answer (abridged)

{
  "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"
}

Example of requirements

All orders (first 100)

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

Orders in pending status

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

Orders with ID greater than 1234

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

If you have a problem or question about the commission system, please write to affiliate@wedos.com.