Вход / Регистрация

EasyBox API

Сведения об API

EasyBox API открывает возможность оформлять заказы на доставку в сервисе EasyBox. Дополнительно, API позволяет отображать список всех ваших заказов, сортируя так, как вам нужно, вносить изменения в заказы, отменять их, получать информацию о местоположении курьера, который в данный момент находится на маршруте.

Для начала работы необходимо пройти регистрацию на тестовом сервере: test.myeasybox.ru. В разделе API интеграция в кабинете вам сразу будет доступен ключ для доступа к тестовому серверу. Используя его вы сможете настроить и протестировать API EasyBox. Юридическим лицам при регистрации начисляется 5 000₽ для осуществления тестовых заказов.

После завершения интеграции проверьте, что все работает как нужно. Если заказы отправляются, редактируются и отменяются без проблем, напишите в поддержку на info@myeasybox.ru. Мы проверим настройки интеграции, подскажем что нужно поправить, если необходимо. После проверки доступ к API на боевом сервере будет активирован в течение суток.

В данный момент версионирование API не производится. В тело ответа в любое время могут быть добавлены новые параметры. Если ваш сервер встречает подобные и не знает как с этим работать - такие параметры следует игнорировать.

URL тестового сервера: https://test.myeasybox.ru/api

URL боевого сервера: https://myeasybox.ru/api

Пример запроса

При обращении к EasyBox API в заголовках каждого запроса необходимо указывать ваш ключ доступа к API в заголовке API-Token.

Ни в коем случае не выкладывайте ваш API-Token в общий доступ. В случае компрометации токена любой желающий сможет размещать заказы от вашего имени, используя баланс вашего кабинета.

EasyBox API принимает запросы через методы GET и POST. Запросы обрабатываются только по протоколу HTTPS.

В POST запросах данные необходимо передавать в формате JSON, кодировка UTF-8. В GET запросах параметры передаются в строке запроса, за исключением заголовка API-Token.

CURL
curl "https://test.myeasybox.ru/api/delivery/all?status=active&count=100"
-H "API-Token: EasyBox API-Token"

Пример ответа

EasyBox API всегда возвращает ответ в формате JSON в кодировке UTF-8.

При успешной обработке запроса возвращается тело ответа в формате JSON с HTTP кодом 200 (ОК).

В случае ошибки возвращается ответ с HTTP кодом 400 (Bad Request) и JSON с кодом и описанием ошибки:

error string
Текстовое описание ошибки.


code integer
Код ошибки


CURL
                                            {"error": "Delivery display limit exceeded", "code": 301}
                                        

Методы API

Получение одного заказа

GET https://test.myeasybox.ru/api/delivery/{id}

В URL запроса где id - номер заказа.

С помощью данного метода можно получить полную информацию по одному конкретному заказу, не запрашивая основой список заказов. Метод будет идеальным при использовании в случае, если вы хотите открыть детальную карточку заказа в своей CRM.

Параметры запроса


Отсутствуют.

Параметры ответа


deliverieslist
Массив заказов
Параметры заказа


successboolean
Успешность запроса.


Пример запроса


curl "https://test.myeasybox.ru/api/delivery/2618"
-H "API-Token: EasyBox API-Token"
                                        {"deliveries":[{"id":2618,"delivery_status":"ACTIVE","created_datetime":"2022-09-06T13:49:38.957+03:00","finish_datetime":null,"cancel_datetime":null,"courier":[{"first_name":"Тест","last_name":"Тест","middle_name":"Теcт","courier_avatar":"https://test.myeasybox.ru/courier/avatar/91/faab111469b7dc24bf411e51cd858d10","phone":"79222370082","latitude":55.734013,"longitude":37.8551244,"last_location_update":"2022-09-06T13:59:05.852+03:00"}],"weight":5,"cargo_info":"Документы","transport_type":"AFOOT","require_loading":false,"delivery_price":454,"declared_price":5000,"backpayment_wallet":"Карта Сбербанк 4276 8400 1188 5041","backpayment_amount":454600,"sum_revenue":500000,"points":[{"id":17059,"status":null,"comment":"Забрать документы","address":"г Москва, ул Шипиловская, д 8 к 2","latitude":55.6154,"longitude":37.700451,"contact_phone":"70000000000","contact_person":"Ирина","payment_here":false,"arrival_date_start":"2022-09-06T13:48:00.000+03:00","arrival_date_end":"2022-09-06T15:48:00.000+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":0,"internet_shop_id":null,"metro_station":"Орехово","metro_line_color":"4FB04F","metro_distance":447},{"id":17060,"status":null,"comment":"Отдать документы и получить наличные","address":"г Москва, ул Земляной Вал, д 29","latitude":55.757491,"longitude":37.660808,"contact_phone":"70000000000","contact_person":"Иван","payment_here":false,"arrival_date_start":"2022-09-06T13:48:00.000+03:00","arrival_date_end":"2022-09-06T16:48:00.000+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":500000,"internet_shop_id":"DO00-123456","metro_station":"Курская","metro_line_color":"915133","metro_distance":128}],"payment_method":"CASH"}],"success":true}
                                    

