Возвращает данные сделки по идентификатору, включая закрепленный контакт и значения дополнительных полей контакта.
API ver.10.0.0 Пользователь
| Запрос | |||
| Параметр | Тип | Значение | Описание |
class * | String | order | |
method * | String | get | |
sid * | String | — | Идентификатор сессии пользователя. |
param * | Number | — | ID сделки. |
| * – обязательные параметры | |||
| Ответ | ||
| Параметр | Тип | Описание |
response * | Object|Null | Объект сделки или null. |
order_id * | Number | ID сделки. |
order_name * | String | Название сделки. |
order_status_id * | Number | ID статуса. |
order_user_creator * | Number | ID создателя. |
order_user_mentor * | Number|Null | ID ответственного. |
chat_id * | Number | ID чата. |
contact_id * | Number | ID контакта. |
contact_name * | String | Имя контакта. |
order_sum * | Number|Null | Стоимость сделки. |
funnel_id * | Number | ID воронки. |
order_create_date * | Number | Дата создания. |
order_change_date * | Number|Null | Дата изменения. |
order_deleted * | Number|Null | Дата удаления. |
order_final_date * | Number|Null | Дата завершения. |
order_success * | Number|Null | Признак успешного завершения. Допустимые значения: 0 1 |
order_user_worker * | Number|Null | ID исполнителя. |
priority * | Number | Приоритет сделки. |
like * | Number|Null | ID пользователя, добавившего сделку в избранное. |
fields * | Object[] | Массив объектов значений дополнительных полей. |
fields.field_value_id * | Number | ID значения поля. |
fields.field_type_base_id * | Number | ID базового типа поля. |
fields.field_type_id * | Number | ID типа поля. |
fields.field_id * | Number | ID поля. |
fields.field_name * | String | Системное имя поля. |
fields.field_view_name * | String | Отображаемое имя поля. |
fields.field_scope_id * | Number | ID области видимости. |
fields.field_sub_type_id * | Number|Null | ID подтипа поля. |
fields.field_min_count * | Number | Минимальное количество значений. |
fields.field_max_count * | Number | Максимальное количество значений. |
fields.field_icon_name * | String|Null | Иконка поля. |
fields.field_priority * | Number | Приоритет поля. |
fields.field_hidden * | Number|Null | Признак скрытого поля: 1 или null. |
fields.field_readonly * | Number|Null | Признак поля только для чтения: 1 или null. |
fields.value * | String|Number|Object|Object[] | Значение поля. |
| * – обязательные параметры | ||
| Коды ошибок | |
| Номер | Описание |
708 | Недостаточно прав доступа для запрашиваемой операции. |
{
"order_id": 1042,
"order_name": "Заявка #1042",
"order_status_id": 5,
"order_user_creator": 1,
"order_user_mentor": 2,
"chat_id": 3301,
"contact_id": 587,
"contact_name": "Иванов Иван",
"order_sum": 15000,
"funnel_id": 1,
"order_create_date": 1708761600,
"order_change_date": 1708848000,
"order_deleted": null,
"order_final_date": null,
"order_success": null,
"order_user_worker": 3,
"priority": 0,
"like": null,
"fields": [
{
"field_value_id": 2001,
"field_type_base_id": 1,
"field_type_id": 1,
"field_id": 10,
"field_name": "comment",
"field_scope_id": 2,
"value": "Комментарий к сделке"
}
]
}
[
{
"code": 708,
"response": null
},
{
"code": 200,
"response": {
"errs": {
"708": "Недостаточно прав доступа для запрашиваемой операции."
}
}
}
]
curl -X POST https://domain.laxo.one/order/get \
-H "Content-Type: application/json" \
-d '{"sid": "YOUR_API_SID", "lang": "ru", "param": "OBJECT WITH PARAMS"}