Az áruház adatainak módosítása
Az API-val módosíthatod az áruház adatait, például egy termék leírását vagy árát.
Kiválasztott mezők módosítása
A termékleírás módosításához nem kell minden termékadatot elküldened. A PATCH kérésben add meg a módosítandó mezőket és a művelet többi kötelező mezőjét. A többi adat változatlan marad.
- Kihagyott mező
- Az értéke változatlan marad.
- null
- A null elküldése törli az értéket, ha a mező ezt engedélyezi. Ellenőrizd a művelet leírásában.
- Üres karakterlánc
- A "" üres szöveget jelent. Ez különbözik a null értéktől, és nem minden mező fogadja el.
Ebben a példában töröljük a termék német leírását. A név és a más nyelvű leírások változatlanok maradnak.
/api/v1/products/example?locale=decURL-kérés
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}'
Válasz
{
"data": {
"deleted": false,
"id": "example",
"version": 2
},
"meta": {
"request_id": "example"
}
}
Ha nem érkezik válasz
A válasz hiánya nem feltétlenül jelenti azt, hogy a módosítás nem lett elmentve. A kapcsolat a mentés után is megszakadhatott.
Adatok mentésekor adj a kéréshez egyedi értékű Idempotency-Key fejlécet. Ha nem kapsz választ, és ugyanazt a módosítást újra elküldöd, használd ugyanazt a kulcsot, címet, metódust és kéréstartalmat.
Ha az API már elmentette a kérés eredményét, azt adja vissza a módosítás újbóli végrehajtása nélkül. Másik módosításhoz új kulcsot használj.
Ha ugyanazt a kulcsot más kéréshez használja, idempotency.key_reused hibát kap.
Ha valaki ugyanazokat az adatokat módosítja
Módosítás előtt kérd le az aktuális adatokat. Ha a művelet megköveteli az expected_version mezőt, add meg benne a kapott verziót.
Ha valaki közben módosította az adatokat, az API elutasítja a mentést. Kérd le őket újra, és ellenőrizd, hogy a tervezett módosítás továbbra is megfelelő-e. Csak ezután küldj új kérést az aktuális verzióval.
Ármódosításkor az ár, a változat vagy az árlista verziójára is szükség lehet. A szükséges mezőket a művelet leírásában találod.