Перейти к содержанию

Управление заявками без CRM

Получить список сделок

POST https://cloud.roistat.com/api/v1/project/leads/lead/list

С помощью данного метода можно получить список сделок и информацию по каждой сделке.

curl 'https://cloud.roistat.com/api/v1/project/leads/lead/list?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '{"period": {"from":"2022-11-08T21:00:00.000Z","to":"2022-11-09T20:59:59.999Z"}}'

Тело запроса:

{
    "period": {
        "from": "2021-11-08T21:00:00.000Z",
        "to": "2022-11-09T20:59:59.999Z"
    },
    "filters": [
        [
            "creation_date",
            ">",
            "2022-01-01T21:00:00+0000"
        ],
        [
            "email",
            "=",
            "ivan@email.com"
        ],
        [
            "id",
            "=",
            "order_41556"
        ],
        [
            "name",
            "=",
            "Иван Петров"
        ],
        [
            "paid_date",
            "=",
            "2022-01-01T21:00:00+0000"
        ],
        [
            "phone",
            "=",
            "+70003894141"
        ],
        [
            "price",
            "=",
            8008
        ],
        [
            "source",
            "=",
            "google2_search_20_10076505_13605556_24363401"
        ],
        [
            "status",
            "=",
            "3"
        ],
        [
            "title",
            "=",
            "Заявка"
        ]
    ],
    "sort_field": "creation_date",
    "sort_order": "desc",
    "limit": 100,
    "offset": 0
}
{
    "leads": [
        {
            "id": "order_41556",
            "title": "Заявка",
            "creation_date": "2022-08-20T20:30:33+0000",
            "paid_date": "2022-01-01T21:00:00+0000",
            "status": "1",
            "price": 8008,
            "name": "Никита Козлов",
            "phone": "+70003894141",
            "email": "Kozlov_Nikita_19920928@example.com",
            "source": "google2_search_20_10076505_13605556_24363401"
        },
        {
            "id": "order_41514",
            "title": "Заявка",
            "creation_date": "2022-08-20T19:41:35+0000",
            "paid_date": null,
            "status": "4",
            "price": 9920,
            "name": "Даниил Попов",
            "phone": "+70005303517",
            "email": "Popov_Daniil_19930217@example.com",
            "source": "direct1_context_12_81619651_73076440_товары для дома сайт каталог"
        }
    ],
    "total": 2,
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
period object Период, сделки за который нужно выгрузить да
from string Начальная дата в формате 2021-11-08T21:00:00.000Z да
to string Конечная дата в формате 2022-11-09T20:59:59.999Z да
filters array Дополнительные фильтры. Указываются в формате "filters": [["<parameter>","<operator>","<value>"]], где:
  • <parameter> – один из параметров фильтрации: creation_date – дата создания сделки в формате 2022-01-01T21:00:00+0000, email – email клиента, id – ID сделки в Roistat, name – имя клиента, paid_date – дата оплаты в формате 2022-01-01T21:00:00+0000, phone – телефон клиента, price – сумма заказа, source – источник сделки, передаваемый в поле roistat, status – ID текущего статуса сделки (можно получить с помощью метода /leads/status/list), title – название сделки.
  • <operator> – один из операторов: =, !=, <=, >=
  • <value> – значение для фильтрации с типом string
нет
sort_field string Параметр, по которому нужно сортировать список: creation_date – дата создания сделки в формате 2022-01-01T21:00:00+0000, id – ID сделки в Roistat, paid_date – дата оплаты в формате 2022-01-01T21:00:00+0000, price – сумма заказа, source – источник сделки, передаваемый в поле roistat, status – ID текущего статуса сделки (можно получить с помощью метода /leads/status/list) да
sort_order string Порядок сортировки: asc – по возрастанию, desc – по убыванию нет
limit integer Максимальное количество результатов в ответе нет
offset integer Количество результатов в начале, которое нужно пропустить нет
Параметр Тип Описание
leads array[object]
id string ID сделки в Roistat
title string Название сделки в Roistat
creation_date string Дата создания сделки в формате 2022-01-01T21:00:00+0000
paid_date string Дата оплаты в формате 2022-01-01T21:00:00+0000
status string ID текущего статуса сделки
price string Сумма заказа
name string Имя клиента
phone string Телефон клиента
email string Email клиента
source string Источник сделки
total integer Количество результатов
status string Статус запроса

Получить список статусов

POST https://cloud.roistat.com/api/v1/project/leads/status/list

С помощью данного метода можно получить список статусов в Управлении заявками без CRM.

curl 'https://cloud.roistat.com/api/v1/project/leads/status/list?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}'

Тело запроса:

Без тела.

{
    "data": [
        {
            "id": "0",
            "name": "В работе",
            "type": "progress"
        },
        {
            "id": "1",
            "name": "Оплачен",
            "type": "paid"
        },
        {
            "id": "2",
            "name": "Отменен",
            "type": "canceled"
        }
    ],
    "total": 3,
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Без тела.

Параметр Тип Описание
data array[object]
id string ID статуса
name string Название статуса
type string Группа, к которой относится статус: progress – В процессе, paid – Оплачено, canceled – Отменено
total integer Количество результатов
status string Статус запроса