1. Wiki
  2. API
  3. Получение списка сделок, с фильтром

Получение списка сделок, с фильтром

URL метода

GET/POST offers/get_from_filter

Например:
https://(ваша компания).stocrm.ru/api/external/v1/offers/get_from_filter?SID=666_abcdefgh

Параметр:
Параметр Тип Описание
FILTER array Ниже в статье
SORT array Ниже в статье
PAGE int С помощью него выбирается номер страницы
LIMIT int С помощью этого параметра указывается сколько выводить элементов на странице

Значения внутри FILTER:

Параметр Тип Что делает
USER_ID array/int/string  По ID пользователя
PAYMENT_STATUS array/int/string По статусу оплаты.
ERROR — Ошибка
FULL_PAYMENT — Полная оплата
FULL_REFUND — Возврат
IN_PROGRESS — Идет процесс печати
NONE — Нет оплаты
PARTIAL_REFUND — Частичный возврат
PREPAYMENT — Внесена предоплата
OFFER_STATUS_ID array/int/string Для получения сделок с определённым статусом (успешные — 6), например FILTER[OFFER_STATUS_ID]=6
DATE_FORMAT string В каком формате присылать переформатированные даты, по умолчанию идёт %Y-%m-%d %H:%i:%s
DATE_FROM int Диапазон дат, дата от — указываются в формате unix time (например 1522667800).
DATE_TO int Диапазон дат, дата до — указываются в формате unix time (например 1556668800).
DATE_FIELD string Выбирает дату, по которой будет поиск по дате. Может принимать одно из следующих значений: DATE_CREATE — по дате создания
DATE_UPDATE — по дате изменения

2) Значения внутри SORT

Ключ Значение Как сортирует
OFFER_ID ASC/DESC По номеру сделки
DATE_CREATE ASC/DESC По дате создания
DATE_UPDATE ASC/DESC По дате изменения

Пример полученных данных:

1    {
2      "RESPONSE": {
3        "DATA": [
4          {
5            "OFFER_ID": 45,
6            "CONTACT_ID": 19,
7            "STATUS_TITLE": "Успешно реализованный",
8            "DATE_CREATE": "2018-09-06 16:04:25",
9            "DATE_CREATE_TIMESTAMP": 1536239065,
10           "DATE_UPDATE_TIMESTAMP": 1536343118,
11           "STATUS_UPDATE_TIMESTAMP": 1536343118,
12           "DATE_CREATE_REFORMATTED": "2018-09-06 16:04:25",
13           "DATE_UPDATE_REFORMATTED": "2018-09-07 20:58:38",
14           "OFFER_SOURCE": "Не указано",
15           "SUM_OF_WORKS": "10114.50",
16           "SUM_OF_ORDERS": false,
17           "SUM_TOTAL": "10114.50",
18           "SUM_OF_HOURS": "1.5000000",
19           "POST_RECORDS": 0,
20           "CAR_TITLE": "Citroen C-Crosser 1 поколение Кроссовер 2.0 CVT 2WD (147 л.с.)",
21           "CAR_LICENSE_PLATE": "E484EH111",
22           "CAR_OWNER": "Евдокимов Анатолий Николаевич",
23           "PAYMENT_STATUS_NAME": "Нет оплаты",
24           "USER_TITLE": "Петрушин Виктор Александрович",
25           "CONTACT_TITLE": "Евдокимов Анатолий Николаевич",
26           "CONTACT_PHONES": "79888888888",
27           "CONTACT_EMAILS": "p@p.ru;1p@1p.ru",
28           "CONTACT_DISCOUNT": 0,
29           "INCOMING_CALLS_COUNT": 0,
30           "OUTGOING_CALLS_COUNT": 0,
31           "TASKS_COUNT": 0,
32           "CONTACT_SEGMENT": "Клиенты",
33           "CONTACT_DOB": false,
34           "CONTACT_DOB_TIMESTAMP": false
35         },
36         {
37           "OFFER_ID": 62,
38           "CONTACT_ID": 15,
39           "STATUS_TITLE": "Закрыто и нереализовано",
40           "DATE_CREATE": "2018-09-06 16:27:01",
41           "DATE_CREATE_TIMESTAMP": 1536240421,
42           "DATE_UPDATE_TIMESTAMP": 1536662144,
43           "STATUS_UPDATE_TIMESTAMP": 1536662144,
44           "DATE_CREATE_REFORMATTED": "2018-09-06 16:27:01",
45           "DATE_UPDATE_REFORMATTED": "2018-09-11 13:35:44",
46           "OFFER_SOURCE": "Не указано",
47           "SUM_OF_WORKS": false,
48           "SUM_OF_ORDERS": false,
49           "SUM_TOTAL": "0.00",
50           "SUM_OF_HOURS": false,
51           "POST_RECORDS": 0,
52           "CAR_TITLE": false,
53           "CAR_LICENSE_PLATE": false,
54           "CAR_OWNER": false,
55           "PAYMENT_STATUS_NAME": "Нет оплаты",
56           "USER_TITLE": "Петрушин Виктор Александрович",
57           "CONTACT_TITLE": "Евдокимов Анатолий Николаевич",
58           "CONTACT_PHONES": "79999999999",
59           "CONTACT_EMAILS": "vap331@jail.ru",
60           "CONTACT_DISCOUNT": 0,
61           "INCOMING_CALLS_COUNT": 0,
62           "OUTGOING_CALLS_COUNT": 0,
63           "TASKS_COUNT": 0,
64           "CONTACT_SEGMENT": "СТО, др. корпоративные клиенты",
65           "CONTACT_DOB": "1990-06-14",
66           "CONTACT_DOB_TIMESTAMP": 645307200
67         }
68       ]
69     }
70   }

Статья с перечнем функций

Обновлено Июль 10, 2019

Related Articles