Tibdel id-data tal-ħanut
Bl-API tista’ tbiddel id-data tal-ħanut tiegħek, bħal deskrizzjoni jew prezz ta’ prodott.
Ibdel oqsma magħżula
Biex tibdel id-deskrizzjoni ta’ prodott, m’għandekx għalfejn tibgħat id-data kollha tiegħu. Fit-talba PATCH, inkludi l-oqsma li qed tibdel u l-oqsma l-oħra meħtieġa għall-operazzjoni. Il-bqija tad-data tibqa’ l-istess.
- Qasam imħolli barra
- Il-valur tiegħu jibqa’ l-istess.
- null
- Jekk tibgħat null, il-valur jitħassar jekk il-qasam jippermetti dan. Iċċekkja d-deskrizzjoni tal-operazzjoni.
- String vojta
- "" tfisser test vojt. Dan huwa differenti minn null u mhux kull qasam jaċċettah.
F’dan l-eżempju nneħħu d-deskrizzjoni tal-prodott bil-Ġermaniż. L-isem u d-deskrizzjonijiet bil-lingwi l-oħra jibqgħu l-istess.
/api/v1/products/example?locale=deTalba cURL
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}'
Risposta
{
"data": {
"deleted": false,
"id": "example",
"version": 2
},
"meta": {
"request_id": "example"
}
}
Jekk ma tirċevix tweġiba
In-nuqqas ta’ tweġiba ma jfissirx bilfors li l-bidla ma ġietx salvata. Il-konnessjoni setgħet inqatgħet wara li saret il-bidla.
Meta tissejvja d-data, żid il-header Idempotency-Key b’valur uniku. Jekk ma tirċevix tweġiba u terġa’ tipprova l-istess bidla, uża l-istess ċavetta, indirizz, metodu u kontenut tat-talba.
Jekk l-API diġà ssejvja r-riżultat ta’ dik it-talba, jirritornah mingħajr ma jwettaq il-bidla mill-ġdid. Għal bidla differenti uża ċavetta ġdida.
L-użu tal-istess ċavetta għal talba differenti jagħti idempotency.key_reused.
Jekk xi ħadd ibiddel l-istess data
Ġib id-data attwali qabel tibdilha. Jekk l-operazzjoni teħtieġ expected_version, daħħal il-verżjoni li rċevejt f’dak il-qasam.
Jekk xi ħadd ikun biddel id-data sadanittant, l-API jirrifjuta s-salvataġġ. Erġa’ ġibha u ċċekkja jekk il-bidla ppjanata għadhiex xierqa. Imbagħad biss ibgħat talba ġdida bil-verżjoni attwali.
Bidla fil-prezz tista’ teħtieġ ukoll il-verżjoni tal-prezz, tal-varjant jew tal-lista tal-prezzijiet. L-oqsma meħtieġa jinsabu fid-deskrizzjoni tal-operazzjoni.