コンテンツにスキップ
ShopentlyLearn

一覧取得 · 商品バリエーション — バリエーションとオプション

「バリエーションとオプション」のデータを取得します。結果はこの操作のパラメーターによって決まります。

GET/api/v1/products/{product_id}/variants

認証
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/variants?limit=20'

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/variants?limit=20');
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/variants?limit=20', 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

JSON
{
  "data": [
    {
      "active": true,
      "created_at": "2026-01-01T12:00:00Z",
      "id": "example",
      "is_default": true,
      "media_ids": [
        "example"
      ],
      "position": 1,
      "pricing": {
        "base_adjustment": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "market_price": null,
        "price": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2,
          "tax_included": true
        },
        "product_version": 1,
        "version": 1
      },
      "primary_media_id": "example",
      "product_id": "example",
      "sku": "example",
      "updated_at": "2026-01-01T12:00:00Z",
      "values": [
        {
          "option_id": "example",
          "option_name": "example",
          "value": "example",
          "value_id": "example"
        }
      ],
      "version": 1
    }
  ],
  "meta": {
    "locale": "en",
    "market_code": "PL",
    "market_id": "example",
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "request_id": "example"
  }
}

仕組み

  • バリエーションは商品に属し、バリエーションオプション辞書の値を使います。
  • リファレンスにはオプションと値の CRUD、および商品バリエーションの読み取り・書き込みを含みます。
  • バリエーションの価格変更には、明示的な価格種別、金額、通貨、必要なバージョンを指定します。
  • 基準価格の調整と固定の市場価格を区別してください。
  • 依存関係のある更新を送る前に、商品と価格の現在の状態を取得します。

パラメーター

パスパラメーター

product_id文字列必須

商品識別子。

制約
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
例: "example"

クエリパラメーター

limit整数任意

このページの最大レコード数。

minimum: 1maximum: 100
既定値: 50例: 20
cursor文字列 null任意

前のページが返した、内部を解釈しない継続値。

文字列:minLength: 1maxLength: 1024
locale文字列 null任意

このリクエストで選択した言語。

文字列:minLength: 2maxLength: 20
market_id文字列 null任意

コンテキストエンドポイントが返した市場識別子。

制約 · 文字列 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_code文字列 null任意

コンテキストエンドポイントが返した市場コード。

文字列:minLength: 1maxLength: 16
active真偽値 null任意

リソースが有効かどうか。

sku文字列 null任意

在庫管理単位のコード。

文字列:minLength: 1maxLength: 100
制約 · 文字列 1
pattern
"^\\S+$"

この操作は JSON 本文を受け付けません。

レスポンス

レスポンス 200

data配列 <ProductVariantData > 必須

成功レスポンスのデータ。

フィールド · data

ProductVariantData

active真偽値必須

リソースが有効かどうか。

created_at文字列必須

作成時刻。

format: "date-time"
id文字列必須

リソース識別子。返された値をそのまま保持してください。

is_default真偽値必須

既定の選択肢かどうか。

media_ids配列 <文字列> 必須

既存のメディアアセット識別子。

position整数必須

順序付きコレクション内の位置。

pricingVariantPricingData 必須

価格設定と同時更新制御用のバージョン。

primary_media_id文字列 null必須

主要メディアアセット識別子。

product_id文字列必須

商品識別子。

sku文字列必須

在庫管理単位のコード。

updated_at文字列必須

最終更新時刻。

format: "date-time"
values配列 <VariantChoiceData > 必須

辞書の値。

version整数必須

同時更新制御に使うリソースバージョン。

metaContextPageMeta ContextMeta PageMeta RequestMeta 必須

レスポンスのメタデータ。

フィールド · meta

ContextPageMeta

locale文字列必須

このリクエストで選択した言語。

market_code文字列必須

コンテキストエンドポイントが返した市場コード。

market_id文字列必須

コンテキストエンドポイントが返した市場識別子。

paginationPagination 必須

カーソルによるページ分割のメタデータ。

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

ContextMeta

locale文字列必須

このリクエストで選択した言語。

market_code文字列必須

コンテキストエンドポイントが返した市場コード。

market_id文字列必須

コンテキストエンドポイントが返した市場識別子。

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

PageMeta

paginationPagination 必須

カーソルによるページ分割のメタデータ。

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

RequestMeta

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