Creating an appeal claim

Accept the User Agreement in the section of the “Lost orders” tool to receive access.

Parameters

HTTP method

Access rights

URL

Parameters

Note

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

Returns a created appeal claim.*

  • * Returns the result in the JSON format.

List of request parameters

Name

Type

Required

Settings restrictions

Allowed values

advcampaign integer   List of affiliate programs
order_id string

Max length 100 characters

 
comment string

512 characters maximum

 
appeal_id string  

Max length 100 characters

 
receipt file jpeg/jpg/png/pdf  

Example of use

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

curl -H 'Authorization: Bearer access_token Accept: application/json' -X POST https://api.admitad.com/appeals/create/ \
     -F 'advcampaign=1' \
     -F 'order_id=YH123D' \
     -F 'comment=example' \
     -F 'appeal_id=788aq' \
     -F 'receipt=@/example/receipt.png'

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

{
    "status": "processing",
    "website": {
        "id": 1,
        "name": "TestWebsite"
    },
    "currency": "USD",
    "order_id": "YH123D",
    "advcampaign": {
        "id": 1,
        "name": "TestAdvCampaign"
    },
    "order_price": "1200.00",
    "order_date": "2016-11-11T00:00:00",
    "date_created": "2016-06-02T19:31:36",
    "id": 6,
    "comment": "example",
    "appeal_id": "788aq",
    "appeal_status": "processing",
    "estimated_reward": "1000",
}

Description of API server response fields

Name

Description

id

Identifier

website

Ad space

advcampaign

Affiliate program

status

Lost order status

order_id

Order number

order_date

Order date

order_price

Order amount

currency

Currency

comment

Comment

date_created

Date of creation

appeal_id

Appeal ID

estimated_reward

Estimated reward