API для интеграции с Easy Way

Для использования API необходимо получить учетную запись.

При вызове методов используется basic-авторизация.

Для PHP разработчиков реализован SDK.

Для разработчиков на платформе 1С:Предприятие реализована внешняя обработка.

Список методов

Описание методов

createOrder

Cоздание заявки на доставку груза

POST-запрос к ресурсу http://apiurl/createOrder

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

{
"id": "test123457",                                          // Идентификатор заказа в системе клиента
"locationFrom": "Москва, ул. Складочная, д 1, стр 9",        // Адрес отправления
"locationTo": "Ростов-на-Дону, ул. М. Горького, 130; кв.4",  // Адрес получения
"pickupPointCode": "123", // Код ПВЗ, полученный методом getPickupPoints из поля guid
                          // обязательный, если тип доставки 2 или 4
"cargoCount": "2",        // Количество грузомест
"weight": 1.5,            // Вес в килограммах
"length": 15,             // Длина в сантиметрах
"width": 30,              // Ширина в сантиметрах
"height": 20,             // Высота в сантиметрах
"assessedCost": 999.99,   // Оценочная стоимость
"paymentMethod": 0,       // Способ оплаты (0 - Безналичная, 1 - Наличными, 2 - предоплата (без наложенного платежа)
"deliveryType": 1,        // Тип доставки 
"total": 999.99,          // Итого с клиента
"senderId": "",           // Идентификатор отправителя (в случае нескольких юр. лиц), необязательный
"noPickup": true,         // true - в случае самостоятельной доставки груза на склад Easy Way, необязательный
"items": [{               // Товарный состав, необязательный
  "article": "123456",    // Артикул
  "name": "Телефон LG",   // Наименование
  "count": 1,             // Количество
  "price": 800            // Цена
  },{
  "article": "123457",
  "name": "Телефон LG",
  "count": 2,
  "price": 199.99
  }
],
"recipient": {           // Получатель
  "name": "Иванов Иван", // ФИО получателя
  "phone": "9055089783"  // Телефон
  },
"services": [            // Дополнительные услуги, необязательный
  "hardPack",                  // Жесткая упаковка
  "addPack1",                  // Дополнительная упаковка
  "addPack2",                  // Пузырьковая пленка
  "docReturn",                 // Возврат документов
  "loadUnload",                // Погрузочно-разгрузочные работы
  "recipientPayer",            // Оплата получателем
  "nightDelivery"              // Ночная доставка
  ]
}

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

{
"isError": false,
"errors": [["code": 200, "descr": "Описание"], [...]],
"data": {
 "id": "000032888"
 }
}

cancelOrder

Отмена заявок на доставку груза

POST-запрос к ресурсу http://apiurl/cancelOrder

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

//Массив id заявок, полученных методом createOrder
[
"000034152",
"000034150"
]

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

{
"isError": false,
"errors": [["code": 200, "descr": "Описание"], [...]],
"data": [
 {
 "id": "000034152",
 "cancel": true,
 "descr": "Отменена"
 },
 {
 "id": "000034150",
 "cancel": false,
 "descr": "Не найдена"
 }
]
}

getPickupPoints

Получение списка ПВЗ

GET-запрос http://apiurl/getPickupPoints

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

[
{
"city": "Москва",
"address": "Россия, Москва, Востряковский проезд, 10Бс19",
"lat": 55.577271,
"lng": 37.626052,
"office": true,
"guid": "67534813-855d-11e6-80c7-000d3a2542c4",
"partner": "ПЭК",
"schedule": "",
"phone": ""
},
{
"city": "Ярославль",
"address": "Россия, Ярославль, проспект Октября, 93",
"lat": 57.661655,
"lng": 39.841954,
"office": false,
"guid": "352845f6-a017-11e6-80c7-000d3a2542c4",
"partner": "ПЭК",
"schedule": "Пн.-Пт. с 9-19, сб. с 10-16, вс.- вых",
"phone": ""
}
]

getTariff

Предварительный расчет доставки

GET-запрос http://apiurl/getTariff?locationFrom=Москва&locationTo=Подольск&weight=1&volume=0.001

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

