Toodete API
- Anastasiia
Selle API abil saate projekti tooteid vaadata, lisada, redigeerida ja kustutada.
Lugemine.
Võimaldab vaadata projektis loodud tooteid.
GET https://api.smartsender.com/v1/products
Peamised parameetrid:
Nimi | Kirjeldus | Kinnitamine |
|---|---|---|
page | Taotletud leht | Minimaalne väärtus 1 |
limitation | Ühel lehel kuvatavate andmete hulk | Minimaalne väärtus 1, maksimaalne 20 |
Eduka vastuse korral saate järgmise teabe:
{
"cursor": Cursor,
"collection": Product[]
}
Vastuse kirjeldus:
Loomine.
Võimaldab luua projektis toodet.
POST https://api.smartsender.com/v1/products
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.
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
}