Gå til innhold
ShopentlyLearn

Vis liste · Produktvarianter — Varianter og valg

Les data fra «Varianter og valg». Resultatet avhenger av parameterne for operasjonen.

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

Autentisering
Bearer
Tilgjengelig fra
STANDARD
Nødvendige tilganger
catalog.product:read

Kodeeksempler

Eksempel på forespørsel

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

Eksempel på svar 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"
  }
}

Prinsipper

  • En variant tilhører et produkt og bruker verdier fra listene over variantvalg.
  • Referansen omfatter opprettelse, lesing, oppdatering og sletting av valg og verdier samt lesing og endring av produktvarianter.
  • Endring av variantpriser bruker eksplisitt pristype, beløp, valuta og nødvendige versjoner.
  • Skill mellom en justering av grunnprisen og en fast markedspris.
  • Les gjeldende produkt- og pristilstand før du sender en avhengig oppdatering.

Parametere

Stiparametere

product_idStrengObligatorisk

Produktidentifikator.

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

Spørringsparametere

limitHeltallValgfritt

Maksimalt antall oppføringer på denne siden.

minimum: 1maximum: 100
Standard: 50Eksempel: 20
cursorStreng nullValgfritt

Ugjennomsiktig fortsettelsesverdi returnert av forrige side.

Streng:minLength: 1maxLength: 1024
localeStreng nullValgfritt

Språk valgt for denne forespørselen.

Streng:minLength: 2maxLength: 20
market_idStreng nullValgfritt

Markedsidentifikator returnert av kontekstendepunktet.

Begrensninger · Streng 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeStreng nullValgfritt

Markedskode returnert av kontekstendepunktet.

Streng:minLength: 1maxLength: 16
activeBoolsk verdi nullValgfritt

Om ressursen er aktiv.

skuStreng nullValgfritt

SKU-varekode.

Streng:minLength: 1maxLength: 100
Begrensninger · Streng 1
pattern
"^\\S+$"

Denne operasjonen godtar ikke JSON-innhold.

Svar

Svar 200

dataArray <ProductVariantData > Obligatorisk

Innholdet i et vellykket svar.

Felter · data

ProductVariantData

activeBoolsk verdiObligatorisk

Om ressursen er aktiv.

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres.

is_defaultBoolsk verdiObligatorisk

Om dette er standardvalget.

media_idsArray <Streng> Obligatorisk

Identifikatorer for medier som allerede finnes.

positionHeltallObligatorisk

Plassering i den sorterte samlingen.

pricingVariantPricingData Obligatorisk

Priskonfigurasjon og versjonene for samtidighetskontroll.

primary_media_idStreng nullObligatorisk

Identifikator for primærmediet.

product_idStrengObligatorisk

Produktidentifikator.

skuStrengObligatorisk

SKU-varekode.

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"
valuesArray <VariantChoiceData > Obligatorisk

Oppslagsverdier.

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorisk

Svarmetadata.

Felter · meta

ContextPageMeta

localeStrengObligatorisk

Språk valgt for denne forespørselen.

market_codeStrengObligatorisk

Markedskode returnert av kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

paginationPagination Obligatorisk

Metadata for markørbasert sideinndeling.

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100

ContextMeta

localeStrengObligatorisk

Språk valgt for denne forespørselen.

market_codeStrengObligatorisk

Markedskode returnert av kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatorisk

Metadata for markørbasert sideinndeling.

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100

RequestMeta

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

200
Vellykket svar Skjema
400
Ugyldig forespørsel
401
Autentisering kreves
403
Tilgang nektet
404
Ressursen ble ikke funnet
409
Versjonskonflikt
422
Validering mislyktes
429
Forespørselsgrensen er overskredet
Andre HTTP-statuser (7)
405
Metoden er ikke tillatt
413
Forespørselen er for stor
415
Formatet støttes ikke
500
Serverfeil
502
Feil i API-gateway
503
Tjenesten er utilgjengelig
504
Tidsavbrudd

Feilkatalog: ErrorResponse

Headere

401

WWW-AuthenticateStrengValgfritt

Autentiseringsmetode serveren krever.

405

AllowStrengValgfritt

HTTP-metoder denne ressursen støtter.

429, 503

Retry-AfterHeltallValgfritt

Minste ventetid før neste forsøk, i sekunder.

minimum: 0