Методы доставки и местоположений
Все методы вызывает гость или вошедший.
| Метод | Адрес | Начинает сессию |
|---|---|---|
| Склады магазина | GET /api/sale/store | нет |
| Поиск местоположения по названию | GET /api/sale/location/search | нет |
| Избранные города | GET /api/sale/favoriteLocations | нет |
| Города справочника местоположений | GET /api/sale/locations | нет |
| Запомнить склад, город и адрес | POST /api/sale/setLocation | да |
| Способы доставки магазина | GET /api/sale/delivery | нет |
| Запомнить способ доставки | POST /api/sale/setDelivery | да |
| Данные службы доставки СДЭК | POST /api/sale/delivery/internalData | нет |
Город и доставка на витрине
- Строка «Город»:
GET /api/sale/location/search?phrase=Каз— подсказки по справочнику местоположений. Быстрый выбор без ввода —GET /api/sale/favoriteLocations. - Пункты самовывоза —
GET /api/sale/store. - Покупатель выбрал город, склад или адрес:
POST /api/sale/setLocation. Метод начинает сессию; витрина сохраняетX-Session-Idиз заголовка ответа. - Способы доставки:
GET /api/sale/delivery. Выбор —POST /api/sale/setDelivery. - Расчёт стоимости доставки для корзины, ограничения по весу и местоположению делает
POST /api/sale/order/refresh(Заказ). - Что сейчас выбрано в сессии, возвращает
GET /api/sale(поляlocationиdelivery; покаsetLocationиsetDeliveryне вызывались, они пустые).
Поиск местоположения
curl -G "https://example.ru/api/sale/location/search" --data-urlencode "phrase=Каз" {
"data": {
"items": [
{ "code": "0000550426", "typeId": "5", "value": "1594", "path": [48, 46, 1], "display": "Казань" }
],
"etc": {
"pathItems": {
"48": { "code": "0000028070", "typeId": "3", "display": "Республика Татарстан", "childCnt": "45", "value": 48 }
}
}
}
} Поиск идёт от трёх символов; для более короткой фразы и для фразы, которой нет в индексе местоположений, ответ пустой (items и etc — пустые массивы). Параметры limit (по умолчанию 10) и offset — постраничный вывод. code из найденного значения передаётся в properties свойства с типом LOCATION в order/refresh и order/save (Заказ); текстовый адрес (улица, дом) — в отдельное свойство ADDRESS. etc.pathItems — описание родительских местоположений из path.
GET /api/sale/locations отдаёт города (тип CITY) по алфавиту, city — только начинающиеся с этой строки. Справочник большой: без city ответ может быть очень длинным, для подсказок по вводу используйте location/search.
Склады
curl "https://example.ru/api/sale/store" {
"data": [
{
"id": 1,
"title": "Склад",
"address": "пр. Московский д. 51",
"coord": "Описание склада (здесь хранят координаты)",
"phone": "8 (495) 212 85 06",
"schedule": "Пн.-Пт. с 9:00 до 20:00",
"email": ""
}
]
} coord — содержимое поля «Описание» склада Битрикса, в нём хранят координаты. Отдаются активные склады.
Запомнить город, склад и адрес
curl -i -X POST "https://example.ru/api/sale/setLocation" \
-H "Content-Type: application/json" \
-d '{"storeId": 1, "cityId": 15, "lonLat": "37.6173,55.7558", "address": "г. Москва, ул. Примерная, д. 1"}' {
"data": {
"storeId": 1,
"cityId": 15,
"lonLat": "37.6173,55.7558",
"address": "г. Москва, ул. Примерная, д. 1",
"city": null,
"store": { "id": 1, "title": "Склад" }
}
} Каждый вызов целиком заменяет прежний выбор: непереданные значения становятся пустыми. cityId — ID элемента инфоблока городов (API-код cities); если город не передан, он определяется по координатам или IP, а если не определился — берётся «Город по умолчанию» из настроек. city — карточка города из инфоблока cities (пусто, если такого инфоблока нет), store — склад по storeId.
Способы доставки
GET /api/sale/delivery отдаёт активные службы доставки Битрикса со штатными полями службы. data — объект, ключ — ID службы:
{
"data": {
"1": {
"id": "1",
"parentId": "0",
"name": "Без доставки",
"active": "Y",
"sort": "100",
"currency": "RUB",
"config": { "main": { "currency": "RUB", "price": 0, "period": { "from": 0, "to": 0, "type": "D" } } }
}
}
} Ответ сокращён. POST /api/sale/setDelivery запоминает выбор: deliveryId, date, time, address. Дата, время и адрес сохраняются как переданы, модуль их не проверяет. Каждый вызов целиком заменяет прежний выбор. В ответе — сохранённые значения и delivery (служба по deliveryId).
СДЭК
POST /api/sale/delivery/internalData — запрос виджета выбора пункта выдачи СДЭК на странице оформления: передаёт deliveryCode (cdek или sdek:pickup) и data (action, weight, sdekId, mode) в модуль ipol.sdek и отдаёт его ответ как есть, поэтому форма ответа зависит от параметров. Для другого кода тело пустое; если модуль не установлен — 400.
Где настраивается доставка
- Настройки модуля -> вкладка «Магазин»: «Город по умолчанию» (ID элемента инфоблока городов).
- Склады, службы доставки, избранные местоположения (список по умолчанию в настройках магазина Битрикса), справочник местоположений — штатные разделы Битрикса.
- Кеш:
favoriteLocationsкешируется на срок слоя «Справочники» (Настройки модуля -> «Кеширование»); выбор покупателя не кешируется.
Ограничения доставки
- Ответ
GET /api/sale/delivery— объект по ID службы, а не массив. - Ошибки приходят в двух формах:
{errors: [текст]}и{success: false, error: текст}— читайте текст изerrorилиerrors[0].