Mine sisu juurde
ShopentlyLearn

Hangi — Tooted

Lugege andmeid ressursist „Tooted“. Tulemus sõltub toimingu parameetritest.

GET/api/v1/products/{product_id}

Autentimine
Bearer
Saadaval alates
STANDARD
Nõutavad õigused
catalog.product:read

Koodinäited

Päringu näide

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

Vastuse näide 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"
  }
}

Kuidas see toimib

  • Integratsioon saab lugeda kustutamata tooteid, sealhulgas mustandeid, välja arvatud paketi piiranguga blokeeritud tooted.
  • Blokeeritud tooted jäetakse loenditest välja; otsepäring tagastab entitlements.resource_blocked.
  • Seega erineb toote nähtavus API-s selle avaldamisest poes.
  • Kasuta brändide, kategooriate, omaduste ja meedia olemasolevaid identifikaatoreid.
  • Hinnad sisaldavad selgesõnalist valuutat, hinnakirja, maksurežiimi ja samaaegsuse kontrolli versioone.
  • Toote ja variandi hinnastamine on eraldi; kasuta toetatud hinnastruktuuri ja täpseid kümnendarvustringe.

Parameetrid

Tee parameetrid

product_idStringKohustuslik

Toote identifikaator.

Piirangud
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Näide: "example"

Päringu parameetrid

localeString nullValikuline

Selle päringu jaoks valitud keel.

String:minLength: 2maxLength: 20
market_idString nullValikuline

Konteksti lõpp-punkti tagastatud turuidentifikaator.

Piirangud · String 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeString nullValikuline

Konteksti lõpp-punkti tagastatud turukood.

String:minLength: 1maxLength: 16

See toiming ei võta vastu JSON-sisu.

Vastused

Vastus 200

dataProductDetailData Kohustuslik

Eduka vastuse andmed.

Väljad · data
availabilityAvailabilityData Kohustuslik

Saadavuse teave valitud kontekstis.

Väljad · availability
available_fromString nullKohustuslik

Saadavuse algus.

String:format: "date-time"
available_untilString nullKohustuslik

Saadavuse lõpp.

String:format: "date-time"
is_availableTõeväärtusKohustuslik

Kas kirje on selles kontekstis saadaval.

brand_idString nullKohustuslik

Brändi identifikaator.

conditionStringKohustuslik

Toote seisukord.

Piirangud
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
created_atStringKohustuslik

Loomise aeg.

format: "date-time"
descriptionString nullKohustuslik

Kirjeldus valitud keeles.

featuresMassiiv <FeatureSelectionData > Kohustuslik

Toote omadused.

Väljad · features
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

identifiersObjektLisaväljad: StringKohustuslik

Toote tuvastuskoodid.

mediaMassiiv <ProductMediaData > Kohustuslik

Lisatud meedia teave.

Väljad · media
meta_descriptionString nullKohustuslik

Otsingumootori kirjeldus valitud keeles.

meta_keywordsMassiiv <String> nullKohustuslik

Otsingumootori märksõnad valitud keeles.

meta_titleString nullKohustuslik

Otsingumootori pealkiri valitud keeles.

nameString nullKohustuslik

Ressursi nimi vastavas kontekstis.

numberStringKohustuslik

Kasutajale mõeldud tellimuse või pöördumise number.

pricePriceData nullKohustuslik

Hinnateave valitud kontekstis.

Väljad · price
price_versionTäisarvKohustuslik

Hinna kehtiv versioon samaaegsuse kontrolliks.

primary_category_idString nullKohustuslik

Põhikategooria identifikaator.

primary_media_idString nullKohustuslik

Peamise meediafaili identifikaator.

publishedTõeväärtusKohustuslik

Kas ressurss on avaldatud.

skuStringKohustuslik

Laoarvestusühiku kood.

slugString nullKohustuslik

URL-i teesegment valitud keeles.

tax_category_idStringKohustuslik

Maksukategooria identifikaator.

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"
variants_enabledTõeväärtusKohustuslik

Kas toode kasutab variante.

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

metaContextPageMeta ContextMeta PageMeta RequestMeta Kohustuslik

Vastuse metaandmed.

Väljad · meta

ContextPageMeta

localeStringKohustuslik

Selle päringu jaoks valitud keel.

market_codeStringKohustuslik

Konteksti lõpp-punkti tagastatud turukood.

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

ContextMeta

localeStringKohustuslik

Selle päringu jaoks valitud keel.

market_codeStringKohustuslik

Konteksti lõpp-punkti tagastatud turukood.

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

PageMeta

paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

RequestMeta

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Vastuse näide

HTTP-olek

200
Edukas vastus Skeem
400
Vigane päring
401
Autentimine on nõutav
403
Juurdepääs keelatud
404
Ressurssi ei leitud
409
Versioonikonflikt
422
Valideerimine nurjus
429
Päringupiirang ületatud
Muud HTTP olekud (7)
405
Meetod pole lubatud
413
Päring on liiga suur
415
Vormingut ei toetata
500
Serveri viga
502
API lüüsi viga
503
Teenus pole saadaval
504
Ajalimiit ületatud

Veakataloog: ErrorResponse

Päised

401

WWW-AuthenticateStringValikuline

Serveri nõutav autentimisskeem.

405

AllowStringValikuline

Selle ressursi toetatud HTTP-meetodid.

429, 503

Retry-AfterTäisarvValikuline

Minimaalne viivitus enne korduskatset, sekundites.

minimum: 0