Pređi na sadržaj
ShopentlyLearn

Preuzmi — Proizvodi

Pročitajte podatke iz „Proizvodi“. Rezultat zavisi od parametara ove radnje.

GET/api/v1/products/{product_id}

Autentifikacija
Bearer
Dostupno od
STANDARD
Potrebna ovlašćenja
catalog.product:read

Primeri koda

Primer zahteva

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

Primer odgovora 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"
  }
}

Kako funkcioniše

  • Integracija može čitati neizbrisane proizvode, uključujući nacrte, osim proizvoda blokiranih ograničenjem plana.
  • Blokirani proizvodi izostavljeni su sa spiska; direktan pristup vraća entitlements.resource_blocked.
  • Vidljivost kroz API zato se razlikuje od objave u izlogu prodavnice.
  • Koristite postojeće identifikatore marki, kategorija, svojstava i medija.
  • Cene imaju izričitu valutu, cenovnik, poreski način i verzije za kontrolu istovremenih upisa.
  • Cene proizvoda i varijanti posebne su; koristite podržanu strukturu cena i tačne decimalne nizove znakova.

Parametri

Parametri putanje

product_idNiz znakovaObavezno

Identifikator proizvoda.

Ograničenja
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primer: "example"

Parametri upita

localeNiz znakova nullOpciono

Jezik odabran za ovaj zahtev.

Niz znakova:minLength: 2maxLength: 20
market_idNiz znakova nullOpciono

Identifikator tržišta vraćen s krajnje tačke konteksta.

Ograničenja · Niz znakova 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeNiz znakova nullOpciono

Kod tržišta vraćen s krajnje tačke konteksta.

Niz znakova:minLength: 1maxLength: 16

Ova operacija ne prihvata JSON telo.

Odgovori

Odgovor 200

dataProductDetailData Obavezno

Podaci uspešnog odgovora.

Polja · data
availabilityAvailabilityData Obavezno

Podaci o dostupnosti za odabrani kontekst.

Polja · availability
available_fromNiz znakova nullObavezno

Početak dostupnosti.

Niz znakova:format: "date-time"
available_untilNiz znakova nullObavezno

Kraj dostupnosti.

Niz znakova:format: "date-time"
is_availableLogička vrednostObavezno

Da li je stavka dostupna u ovom kontekstu.

brand_idNiz znakova nullObavezno

Identifikator marke.

conditionNiz znakovaObavezno

Stanje proizvoda.

Ograničenja
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
created_atNiz znakovaObavezno

Vreme kreiranja.

format: "date-time"
descriptionNiz znakova nullObavezno

Opis na odabranom jeziku.

featuresNiz vrednosti <FeatureSelectionData > Obavezno

Svojstva proizvoda.

Polja · features
idNiz znakovaObavezno

Identifikator resursa; sačuvajte ga u vraćenom obliku.

identifiersObjekatDodatna polja: Niz znakovaObavezno

Identifikacijski kodovi proizvoda.

mediaNiz vrednosti <ProductMediaData > Obavezno

Podaci o priloženim medijima.

Polja · media
meta_descriptionNiz znakova nullObavezno

Opis za pretraživače na odabranom jeziku.

meta_keywordsNiz vrednosti <Niz znakova> nullObavezno

Ključne reči za pretraživače na odabranom jeziku.

meta_titleNiz znakova nullObavezno

Naslov za pretraživače na odabranom jeziku.

nameNiz znakova nullObavezno

Naziv resursa u odgovarajućem kontekstu.

numberNiz znakovaObavezno

Broj porudžbine ili zahteva namenjen korisniku.

pricePriceData nullObavezno

Podaci o ceni u odabranom kontekstu.

Polja · price
price_versionCeli brojObavezno

Trenutna verzija cene za kontrolu istovremenih upisa.

primary_category_idNiz znakova nullObavezno

Identifikator glavne kategorije.

primary_media_idNiz znakova nullObavezno

Identifikator glavne medijske datoteke.

publishedLogička vrednostObavezno

Da li je resurs objavljen.

skuNiz znakovaObavezno

Šifra skladišne jedinice.

slugNiz znakova nullObavezno

Deo URL putanje na odabranom jeziku.

tax_category_idNiz znakovaObavezno

Identifikator poreske kategorije.

updated_atNiz znakovaObavezno

Vreme poslednjeg ažuriranja.

format: "date-time"
variants_enabledLogička vrednostObavezno

Da li koristi proizvod varijante.

versionCeli brojObavezno

Verzija resursa za kontrolu istovremenih upisa.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obavezno

Metapodaci odgovora.

Polja · meta

ContextPageMeta

localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

market_codeNiz znakovaObavezno

Kod tržišta vraćen s krajnje tačke konteksta.

market_idNiz znakovaObavezno

Identifikator tržišta vraćen s krajnje tačke konteksta.

paginationPagination Obavezno

Metapodaci paginacije pomoću kursora.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

ContextMeta

localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

market_codeNiz znakovaObavezno

Kod tržišta vraćen s krajnje tačke konteksta.

market_idNiz znakovaObavezno

Identifikator tržišta vraćen s krajnje tačke konteksta.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obavezno

Metapodaci paginacije pomoću kursora.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

RequestMeta

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100
Primer odgovora

HTTP status

200
Uspešan odgovor Šema
400
Nevažeći zahtev
401
Potrebna je autentifikacija
403
Pristup odbijen
404
Resurs nije pronađen
409
Sukob verzija
422
Provera nije uspela
429
Prekoračeno ograničenje zahteva
Ostali HTTP statusi (7)
405
Metoda nije dozvoljena
413
Zahtev je prevelik
415
Nepodržan format
500
Greška servera
502
Greška API mrežnog prolaza
503
Usluga nije dostupna
504
Istek vremena

Katalog grešaka: ErrorResponse

Zaglavlja

401

WWW-AuthenticateNiz znakovaOpciono

Šema autentifikacije koju zahteva server.

405

AllowNiz znakovaOpciono

HTTP metode koje ovaj resurs podržava.

429, 503

Retry-AfterCeli brojOpciono

Najkraće čekanje pre ponavljanja, u sekundama.

minimum: 0