Получение списка заказов

GET https://test.myeasybox.ru/api/delivery/all

С помощью данного метода можно получить список оформленных, активных, завершенных и отмененных заказов.

Параметры запроса


countinteger
Количество заказов, которые необходимо отобразить. Будет удобно при оформлении постраничной навигации (пагинации) списка заказов. Максимальное значение: 50.
Значение по умолчанию: 10.


offsetinteger
Смещение заказов для постраничной навигации.
Значение по умолчанию: 0.


statusstring
Фильтрация по статусам заказа. При отсутствии в запросе данного параметра, будут отображены все заказы отсортированные в порядке убывания id.
Значение по умолчанию: отсутствует.

available
Заказ оформлен и находится в процессе поиска курьера


active
Заказ активен, курьер на заказ назначен


completed
Заказ выполнен


cancelled
Заказ отменен


Параметры ответа


deliverieslist
Массив заказов
Параметры заказа


successboolean
Успешность запроса.


total_delivery_countinteger
Общее количество заказов, найденных по данному фильтру. Необходимо для подсчета страниц пагинации в вашей CRM.


Пример запроса


curl "https://test.myeasybox.ru/api/delivery/all?status=active"
-H "API-Token: EasyBox API-Token"
                                        {"deliveries":[{"id":2618,"delivery_status":"ACTIVE","created_datetime":"2022-09-06T13:49:38.957+03:00","finish_datetime":null,"cancel_datetime":null,"courier":[{"first_name":"Тест","last_name":"Тест","middle_name":"Тест","courier_avatar":"https://test.myeasybox.ru/courier/avatar/91/faab111469b7dc24bf411e51cd858d10","phone":"79222370082","latitude":55.7340389,"longitude":37.8552605,"last_location_update":"2022-09-08T17:26:58.883+03:00"}],"weight":5,"cargo_info":"Документы","transport_type":"AFOOT","require_loading":false,"delivery_price":454,"declared_price":5000,"backpayment_wallet":"Карта Сбербанк 4276 8400 1188 5041","backpayment_amount":454600,"sum_revenue":500000,"points":[{"id":17059,"status":null,"comment":"Забрать документы","address":"г Москва, ул Шипиловская, д 8 к 2","latitude":55.6154,"longitude":37.700451,"contact_phone":"70000000000","contact_person":"Ирина","payment_here":false,"arrival_date_start":"2022-09-06T13:48:00.000+03:00","arrival_date_end":"2022-09-06T15:48:00.000+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":0,"internet_shop_id":null,"metro_station":"Орехово","metro_line_color":"4FB04F","metro_distance":447},{"id":17060,"status":null,"comment":"Отдать документы и получить наличные","address":"г Москва, ул Земляной Вал, д 29","latitude":55.757491,"longitude":37.660808,"contact_phone":"70000000000","contact_person":"Иван","payment_here":false,"arrival_date_start":"2022-09-06T13:48:00.000+03:00","arrival_date_end":"2022-09-06T16:48:00.000+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":500000,"internet_shop_id":"DO00-123456","metro_station":"Курская","metro_line_color":"915133","metro_distance":128}],"payment_method":"CASH"}],"success":true,"total_delivery_count":1}                                    

Расчет стоимости заказа

POST https://test.myeasybox.ru/api/delivery/calculate-delivery

С помощью данного метода можно расчитать стоимость заказа и проверить заказ на наличие ошибок. Ошибки, при их наличии, будут отображены в JSON-ответе.
Ниже указан минимально возможный набор параметров, без которых расчет заказа работать не будет, но если вам удобно, вы можете отправлять JSON-объект готового заказа, в таком случае система просто проигнорирует ненужные поля и произведет расчет.

Параметры запроса


weightinteger
Вес заказа в килограммах. Максимальный вес для способа доставки AFOOT - 15 кг; для способа доставки PASSENGER_CAR - 200 кг.
Значение по умолчанию: 1.


transport_typestring ОБЯЗАТЕЛЬНО

