Руководство по ClientApi

Документация позволит получать данные продавца из Telegramius

Префикс для всех урлов client-api/

(например client-api/get-products)

Основные команды:

Api tokens

  • /refresh-token

Заказы

  • /get-orders
  • /update-order

Магазин

  • /get-shop

Продукты

  • /get-products
  • /get-product
  • /delete-product
  • /update-product

Категории

  • /get-categories
  • /get-category
  • /get-category-select
  • /delete-category
  • /update-category
  • /update-category/index
  • /create-category

Заказы

Получить все заказы

/get-orders | POST

Параметры

  • отсутствуют

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

/count/orders | GET

Параметры

  • отсутствуют

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

/count/orders/prices | GET

Параметры

  • отсутствуют

Изменить заказ

/update-order | POST

Параметры

  • order
    • id* (int)
    • status (Новый, Возврат, Оплачен, Отказ, Завершен, Не подтвержден) (string)
    • products (array)
      • id* (int)
      • qty* (int)
  • shop_id* (int)

Магазин

Получить информацию о магазине

/get-shop | GET

Параметры:

  • отсутствуют

Продукты

Найти продукты или получить все

/get-products | POST

Параметры

  • category_id (int)
  • search (string)
  • limit (количество товаров на странице)
  • page

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

/count/products | GET

Параметры

  • отсутствуют

Найти продукт по айди

/get-product | POST

Параметры

  • product_id* (int)

Удалить продукт по айди

/delete-product | POST

Параметры

  • product_id* (int)

Обновить продукт по айди

/update-product | POST

Параметры

  • product_id*
  • title (string)
  • description (string)
  • price (string)
  • remainder (количество) (int)
  • category_id (int)
  • isDiscount (bool)
  • discount (int)
  • discountType (%, $, RUB) (string)
  • is_published (bool)
  • articul (int)
  • comment (string)
  • currency (тикер валюты) (string)
  • inline_command
  • categories_id (int)
  • images (file)

Категории

Получить все категории

/get-categories | POST

Параметры:

  • search (string)
  • parent_id (int)
  • limit (количество товаров на странице) (int)
  • page

Получить количество категорий

/count/categories | GET

Параметры

  • отсутствуют

Найти категорию по айди

/get-category | POST

Параметры

  • category_id* (int)

Удалить категорию по айди

/delete-category | POST

Параметры

  • category_id* (int)

Редактировать категорию по айди

/update-category | POST

Параметры

  • category_id* (int)
  • name (string)
  • inline_command
  • image (file)
  • parent_id (int)
  • is_published (bool)
  • is_visible_name (bool)

Редактировать категорию по айди

/create-category | POST

Параметры

  • category_id* (int)
  • name* (string)
  • inline_command
  • image (file)
  • parent_id (int)
  • is_published (bool)
  • is_visible_name (bool)