Hent — Produkter
Læs data fra ”Produkter”. Resultatet afhænger af handlingens parametre.
GET/api/v1/products/{product_id}
- Godkendelse
Bearer- Tilgængelig fra
- STANDARD
- Nødvendige rettigheder
catalog.product:read
Kodeeksempler
Eksempel på forespørgsel
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))
Eksempel på svar 200
{
"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"
}
}
Principper
- Integrationen kan læse ikke-slettede produkter, herunder kladder, undtagen produkter blokeret af en abonnementsgrænse.
- Blokerede produkter udelades fra lister; direkte adgang returnerer entitlements.resource_blocked.
- Produktsynlighed i API'et adskiller sig derfor fra offentliggørelse i butikken.
- Brug eksisterende identifikatorer for mærker, kategorier, egenskaber og medier.
- Priser har en eksplicit valuta, prisliste, afgiftsindstilling og versioner til samtidighedskontrol.
- Produkt- og variantpriser er adskilte; brug den understøttede prisstruktur og præcise decimalstrenge.
Parametre
Stiparametre
product_idStrengObligatoriskProduktidentifikator.
Begrænsninger
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Forespørgselsparametre
localeStreng nullValgfritSprog valgt til denne forespørgsel.
Streng:minLength:2maxLength:20market_idStreng nullValgfritMarkedsidentifikator returneret af kontekstendepunktet.
Begrænsninger · Streng 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeStreng nullValgfritMarkedskode returneret af kontekstendepunktet.
Streng:minLength:1maxLength:16
Denne operation accepterer ikke JSON-indhold.
Svar
Svar 200
Fuld model: ApiResponse_ProductDetailData_
dataProductDetailDataObligatoriskIndholdet af et vellykket svar.
Felter ·
dataavailabilityAvailabilityDataObligatoriskTilgængelighedsoplysninger for den valgte kontekst.
Felter ·
availabilityavailable_fromStreng nullObligatoriskBegyndelsen af tilgængelighedsperioden.
Streng:format:"date-time"available_untilStreng nullObligatoriskSlutningen af tilgængelighedsperioden.
Streng:format:"date-time"is_availableBoolesk værdiObligatoriskOm varen er tilgængelig i denne kontekst.
brand_idStreng nullObligatoriskMærkeidentifikator.
conditionStrengObligatoriskProduktets stand.
Begrænsninger
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_atStrengObligatoriskOprettelsestidspunkt.
format:"date-time"descriptionStreng nullObligatoriskBeskrivelse på det valgte sprog.
featuresArray <FeatureSelectionData> ObligatoriskProduktegenskaber.
Felter ·
featuresidStrengObligatoriskRessourceidentifikator; bevar den som returneret.
identifiersObjektYderligere felter: StrengObligatoriskProduktidentifikationskoder.
mediaArray <ProductMediaData> ObligatoriskOplysninger om tilknyttede medier.
Felter ·
mediameta_descriptionStreng nullObligatoriskBeskrivelse til søgemaskiner på det valgte sprog.
meta_keywordsArray <Streng> nullObligatoriskNøgleord til søgemaskiner på det valgte sprog.
meta_titleStreng nullObligatoriskTitel til søgemaskiner på det valgte sprog.
nameStreng nullObligatoriskRessourcens navn i den relevante kontekst.
numberStrengObligatoriskOrdre- eller sagsnummer beregnet til mennesker.
pricePriceDatanullObligatoriskPrisoplysninger i den valgte kontekst.
Felter ·
priceprice_versionHeltalObligatoriskAktuel prisversion til samtidighedskontrol.
primary_category_idStreng nullObligatoriskIdentifikator for primær kategori.
primary_media_idStreng nullObligatoriskIdentifikator for primært medie.
publishedBoolesk værdiObligatoriskOm ressourcen er offentliggjort.
skuStrengObligatoriskSKU-varekode.
slugStreng nullObligatoriskURL-stisegment på det valgte sprog.
tax_category_idStrengObligatoriskIdentifikator for afgiftskategori.
updated_atStrengObligatoriskTidspunkt for seneste opdatering.
format:"date-time"variants_enabledBoolesk værdiObligatoriskOm produktet bruger varianter.
versionHeltalObligatoriskRessourceversion anvendt til samtidighedskontrol.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatoriskSvarmetadata.
Felter ·
metalocaleStrengObligatoriskSprog valgt til denne forespørgsel.
market_codeStrengObligatoriskMarkedskode returneret af kontekstendepunktet.
market_idStrengObligatoriskMarkedsidentifikator returneret af kontekstendepunktet.
paginationPaginationObligatoriskMetadata for markørbaseret sideinddeling.
request_idStrengObligatoriskSagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.
minLength:1maxLength:100
localeStrengObligatoriskSprog valgt til denne forespørgsel.
market_codeStrengObligatoriskMarkedskode returneret af kontekstendepunktet.
market_idStrengObligatoriskMarkedsidentifikator returneret af kontekstendepunktet.
request_idStrengObligatoriskSagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.
minLength:1maxLength:100
paginationPaginationObligatoriskMetadata for markørbaseret sideinddeling.
request_idStrengObligatoriskSagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.
minLength:1maxLength:100
request_idStrengObligatoriskSagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.
minLength:1maxLength:100
HTTP-status
200- Vellykket svar Skema
400- Ugyldig anmodning
401- Godkendelse påkrævet
403- Adgang nægtet
404- Ressource ikke fundet
409- Versionskonflikt
422- Validering mislykkedes
429- Grænsen for anmodninger er overskredet
Andre HTTP-statusser (7)
405- Metoden er ikke tilladt
413- Anmodningen er for stor
415- Formatet understøttes ikke
500- Serverfejl
502- Fejl i API-gateway
503- Tjenesten er utilgængelig
504- Tidsgrænsen er overskredet
Fejlkatalog: ErrorResponse
Headere
401
WWW-AuthenticateStrengValgfritGodkendelsesmetode, som serveren kræver.
405
AllowStrengValgfritHTTP-metoder, som denne ressource understøtter.
429, 503
Retry-AfterHeltalValgfritMindste ventetid før næste forsøg, i sekunder.
minimum:0