AFOOT
Пешком


PASSENGER_CAR
Легковой автомобиль


require_loadingboolean
Требуется ли погрузка-разгрузка.
Указывается только для заказов со способом доставки PASSENGER_CAR. В остальных случаях автоматически установится в false.


declared_priceinteger ОБЯЗАТЕЛЬНО
Объявленная ценность заказа. Должна быть от 0 до 20 000₽.


pointslist ОБЯЗАТЕЛЬНО
Список адресов с параметрами.
Минимально возможное количество адресов: 2, максимально в одном заказе: 30.

addressstring ОБЯЗАТЕЛЬНО
Указывается адрес точки в формате: город, улица, дом. Адрес будет обработан через Google Maps API и возвращен в отформатированном виде, по нему будут заполнены поля latitude и longitude в заказе.
Квартира, код домофона и прочие параметры указываются в поле comment при отправке заказа, в расчете стоимости они не учавствуют.


latitudedouble
Широта точки доставки. Если указана, то расчет будет осуществлен по указанным координатам. Если не указана, то координаты автоматически подставятся на основании данных, полученных от Google API на основании поля address, при этом адрес автоматически определится по координатам, поэтому его не обязательно передавать, если указаны координаты.


longitudedouble
Долгота точки доставки. Если указана, то расчет будет осуществлен по указанным координатам. Если не указана, то координаты автоматически подставятся на основании данных, полученных от Google API на основании поля address, при этом адрес автоматически определится по координатам, поэтому его не обязательно передавать, если указаны координаты.


arrival_date_starttimestamp ОБЯЗАТЕЛЬНО
Начальный интервал указанного адреса, время "с".


arrival_date_endtimestamp ОБЯЗАТЕЛЬНО
Конечный интервал указанного адреса, время "до".


internet_shop_priceinteger
Сумма, которую должен получить курьер от получателя на данном адресе (для интернет-магазинов), указывается в рублях, без копеек. Можно указывать на любых адресах, кроме первого.



payment_methodstring ОБЯЗАТЕЛЬНО

CASH
Оплата наличными
Доступно только для физических лиц


SBP
Оплата переводом через СБП
Доступно только для физических лиц


QIWI
Оплата картой онлайн
Доступно только для физических лиц


CASHLESS
Оплата с баланса юридического лица
Доступно только для юридических лиц


Параметры ответа


В ответ возвращается JSON-объект подготовленного заказа, подробнее ознакомиться можно с параметрами полей заказа можно в разделе Параметры заказа.


Пример запроса


curl "https://test.myeasybox.ru/api/delivery/calculate-delivery" \
-X POST \
-d "{"weight: 1, "cargo_info": "Документы", "transport_type: "AFOOT", "require_loading": false, "declared_price": 0, "points": [{"address": "москва, ленинский проспект 1к2", "arrival_date_start": "2021-12-03T10:15:30+03:00", "arrival_date_end": "2021-12-03T10:15:30+03:00"},{"address": "москва алтуфьевское шоссе 40", "arrival_date_start": "2021-12-03T10:15:30+03:00", "arrival_date_end": "2021-12-03T10:15:30+03:00", "internet_shop_price": 500}], "payment_method": "CASH"} \
-H "API-Token: EasyBox API-Token" \
-H "Content-Type: application/json"
                                    {"id":null,"delivery_status":null,"created_datetime":null,"finish_datetime":null,"cancel_datetime":null,"courier":null,"weight":1,"cargo_info":"Документы","transport_type":"AFOOT","require_loading":false,"delivery_price":426,"declared_price":0,"backpayment_wallet":null,"backpayment_amount":74,"sum_revenue":500,"points":[{"id":null,"status":null,"comment":null,"address":"Москва, Ленинский пр-т., 1к2","latitude":55.7268803,"longitude":37.6093931,"contact_phone":null,"contact_person":null,"payment_here":false,"arrival_date_start":"2021-12-03T10:15:30+03:00","arrival_date_end":"2021-12-03T10:15:30+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":500,"internet_shop_id":null,"metro_station":"Октябрьская","metro_line_color":"915133","metro_distance":285},{"id":null,"status":null,"comment":null,"address":"Москва, Алтуфьевское ш., 40","latitude":55.8717031,"longitude":37.5871256,"contact_phone":null,"contact_person":null,"payment_here":false,"arrival_date_start":"2021-12-03T10:15:30+03:00","arrival_date_end":"2021-12-03T10:15:30+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":500,"internet_shop_id":null,"metro_station":"Дегунино","metro_line_color":"ED9F2D","metro_distance":1112}],"payment_method":"CASH"}
                                    

