API request

Preparing source data

Prepare source data in JSON format, taking into account its features and restrictions.

Use the parameters described in the Parameter list section. Make sure that the required parameters are included in the request: to learn which parameters are mandatory, see the list.

JSON structure

{
    "locations": [
        // Describes locations.
    ],
    "employees": [
        // Describes mobile employees.
    ],
   "options": {
        // Describes planning options.
    },
    "zones": [
        // Describes geofences (optional object).
    ]
}

API request

Below is a sample request for the cURL command-line utility.

curl -X POST "https://courier.yandex.com/vrs/api/v1/calendar_planning/tasks?apikey=<my-api-key>" -d @task.json

where my-api-key is the API key. The signature must be passed in the X-YaCourier-Signature request header.

The response should be:

202 Accepted
{
    "id": "task_id",
    "status": "queued",
    "message": "Task queued"
}

Request parameters

Response parameters

Response codes

Analyzing the resulting solution

Typical errors returned by the API request are described in the Error handling section.