Přejít na obsah
ShopentlyLearn

Načíst — Produkty

Načtěte data z „Produkty“. Výsledek závisí na parametrech této operace.

GET/api/v1/products/{product_id}

Ověřování
Bearer
Dostupné od tarifu
STANDARD
Požadovaná oprávnění
catalog.product:read

Příklady kódu

Příklad požadavku

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

Příklad odpovědi 200

JSON
{
  "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"
  }
}

Jak to funguje

  • Integrace může číst nesmazané produkty včetně konceptů, kromě produktů blokovaných limitem tarifu.
  • Blokované produkty nejsou v seznamech; přímý přístup vrací entitlements.resource_blocked.
  • Viditelnost produktu v API se proto liší od jeho zveřejnění v obchodě.
  • Používejte existující identifikátory značek, kategorií, vlastností a médií.
  • Ceny obsahují výslovně určenou měnu, ceník, daňový režim a verze pro řízení souběžných změn.
  • Ceny produktů a variant se rozlišují; používejte podporovanou strukturu cen a přesné desetinné řetězce.

Parametry

Parametry cesty

product_idŘetězecPovinné

Identifikátor produktu.

Omezení
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Příklad: "example"

Parametry dotazu

localeŘetězec nullVolitelné

Jazyk vybraný pro tento požadavek.

Řetězec:minLength: 2maxLength: 20
market_idŘetězec nullVolitelné

Identifikátor trhu vrácený koncovým bodem kontextu.

Omezení · Řetězec 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeŘetězec nullVolitelné

Kód trhu vrácený koncovým bodem kontextu.

Řetězec:minLength: 1maxLength: 16

Tato operace nepřijímá tělo JSON.

Odpovědi

Odpověď 200

dataProductDetailData Povinné

Obsah úspěšné odpovědi.

Pole · data
availabilityAvailabilityData Povinné

Informace o dostupnosti ve vybraném kontextu.

Pole · availability
available_fromŘetězec nullPovinné

Začátek dostupnosti.

Řetězec:format: "date-time"
available_untilŘetězec nullPovinné

Konec dostupnosti.

Řetězec:format: "date-time"
is_availableLogická hodnotaPovinné

Zda je položka v tomto kontextu dostupná.

brand_idŘetězec nullPovinné

Identifikátor značky.

conditionŘetězecPovinné

Stav produktu.

Omezení
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
descriptionŘetězec nullPovinné

Popis ve vybraném jazyce.

featuresPole <FeatureSelectionData > Povinné

Vlastnosti produktu.

Pole · features
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

identifiersObjektDalší pole: ŘetězecPovinné

Identifikační kódy produktu.

mediaPole <ProductMediaData > Povinné

Informace o připojených médiích.

Pole · media
meta_descriptionŘetězec nullPovinné

Popis pro vyhledávače ve vybraném jazyce.

meta_keywordsPole <Řetězec> nullPovinné

Klíčová slova pro vyhledávače ve vybraném jazyce.

meta_titleŘetězec nullPovinné

Titulek pro vyhledávače ve vybraném jazyce.

nameŘetězec nullPovinné

Název zdroje v příslušném kontextu.

numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

pricePriceData nullPovinné

Informace o ceně ve vybraném kontextu.

Pole · price
price_versionCelé čísloPovinné

Aktuální verze ceny pro řízení souběžných změn.

primary_category_idŘetězec nullPovinné

Identifikátor hlavní kategorie.

primary_media_idŘetězec nullPovinné

Identifikátor hlavního mediálního souboru.

publishedLogická hodnotaPovinné

Zda je zdroj zveřejněn.

skuŘetězecPovinné

Skladový kód položky.

slugŘetězec nullPovinné

Úsek cesty URL ve vybraném jazyce.

tax_category_idŘetězecPovinné

Identifikátor daňové kategorie.

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"
variants_enabledLogická hodnotaPovinné

Zda produkt používá varianty.

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metadata odpovědi.

Pole · meta

ContextPageMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

ContextMeta

localeŘetězecPovinné

Jazyk vybraný pro tento požadavek.

market_codeŘetězecPovinné

Kód trhu vrácený koncovým bodem kontextu.

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100
Příklad odpovědi

Stav HTTP

200
Úspěšná odpověď Schéma
400
Neplatný požadavek
401
Vyžadováno ověření
403
Přístup odepřen
404
Zdroj nenalezen
409
Konflikt verzí
422
Chyba validace
429
Překročen limit požadavků
Další stavy HTTP (7)
405
Metoda není povolena
413
Příliš velký požadavek
415
Nepodporovaný formát
500
Chyba serveru
502
Chyba brány API
503
Služba nedostupná
504
Vypršel časový limit

Katalog chyb: ErrorResponse

Hlavičky

401

WWW-AuthenticateŘetězecVolitelné

Způsob ověření požadovaný serverem.

405

AllowŘetězecVolitelné

Metody HTTP podporované tímto zdrojem.

429, 503

Retry-AfterCelé čísloVolitelné

Minimální prodleva před opakováním v sekundách.

minimum: 0