Vymazať — Kategórie
Odstráňte zadanú položku z „Kategórie“. Požiadavky tejto operácie sú opísané nižšie.
DELETE/api/v1/categories/{category_id}
- Overovanie
Bearer- Dostupné od plánu
- STANDARD
- Požadované oprávnenia
catalog.category:delete
Príklady kódu
Príklad požiadavky
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_category_api_v1_categories__category_id__delete' \
--url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/categories/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_category_api_v1_categories__category_id__delete'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/categories/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_category_api_v1_categories__category_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/categories/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))
Príklad odpovede 200
{
"data": {
"deleted": true,
"id": "example",
"version": null
},
"meta": {
"request_id": "example"
}
}
Ako to funguje
- Kategórie vytvárajte a aktualizujte s platnými identifikátormi nadradených kategórií a vo vybranom jazykovom a trhovom kontexte.
- Pred úpravou alebo zmazaním kategórie načítajte aktuálnu verziu.
- Mazanie musí rešpektovať existujúce vzťahy.
- Zmazanie používanej kategórie môže byť odmietnuté chybou resource.in_use; najskôr vyriešte jej závislosti pomocou podporovaných operácií.
Parametre
Parametre cesty
category_idReťazecPovinnéIdentifikátor kategórie.
Obmedzenia
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Parametre dopytu
expected_versionCelé čísloPovinnéVerzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.
minimum:1maximum:9223372036854775807
Hlavičky požiadavky
Idempotency-KeyReťazecPovinnéJedinečný identifikátor jednej logickej operácie zápisu.
minLength:1maxLength:128Obmedzenia
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Táto operácia neprijíma telo JSON.
Odpovede
Odpoveď 200
Úplný model: ApiResponse_MutationData_
dataMutationDataPovinnéObsah úspešnej odpovede.
Polia ·
datadeletedLogická hodnotaPovinnéČi bolo zmazanie vykonané.
idReťazecPovinnéIdentifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.
versionCelé číslo nullPovinnéVerzia zdroja používaná na riadenie súbežných zmien.
metaContextPageMetaContextMetaPageMetaRequestMetaPovinnéMetaúdaje odpovede.
Polia ·
metalocaleReťazecPovinnéJazyk vybraný pre túto požiadavku.
market_codeReťazecPovinnéKód trhu vrátený koncovým bodom kontextu.
market_idReťazecPovinnéIdentifikátor trhu vrátený koncovým bodom kontextu.
paginationPaginationPovinnéMetaúdaje stránkovania pomocou kurzora.
request_idReťazecPovinnéIdentifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.
minLength:1maxLength:100
localeReťazecPovinnéJazyk vybraný pre túto požiadavku.
market_codeReťazecPovinnéKód trhu vrátený koncovým bodom kontextu.
market_idReťazecPovinnéIdentifikátor trhu vrátený koncovým bodom kontextu.
request_idReťazecPovinnéIdentifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.
minLength:1maxLength:100
paginationPaginationPovinnéMetaúdaje stránkovania pomocou kurzora.
request_idReťazecPovinnéIdentifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.
minLength:1maxLength:100
request_idReťazecPovinnéIdentifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.
minLength:1maxLength:100
Stav HTTP
200- Úspešná odpoveď Schéma
400- Neplatná požiadavka
401- Vyžaduje sa overenie
403- Prístup zamietnutý
404- Zdroj sa nenašiel
409- Konflikt verzií
422- Chyba validácie
429- Prekročený limit požiadaviek
Ďalšie stavy HTTP (7)
405- Metóda nie je povolená
413- Príliš veľká požiadavka
415- Nepodporovaný formát
500- Chyba servera
502- Chyba brány API
503- Služba nedostupná
504- Vypršal časový limit
Katalóg chýb: ErrorResponse
Hlavičky
401
WWW-AuthenticateReťazecVoliteľnéSpôsob overenia požadovaný serverom.
405
AllowReťazecVoliteľnéMetódy HTTP podporované týmto zdrojom.
429, 503
Retry-AfterCelé čísloVoliteľnéMinimálne oneskorenie pred opakovaním v sekundách.
minimum:0