Products API - FI
- Anastasiia
Tämän API:n avulla voit tarkastella, lisätä, muokata ja poistaa tuotteita projektissa.
Lukeminen.
Voit tarkastella projektissa luotuja tuotteita.
GET https://api.smartsender.com/v1/products
Pääparametrit:
Nimi | Kuvaus | Validointi |
|---|---|---|
page | Pyydetty sivu | Vähimmäisarvo 1 |
limitation | Näytettävien tietojen määrä sivua kohden | Pienin arvo 1, maksimi 20 |
Jos vastaus on onnistunut, saat seuraavat tiedot:
{
"cursor": Cursor,
"collection": Product[]
}
Vastauksen kuvaus:
Luominen.
Mahdollistaa tuotteen luomisen projektissa.
POST https://api.smartsender.com/v1/products
Pääparametrit:
Nimi | Kuvaus | Validointi |
|---|---|---|
name | Nimi | Ainutlaatuinen projektin sisällä |
labels | Label ID -joukko |
|
essences | ProductEssence-tyyppinen taulukko ilman väliaikaisia arvoja | Vähintään 1 |
paymentSystems | Joukko maksujärjestelmien tunnisteita |
|
categoryId | Luokkatunnus |
|
Jos vastaus onnistuu, saat luodun Product esine.
Päivittää.
Voit päivittää projektissa valitun tuotteen.
Pääparametrit:
Nimi | Kuvaus | Validointi |
|---|---|---|
name | Nimi | Ainutlaatuinen projektin sisällä |
labels | Label ID -joukko |
|
essences | ProductEssence-tyyppinen taulukko ilman väliaikaisia arvoja | Vähintään 1 |
paymentSystems | Joukko maksujärjestelmien tunnisteita |
|
categoryId | Luokkatunnus |
|
Jos vastaus onnistuu, saat luodun Product esine.
Poistaminen.
Voit poistaa olemassa olevan tuotteen.
Jos vastaus on onnistunut, saat seuraavat tiedot: