API для создания заявок
Last updated
Last updated
URL:
Тип запроса: POST
Обязательные поля для авторизации (могут быть переданы через GET или POST)
identifier - идентификатор клиента в системе (тот который вводится при входе в систему)
webApiKey - ключ для доступа в методам API
Обязательные поля заявки:
name - имя клиента
phone - номер телефона в любом формате
Необязательные дополнительные поля:
address_text - Адрес клиента
promocode - Промокод
comment - Комментарий клиента к заявке
diet_name - Название диеты (игнорируется, если передано поле diet_id)
diet_id - Идентификатор диеты
tariff_id - Идентификатор тарифа в PrivateCRM
tariff_name - Название тарифа (игнорируется, если передано поле tariff_id)\
delivery_time_id - Идентификатор интервала доставки
delivery_time_name - Название интервала доставки (игнорируется, если передано поле delivery_time_id)\
order_source_id - Идентификатор источника заказа в PrivateCRM
order_source_name - Название источника заказа (игнорируется, если передано поле order_source_id)
order_source_utm - UTM-метка источника заказа (игнорируется, если переданы другие поля). Это значение присваивается источнику заказов в разделе Источники заказов в PrivateCRM\
project_id - Идентификатор проекта в PrivateCRM
project_name - Название проекта (игнорируется, если передано поле project_id)
start_date - Дата начала питания (необходимо передать, если передано поле end_date)
end_date - Дата окончания питания
days_count - Количество дней питания (игнорируется, если передано поле end_date)
additional[ ] - массив дополнительных данных. Передается в виде additional[Название поля] => Данные
price - Цена заказа для отображения в системе (Не используется в расчетах)
Пример ответа в случае неправильного запроса:
{"status": "error", "message": "The start date is not a valid date.\r\n"}\
Пример ответа в случае успеха
{
"status": "success",
"message": "Order request successfully added",
"request": {
"id": 52,
"user_id": 2417,
"user_phone": "+7 999 999-99-99",
"diet_id": null,
"tariff_id": null,
"project_id": null,
"delivery_time_id": null,
"user_address_id": 4025,
"start_date": "2022-12-20",
"end_date": "2022-12-20",
"days_count": "6",
"promocode": "promo1",
"comment": "комментарий",
"create_time": 1671527653,
"order_source_id": null
}
}\
Метод возвращает статус ответа и данные о созданной заявке в случае успеха (формат JSON)