📂 На этом этапе необходимы:
Сделки добавляются с помощью метода Create Deal или Create Many Deals
❗ Не забудьте для каждого запроса указывать header Authorization: Token <токен_доступа> полученный на этапе ⚠️ 0. Производим аутентификацию
POST https://apps.smartanalytics.io/crm/v1/api/deals/
Request Body:
{
"name": "string",
"pipeline_id": "string",
"status_id": "string",
"manager_id": "string",
"contact_id": "string",
"utm_source": "string",
"utm_medium": "string",
"utm_campaign": "string",
"utm_content": "string",
"utm_term": "string",
"metrika_cid": "string",
"smart_visitor_id": "string",
"google_cid": "string",
"price": 0,
"products": [
{
"name": "string",
"category": "string",
"quentity": 0,
"price": 0
}
],
"custom_fields": [
{
"id": "string",
"value": "string"
}
],
"purchase_tax": 0,
"purchase_shipping": 0,
"first_cost": 0,
"created": 0,
"last_modified": 0,
"invoice": "string",
"entity_link": "string"
}
Response:
{
"name": "string",
"pipeline_id": "string",
"status_id": "string",
"manager_id": "string",
"contact_id": "string",
"utm_source": "string",
"utm_medium": "string",
"utm_campaign": "string",
"utm_content": "string",
"utm_term": "string",
"metrika_cid": "string",
"smart_visitor_id": "string",
"price": 0,
"products": [
null
],
"custom_fields": [
null
],
"purchase_tax": 0,
"purchase_shipping": 0,
"first_cost": 0,
"created": 0,
"last_modified": 0,
"invoice": "string",
"entity_link": "string",
"id": "string"
}
Обязательное поле | Название поля в API | Тип поля | Описание поля |
Да | name | string (Name) | название сделки(заказа) |
Да | pipeline_id | string (Pipeline Id) | Идентификатор воронки, в которой находится сделка |
Да | status_id | string (Status Id) | Статус сделки |
Нет | manager_id | string (Manager Id) | Идентификатор менеджера |
Нет | contact_id | string (Contact Id) | Идентификатор “карточки” с контактами |
Нет | utm_source | string (Utm Source) | UTM source |
Нет | utm_medium | string (Utm Medium) | UTM medium |
Нет | utm_campaign | string (Utm Campaign) | UTM campaign |
Нет | utm_content | string (Utm Content) | UTM content |
Нет | utm_term | string (Utm Term) | UTM term |
Нет | metrika_cid | string (Metrika CID) | Уникальный идентификатор Яндекс метрики |
Нет | google_cid | string (Google CID) | Уникальный идентификатор Гугл метрики |
Да | price | number (Price) | Итоговая цена сделки (заказа) |
Да | products | Array of objects (Products) | Массив с позициями в сделке(заказе) |
Да | custom_fields | Array of objects (Custom Fields) | Кастомные поля для сделки |
Нет | purchase_tax | number (Purchase Tax)Default: 0 | Налог |
Нет | purchase_shipping | number (Purchase Shipping)Default: 0 | Тип доставки |
Нет | rejection_reason | string (Rejection Reason) | Причина отказа |
Нет | first_cost | number (First Cost)Default: 0 | Себестоимость заказа |
Да | created | timestamp (Created) | Дата создания сделки |
Да | last_modified | timestamp (Last Modified) | Дата последнего изменения сделки |
Нет | invoice | string (Invoice)Default: «none» | Счет на который пришла оплата |
Нет | entity_link | string (Entity Link)Default: «none» | Ссылка на сделку |
Нет | outer_id | string (Outer Id) | Внешний идентификатор сделки |
Позиция в массиве products
Обязательное поле | Название поля в API | Тип поля | Описание поля |
Нет | id | string (Id) | Идентификатор продукта |
Да | name | string (Name) | Название продукта |
Да | category | string (Category) | Категория продукта |
Да | quantity | integer (Quantity) | количество элементов конкретного id в заказе |
Да | price | number (Price) | Стоимость продукта |
Позиция в массиве custom_fields
Обязательное поле | Название поля в API | Тип поля | Описание поля |
Да | id | string (Id) | Идентификатор кастомного поля |
Да | value | any (Value) | Значение кастомного поля |
Далее перейти к ⚠️ 8. Обновляем сделки (заявки).