Передача заказов по API

Общая информация

При конфигурации приложения настройщик проекта указывает URL, на который POST-запросом будет приходить от системы информация о заказе, оформленном в приложении.

Тело POST-запроса представляет из себя JSON-объект следующего формата:

Пример блока сведений о заказе:

{
    "version": "1.4.1",
    "method": "neworder",
    "platform": "ios",
    "appId": 749356,
    "user": "mobium",
    "data": {

    },
    "region_data": {
        "id": "SPB",
        "title": "Санкт-Петербург",
        "google_place_id": "ChIJ7WVKx4w3lkYR_46Eqz9nx20",
        "coordinates": {
            "lon": 30.3350986,
            "lat": 59.9342802
        }
    },
    "access_token": null
}

Поля корневого объекта имеет значение обрабатывать лишь при расширении функционала связи между системой и клиентом.

Сопроводительные сведения

Блок order_info, вложенный в блок data, представляет из себя совокупность полей — имя, телефон, адрес электронной почты и комментарий — и полей, определяемых при выгрузке способов доставки для данного типа доставки, указанного в поле deliveryType.

"order_info": {
    "name": "Аноним",
    "phone": "+79044153612",
    "email": "admin@mobiumapps.com",
    "comments": "Приложением доволен, хорошо сделали",
    "regionId": "spb",
    "bonuses_used": 0
}

Формулировка заказа

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

Пример блока items

"items": [
     {
        "id": "15",
        "count": 1
    },
    {
        "id": "332",
        "count": 3
    }
]

Сведения об оплате

При оформлении заказа также передаются сведения о том, каким способом пользователь решил оплатить покупку. Сведения об этом передаются в поле payment.

"payment": {
    "type": "cash",
    "transactionId": null,
    "id": "5a43a9d8c7c5f",
    "title": "Наличными"
}

Удачный приём заказа

{
    "status": 0,
    "data": {
        "order_id": "34",
        "link": "https://.."
    }
}

Ошибка при приёме заказа

{
  "status" : 1,
  "message" : "Критическая ошибка #59"
}

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

{
    "version": "1.4.1",
    "method": "neworder",
    "platform": "ios",
    "appId": 749356,
    "user": "mobium",
    "data": {
        "deliveryCost": 0,
        "deliveryType": "Самовывоз",
        "deliveryData": [
            {
                "title": "Дом",
                "value": "1"
            },
            {
                "title": "Квартира",
                "value": "14"
            }
        ],
        "items": [
            {
                "id": "1",
                "count": 1
            }
        ],
        "fake": 0,
        "order_info": {
            "name": "",
            "phone": "999 999-99-99",
            "email": "",
            "comments": "",
            "regionId": "SPB",
            "payment_type": {
                "type": "cash",
                "id": "5a43a9d8c7c5f",
                "title": "Наличными"
            },
            "bonuses_used": 0
        },
        "payment": {
            "type": "cash",
            "transactionId": null,
            "id": "5a43a9d8c7c5f",
            "title": "Наличными"
        }
    },
    "region_data": {
        "id": "SPB",
        "title": "Санкт-Петербург",
        "google_place_id": "ChIJ7WVKx4w3lkYR_46Eqz9nx20",
        "coordinates": {
            "lon": 30.3350986,
            "lat": 59.9342802
        }
    },
    "access_token": null
}