Za pomocą tego interfejsu API można wyświetlać, dodawać, edytować i usuwać produkty w projekcie.
Przeczytaj.
Umożliwia wyświetlenie utworzonych produktów w projekcie.
GET https://api.smartsender.com/v1/products
Parametry podstawowe:
Tytuł | Opis | Walidacja |
|---|---|---|
page | Żądana strona | Wartość minimalna 1 |
limitation | Ilość danych, które mają być wyświetlane na stronie | Wartość minimalna 1, wartość maksymalna 20 |
Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:
{
"cursor": Cursor,
"collection": Product[]
}
Opis odpowiedzi:
Tytuł | Opis |
|---|---|
cursor | Typ obiektu Cursor |
collection | Tablica obiektów typu Produkt |
Stworzenie.
Umożliwia utworzenie produktu w projekcie.
POST https://api.smartsender.com/v1/products
Parametry podstawowe:
Tytuł | Opis | Walidacja |
|---|---|---|
name | Tytuł | Unikalność w ramach projektu |
labels | Tablica identyfikatorów etykiet | |
essences | Tablica typu ProductEssence bez wartości tymczasowych | Wartość minimalna 1, wartość maksymalna 20 |
paymentSystems | Tablica identyfikatorów systemów płatności | |
categoryId | Identyfikator kategorii |
Jeśli się powiedzie, otrzymasz utworzony obiekt Produkt.
Aktualizacja.
Umożliwia aktualizację wybranego produktu w projekcie.
PUT https://api.smartsender.com/v1/products/{productId}
Parametry podstawowe:
Tytuł | Opis | Walidacja |
|---|---|---|
name | Tytuł | Unikalność w ramach projektu |
labels | Tablica identyfikatorów etykiet | |
essences | Tablica typu ProductEssence bez wartości tymczasowych | Wartość minimalna 1, wartość maksymalna 20 |
paymentSystems | Tablica identyfikatorów systemów płatności | |
categoryId | Identyfikator kategorii |
Jeśli się powiedzie, otrzymasz utworzony obiekt Produkt.
Usuń.
Umożliwia usunięcie istniejącego produktu.
DELETE https://api.smartsender.com/v1/products/{productId}
Jeśli odpowiedź będzie prawidłowa, otrzymasz następujące informacje:
{
"state": true
}