Отправка заказа

POST https://test.myeasybox.ru/api/delivery/create-delivery

С помощью данного метода можно разместить заказ. Ошибки, при их наличии, будут отображены в JSON-ответе.

Параметры запроса


weightinteger
Вес заказа в килограммах. Максимальный вес для способа доставки AFOOT - 15 кг; для способа доставки PASSENGER_CAR - 200 кг.
Значение по умолчанию: 1.


cargo_infostring ОБЯЗАТЕЛЬНО
Описание заказа. Поле "Что везем".


transport_typestring ОБЯЗАТЕЛЬНО

AFOOT
Пешком


PASSENGER_CAR
Легковой автомобиль


require_loadingboolean
Требуется ли погрузка-разгрузка.
Указывается только для заказов со способом доставки PASSENGER_CAR. В остальных случаях по умолчанию установится в false.


declared_priceinteger ОБЯЗАТЕЛЬНО
Объявленная ценность заказа. Должна быть от 0 до 20 000₽.


backpayment_walletstring УСЛОВНО-ОБЯЗАТЕЛЬНО
Реквизиты для перевода выручки. Обязательно указывается при наличии выручки в заказе.


pointslist ОБЯЗАТЕЛЬНО
Список адресов с параметрами.
Минимально возможное количество адресов: 2, максимально в одном заказе: 30.

commentstring
Комментарий к адресу для курьера. Аналог поля "Поручение для курьера" на сайте. Сюда можно написать как пройти на адрес, квартиру, или поручение для курьера, например: подписать документы.
Максимальная длина: 512 символов


addressstring ОБЯЗАТЕЛЬНО
Указывается адрес точки в формате: город, улица, дом, строение. Адрес будет обработан через Google Maps API и возвращен в отформатированном виде, по нему будут заполнены поля latitude и longitude в заказе.
Квартира, код домофона и прочие параметры указываются в поле comment при отправке заказа.
Максимальная длина: 150 символов


latitudedouble
Широта точки доставки. Если указана, то расчет будет осуществлен по указанным координатам. Если не указана, то координаты автоматически подставятся на основании данных, полученных от Google API на основании поля address, при этом адрес автоматически определится по координатам, поэтому его не обязательно передавать, если указаны координаты.


longitudedouble
Долгота точки доставки. Если указана, то расчет будет осуществлен по указанным координатам. Если не указана, то координаты автоматически подставятся на основании данных, полученных от Google API на основании поля address, при этом адрес автоматически определится по координатам, поэтому его не обязательно передавать, если указаны координаты.


contact_phonestring ОБЯЗАТЕЛЬНО
Номер телефона контактного лица, начинается с 7.
Максимальная длина: 11 символов. Пример: 79631234567


contact_personstring
Имя контактного лица на адресе.
Максимальная длина: 20 символов.


arrival_date_starttimestamp ОБЯЗАТЕЛЬНО
Начальный интервал указанного адреса, время "с". При указании прошедшего интервала, либо интервала меньше допустимого, время будет автоматически скорректировано системой на ближайшее возможное.


arrival_date_endtimestamp ОБЯЗАТЕЛЬНО
Конечный интервал указанного адреса, время "до". При указании прошедшего интервала, либо интервала меньше допустимого, время будет автоматически скорректировано системой на ближайшее возможное.


internet_shop_priceinteger
Сумма в рублях, которую должен получить курьер от получателя на данном адресе (для интернет-магазинов).


internet_shop_idstring
Максимальная длина: 20 символов.


payment_methodstring ОБЯЗАТЕЛЬНО

CASH
Оплата наличными
Доступно только для физических лиц


SBP
Оплата переводом через СБП
Доступно только для физических лиц


QIWI
Оплата картой онлайн
Доступно только для физических лиц


CASHLESS
Оплата с баланса юридического лица
Доступно только для юридических лиц


Параметры ответа


В ответ возвращается JSON-объект подготовленного заказа, подробнее ознакомиться можно с параметрами полей заказа можно в разделе Параметры заказа.


Пример запроса


