Оновити — Категорії
Змініть зазначені дані в «Категорії». Обов’язкові поля та правила запису описано нижче.
PATCH/api/v1/categories/{category_id}
- Автентифікація
Bearer- Доступно починаючи з
- STANDARD
- Потрібні дозволи
catalog.category:update
Приклади коду
Приклад запиту
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request PATCH \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: example-update_category_api_v1_categories__category_id__patch' \
--header 'Content-Type: application/json' \
--data-raw '{
"expected_version": 1,
"name": "Example"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/categories/example
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-update_category_api_v1_categories__category_id__patch', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/categories/example');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
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);
},
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
"expected_version": 1,
"name": "Example"
}');
$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-update_category_api_v1_categories__category_id__patch'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n "expected_version": 1,\n "name": "Example"\n}'
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(
'PATCH', base_url + '/api/v1/categories/example', 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))
Приклад відповіді 200
{
"data": {
"deleted": false,
"id": "example",
"version": 1
},
"meta": {
"request_id": "example"
}
}
Як це працює
- Створюйте й оновлюйте категорії з правильними ідентифікаторами батьківських категорій та вибраним контекстом мови й ринку.
- Перед редагуванням або видаленням категорії прочитайте її поточну версію.
- Видалення має враховувати наявні зв’язки.
- Видалення категорії, яка ще використовується, може бути відхилене з resource.in_use; спочатку усуньте залежності через підтримувані операції.
Параметри
Параметри шляху
category_idРядокОбов’язковеІдентифікатор категорії.
Обмеження
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Параметри запиту
localeРядок nullНеобов’язковеМова, вибрана для цього запиту.
Рядок:minLength:2maxLength:20market_idРядок nullНеобов’язковеІдентифікатор ринку, повернутий кінцевою точкою контексту.
Обмеження · Рядок 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeРядок nullНеобов’язковеКод ринку, повернутий кінцевою точкою контексту.
Рядок:minLength:1maxLength:16
Заголовки запиту
Idempotency-KeyРядокОбов’язковеУнікальний ідентифікатор однієї логічної операції запису.
minLength:1maxLength:128Обмеження
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Тіло запиту
application/json · Обов’язкове
CategoryUpdate
descriptionРядок nullНеобов’язковеОпис вибраною мовою.
Рядок:maxLength:50000expected_versionЦіле числоОбов’язковеВерсія, прочитана перед записом; невідповідність блокує оновлення.
minimum:1maximum:9223372036854775807introductionРядок nullНеобов’язковеВступний текст вибраною мовою.
Рядок:maxLength:5000is_visibleЛогічне значенняНеобов’язковеЧи є ресурс видимим.
market_idsМасив <Рядок> Необов’язковеІдентифікатори вибраних ринків.
maxItems:1000Масив:minLength:1maxLength:63meta_descriptionРядок nullНеобов’язковеОпис для пошукових систем вибраною мовою.
Рядок:maxLength:160meta_keywordsМасив <Рядок> nullНеобов’язковеКлючові слова для пошукових систем вибраною мовою.
Масив:maxItems:20Масив / Масив:maxLength:50meta_titleРядок nullНеобов’язковеЗаголовок для пошукових систем вибраною мовою.
Рядок:maxLength:70nameРядок nullНеобов’язковеНазва ресурсу у відповідному контексті.
Рядок:maxLength:200parent_idРядок nullНеобов’язковеІдентифікатор батьківської категорії.
Рядок:minLength:1maxLength:63slugРядок nullНеобов’язковеСегмент шляху URL вибраною мовою.
Рядок:maxLength:160
Відповіді
Відповідь 200
Повна модель: ApiResponse_MutationData_
dataMutationDataОбов’язковеДані успішної відповіді.
Поля ·
datadeletedЛогічне значенняОбов’язковеЧи виконано видалення.
idРядокОбов’язковеІдентифікатор ресурсу; зберігайте його в отриманому вигляді.
versionЦіле число nullОбов’язковеВерсія ресурсу для контролю одночасних змін.
metaContextPageMetaContextMetaPageMetaRequestMetaОбов’язковеМетадані відповіді.
Поля ·
metalocaleРядокОбов’язковеМова, вибрана для цього запиту.
market_codeРядокОбов’язковеКод ринку, повернутий кінцевою точкою контексту.
market_idРядокОбов’язковеІдентифікатор ринку, повернутий кінцевою точкою контексту.
paginationPaginationОбов’язковеМетадані пагінації за курсором.
request_idРядокОбов’язковеІдентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.
minLength:1maxLength:100
localeРядокОбов’язковеМова, вибрана для цього запиту.
market_codeРядокОбов’язковеКод ринку, повернутий кінцевою точкою контексту.
market_idРядокОбов’язковеІдентифікатор ринку, повернутий кінцевою точкою контексту.
request_idРядокОбов’язковеІдентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.
minLength:1maxLength:100
paginationPaginationОбов’язковеМетадані пагінації за курсором.
request_idРядокОбов’язковеІдентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.
minLength:1maxLength:100
request_idРядокОбов’язковеІдентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.
minLength:1maxLength:100
Статус HTTP
200- Успішна відповідь Схема
400- Некоректний запит
401- Потрібна автентифікація
403- Доступ заборонено
404- Ресурс не знайдено
409- Конфлікт версій
422- Помилка валідації
429- Перевищено ліміт запитів
Інші статуси HTTP (7)
405- Метод не дозволено
413- Завеликий запит
415- Непідтримуваний формат
500- Помилка сервера
502- Помилка шлюзу API
503- Сервіс недоступний
504- Перевищено час очікування
Каталог помилок: ErrorResponse
Заголовки
401
WWW-AuthenticateРядокНеобов’язковеСхема автентифікації, потрібна серверу.
405
AllowРядокНеобов’язковеМетоди HTTP, підтримувані цим ресурсом.
429, 503
Retry-AfterЦіле числоНеобов’язковеМінімальна затримка перед повтором у секундах.
minimum:0