Kaupan tietojen muuttaminen

API:n avulla voit muuttaa kaupan tietoja, kuten tuotteen kuvausta tai hintaa.

Muuta valittuja kenttiä

Tuotekuvauksen muuttaminen ei vaadi kaikkien tuotetietojen lähettämistä. Lisää PATCH-pyyntöön muutettavat kentät ja muut toiminnon vaatimat kentät. Muut tuotetiedot pysyvät ennallaan.

Pois jätetty kenttä: Arvo pysyy ennallaan.
null: Arvon null lähettäminen poistaa arvon, jos kenttä sallii sen. Tarkista asia toiminnon kuvauksesta.
Tyhjä merkkijono: "" tarkoittaa tyhjää merkkijonoa. Se eroaa arvosta null, eivätkä kaikki kentät hyväksy sitä.

Tässä esimerkissä poistamme tuotteen saksankielisen kuvauksen. Nimi ja muunkieliset kuvaukset pysyvät ennallaan.

PATCH/api/v1/products/example?locale=de

cURL-pyyntö

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request PATCH \
  --url 'https://shop.onshopently.com/api/v1/products/example?locale=de' \
  --header 'Authorization: Bearer EXAMPLE_ACCESS_TOKEN' \
  --header 'Idempotency-Key: example-product-clear-translation' \
  --header 'Content-Type: application/json' \
  --data-raw '{"description":null,"expected_version":1}'

Vastaus

{
  "data": {
    "deleted": false,
    "id": "example",
    "version": 2
  },
  "meta": {
    "request_id": "example"
  }
}

Jos vastausta ei tule

Vastauksen puuttuminen ei välttämättä tarkoita, ettei muutos tallentunut. Yhteys on voinut katketa vasta muutoksen jälkeen.

Lisää tietoja tallentaessasi pyyntöön Idempotency-Key-otsake, jolla on yksilöllinen arvo. Jos et saa vastausta ja yrität samaa muutosta uudelleen, käytä samaa avainta, URL-osoitetta, menetelmää ja pyynnön sisältöä.

Jos API on jo tallentanut pyynnön tuloksen, se palauttaa sen tekemättä muutosta uudelleen. Käytä eri muutokselle uutta avainta.

Avaimen käyttö eri pyyntöön tuottaa idempotency.key_reused-virheen.

Jos joku muuttaa samoja tietoja

Hae ajantasaiset tiedot ennen muutosta. Jos toiminto vaatii expected_version-kentän, anna siinä saamasi versio.

Jos joku on muuttanut tietoja sillä välin, API hylkää tallennuksen. Hae tiedot uudelleen ja tarkista, onko suunniteltu muutos edelleen sopiva. Lähetä vasta sitten uusi pyyntö nykyisellä versiolla.

Hinnan muuttaminen voi vaatia myös hinnan, variantin tai hinnaston version. Tarvittavat kentät löytyvät toiminnon kuvauksesta.