Törlés · Opcióértékek — Variánsok és opciók
Törölje a(z) „Variánsok és opciók” megadott elemét. A művelet követelményei alább találhatók.
DELETE/api/v1/variant-options/{identity}/values/{value_id}
- Hitelesítés
Bearer- Elérhető ettől a csomagtól
- STANDARD
- Szükséges jogosultságok
catalog.variant_option:delete
Kódpéldák
Példakérés
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request DELETE \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: example-delete_variant_value_api_v1_variant_options__identity__values__value_id__delete' \
--url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/variant-options/example/values/example?expected_version=1'
PHP
<?php
declare(strict_types=1);
$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
isset($origin['query']) || isset($origin['fragment'])) {
throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
throw new RuntimeException('Invalid credential');
}
$headers = ['Idempotency-Key: example-delete_variant_value_api_v1_variant_options__identity__values__value_id__delete'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/variant-options/example/values/example?expected_version=1');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
throw new RuntimeException('HTTP ' . $status . '; request_id=' .
($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;
Python
from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit
import requests # python -m pip install requests
base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
raise ValueError("Invalid credential")
headers = {'Idempotency-Key': 'example-delete_variant_value_api_v1_variant_options__identity__values__value_id__delete'}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
headers["Content-Type"] = "application/json"
with ExitStack() as stack:
session = stack.enter_context(requests.Session())
files = None
if False:
image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
if os.fstat(image.fileno()).st_size > 5242880:
raise ValueError("Image exceeds 5 MiB")
files = {"file": ("article.png", image, "image/png")}
response = session.request(
'DELETE', base_url + '/api/v1/variant-options/example/values/example?expected_version=1', headers=headers,
data=body.encode("utf-8") if body is not None else None, files=files,
timeout=(5, 30), allow_redirects=False,
)
if not 200 <= response.status_code < 300:
raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
if False:
if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
raise ValueError("Unexpected image response")
with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
output.write(response.content)
else:
result = response.json() if response.content else None
print(json.dumps(result, ensure_ascii=False, indent=2))
Példaválasz 200
{
"data": {
"deleted": true,
"id": "example",
"version": null
},
"meta": {
"request_id": "example"
}
}
Működés
- A variáns egy termékhez tartozik, és a variánsopciók szótárainak értékeit használja.
- A leírás tartalmazza az opciók és értékeik létrehozását, olvasását, módosítását és törlését, valamint a termékvariánsok olvasási és írási műveleteit.
- A variánsár módosításához kifejezett árazási típus, összeg, pénznem és a szükséges verziók tartoznak.
- Különböztesse meg az alapárhoz viszonyított módosítást a rögzített piaci ártól.
- Függő módosítás előtt olvassa ki a termék és az ár aktuális állapotát.
Paraméterek
Útvonalparaméterek
identityKarakterláncKötelezőAz erőforrás útvonalában használt azonosító.
Korlátozások
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
value_idKarakterláncKötelezőSzótárérték-azonosító.
Korlátozások
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Lekérdezési paraméterek
expected_versionEgész számKötelezőAz írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.
minimum:1maximum:9223372036854775807
Kérésfejlécek
Idempotency-KeyKarakterláncKötelezőEgy logikai írási művelet egyedi azonosítója.
minLength:1maxLength:128Korlátozások
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Ez a művelet nem fogad JSON-törzset.
Válaszok
Válasz 200
Teljes modell: ApiResponse_MutationData_
dataMutationDataKötelezőA sikeres válasz adatai.
Mezők ·
datadeletedLogikai értékKötelezőJelzi, hogy a törlés megtörtént-e.
idKarakterláncKötelezőErőforrás-azonosító; a visszaadott alakban őrizze meg.
versionEgész szám nullKötelezőAz erőforrás verziója az egyidejű módosítások ellenőrzéséhez.
metaContextPageMetaContextMetaPageMetaRequestMetaKötelezőA válasz metaadatai.
Mezők ·
metaTeljes modell:
ContextPageMetalocaleKarakterláncKötelezőA kéréshez kiválasztott nyelv.
market_codeKarakterláncKötelezőA környezetvégpont által visszaadott piackód.
market_idKarakterláncKötelezőA környezetvégpont által visszaadott piacazonosító.
paginationPaginationKötelezőA kurzoros lapozás metaadatai.
request_idKarakterláncKötelezőKérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.
minLength:1maxLength:100
localeKarakterláncKötelezőA kéréshez kiválasztott nyelv.
market_codeKarakterláncKötelezőA környezetvégpont által visszaadott piackód.
market_idKarakterláncKötelezőA környezetvégpont által visszaadott piacazonosító.
request_idKarakterláncKötelezőKérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.
minLength:1maxLength:100
paginationPaginationKötelezőA kurzoros lapozás metaadatai.
request_idKarakterláncKötelezőKérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.
minLength:1maxLength:100
request_idKarakterláncKötelezőKérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.
minLength:1maxLength:100
HTTP-állapot
200- Sikeres válasz Séma
400- Érvénytelen kérés
401- Hitelesítés szükséges
403- Hozzáférés megtagadva
404- Az erőforrás nem található
409- Verzióütközés
422- Sikertelen ellenőrzés
429- Kérésszámkorlát túllépve
További HTTP-állapotok (7)
405- Nem engedélyezett metódus
413- Túl nagy kérés
415- Nem támogatott formátum
500- Szerverhiba
502- API-átjáróhiba
503- A szolgáltatás nem érhető el
504- Időtúllépés
Hibakatalógus: ErrorResponse
Fejlécek
401
WWW-AuthenticateKarakterláncNem kötelezőA szerver által megkövetelt hitelesítési séma.
405
AllowKarakterláncNem kötelezőAz erőforrás által támogatott HTTP-metódusok.
429, 503
Retry-AfterEgész számNem kötelezőAz újrapróbálás előtti minimális várakozás másodpercben.
minimum:0