curl "https://test.myeasybox.ru/api/delivery/create-delivery" \
-X POST \
-d "{ "weight": 10, "cargo_info": "Подарок", "transport_type": "AFOOT", "require_loading": false, "declared_price": 6000, "points": [ { "address": "москва суздальская 43", "contact_phone": "70000000000", "contact_person": "Ирина", "payment_here": true, "arrival_date_start": "2022-09-20T10:01:00+03:00", "arrival_date_end": "2022-09-20T13:28:00+03:00" }, { "comment": "Отдать документы", "address": "москва новокосинская 8к1", "contact_phone": "70000000000", "contact_person": "Иван", "payment_here": false, "arrival_date_start": "2022-09-25T10:02:30+03:00", "arrival_date_end": "2022-09-25T16:29:00+03:00", "internet_shop_price": 500 } ], "payment_method": "CASH" } \
-H "API-Token: EasyBox API-Token" \
-H "Content-Type: application/json"
                                    {"id":2694,"delivery_status":"AVAILABLE","created_datetime":"2022-09-15T19:54:39.370+03:00","finish_datetime":null,"cancel_datetime":null,"courier":null,"weight":10,"cargo_info":"Подарок","transport_type":"AFOOT","require_loading":false,"delivery_price":334,"declared_price":6000,"backpayment_wallet":null,"backpayment_amount":166,"sum_revenue":500,"points":[{"id":17198,"status":null,"comment":null,"address":"Москва, ул. Суздальская, 43","latitude":55.739233,"longitude":37.84606220000001,"contact_phone":"70000000000","contact_person":"Ирина","payment_here":true,"arrival_date_start":"2022-09-20T10:01:00.000+03:00","arrival_date_end":"2022-09-20T13:28:00.000+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":0,"internet_shop_id":null,"metro_station":"Новокосино","metro_line_color":"FFCD1C","metro_distance":1306},{"id":17199,"status":null,"comment":"Отдать документы","address":"Москва, ул. Новокосинская, 8","latitude":55.7395521,"longitude":37.8531408,"contact_phone":"70000000000","contact_person":"Иван","payment_here":false,"arrival_date_start":"2022-09-25T10:02:30.000+03:00","arrival_date_end":"2022-09-25T16:29:30.000+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":500,"internet_shop_id":null,"metro_station":"Новокосино","metro_line_color":"FFCD1C","metro_distance":924}],"payment_method":"CASH"}                                    

Редактирование заказа

POST https://test.myeasybox.ru/api/delivery/edit-delivery

С помощью данного метода можно отредактировать заказ. Ошибки, при их наличии, будут отображены в JSON-ответе. Отправляется такой же объект заказа, как и при создании, при этом API обратит внимание на изменившиеся данные, к примеру, если в новом теле заказа будет отсутствовать какой-либо адрес, он удалится из заказа.

Параметры запроса


idinteger ОБЯЗАТЕЛЬНО
Номер заказа для редактирования.


weightinteger
Вес заказа в килограммах. Максимальный вес для способа доставки AFOOT - 15 кг; для способа доставки PASSENGER_CAR - 200 кг.
Значение по умолчанию: 1.


cargo_infostring ОБЯЗАТЕЛЬНО
Описание заказа. Поле "Что везем".


transport_typestring ОБЯЗАТЕЛЬНО

AFOOT
Пешком


PASSENGER_CAR
Легковой автомобиль


require_loadingboolean
Требуется ли погрузка-разгрузка.
Указывается только для заказов со способом доставки PASSENGER_CAR. В остальных случаях по умолчанию установится в false.


declared_priceinteger ОБЯЗАТЕЛЬНО
Объявленная ценность заказа. Должна быть от 0 до 20 000₽.


backpayment_walletstring УСЛОВНО-ОБЯЗАТЕЛЬНО
Реквизиты для перевода выручки. Обязательно указывается при наличии выручки в заказе.


pointslist ОБЯЗАТЕЛЬНО
Список адресов с параметрами.
Минимально возможное количество адресов: 2, максимально в одном заказе: 30.

idinteger УСЛОВНО-ОБЯЗАТЕЛЬНО
Номер адреса для редактирования. Обязателен для указания, если происходит редактирование существующиего адреса. Если добавляется новый, то указывать не нужно.


commentstring
Комментарий к адресу для курьера. Аналог поля "Поручение для курьера" на сайте. Сюда можно написать как пройти на адрес, квартиру, или поручение для курьера, например: подписать документы.
Максимальная длина: 512 символов


addressstring ОБЯЗАТЕЛЬНО
Указывается адрес точки в формате: город, улица, дом, строение. Адрес будет обработан через Google Maps API и возвращен в отформатированном виде, по нему будут заполнены поля latitude и longitude в заказе.
Квартира, код домофона и прочие параметры указываются в поле comment при отправке заказа.
Максимальная длина: 150 символов


