Чеки

Вы можете использовать API для получения документов в вашу учетную систему. Вы можете хранить номера документов из своей учетной системе в поле code и потом использовать его в своих запросах к сайту. Чтобы не получать дважды загруженные документы используйте параметр exchange в запросах получения документов. После получения документа, присвойте ему exchange равный 1.

Список чеков

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

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

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

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

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

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

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

Чек

Получает данные указанного заказа

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

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

Возвращает

• id — номер
• code — внешний номер заказа
• number — номер заказа, назначаемый по выбору менеджера сайта
• bank_account_id — номер компании продавца
• totalprice — полная сумма заказа
• cost_price — себестоимость
• type_price — тип цены
• paid — статус оплаты
• date_paid — дата оплаты
• status — код статуса заказа
• contact_id — номер покупателя в базе CRM
• company_id — номер компании в базе CRM
• manager_id — номер менеджера
• date_insert — дата заказа
• date_status_update — дата обновления статуса
• products — массив товаров заказа
• taxes — массив налогов на товары

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

Получить данные чека с id 10

 /wp-json/usam/v1/check/10

Обновить чек

Обновить данные указанного заказа, например, обновит данные 10 заказа /wp-json/usam/v1/check/10

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

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

• status (строка) (не обязательно)— новый статус чека;
• bank_account_id (число) (не обязательно)— новый продавец;
• manager_id (число) (не обязательно)— номер менеджера;
• code (строка) (не обязательно) — внешний номер;
• exchange (число) (не обязательно)— обмен произведен, число 1 или 0;

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

Указать, что чек с id 10 выгружен во внешнюю учетную систему:

 /wp-json/usam/v1/check/10

{
   "exchange": 1 
}

Возвращает

true если чек обновлен или false если не обновлен

Создать чек

Создать новый чек.

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

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

• status (число) (не обязательно) — код статуса;
• payment_type (строка) (не обязательно) — тип оплаты;
• bank_account_id (число) (не обязательно) — номер продавца;
• store_id (число) (не обязательно) — номер магазина (id склада);
• store_code (строка) (не обязательно) — код магазина (внешний код склада);
• type_price (строка) (не обязательно) — код цены;
• price_external_code (строка) (не обязательно) — внешний код цены;
• manager_id (число) (не обязательно) — номер менеджера;
• code (строка) (не обязательно) — внешний номер чека;
• products (массив ) (обязательно) — список товаров;

Типы оплаты

• cash — наличными
• card — банковской картой
• certificate — сертификатом
• account — оплата с внутреннего счета

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

 /wp-json/usam/v1/check

{
  "status": "received",
  "type_price": "tp_1",
  "store_code": "adsfrts",
  "code": "sdefsd23435",
  "products": [{"code":"rftreg","price":345},{"code":"123hfgj","price":2145}],
}

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

Массовое обновление чеков или создания новых чеков

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

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

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

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

• status (строка) (не обязательно) — новый статус;
• bank_account_id (число) (не обязательно) — новый продавец;
• exchange (число) (не обязательно) — обмен произведен, число 1 или 0;

Данные, которые содержит items для создания

• status (строка) (обязательно) — новый статус;
• bank_account_id (число) (обязательно) — новый продавец;
• exchange (число) (не обязательно) — обмен произведен, число 1 или 0;
• code (строка) (не обязательно) — код во внешней учетной системе;

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

Пометим, что заказы 1,2,3 выгружены и больше не нуждаются в выгрузке

 /wp-json/usam/v1/check

{
"items": [{
       "id": 1,
       "exchange": 1
     },
    {
       "id": 2,
       "exchange": 1
    },
    {
       "id": 3,
       "exchange": 1
    }] 
}

или если использовать code вместо id чека

 /wp-json/usam/v1/check

{
"items": [{
       "code": "sdfkjliji",
       "exchange": 1
     },
    {
       "code": "1sddd65",
       "exchange": 1
    },
    {
       "code": "fsfdd65",
       "exchange": 1
    }] 
}

Возвращает

количество обновленных