Preskoči na vsebino
ShopentlyLearn

Pridobi · Različice izdelka — Različice izdelkov in možnosti

Preberite podatke iz »Različice izdelkov in možnosti«. Rezultat je odvisen od parametrov tega dejanja.

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

Preverjanje pristnosti
Bearer
Na voljo od paketa
STANDARD
Zahtevana dovoljenja
catalog.product:read

Primeri kode

Primer zahteve

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))

Primer odgovora 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"
  }
}

Kako deluje

  • Različica pripada izdelku in uporablja vrednosti iz slovarjev možnosti različic.
  • Dokumentacija zajema ustvarjanje, branje, posodabljanje in brisanje možnosti in vrednosti ter branje in spreminjanje različic izdelkov.
  • Spremembe cen različic uporabljajo izrecno vrsto cene, znesek, valuto in zahtevane različice zapisov.
  • Ločite prilagoditev osnovne cene od fiksne cene za trg.
  • Pred povezano posodobitvijo preberite trenutno stanje izdelka in cen.

Parametri

Parametri poti

product_idNizObvezno

Identifikator izdelka.

Omejitve
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primer: "example"
variant_idNizObvezno

Identifikator različice izdelka.

Omejitve
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primer: "example"

Parametri poizvedbe

localeNiz nullIzbirno

Jezik, izbran za to zahtevo.

Niz:minLength: 2maxLength: 20
market_idNiz nullIzbirno

Identifikator trga, vrnjen s končno točko konteksta.

Omejitve · Niz 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeNiz nullIzbirno

Koda trga, vrnjena s končno točko konteksta.

Niz:minLength: 1maxLength: 16

Ta operacija ne sprejema telesa JSON.

Odgovori

Odgovor 200

dataProductVariantData Obvezno

Vsebina uspešnega odgovora.

Polja · data
activeLogična vrednostObvezno

Ali je vir aktiven.

created_atNizObvezno

Čas nastanka.

format: "date-time"
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki.

is_defaultLogična vrednostObvezno

Ali je to privzeta izbira.

media_idsPolje elementov <Niz> Obvezno

Identifikatorji že obstoječih medijskih datotek.

positionCelo številoObvezno

Položaj v urejeni zbirki.

pricingVariantPricingData Obvezno

Nastavitve cen in njihove različice za nadzor sočasnosti.

Polja · pricing
base_adjustmentMoneyData Obvezno

Prilagoditev glede na osnovno ceno.

market_priceMoneyData nullObvezno

Cena za izbrani trg.

pricePriceData nullObvezno

Podatki o ceni v izbranem kontekstu.

product_versionCelo številoObvezno

Trenutna različica izdelka za nadzor sočasnosti.

versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

primary_media_idNiz nullObvezno

Identifikator primarne medijske datoteke.

product_idNizObvezno

Identifikator izdelka.

skuNizObvezno

Koda enote za vodenje zaloge.

updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
valuesPolje elementov <VariantChoiceData > Obvezno

Vrednosti slovarja.

Polja · values
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno

Metapodatki odgovora.

Polja · meta

ContextPageMeta

localeNizObvezno

Jezik, izbran za to zahtevo.

market_codeNizObvezno

Koda trga, vrnjena s končno točko konteksta.

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

ContextMeta

localeNizObvezno

Jezik, izbran za to zahtevo.

market_codeNizObvezno

Koda trga, vrnjena s končno točko konteksta.

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100
Primer odgovora

Status HTTP

200
Uspešen odgovor Shema
400
Neveljavna zahteva
401
Potrebna je avtentikacija
403
Dostop zavrnjen
404
Vir ni najden
409
Spor različic
422
Preverjanje ni uspelo
429
Presežena omejitev zahtev
Druga stanja HTTP (7)
405
Metoda ni dovoljena
413
Zahteva je prevelika
415
Nepodprta oblika
500
Napaka strežnika
502
Napaka prehoda API
503
Storitev ni na voljo
504
Časovna omejitev je potekla

Katalog napak: ErrorResponse

Glave

401

WWW-AuthenticateNizIzbirno

Shema preverjanja pristnosti, ki jo zahteva strežnik.

405

AllowNizIzbirno

Metode HTTP, ki jih podpira ta vir.

429, 503

Retry-AfterCelo številoIzbirno

Najkrajši zamik pred ponovitvijo v sekundah.

minimum: 0