POST https://cityads.com/api/rest/webmaster/v2/lostOrders
{
"lostOrder": {
"traffic_channel_id": 1226971,
"order_number": "123456",
"order_date": "2018-06-08",
"offer_id": "4325",
"order_sum": "7263",
"order_currency_id": 3,
"comment": "comment"
}
}
Name: | Description: | |
---|---|---|
traffic_channel_id
|
Traffic channel ID. See traffic channels list. | |
order_number
|
Number of the lost order. | |
order_date
|
Date when tha lost order was made. | |
offer_id
|
Offer ID. See offers list. | |
order_sum
|
The amount of the lost order. | |
order_currency_id
|
The currency ID of the lost order. See currencies list. | |
comment
|
Your comment. |
GET https://cityads.com/api/rest/webmaster/v2/lostOrders?offers=4325,663
&order_number=123&status=processing,accepted&status_id=2,3
&order_date_start=2018-10-01&order_date_end=2018-10-02
&created_at_start=2018-10-03&created_at_end=2018-10-04
&updated_at_start=2018-10-05&updated_at_end=2018-10-06
&ids=1,2,3&page=1&perpage=10
Type: | Name: | Description: | Possible values: | Required: |
---|---|---|---|---|
int
|
page
|
Current page number. 0 by default. | ||
int
|
perpage
|
Number of elements on a page. 20 by default. | No more than 1000. | |
int
|
offers
|
Filter by offers. Comma-delimited integer identifiers. | See offers list. | |
string
|
order_number
|
Filter by order numbers. Comma-delimited. | ||
enum
|
status
|
Filter by request statuses. Comma-delimited string codes. |
new , processing ,
accepted , rejected .
|
|
int
|
status_id
|
Filter by request statuses. Comma-delimited integer identifiers. | See statuses list. | |
string
|
order_date_start
|
Order date from |
yyyy-mm-dd |
|
string
|
order_date_end
|
Order date to |
yyyy-mm-dd |
|
string
|
created_at_start
|
Request creation date from |
yyyy-mm-dd |
|
string
|
created_at_end
|
Request creation date to |
yyyy-mm-dd |
|
string
|
updated_at_start
|
Date of the last action on the request from |
yyyy-mm-dd |
|
string
|
updated_at_end
|
Date of the last action on the request to |
yyyy-mm-dd |
|
string
|
ids
|
Filter by lost order request identintifiers. Comma-delimited. |
{
"lostOrder": [
{
"id": "31",
"offer_id": "2174",
"traffic_channel_id": "1226971",
"order_number": "123",
"order_sum": "423",
"order_currency_id": "3",
"order_date": "2018-10-01",
"status_id": "1",
"comment": "234234",
"manager_comment": "",
"created_at": "2018-10-08T14:42:55+03:00",
"updated_at": "2018-10-09T14:36:12+03:00"
},
...
]
}
Name: | Description: | |
---|---|---|
id
|
Request ID. | |
offer_id
|
Offer ID. See offers list. | |
traffic_channel_id
|
Traffic channel ID. See traffic channels list. | |
order_number
|
Order number. | |
order_sum
|
Order amount. | |
order_currency_id
|
Lost order currency ID. See currencies list. | |
order_date
|
The date when the order was made. | |
status_id
|
Request status ID. See statuses list. | |
comment
|
Your comment. | |
manager_comment
|
Manager comment. | |
created_at
|
The date and time of the request creation. | |
updated_at
|
The date and time of the last action on the request. |
GET https://cityads.com/api/rest/webmaster/v2/lostOrders/{id}
{
"lostOrder": {
"id": "31",
"offer_id": "2174",
"traffic_channel_id": "1226971",
"order_number": "123",
"order_sum": "423",
"order_currency_id": "3",
"order_date": "2018-10-01",
"status_id": "1",
"comment": "234234",
"manager_comment": "",
"created_at": "2018-10-08T14:42:55+03:00",
"updated_at": "2018-10-09T14:36:12+03:00"
}
}
Name: | Description: | |
---|---|---|
id
|
Request ID. | |
offer_id
|
Offer ID. See offers list. | |
traffic_channel_id
|
Traffic channel ID. See traffic channels list. | |
order_number
|
Order number. | |
order_sum
|
Order amount. | |
order_currency_id
|
Lost order currency ID. See currencies list. | |
order_date
|
The date when the order was made. | |
status_id
|
Request status ID. See statuses list. | |
comment
|
Your comment. | |
manager_comment
|
Manager comment. | |
created_at
|
The date and time of the request creation. | |
updated_at
|
The date and time of the last action on the request. |
new
status)PATCH https://cityads.com/api/rest/webmaster/v2/lostOrders/{id}
{
"lostOrder": {
"order_sum": "123"
}
}
new
status)DELETE https://cityads.com/api/rest/webmaster/v2/lostOrders/{id}