[
{
"deliveryType": 1,
"total": 260,
"estDeliveryTime": {
 "min": "1",
 "max": "2"
 }
},
{
"deliveryType": 2,
"total": 130,
"estDeliveryTime": {
 "min": "1",
 "max": "2"
 }
},
{
"deliveryType": 3,
"total": 0,
"estDeliveryTime": {
 "min": "-",
 "max": "-"
 }
},
{
"deliveryType": 4,
"total": 0,
"estDeliveryTime": {
 "min": "-",
 "max": "-"
 }
}
]

deliveryType - тип доставки

  1. Авто до двери
  2. Авто до ПВЗ
  3. Авиа до двери
  4. Авиа до ПВЗ

getStatus

Запрос статусов заявок

GET-запрос http://apiurl/getStatus?number=1091840-YD1854000,66012-YD1854327

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

[
{
"orderNumber": "1091840-YD1854000",
"date": "2017-05-20T11:58:42",
"status": "На ПВЗ",
"arrivalPlanDateTime": "2017-05-22T15:00:00",
"dateOrder": "2017-05-15T15:08:00",
"sender": "Московская область",
"receiver": "Самара",
"carrierTrackNumber": "000029766",
"address": "Терминал, Склад ПЭК, г. Ярославль, проспект Октября, 93",
"deliveryType": "Терминал",
"phone": "",
"id": "000038700",
"statusCode": "675f4358-6f61-11e6-80ea-003048baa05f"
},
{
"orderNumber": "66012-YD1854327",
"date": "2017-05-22T13:32:37",
"status": "Выдан",
"arrivalPlanDateTime": "2017-05-20T15:00:00",
"dateOrder": "2017-05-15T15:27:17",
"sender": "Москва",
"receiver": "Брянск",
"carrierTrackNumber": "000029779",
"address": "Терминал, Склад ПЭК, г. Ярославль, проспект Октября, 93",
"deliveryType": "Терминал",
"phone": "",
"id": "000038700",
"statusCode": "b3e0596a-6b97-11e6-80e9-003048baa05f"
}
]

getOrderInfo

Получение подробной информации по заявкам

GET-запрос http://apiurl/getOrderInfo?number=1091840-YD1854000,66012-YD1854327

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

[
{
"id": "66012-YD1854327",
"date": "2017-05-15T15:27:17",
"regionFrom": "Москва",
"regionTo": "Брянск",
"addressFrom": "Россия, 0, г Москва, Огородный проезд, 20, К3",
"addressTo": "ПВЗ, Склад ПЭК, Брянск 241014, ул. Марии Расковой, д. 25",
"weight": 10.4,
"volume": 0.0495,
"length": 37.4,
"width": 37.6,
"height": 35.2,
"accessedCost": 11004,
"cargoCost": 11004,
"recipient": "ООО Велес ООО Велес ",
"recipientPhone": "74832686281",
"total": 0,            // Наложенный платеж
"deliveryCost": 334,   // Стоимость доставки
"outsideZoneCost": 0,  // Стоимость доставки за пределами городской зоны (Оплата километража)
"insuranceCost": 0,    // Страхование груза
"addServicesCost": 0   // Дополнительные услуги (Все остальное кроме НП)
},
{
"id": "1091840-YD1854000",
"date": "2017-05-15T15:08:00",
"regionFrom": "Московская область",
"regionTo": "Самара",
"addressFrom": "Россия, 0, г Москва, Огородный проезд, 20, К3",
"addressTo": "ПВЗ, Склад ПЭК, г. Самара, ул. Береговая, д.36",
"weight": 11.34,
"volume": 0.074784,
"length": 41,
"width": 40,
"height": 45.6,
"accessedCost": 5650,
"cargoCost": 5650,
"recipient": "Иван Иванов Иванович",
"recipientPhone": "79053049601",
"total": 6177,
"deliveryCost": 398,
"outsideZoneCost": 0,
"insuranceCost": 0,
"addServicesCost": 0
}
]

getLabel

Получение этикеток для печати

GET-запрос http://apiurl/getLabel?number=000026718,000033668

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

Возвращает HTML разметку этикетки Easy Way

Москва Санкт-Петербург 3 24.04.2017
Заказ №000026718 Место 1 из 3
Заказ клиента №448722/1
МВМВ