Creation of lost order

Parameters

HTTP method

Access rights

URL

Parameters

Note

POST manage_lost_orders https://api.admitad.com/lost_orders/create/ List of request parameters

Returns the created order.*

  • * Returns the result in the JSON format.

List of request parameters

Name

Type

Required

Settings restrictions

Allowed values

advcampaign integer   List of affiliate programs
website integer ✔ *   The list of publisher’s ad spaces
order_id string

Max length 100 characters

 
order_date date ✔ *   %d.%m.%Y
order_price float ✔ *    
comment string

512 characters maximum

 
attachment file

Max size 5MB

Allowed types
jpg, jpeg, png, gif
appeal_id string  

Max length 100 characters

 
  • * Not required when creating request for erroneously rejected order.

Example of use

Example of a request with utility ``curl``:

curl -H 'Authorization: Bearer access_token' -X POST https://api.admitad.com/lost_orders/create/ \
     -F 'website=1' \
     -F 'advcampaign=1' \
     -F 'order_id=YH123D' \
     -F 'order_date=11.11.2016' \
     -F 'order_price=1200' \
     -F 'appeal_id=788aq' \
     -F 'attachment=@file1.png' \
     -F 'attachment=@file2.png'

Example of the response from the API server in the JSON format:

{
    "status": "processing",
    "website": {
        "id": 1,
        "name": "TestWebsite"
    },
    "attachments": [
        {
            "id": 12,
            "url": "https://www.admitad.com/en/display_file/12/b9e12a4f8911318d08c496c77eb53c83/",
        },
        {
            "id": 13,
            "url": "https://www.admitad.com/en/display_file/13/23dedf7bca3a71dad80e10f3d0f56c01/",
        }
    ],
    "currency": "USD",
    "order_id": "YH123D",
    "advcampaign": {
        "id": 1,
        "name": "TestAdvCampaign"
    },
    "order_price": 1200,
    "order_date": "2016-11-11T00:00:00",
    "date_created": "2016-06-02T19:31:36",
    "id": 6,
    "comment": "",
    "appeal_id": "788aq",
    "appeal_status": "processing"
}

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

currency

Currency

comment

Comment

attachments

List of attached files

date_created

Date of creation

appeal_id

Appeal ID

appeal_status

Appeal status