Pāriet uz saturu
ShopentlyLearn

Iegūt — Produkti

Nolasiet datus no “Produkti”. Rezultāts ir atkarīgs no šīs darbības parametriem.

GET/api/v1/products/{product_id}

Autentifikācija
Bearer
Pieejams no
STANDARD
Nepieciešamās atļaujas
catalog.product:read

Koda piemēri

Pieprasījuma piemērs

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

Atbildes piemērs 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"
  }
}

Kā tas darbojas

  • Integrācija var lasīt nedzēstus produktus, tostarp melnrakstus, izņemot ar plāna limitu bloķētos produktus.
  • Bloķētie produkti nav sarakstos; tieša piekļuve atgriež entitlements.resource_blocked.
  • Tāpēc produktu redzamība API atšķiras no publicēšanas veikalā.
  • Izmantojiet esošos zīmolu, kategoriju, īpašību un multivides identifikatorus.
  • Cenas ietver skaidri norādītu valūtu, cenrādi, nodokļu režīmu un vienlaicīgu izmaiņu versijas.
  • Produktu un variantu cenas ir atsevišķas; izmantojiet atbalstīto cenu struktūru un precīzas decimālskaitļu virknes.

Parametri

Ceļa parametri

product_idVirkneObligāts

Produkta identifikators.

Ierobežojumi
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Piemērs: "example"

Vaicājuma parametri

localeVirkne nullNeobligāts

Šim pieprasījumam izvēlētā valoda.

Virkne:minLength: 2maxLength: 20
market_idVirkne nullNeobligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

Ierobežojumi · Virkne 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeVirkne nullNeobligāts

Konteksta galapunkta atgrieztais tirgus kods.

Virkne:minLength: 1maxLength: 16

Šī darbība nepieņem JSON saturu.

Atbildes

Atbilde 200

dataProductDetailData Obligāts

Veiksmīgas atbildes dati.

Lauki · data
availabilityAvailabilityData Obligāts

Pieejamības informācija izvēlētajā kontekstā.

Lauki · availability
available_fromVirkne nullObligāts

Pieejamības sākums.

Virkne:format: "date-time"
available_untilVirkne nullObligāts

Pieejamības beigas.

Virkne:format: "date-time"
is_availableLoģiska vērtībaObligāts

Vai vienums ir pieejams šajā kontekstā.

brand_idVirkne nullObligāts

Zīmola identifikators.

conditionVirkneObligāts

Produkta stāvoklis.

Ierobežojumi
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
created_atVirkneObligāts

Izveides laiks.

format: "date-time"
descriptionVirkne nullObligāts

Apraksts izvēlētajā valodā.

featuresMasīvs <FeatureSelectionData > Obligāts

Produkta īpašības.

Lauki · features
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā.

identifiersObjektsPapildu lauki: VirkneObligāts

Produkta identifikācijas kodi.

mediaMasīvs <ProductMediaData > Obligāts

Pievienotās multivides informācija.

Lauki · media
meta_descriptionVirkne nullObligāts

Meklētājprogrammas apraksts izvēlētajā valodā.

meta_keywordsMasīvs <Virkne> nullObligāts

Meklētājprogrammas atslēgvārdi izvēlētajā valodā.

meta_titleVirkne nullObligāts

Meklētājprogrammas virsraksts izvēlētajā valodā.

nameVirkne nullObligāts

Resursa nosaukums attiecīgajā kontekstā.

numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

pricePriceData nullObligāts

Cenas informācija izvēlētajā kontekstā.

Lauki · price
price_versionVesels skaitlisObligāts

Pašreizējā cenas versija vienlaicīgu izmaiņu kontrolei.

primary_category_idVirkne nullObligāts

Galvenās kategorijas identifikators.

primary_media_idVirkne nullObligāts

Galvenā multivides resursa identifikators.

publishedLoģiska vērtībaObligāts

Vai resurss ir publicēts.

skuVirkneObligāts

Krājumu uzskaites vienības kods.

slugVirkne nullObligāts

URL ceļa segments izvēlētajā valodā.

tax_category_idVirkneObligāts

Nodokļu kategorijas identifikators.

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"
variants_enabledLoģiska vērtībaObligāts

Vai produkts izmanto variantus.

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligāts

Atbildes metadati.

Lauki · meta

ContextPageMeta

localeVirkneObligāts

Šim pieprasījumam izvēlētā valoda.

market_codeVirkneObligāts

Konteksta galapunkta atgrieztais tirgus kods.

market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

paginationPagination Obligāts

Kursora lapošanas metadati.

request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100

ContextMeta

localeVirkneObligāts

Šim pieprasījumam izvēlētā valoda.

market_codeVirkneObligāts

Konteksta galapunkta atgrieztais tirgus kods.

market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligāts

Kursora lapošanas metadati.

request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100

RequestMeta

request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100
Atbildes piemērs

HTTP statuss

200
Veiksmīga atbilde Shēma
400
Nederīgs pieprasījums
401
Nepieciešama autentifikācija
403
Piekļuve liegta
404
Resurss nav atrasts
409
Versiju konflikts
422
Validācijas kļūda
429
Pārsniegts pieprasījumu limits
Citi HTTP statusi (7)
405
Metode nav atļauta
413
Pieprasījums ir pārāk liels
415
Neatbalstīts formāts
500
Servera kļūda
502
API vārtejas kļūda
503
Pakalpojums nav pieejams
504
Noildze

Kļūdu katalogs: ErrorResponse

Galvenes

401

WWW-AuthenticateVirkneNeobligāts

Servera pieprasītā autentifikācijas shēma.

405

AllowVirkneNeobligāts

Šī resursa atbalstītās HTTP metodes.

429, 503

Retry-AfterVesels skaitlisNeobligāts

Minimālā aizkave pirms atkārtošanas sekundēs.

minimum: 0