latitudedouble
Широта точки доставки. Если указана, то расчет будет осуществлен по указанным координатам. Если не указана, то координаты автоматически подставятся на основании данных, полученных от Google API на основании поля address, при этом адрес автоматически определится по координатам, поэтому его не обязательно передавать, если указаны координаты.


longitudedouble
Долгота точки доставки. Если указана, то расчет будет осуществлен по указанным координатам. Если не указана, то координаты автоматически подставятся на основании данных, полученных от Google API на основании поля address, при этом адрес автоматически определится по координатам, поэтому его не обязательно передавать, если указаны координаты.


contact_phonestring ОБЯЗАТЕЛЬНО
Номер телефона контактного лица, начинается с 7.
Максимальная длина: 11 символов. Пример: 79631234567


contact_personstring
Имя контактного лица на адресе.
Максимальная длина: 20 символов.


arrival_date_starttimestamp ОБЯЗАТЕЛЬНО
Начальный интервал указанного адреса, время "с". При указании прошедшего интервала, либо интервала меньше допустимого, время будет автоматически скорректировано системой на ближайшее возможное.


arrival_date_endtimestamp ОБЯЗАТЕЛЬНО
Конечный интервал указанного адреса, время "до". При указании прошедшего интервала, либо интервала меньше допустимого, время будет автоматически скорректировано системой на ближайшее возможное.


internet_shop_priceinteger
Сумма в рублях, которую должен получить курьер от получателя на данном адресе (для интернет-магазинов).


internet_shop_idstring
Максимальная длина: 20 символов.


payment_methodstring ОБЯЗАТЕЛЬНО

CASH
Оплата наличными
Доступно только для физических лиц


SBP
Оплата переводом через СБП
Доступно только для физических лиц


QIWI
Оплата картой онлайн
Доступно только для физических лиц


CASHLESS
Оплата с баланса юридического лица
Доступно только для юридических лиц


Параметры ответа


В ответ возвращается JSON-объект отредактированного заказа, подробнее ознакомиться можно с параметрами полей заказа можно в разделе Параметры заказа.


Пример запроса


curl "https://test.myeasybox.ru/api/delivery/edit-delivery" \
-X POST \
-d "{ "id": 2724, "weight": 15, "cargo_info": "Проверка редактирования заказа", "transport_type": "AFOOT", "require_loading": false, "declared_price": 0, "backpayment_wallet": "123456", "points": [ { "id": 17232, "comment": null, "address": "Москва, Алтуфьевское ш., 40", "latitude": 55.8717031, "longitude": 37.5871256, "contact_phone": "70000000000", "contact_person": null, "payment_here": false, "arrival_date_start": "2021-12-03T10:15:30.000+03:00", "arrival_date_end": "2021-12-03T10:15:30.000+03:00", "internet_shop_price": 0, "internet_shop_id": null }, { "id": 17233, "status": null, "comment": null, "address": "москва", "contact_phone": "70000000000", "payment_here": false, "arrival_date_start": "2021-12-05T10:15:30.000+03:00", "arrival_date_end": "2021-12-05T10:15:30.000+03:00", "arrival_set_start": null, "arrival_set_end": null, "courier_in_place_date": null, "completed_date": null, "paid_waiting_time": 0, "fee_waiting_time": 0, "internet_shop_price": 500, "internet_shop_id": null, "metro_station": "Новокосино", "metro_line_color": "FFCD1C", "metro_distance": 315 }, { "status": null, "comment": null, "address": "Москва, ул. Новокосинская, 10к1", "latitude": 55.73316000000001, "longitude": 37.855341, "contact_phone": "70000000000", "contact_person": "", "payment_here": false, "arrival_date_start": "2021-12-03T10:15:30.000+03:00", "arrival_date_end": "2021-12-03T10:15:30.000+03:00", "arrival_set_start": null, "arrival_set_end": null, "courier_in_place_date": null, "completed_date": null, "paid_waiting_time": 0, "fee_waiting_time": 0, "internet_shop_price": 5000, "internet_shop_id": null, "metro_station": "Новокосино", "metro_line_color": "FFCD1C", "metro_distance": 1439 } ], "payment_method": "CASH" } \
-H "API-Token: EasyBox API-Token" \
-H "Content-Type: application/json"
                                        {"id":2724,"delivery_status":null,"created_datetime":null,"finish_datetime":null,"cancel_datetime":null,"courier":null,"weight":15,"cargo_info":"Проверка редактирования заказа","transport_type":"AFOOT","require_loading":false,"delivery_price":917,"declared_price":0,"backpayment_wallet":"123456","backpayment_amount":4583,"sum_revenue":5500,"points":[{"id":17232,"status":null,"comment":null,"address":"Алтуфьевское ш., 40, Москва, Россия, 127566","latitude":55.8717031,"longitude":37.5871256,"contact_phone":"70000000000","contact_person":null,"payment_here":false,"arrival_date_start":"2021-12-03T10:15:30.000+03:00","arrival_date_end":"2021-12-03T10:15:30.000+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":0,"internet_shop_id":null,"metro_station":"Дегунино","metro_line_color":"ED9F2D","metro_distance":1112},{"id":17233,"status":null,"comment":null,"address":"Москва","latitude":55.755826,"longitude":37.6173,"contact_phone":"70000000000","contact_person":null,"payment_here":false,"arrival_date_start":"2021-12-05T10:15:30.000+03:00","arrival_date_end":"2021-12-05T10:15:30.000+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":500,"internet_shop_id":null,"metro_station":"Охотный ряд","metro_line_color":"E42313","metro_distance":209},{"id":17293,"status":null,"comment":null,"address":"ул. Новокосинская, 8, Москва, Россия, 111673","latitude":55.73316000000001,"longitude":37.855341,"contact_phone":"70000000000","contact_person":"","payment_here":false,"arrival_date_start":"2021-12-03T10:15:30.000+03:00","arrival_date_end":"2021-12-03T10:15:30.000+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":5000,"internet_shop_id":null,"metro_station":"Новокосино","metro_line_color":"FFCD1C","metro_distance":1439}],"payment_method":"CASH"} 

