Лиды

Вы можете создавать лиды через API

Список лидов

Список можно фильтровать и производить поиск.

Путь: /wp-json/usam/v1/leads

Метод запроса: GET

• fields (массив) (не обязательно) — дополнительные поля. products — товары, properties — свойства;
• search (строка) (не обязательно) — поиск по номеру, по артикулу товара, по названию товара, по телефону, электронной почте или адресу покупателя;
• status (строка, массив) (не обязательно) — коды статусов;
• exchange (число) (не обязательно) — заказы для выгрузки если 1, если 0 или параметр отсутствует все заказы;
• bank_account_id (число) (не обязательно) — банковский счет продавца;
• count (число) (не обязательно) — количество заказов, по умолчанию 10 заказов (не обязательный);
• paged (число) (не обязательно) — страница списка (не обязательный);
• orderby (строка) (не обязательно) — сортировать по полю;
• order (строка) (не обязательно) — направление сортировки ASC или DESC;

properties содержит данные покупателя.

Пример запроса

Запрос для получения всех лидов, не выгруженных в стороннюю учетную систему:

{
   "fields": ["products","properties"],
   "exchange": 1 
}

Получить лид по номеру

Путь: /wp-json/usam/v1/lead/(номер)

Метод запроса: GET

Обновить лид по его номеру

Путь: /wp-json/usam/v1/lead/(номер)

Метод запроса: POST

• status (строка) (не обязательно) — код статуcа заказа;
• bank_account_id (число) (не обязательно) — банковский счет продавца;
• source (строка) (не обязательно) — источник заказа;
• type_price (строка) (не обязательно) — тип цены;
• price_external_code (строка) (не обязательно) — внешний код цены;
• manager_id (число) (не обязательно) — номер менеджера;
• user_ID (число) (не обязательно) — номер пользователя;
• code (строка) (не обязательно) — внешний номер;
• type_payer (число) (не обязательно) — тип плательщика;
• exchange (число) (не обязательно) — обмен произведен, число 1 или 0;
• cancellation_reason (строка) (не обязательно) — причина отказа;
• products (массив) (обязательно) — товары;
• properties (массив) (не обязательно) — свойства;

Создать лид

Путь: /wp-json/usam/v1/lead

Метод запроса: POST

• status (строка) (не обязательно) — код статуcа заказа;
• bank_account_id (число) (не обязательно) — банковский счет продавца;
• source (строка) (не обязательно) — источник заказа;
• type_price (строка) (не обязательно) — тип цены;
• price_external_code (строка) (не обязательно) — внешний код цены;
• manager_id (число) (не обязательно) — номер менеджера;
• user_ID (число) (не обязательно) — номер пользователя;
• code (строка) (не обязательно) — внешний номер;
• type_payer (число) (не обязательно) — тип плательщика;
• exchange (число) (не обязательно) — обмен произведен, число 1 или 0;
• cancellation_reason (строка) (не обязательно) — причина отказа;
• products (массив) (обязательно) — товары;
• properties (массив) (не обязательно) — свойства;

Удалить лид по номеру

Путь: /wp-json/usam/v1/lead/(номер)

Метод запроса: DELETE

Массовые обновления лидов

Путь: /wp-json/usam/v1/leads

Метод запроса: PUT

• items — массив содержащий данные для обновления (обязательный)

Данные, которые содержит items те же, что и при обновлении