List of lost orders¶
The “Lost orders” tool is available only to the owners of cashback services and loyalty programs. Accept the User Agreement in the section of the “Lost orders” tool to receive access.
Parameters¶
HTTP method |
Access rights |
URL | Parameters |
Note |
---|---|---|---|---|
GET | lost_orders | https://api.admitad.com/lost_orders/ |
List of request parameters | Returns the list of lost orders.* |
GET | lost_orders | https://api.admitad.com/lost_orders/{id}/ |
Returns the lost order.*, where id is the lost order identifier. |
* Returns the result in the JSON format.
List of request parameters¶
Name |
Type |
Allowed values |
---|---|---|
advcampaign | integer | List of affiliate programs |
website | integer | The list of publisher’s ad spaces |
status | string |
|
limit | integer | limit, offset parameters |
offset | integer | limit, offset parameters |
start_date | date | %d.%m.%Y |
end_date | date | %d.%m.%Y |
appeal_id | string | |
appeal_status | string |
|
Example of use¶
Example of a request with utility ``curl``:
curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/lost_orders/?limit=1
curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/lost_orders/3/
Example of the response from the API server in the JSON format:
{
"results": [
{
"status": "processing",
"website": {
"id": 1,
"name": "TestWebsite"
},
"order_id": "574T32EDD1H1",
"advcampaign": {
"id": 1,
"name": "TestAdvCampaign"
},
"currency": "USD",
"order_price": 230,
"order_date": "2016-01-01T00:00:00",
"date_created": "2016-06-02T19:31:36",
"id": 3,
"comment": "",
"appeal_id": "",
"appeal_status": "processing",
"estimated_reward": 7
}
],
"_meta": {
"count": 3,
"limit": 1,
"offset": 0
}
}
Description of API server response fields¶
Name |
Description |
---|---|
id | Identifier |
website | Ad space |
campaign | Affiliate program |
status | Lost order status |
order_id | Order number |
order_date | Order date |
order_price | Order amount |
comment | Comment |
date_created | Date of creation |
currency | Currency |
reject_reason | Reject reason |
reject_comment | Comment |
reward | Reward |
appeal_id | Appeal ID |
appeal_status | Appeal status |
estimated_reward | Estimated reward |