Lost orders
Creating a lost order
The “Lost orders” tool allows you to add and view requests for orders that you think belong to you but failed to be displayed in your sales stats. The advertiser will re-evaluate whether the sale should indeed be attributed to you.
Parameters
HTTP METHOD | AUTHORIZATION | URL | PARAMETERS | NOTE |
---|---|---|---|---|
POST | Authorization: Bearer {token} | List of parameters |
|
Your authorization token can be found in the XML API section.
List of parameters for the request
TITLE | TYPE |
MANDATORY |
PARAMETER LIMITS | ACCEPTABLE VALUES |
---|---|---|---|---|
order_id | string | Yes | Maximum length 255 characters | |
order_date | date | Yes | Over the past 3 months | %d.%m.%Y или %Y-%m-%d |
order_total | float | Yes | 2 characters after the floating point | |
merchant_id | integer | Yes | List of advertisers | |
attachment | file | Yes | JPEG/JPG/PNG/PDF, size not over 10MB | |
description | string | No | Maximum length 255 characters |
Example of use
An example request using the curl utility:
curl -L -H 'Authorization: Bearer {access_token}' -X POST https://gs.kit.global/api/v1/lost-orders/
-F 'order_id=GS123L' \
-F 'order_date=24.07.2018' \
-F 'order_total=554.34' \
-F 'merchant_id=54376' \
-F 'attachment=@/example/FS859YVnMiY.jpg' \
-F 'description=really my order'
An example of a JSON API server response:
{ "id": 5796, "order_id": "2342lost", "order_date": "2021-06-28", "description": "Creating the item with API", "attachment": "http://https://gs.kit.global/api/v1/lost-orders/", "merchant_id":
54376, "merchant_name": "merchant.com", "order_updated_date": "2021-07-27", "order_total": 12020.22, "order_status": "in_waiting", "ticket_state": "in_work" }
Description of API server response fields:
TITLE | DESCRIPTION |
---|---|
id |
Request ID |
order_id |
Order number |
order_date |
Order date |
description |
Request description |
attachment |
Uploaded file path |
merchant_id |
Advertiser ID |
merchant_name |
Advertiser name |
order_updated_date |
Order update date |
order_total |
Order amount |
order_status |
Order status |
ticket_state |
Request status |
Parameters
HTTP METHOD | AUTHORIZATION | URL | PARAMETERS | NOTE |
---|---|---|---|---|
GET | Authorization: Bearer {token} | List of parameters | JSON response | |
GET | Authorization: Bearer {token} | List of parameters | JSON response |
List of parameters for the request
Название | Тип | Допустимые значения |
---|---|---|
ticket_id | integer | |
merchant_id | integer | List of advertisers |
start_date | string | %d.%m.%Y или %Y-%m-%d |
end_date | string | %d.%m.%Y или %Y-%m-%d |
ticket_status | string | "in_work", "closed" |
order_status | string | "waiting", "confirmed", "declined" |
Example of use
An example request using the curl utility:
curl -L -H 'Authorization: Bearer {access_token}' -X GET https://gs.kit.global/api/v1/lost-orders/curl -L -H 'Authorization: Bearer {access_token}' -X GET https://gs.kit.global/api/v1/lost-orders/?merchant_id=54823
An example of a JSON API server response:
{
"id": 5774,
"order_id": "345lost",
"order_date": "2021-07-23",
"description": "",
"attachment": "https://gs.kit.global/uploads/pathtofile/9lbrkthauyltbkpn_1602748677.jpeg",
"merchant_id": 85122,
"merchant_name": "12storeez.com",
"sale_updated_at": "2021-07-27",
"order_total": 12312.00,
"order_status": "confirmed",
"ticket_state": "in_work"
}
Description of API server response fields:
Название | Описание |
---|---|
order_id |
Order number |
order_date |
Order date |
description |
Request description |
attachment |
Uploaded file path |
merchant_id |
Advertiser ID |
merchant_name |
Advertiser name |
order_updated_date |
Order update date |
order_total |
Order amount |
order_status |
Order status |
ticket_state |
Request status |