Zum Inhalt springen
ShopentlyLearn

Abrufen — Produkte

Lesen Sie Daten aus „Produkte“. Das Ergebnis hängt von den Parametern dieser Operation ab.

GET/api/v1/products/{product_id}

Authentifizierung
Bearer
Verfügbar ab
STANDARD
Erforderliche Berechtigungen
catalog.product:read

Codebeispiele

Beispielanfrage

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

Beispielantwort 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"
  }
}

Funktionsweise

  • Die Integration kann nicht gelöschte Produkte einschließlich Entwürfen lesen, außer durch ein Tariflimit gesperrten Produkten.
  • Gesperrte Produkte fehlen in Listen; direkter Zugriff liefert entitlements.resource_blocked.
  • API-Sichtbarkeit unterscheidet sich daher von der Veröffentlichung im Shop.
  • Verwenden Sie vorhandene Kennungen für Marken, Kategorien, Merkmale und Medien.
  • Preise enthalten eine ausdrückliche Währung, Preisliste, Steuerbehandlung und Versionsprüfungen.
  • Produkt- und Variantenpreise sind getrennt; verwenden Sie die unterstützte Preisstruktur und exakte Dezimalzeichenfolgen.

Parameter

Pfadparameter

product_idZeichenfolgeErforderlich

Produktkennung.

Einschränkungen
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Beispiel: "example"

Abfrageparameter

localeZeichenfolge nullOptional

Für diese Anfrage ausgewählte Sprache.

Zeichenfolge:minLength: 2maxLength: 20
market_idZeichenfolge nullOptional

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

Einschränkungen · Zeichenfolge 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeZeichenfolge nullOptional

Vom Kontext-Endpunkt zurückgegebener Marktcode.

Zeichenfolge:minLength: 1maxLength: 16

Diese Operation akzeptiert keinen JSON-Inhalt.

Antworten

Antwort 200

dataProductDetailData Erforderlich

Nutzdaten einer erfolgreichen Antwort.

Felder · data
availabilityAvailabilityData Erforderlich

Verfügbarkeitsinformationen im ausgewählten Kontext.

Felder · availability
available_fromZeichenfolge nullErforderlich

Beginn der Verfügbarkeit.

Zeichenfolge:format: "date-time"
available_untilZeichenfolge nullErforderlich

Ende der Verfügbarkeit.

Zeichenfolge:format: "date-time"
is_availableBoolescher WertErforderlich

Gibt an, ob der Artikel in diesem Kontext verfügbar ist.

brand_idZeichenfolge nullErforderlich

Markenkennung.

conditionZeichenfolgeErforderlich

Zustand des Produkts.

Einschränkungen
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"
descriptionZeichenfolge nullErforderlich

Beschreibung in der ausgewählten Sprache.

featuresArray <FeatureSelectionData > Erforderlich

Produktmerkmale.

Felder · features
idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

identifiersObjektZusätzliche Felder: ZeichenfolgeErforderlich

Identifikationscodes des Produkts.

mediaArray <ProductMediaData > Erforderlich

Informationen zu zugeordneten Medien.

Felder · media
meta_descriptionZeichenfolge nullErforderlich

Suchmaschinenbeschreibung in der ausgewählten Sprache.

meta_keywordsArray <Zeichenfolge> nullErforderlich

Suchmaschinen-Schlüsselwörter in der ausgewählten Sprache.

meta_titleZeichenfolge nullErforderlich

Suchmaschinentitel in der ausgewählten Sprache.

nameZeichenfolge nullErforderlich

Name der Ressource im jeweiligen Kontext.

numberZeichenfolgeErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

pricePriceData nullErforderlich

Preisinformationen im ausgewählten Kontext.

Felder · price
price_versionGanzzahlErforderlich

Aktuelle Preisversion zur Nebenläufigkeitskontrolle.

primary_category_idZeichenfolge nullErforderlich

Kennung der Hauptkategorie.

primary_media_idZeichenfolge nullErforderlich

Kennung der primären Mediendatei.

publishedBoolescher WertErforderlich

Gibt an, ob die Ressource veröffentlicht ist.

skuZeichenfolgeErforderlich

Artikelcode der Lagerhaltungseinheit.

slugZeichenfolge nullErforderlich

URL-Pfadsegment in der ausgewählten Sprache.

tax_category_idZeichenfolgeErforderlich

Kennung der Steuerkategorie.

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"
variants_enabledBoolescher WertErforderlich

Gibt an, ob das Produkt Varianten verwendet.

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich

Metadaten der Antwort.

Felder · meta

ContextPageMeta

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

market_codeZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebener Marktcode.

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

ContextMeta

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

market_codeZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebener Marktcode.

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

PageMeta

paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

RequestMeta

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100
Beispielantwort

HTTP-Status

200
Erfolgreiche Antwort Schema
400
Ungültige Anfrage
401
Authentifizierung erforderlich
403
Berechtigung verweigert
404
Ressource nicht gefunden
409
Versionskonflikt
422
Validierung fehlgeschlagen
429
Anfragelimit überschritten
Weitere HTTP-Statuscodes (7)
405
Methode nicht erlaubt
413
Anfrage zu groß
415
Nicht unterstützter Medientyp
500
Serverfehler
502
API-Gateway-Fehler
503
Dienst nicht verfügbar
504
Gateway-Zeitüberschreitung

Fehlerkatalog: ErrorResponse

Header

401

WWW-AuthenticateZeichenfolgeOptional

Vom Server verlangtes Authentifizierungsschema.

405

AllowZeichenfolgeOptional

Von dieser Ressource unterstützte HTTP-Methoden.

429, 503

Retry-AfterGanzzahlOptional

Mindestwartezeit vor einem erneuten Versuch in Sekunden.

minimum: 0