取得 — 商品
「商品」のデータを取得します。結果はこの操作のパラメーターによって決まります。
GET/api/v1/products/{product_id}
- 認証
Bearer- 利用可能な最低プラン
- STANDARD
- 必要な権限
catalog.product:read
コード例
リクエスト例
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request GET \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/products/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 = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/products/example');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'GET',
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 = {}
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(
'GET', base_url + '/api/v1/products/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": {
"availability": {
"available_from": null,
"available_until": null,
"is_available": true
},
"brand_id": null,
"condition": "new",
"created_at": "2026-01-01T12:00:00Z",
"description": "example",
"features": [
{
"feature_id": "example",
"feature_name": "example",
"value": "example",
"value_id": "example"
}
],
"id": "example",
"identifiers": {},
"media": [
{
"alt_text": "example",
"id": "example",
"is_primary": true,
"kind": "image",
"mime_type": "image/jpeg",
"position": 1,
"url": "https://example.invalid/product.jpg"
}
],
"meta_description": "example",
"meta_keywords": [
"example"
],
"meta_title": "example",
"name": "Example",
"number": "example",
"price": {
"amount": "0.00",
"currency": "PLN",
"minor_units": 2,
"tax_included": true
},
"price_version": 1,
"primary_category_id": "example",
"primary_media_id": "example",
"published": false,
"sku": "example",
"slug": "example",
"tax_category_id": "example",
"updated_at": "2026-01-01T12:00:00Z",
"variants_enabled": false,
"version": 1
},
"meta": {
"locale": "en",
"market_code": "PL",
"market_id": "example",
"request_id": "example"
}
}
仕組み
- プラン制限でブロックされた商品を除き、下書きを含む未削除の商品を取得できます。
- ブロックされた商品は一覧から除外され、直接アクセスすると entitlements.resource_blocked が返ります。
- そのため API での可視性はストアでの公開状態とは異なります。
- ブランド、カテゴリー、属性、メディアには既存の識別子を使います。
- 価格には通貨、価格表、税モード、同時更新制御用のバージョンを明示します。
- 商品価格とバリエーション価格は別です。
- 対応する価格構造と正確な10進数文字列を使用してください。
パラメーター
パスパラメーター
product_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
この操作は JSON 本文を受け付けません。
レスポンス
レスポンス 200
完全なモデル: ApiResponse_ProductDetailData_
dataProductDetailData必須成功レスポンスのデータ。
フィールド ·
dataavailabilityAvailabilityData必須選択したコンテキストでの利用可能性。
フィールド ·
availabilityavailable_from文字列 null必須利用可能期間の開始。
文字列:format:"date-time"available_until文字列 null必須利用可能期間の終了。
文字列:format:"date-time"is_available真偽値必須このコンテキストで対象を利用できるかどうか。
brand_id文字列 null必須ブランド識別子。
condition文字列必須商品の状態。
制約
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_at文字列必須作成時刻。
format:"date-time"description文字列 null必須選択した言語での説明。
features配列 <FeatureSelectionData> 必須商品の属性。
フィールド ·
featuresid文字列必須リソース識別子。返された値をそのまま保持してください。
identifiersオブジェクト追加フィールド: 文字列必須商品識別コード。
media配列 <ProductMediaData> 必須添付メディア情報。
フィールド ·
mediameta_description文字列 null必須選択した言語での検索エンジン向け説明。
meta_keywords配列 <文字列> null必須選択した言語での検索エンジン向けキーワード。
meta_title文字列 null必須選択した言語での検索エンジン向けタイトル。
name文字列 null必須該当コンテキストでのリソース名。
number文字列必須人向けの注文番号または申請番号。
pricePriceDatanull必須選択したコンテキストでの価格情報。
フィールド ·
priceprice_version整数必須同時更新制御に使う現在の価格バージョン。
primary_category_id文字列 null必須主要カテゴリー識別子。
primary_media_id文字列 null必須主要メディアアセット識別子。
published真偽値必須リソースが公開済みかどうか。
sku文字列必須在庫管理単位のコード。
slug文字列 null必須選択した言語での URL パス部分。
tax_category_id文字列必須税カテゴリー識別子。
updated_at文字列必須最終更新時刻。
format:"date-time"variants_enabled真偽値必須商品がバリエーションを使うかどうか。
version整数必須同時更新制御に使うリソースバージョン。
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