Pereiti prie turinio
ShopentlyLearn

Gauti — Produktai

Skaitykite „Produktai“ duomenis. Rezultatas priklauso nuo šio veiksmo parametrų.

GET/api/v1/products/{product_id}

Tapatybės patvirtinimas
Bearer
Prieinama nuo plano
STANDARD
Būtinos teisės
catalog.product:read

Kodo pavyzdžiai

Užklausos pavyzdys

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

Atsakymo pavyzdys 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"
  }
}

Kaip tai veikia

  • Integracija gali skaityti nepašalintus produktus, įskaitant juodraščius, išskyrus dėl plano ribos užblokuotus produktus.
  • Užblokuoti produktai neįtraukiami į sąrašus; tiesioginė prieiga grąžina entitlements.resource_blocked.
  • Todėl produkto matomumas API skiriasi nuo jo paskelbimo parduotuvėje.
  • Naudokite esamus prekių ženklų, kategorijų, savybių ir medijos identifikatorius.
  • Kainose aiškiai nurodoma valiuta, kainoraštis, mokesčių režimas ir lygiagrečių pakeitimų kontrolės versijos.
  • Produkto ir jo variantų kainodara yra atskira; naudokite palaikomą kainodaros struktūrą bei tikslias dešimtaines eilutes.

Parametrai

Kelio parametrai

product_idEilutėPrivalomas

Produkto identifikatorius.

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

Užklausos parametrai

localeEilutė nullNeprivalomas

Šiai užklausai pasirinkta kalba.

Eilutė:minLength: 2maxLength: 20
market_idEilutė nullNeprivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

Apribojimai · Eilutė 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeEilutė nullNeprivalomas

Konteksto prieigos taško grąžintas rinkos kodas.

Eilutė:minLength: 1maxLength: 16

Ši operacija nepriima JSON turinio.

Atsakymai

Atsakymas 200

dataProductDetailData Privalomas

Sėkmingo atsakymo duomenys.

Laukai · data
availabilityAvailabilityData Privalomas

Prieinamumo informacija pasirinktame kontekste.

Laukai · availability
available_fromEilutė nullPrivalomas

Prieinamumo pradžia.

Eilutė:format: "date-time"
available_untilEilutė nullPrivalomas

Prieinamumo pabaiga.

Eilutė:format: "date-time"
is_availableLoginė reikšmėPrivalomas

Ar elementas prieinamas šiame kontekste.

brand_idEilutė nullPrivalomas

Prekės ženklo identifikatorius.

conditionEilutėPrivalomas

Produkto būklė.

Apribojimai
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"
descriptionEilutė nullPrivalomas

Aprašymas pasirinkta kalba.

featuresMasyvas <FeatureSelectionData > Privalomas

Produkto savybės.

Laukai · features
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

identifiersObjektasPapildomi laukai: EilutėPrivalomas

Produkto identifikavimo kodai.

mediaMasyvas <ProductMediaData > Privalomas

Pridėtos medijos informacija.

Laukai · media
meta_descriptionEilutė nullPrivalomas

Aprašymas paieškos sistemoms pasirinkta kalba.

meta_keywordsMasyvas <Eilutė> nullPrivalomas

Raktažodžiai paieškos sistemoms pasirinkta kalba.

meta_titleEilutė nullPrivalomas

Antraštė paieškos sistemoms pasirinkta kalba.

nameEilutė nullPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

numberEilutėPrivalomas

Žmogui rodomas užsakymo arba prašymo numeris.

pricePriceData nullPrivalomas

Kainos informacija pasirinktame kontekste.

Laukai · price
price_versionSveikasis skaičiusPrivalomas

Dabartinė kainos versija lygiagrečių pakeitimų kontrolei.

primary_category_idEilutė nullPrivalomas

Pagrindinės kategorijos identifikatorius.

primary_media_idEilutė nullPrivalomas

Pagrindinio medijos failo identifikatorius.

publishedLoginė reikšmėPrivalomas

Ar išteklius paskelbtas.

skuEilutėPrivalomas

Atsargų apskaitos vieneto kodas.

slugEilutė nullPrivalomas

URL kelio segmentas pasirinkta kalba.

tax_category_idEilutėPrivalomas

Mokesčių kategorijos identifikatorius.

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"
variants_enabledLoginė reikšmėPrivalomas

Ar produktas naudoja variantus.

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

metaContextPageMeta ContextMeta PageMeta RequestMeta Privalomas

Atsakymo metaduomenys.

Laukai · meta

ContextPageMeta

localeEilutėPrivalomas

Šiai užklausai pasirinkta kalba.

market_codeEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos kodas.

market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

paginationPagination Privalomas

Skaidymo į puslapius pagal žymeklį metaduomenys.

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100

ContextMeta

localeEilutėPrivalomas

Šiai užklausai pasirinkta kalba.

market_codeEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos kodas.

market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100

PageMeta

paginationPagination Privalomas

Skaidymo į puslapius pagal žymeklį metaduomenys.

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100

RequestMeta

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100
Atsakymo pavyzdys

HTTP būsena

200
Sėkmingas atsakymas Schema
400
Netinkama užklausa
401
Būtinas tapatybės patvirtinimas
403
Prieiga uždrausta
404
Išteklius nerastas
409
Versijų konfliktas
422
Tikrinimo klaida
429
Viršytas užklausų limitas
Kitos HTTP būsenos (7)
405
Metodas neleidžiamas
413
Užklausa per didelė
415
Nepalaikomas formatas
500
Serverio klaida
502
API tinklų sietuvo klaida
503
Paslauga nepasiekiama
504
Baigėsi laukimo laikas

Klaidų katalogas: ErrorResponse

Antraštės

401

WWW-AuthenticateEilutėNeprivalomas

Serverio reikalaujama tapatybės patvirtinimo schema.

405

AllowEilutėNeprivalomas

Šio ištekliaus palaikomi HTTP metodai.

429, 503

Retry-AfterSveikasis skaičiusNeprivalomas

Mažiausias laukimo laikas prieš kartojant, sekundėmis.

minimum: 0