Siirry sisältöön
ShopentlyLearn

Käyttöoikeudet ja paketit

Käyttö edellyttää sekä soveltuvaa kaupan pakettia että avaimen voimassa olevia oikeuksia.

Ennen API-kutsua

  1. Todentaminen

    Tarkista tunnistautuminen.

  2. Saatavilla alkaen

    Tarkista, että kaupan tilaus sisältää tarvittavan API-toiminnon.

  3. Vaaditut käyttöoikeudet

    Tarkista avaimen käyttöoikeudet ja lähetettävien kenttien ehdot.

Tarvittava tilaus

Tarvittava tilaus
Saatavilla alkaenKuvaus
BASICBASIC sisältää tilausten ja asiakastapausten lukemisen, niiden tilojen muuttamisen, tilausten maksutilan muuttamisen ja kirjatun palautussumman muuttamisen.
STANDARDTuoteluettelo-, CMS-, haku- ja varastotoiminnot edellyttävät STANDARD-pakettia tai ylempää pakettia.

Myös nykyisen tilauksen tehneet kaupat saavat pakettiinsa sisältyvät API-ominaisuudet.

Toiminnon käyttöoikeudet

  • Viitetiedoissa luetellaan kunkin toiminnon required_scopes ja arkaluonteisten kenttien tai muutosten conditional_scopes.
  • Resurssin lukuoikeus ei anna oikeutta luoda, muokata tai poistaa sitä.
  • Tunnuksen myöntäminen ja kontekstin käyttö edellyttävät todentamista myös silloin, kun resurssioikeutta ei ole lueteltu.

Listaa

GET/api/v1/products
Todentaminen
Bearer
Saatavilla alkaen
STANDARD
Vaaditut käyttöoikeudet
catalog.product:read

Päivitä

PATCH/api/v1/products/{product_id}
Todentaminen
Bearer
Saatavilla alkaen
STANDARD
Vaaditut käyttöoikeudet
catalog.product:update

Milloin lisäoikeuksia tarvitaan

Päivitä

PATCH/api/v1/products/{product_id}
Todentaminen
Bearer
Saatavilla alkaen
STANDARD
Vaaditut käyttöoikeudet
catalog.product:update
Valittujen kenttien lisäoikeudet
  • Kun variant_value_ids annetaan: catalog.product_variant:create, catalog.product_variant:update, catalog.product_variant:delete
  • Kun variants_enabled annetaan: catalog.product_variant:update

Mitä tilauksen vaihtuessa tapahtuu

Kun siirtyminen alempaan pakettiin poistaa oikeuden, se poistetaan API-avaimista ja näkyy hallintapaneelissa valitsemattomana ja poissa käytöstä.