更新 — 品牌
修改「品牌」中的指定資料。必填欄位和寫入規則如下所述。
PATCH/api/v1/brands/{identity}
- 身份驗證
Bearer- 最低方案
- STANDARD
- 所需權限
catalog.brand: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_brand_api_v1_brands__identity__patch' \
--header 'Content-Type: application/json' \
--data-raw '{
"expected_version": 1,
"name": "Example"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/brands/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_brand_api_v1_brands__identity__patch', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/brands/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_brand_api_v1_brands__identity__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/brands/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"
}
}
工作原理
- 使用所需目錄權限建立、更新和刪除品牌。
- 建立或編輯產品時,請使用此商店回傳的品牌識別碼。
- 翻譯欄位遵循所選語言上下文。
- 刪除已被引用的品牌可能要求先處理現有關係;不要假設刪除會自動重寫產品。
參數
路徑參數
identity字串必填資源路徑中使用的識別碼。
約束
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
請求標頭
Idempotency-Key字串必填單個邏輯寫入操作的唯一識別碼。
minLength:1maxLength:128約束
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
請求本文
application/json · 必填
BrandUpdate
expected_version整數必填寫入前讀取的版本;不匹配時拒絕更新。
minimum:1maximum:9223372036854775807name字串必填對應上下文中的資源名稱。
minLength:1maxLength: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
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