С помощью данного 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 | Идентификатор категории |
|
Kui see õnnestub, hankige vastloodud toote objekt.
Värskenda.
Võimaldab projektis valitud toodet värskendada.
PUT https://api.smartsender.com/v1/products/{productId}
Peamised parameetrid:
Nimi | Kirjeldus | Kinnitamine |
|---|---|---|
name | Nimi | Projekti sees ainulaadne |
labels | Sildi ID massiiv |
|
essences | Massiivi tüüpi ProductEssence ilma ajutiste väärtusteta | Vähemalt 1 |
paymentSystems | Maksesüsteemide identifikaatorite hulk |
|
categoryId | Kategooria ID |
|
Kui see õnnestub, hankige vastloodud toote objekt.
Eemaldus.
Võimaldab eemaldada olemasoleva toote.
DELETE https://api.smartsender.com/v1/products/{productId}
Eduka vastuse korral saate järgmise teabe:
{
"state": true
}