Отмена заказа

POST https://test.myeasybox.ru/api/delivery/cancel-delivery

С помощью данного метода можно отменить заказ. Ошибки, при их наличии, будут отображены в JSON-ответе.

Параметры запроса


idinteger ОБЯЗАТЕЛЬНО
Номер заказа, который требуется отменить.


Параметры ответа


В ответ возвращается JSON-объект отмененного заказа, подробнее ознакомиться можно с параметрами полей заказа можно в разделе Параметры заказа.


Пример запроса


curl "https://test.myeasybox.ru/api/delivery/cancel-delivery" \
-X POST \
-d "{ "id": 2705 } \
-H "API-Token: EasyBox API-Token" \
-H "Content-Type: application/json"
                                        {"id":2705,"delivery_status":"CANCELLED","created_datetime":"2022-09-23T14:52:31.777+03:00","finish_datetime":null,"cancel_datetime":"2022-09-23T15:15:25.918+03:00","courier":[{"first_name":"Тест","last_name":"Тест","middle_name":"Темт","courier_avatar":"https://test.myeasybox.ru/courier/avatar/91/faaa111469b7dc24bf411e51cd858d10","phone":null,"latitude":null,"longitude":null,"last_location_update":null}],"weight":1,"cargo_info":"Подарок","transport_type":"AFOOT","require_loading":false,"delivery_price":120,"declared_price":0,"backpayment_wallet":"123456","backpayment_amount":0,"sum_revenue":0,"points":[{"id":17218,"status":"IN_PLACE","comment":"","address":"г Москва, ул Новокосинская, д 10 к 1","latitude":55.734679,"longitude":37.85559,"contact_phone":"70000000000","contact_person":"Ирина","payment_here":true,"arrival_date_start":"2022-09-23T15:05:00.000+03:00","arrival_date_end":"2022-09-23T16:52:00.000+03:00","arrival_set_start":"2022-09-23T15:35:14.541+03:00","arrival_set_end":"2022-09-23T16:05:14.541+03:00","courier_in_place_date":"2022-09-23T15:05:57.631+03:00","completed_date":"2022-09-23T15:05:57.631+03:00","paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":0,"internet_shop_id":null,"metro_station":"Новокосино","metro_line_color":"FFCD1C","metro_distance":1278},{"id":17219,"status":null,"comment":"Отдать документы","address":"Москва, ул. Новокосинская, 8 корпус 1","latitude":55.7329675,"longitude":37.8553918,"contact_phone":"70000000000","contact_person":"Иван","payment_here":false,"arrival_date_start":"2022-09-25T15:05:00.000+03:00","arrival_date_end":"2022-09-25T17:52:00.000+03:00","arrival_set_start":null,"arrival_set_end":null,"courier_in_place_date":null,"completed_date":null,"paid_waiting_time":0,"fee_waiting_time":0,"internet_shop_price":0,"internet_shop_id":"","metro_station":"Новокосино","metro_line_color":"FFCD1C","metro_distance":1458}],"payment_method":"CASH"}
                                    

Типы данных


integer
Целое число


boolean
Логический оператор. Принимает значения true или false


timestamp
Дата и время в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ
Образец: 2022-09-05T16:35:00+03:00


object
JSON объект


list
JSON список


double
Число с плавающей точкой, аналог float.
Образец: 55.123456


Параметры заказа


idinteger
Номер заказа.


delivery_statusstring

AVAILABLE
Заказ оформлен и находится в процессе поиска курьера


ACTIVE
Заказ активен, курьер на заказ назначен


COMPLETED
Заказ выполнен


CANCELLED
Заказ отменен


created_datetimetimestamp
Время оформления заказа.


finish_datetimetimestamp
Время завершения заказа. В случае, если заказ не завершен, будет возвращено null.


cancel_datetimetimestamp
Время отмены заказа. Если заказ не был отменен, будет возвращено null.


courierobject
Информация о назначенном курьере. В случае, если статус заказа не active, будет возвращено null.
Параметры курьера


weightinteger
Вес в килограммах/


cargo_infostring
Описание заказа. Поле "Что везем".


transport_typestring

AFOOT
Пешком


PASSENGER_CAR
Легковой автомобиль


require_loadingboolean
Наличие в заказе услуги погрузки/разгрузки.


delivery_priceinteger
Общая стоимость доставки в рублях.


declared_priceinteger
Объявленная ценность в рублях.


backpayment_walletstring
Реквизиты для перевода выручки.


backpayment_amountinteger
Сумма выручки к возврату.


sum_revenueinteger
Общая сумма выручки на адресах.


pointslist
Массив адресов доставки заказа.
Параметры адреса доставки


payment_methodstring

CASH
Оплата наличными


SBP
Оплата переводом через СБП


QIWI
Оплата картой онлайн
Доступно только для физических лиц


CASHLESS
Оплата с баланса юридического лица
Доступно только для юридических лиц


Параметры адреса


idinteger
Номер адреса.


statusstring
Статус адреса. Если курьер еще не выехал по данному адресу, будет возвращено null.

STARTED
Курьер выехал по указанному адресу, направляется на него


IN_PLACE
Курьер прибыл на адрес и находится на нем


COMPLETED
Курьер посетил адрес и уже уехал с него


commentstring
Комментарий к адресу для курьера. Аналог поля "Поручение для курьера" на сайте.


addressstring
Адрес доставки.


latitudedouble
Широта точки, куда должен прибыть курьер.


longitudedouble
Долгота точки, куда должен прибыть курьер.


contact_phonestring
Номер телефона контактного лица, начинается с 7.
Пример: 79631234567


contact_personstring
Имя контактного лица на адресе.


payment_hereboolean
Указывает, будет ли оплачена вся стоимость заказа (доставки) на данном адресе.


arrival_date_starttimestamp
Начальный интервал указанного адреса, время "с".


arrival_date_endtimestamp
Конечный интервал указанного адреса, время "до".


arrival_set_starttimestamp
Начальный интервал времени прибытия курьера, устанавливается курьером самостоятельно.


arrival_set_endtimestamp
Конечный интервал времени прибытия курьера, устанавливается курьером самостоятельно.


courier_in_place_datetimestamp
Время, когда курьер прибыл на адрес.


completed_datetimestamp
Время, когда курьер посетил адрес и уехал с него.


paid_waiting_timeinteger
Количество минут платного ожидания.


fee_waiting_timeinteger
Надбавка к цене заказа за платное время ожидания.


internet_shop_priceinteger
Сумма, которую должен получить курьер от получателя на данном адресе (для интернет-магазинов).


internet_shop_idinteger
Внутренний номер заказа магазина (для интернет-магазинов).


metro_stationstring
Ближайшая станция метро к данному адресу.


metro_line_colorstring
HEX-код цвета линии метрополитена, где находится данная станция.


metro_distanceinteger
Расстояние в метрах от метро, считается ортодомически (по прямой).


Параметры курьера


first_namestring
Фамилия курьера.


last_namestring
Имя курьера.


middle_namestring
Отчество курьера.


courier_avatarstring
URL фотографии курьера.


phonestring
Номер телефона курьера, начинается с 7.
Пример: 79631234567
Возвращается только, если статус заказа ACTIVE.


latitudedouble
Широта курьера.
Возвращается только, если статус заказа ACTIVE.


longitudedouble
Долгота курьера.
Возвращается только, если статус заказа ACTIVE.


last_location_updatetimestamp
Время обновления геолокации курьера.
Возвращается только, если статус заказа ACTIVE.