API for merchant

To get started with the API you should get an ID and a key. They are available in the Profile section. Hereinafter, the user ID will be denoted as {user} and the access key as {key}. Important! You don't need to include curly braces in the query string!

Interaction with the service is carried out via the HTTP protocol. The request format is pure POST. The result format is JSON. There is no limit on the number of requests. If you need to send a request via JSON POST, do not forget to include the header Content-type: application/json

Add new order

URL: https://api.cpa.moe/comp/add.json?id={user}-{key}

The function allows you to add a new lead as the company, with no order source specified. New lead data is transmitted in a POST request.

The function accepts the following primary data about the lead:

Additional parameters for lead creation:

Example of a simple lead creation request (shown in JSON for convenience):

{
    "offer": 217,
    "ip": "12.34.56.78",
    "name": "John Doe",
    "phone": "77000000000",
    "country": "kz",
}

Example of creating a lead specifying the array of nested goods (shown in JSON for convenience):

{
    "offer": 217,
    "ip": "12.34.56.78",
    "name": "Jane Doe",
    "phone": "79000000000",
    "country": "ru",
    "items": [
        {
            "id": 135,
            "price": 9900,
            "count": 1
        }
    ]
}

Example of a simple lead creation with custom fields (shown in JSON for convenience):

{
    "offer": 217,
    "ip": "12.34.56.78",
    "name": "John",
    "phone": "77000000000",
    "country": "kz",
    "params": {
        "sirname": "Doe",
        "phonecc": "+7"
    }
}

The result of the function is an associative array:

Function response example:

{ "status": "ok", "id": 1234 }

List orders

URL: https://api.cpa.moe/comp/list.json?id={user}-{key}&oid=1,2,3

Function shows the list of orders. Request parameters can be sent via both GET and POST.

You can use following parameters for order filtering:

The result of the function is an array of elements with following fields:

Function response example:

[
    {
        "id": 13131,
        "offer": 15,
        "offername": "Shiny test offer",
        "wm": 59,
        "stage": "approve",
        "phase": 3,
        "status": 8,
        "reason": 0,
        "ip": "12.34.56.78",
        "time": 1234567890,
        "name": "John Doe",
        "gender": 0,
        "phone": "123456789000",
        "country": "ru",
        "index": "100000",
        "area": "",
        "city": "Moscow",
        "street": "Lenina street",
        "addr": "1",
        "comment": "Will pick up order in three days",
        "count": 6,
        "items": {
            "12": [ 3, 665 ],
            "23": [ 1, 665 ],
            "34": [ 2, 665 ]
        },
        "delivery": 1,
        "discount": 0,
        "currency": "rub",
        "base": "0.00",
        "more": "0.00",
        "delpr": "350.00",
        "price": "4340.00"
    }
]

Set order status

URL: https://api.cpa.moe/comp/status.json?id={user}-{key}&oid=123&status=approve

Function changes order status and can set some order fields. Almost all the parameters can be sent via both GET and POST. Optimal for use in postbacks.

Function can use following input parameters:

Order ID and status are required parameters, other fields are optional. The result of the function is an associative array:

Successful response example:

{ "status" : "ok" }

Error response example:

{ "status" : "error", "error" : "access-denied" }

Edit order info

URL: https://api.cpa.moe/comp/edit.json?id={user}-{key}

Function edits order info. Generally, all the parameters should be send via POST, but some of them can also can be sent via GET.

Function can use following input parameters:

Order ID is the only required field, other fields are optional. The result of the function is an associative array:

Successful response example:

{ "status" : "ok" }

Error response example:

{ "status" : "error", "error" : "access-denied" }

Order analytics

URL: https://api.cpa.moe/comp/stats.json?id={user}-{key}&item=date

Function shows order statistics, groupped by the specified parameter. This function gives detailed statistics on the number of orders in each status.

Function can use following input parameters:

The result of the function is an associative array. Each element is identified by the ID of grouping field. Each item includes following fields:

Function response example:

{
    "20190801": {
        "id": 20190801, // Element ID
        "name": "2019-08-01" // Element name
        "count": 24, // Number of orders
        "app": 100, // Approve percentage
        "apps": 100, // Approve percentage including trash
        "cash": { // Distribution by currency
            "usd": [ // Currency ISO code
                23, // Number of orders
                40477 // Orders total
            ],
            "rub": [ 1, 13990 ]
        },
        "status": { // Distribution by status
            "6": { // Status ID
                "count": 24, // Number of orders
                "cash": { // Distribution by currency
                    "usd": [ 23, 40477 ],
                    "rub": [ 1, 13990 ]
                }
            }
        },
    },
}

Adding audio recording of a call

URL: https://api.cpa.moe/comp/audio.json?id={user}-{key}

To attach a call record to an order, you need the URL of the record itself and the phone number to which the call was made. The phone number must match the one specified in the order itself. It is highly desirable to indicate the time of the call and the outgoing number of the operator specified in his profile. The system will try to determine the specific order IDs and change IDs automatically. If it is possible to specify the order ID, it will be much better.

Parameters can be passed in both GET and POST.

The result of the function is an associative array:

Successful response example:

{ "status" : "ok", "id": 1234 }

Error response example:

{ "status" : "error", "error" : "access-denied" }