Products API - ua
- Anastasiia
За допомогою цього API ви можете переглядати, додавати, редагувати та видаляти продукти у проекті.
Читання.
Дозволяє переглянути створені продукти у проекті.
GET https://api.smartsender.com/v1/products
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
page | Запрошувана сторінка | Мінімальне значення 1 |
limitation | Кількість даних для виводу на сторінці | Мінімальне значення 1, максимальне 20 |
У разі успішної відповіді отримаєте таке:
{
"cursor": Cursor,
"collection": Product[]
}
Опис відповіді:
Створення.
Дозволяє створити продукт у проекті.
POST https://api.smartsender.com/v1/products
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
name | Назва | Унікальний в рамках проекту |
labels | Масив ідентифікаторів ярликів |
|
essences | Масив типу ProductEssence без тимчасових значень | Як мінімум 1 |
paymentSystems | Масив ідентифікаторів платіжних систем |
|
categoryId | Ідентифікатор категорії |
|
У разі успішної відповіді отримаєте створений Product об'єкт.
Оновлення.
Дозволяє оновити вибраний продукт у проекті.
Основні параметри:
Назва | Опис | Валідація |
|---|---|---|
name | Назва | Унікальний в рамках проекту |
labels | Масив ідентифікаторів ярликів |
|
essences | Масив типу ProductEssence без тимчасових значень | Як мінімум 1 |
paymentSystems | Масив ідентифікаторів платіжних систем |
|
categoryId | Ідентифікатор категорії |
|
У разі успішної відповіді отримаєте створений Product об'єкт.
Видалення.
Дозволяє видалити наявний продукт.
У разі успішної відповіді отримайте таке: