API для заказов - Документация universam

API для заказов

Купоны

Вы можете управлять купонами через API

Список купонов

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

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

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

  • search (строка) (не обязательно) — поиск по номеру;
  • user_id (число) (не обязательно) — номер пользователя;
  • count (число) (не обязательно) — количество заказов, по умолчанию 10 заказов (не обязательный);
  • paged (число) (не обязательно) — страница списка (не обязательный);
  • orderby (строка) (не обязательно) — сортировать по полю;
  • order (строка) (не обязательно) — направление сортировки ASC или DESC;

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

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

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

Создать купон

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

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

  • user_id (число) (не обязательно) — номер пользователя;
  • coupon_code (строка) (не обязательно) — код купона;
  • description (строка) (не обязательно) — описание;
  • start_date (дата-время) (не обязательно) — дата начала действия;
  • end_date (дата-время) (не обязательно) — дата конца действия;
  • amount_bonuses_author (число) (не обязательно) — сколько бонусов зачислить автору купона при использовании;
  • max_is_used (число) (не обязательно) — максимальное количество использований;
  • active (число) (не обязательно) — активирован 1, нет 0;

Обновить купон

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

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

  • user_id (число) (не обязательно) — номер пользователя;
  • description (строка) (не обязательно) — описание;
  • start_date (дата-время) (не обязательно) — дата начала действия;
  • end_date (дата-время) (не обязательно) — дата конца действия;
  • amount_bonuses_author (число) (не обязательно) — сколько бонусов зачислить автору купона при использовании;
  • max_is_used (число) (не обязательно) — максимальное количество использований;
  • active (число) (не обязательно) — активирован 1, нет 0;

Удалить купон

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

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

Посмотри платформу для wordpress
сейчас
Посмотреть интернет-магазин
Вид интернет-магазина