作成 — カテゴリー
以下で説明するデータを使用して、「カテゴリー」で「作成」を実行します。
POST/api/v1/categories
- 認証
Bearer- 利用可能な最低プラン
- STANDARD
- 必要な権限
catalog.category:create
コード例
リクエスト例
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request POST \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--header 'Idempotency-Key: example-create_category_api_v1_categories_post' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Example"
}' \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/categories
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-create_category_api_v1_categories_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/categories');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'POST',
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, '{
"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-create_category_api_v1_categories_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\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(
'POST', base_url + '/api/v1/categories', 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))
レスポンス例 201
{
"data": {
"deleted": false,
"id": "example",
"version": 1
},
"meta": {
"request_id": "example"
}
}
仕組み
- 作成・更新には有効な親カテゴリー識別子と、選択した言語・市場コンテキストを使います。
- 編集や削除の前に現在のバージョンを取得してください。
- 削除時にも既存の関連付けが考慮されます。
- 使用中のカテゴリーは resource.in_use で拒否される場合があります。
- まず対応する操作で依存関係を解消してください。
パラメーター
クエリパラメーター
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文字列必須1つの論理的な書き込み操作の一意な識別子。
minLength:1maxLength:128制約
pattern"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
リクエスト本文
application/json · 必須
CategoryCreate
description文字列 null任意選択した言語での説明。
文字列:maxLength:50000introduction文字列 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文字列必須該当コンテキストでのリソース名。
minLength:1maxLength:200parent_id文字列 null任意親カテゴリー識別子。
文字列:minLength:1maxLength:63slug文字列 null任意選択した言語での URL パス部分。
文字列:maxLength:160
レスポンス
レスポンス 201
完全なモデル: 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 ステータス
201- リソースを作成しました スキーマ
400- 無効なリクエスト
401- 認証が必要です
403- 権限がありません
404- リソースが見つかりません
409- バージョンの競合
422- 検証エラー
429- リクエスト上限を超過
その他の HTTP ステータス (7)
405- 許可されていないメソッド
413- リクエストが大きすぎます
415- 未対応の形式
500- サーバーエラー
502- API ゲートウェイエラー
503- サービスを利用できません
504- タイムアウト
エラー一覧: ErrorResponse
ヘッダー
201
Location文字列任意作成したリソースの相対 URL。
401
WWW-Authenticate文字列任意サーバーが要求する認証方式。
405
Allow文字列任意このリソースが対応する HTTP メソッド。
429, 503
Retry-After整数任意再試行までに最低限待つ秒数。
minimum:0