Перейти до вмісту
ShopentlyLearn

Отримати · Варіанти товару — Варіанти й опції

Отримайте дані з «Варіанти й опції». Результат залежить від параметрів цієї операції.

GET/api/v1/products/{product_id}/variants/{variant_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/variants/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/variants/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/variants/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

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",
    "request_id": "example"
  }
}

Як це працює

  • Варіант належить товару й використовує значення з довідників опцій варіантів.
  • Довідник API містить операції CRUD для опцій і значень, а також читання й запис варіантів товару.
  • Для зміни ціни варіанта явно задавайте тип ціноутворення, суму, валюту та потрібні версії.
  • Відрізняйте коригування базової ціни від фіксованої ціни для ринку.
  • Перед залежним оновленням прочитайте поточний стан товару й ціни.

Параметри

Параметри шляху

product_idРядокОбов’язкове

Ідентифікатор товару.

Обмеження
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Приклад: "example"
variant_idРядокОбов’язкове

Ідентифікатор варіанта товару.

Обмеження
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Приклад: "example"

Параметри запиту

localeРядок nullНеобов’язкове

Мова, вибрана для цього запиту.

Рядок:minLength: 2maxLength: 20
market_idРядок nullНеобов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

Обмеження · Рядок 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeРядок nullНеобов’язкове

Код ринку, повернутий кінцевою точкою контексту.

Рядок:minLength: 1maxLength: 16

Ця операція не приймає тіло JSON.

Відповіді

Відповідь 200

dataProductVariantData Обов’язкове

Дані успішної відповіді.

Поля · data
activeЛогічне значенняОбов’язкове

Чи є ресурс активним.

created_atРядокОбов’язкове

Час створення.

format: "date-time"
idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

is_defaultЛогічне значенняОбов’язкове

Чи є цей вибір типовим.

media_idsМасив <Рядок> Обов’язкове

Ідентифікатори вже наявних медіафайлів.

positionЦіле числоОбов’язкове

Позиція у впорядкованому списку.

pricingVariantPricingData Обов’язкове

Налаштування ціни та версії для контролю одночасних змін.

Поля · pricing
base_adjustmentMoneyData Обов’язкове

Коригування ціни відносно базової ціни.

market_priceMoneyData nullОбов’язкове

Ціна для вибраного ринку.

pricePriceData nullОбов’язкове

Відомості про ціну у вибраному контексті.

product_versionЦіле числоОбов’язкове

Поточна версія товару для контролю одночасних змін.

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

primary_media_idРядок nullОбов’язкове

Ідентифікатор основного медіафайлу.

product_idРядокОбов’язкове

Ідентифікатор товару.

skuРядокОбов’язкове

Код складської облікової одиниці.

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"
valuesМасив <VariantChoiceData > Обов’язкове

Значення довідника.

Поля · values
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