Treci la conținut
ShopentlyLearn

Listează — Produse

Citiți datele din „Produse”. Rezultatul depinde de parametrii acestei operațiuni.

GET/api/v1/products

Autentificare
Bearer
Disponibil începând cu
STANDARD
Permisiuni necesare
catalog.product:read

Exemple de cod

Exemplu de cerere

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?limit=20'

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?limit=20');
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?limit=20', 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))

Exemplu de răspuns 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",
      "id": "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",
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "request_id": "example"
  }
}

Cum funcționează

Integrarea poate citi produsele neșterse, inclusiv ciornele, cu excepția produselor blocate de o limită a planului. Produsele blocate sunt excluse din liste; accesul direct returnează entitlements.resource_blocked. Vizibilitatea în API diferă astfel de publicarea în magazin.

Parametri

Parametri de interogare

limitNumăr întregOpțional

Numărul maxim de înregistrări pe această pagină.

minimum: 1maximum: 100
Valoare implicită: 50Exemplu: 20
cursorȘir de caractere nullOpțional

Valoare opacă de continuare returnată de pagina anterioară.

Șir de caractere:minLength: 1maxLength: 1024
localeȘir de caractere nullOpțional

Limba selectată pentru această cerere.

Șir de caractere:minLength: 2maxLength: 20
market_idȘir de caractere nullOpțional

Identificatorul pieței returnat de endpointul de context.

Restricții · Șir de caractere 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeȘir de caractere nullOpțional

Codul pieței returnat de endpointul de context.

Șir de caractere:minLength: 1maxLength: 16
skuȘir de caractere nullOpțional

Codul unității de stoc.

Șir de caractere:minLength: 1maxLength: 100
Restricții · Șir de caractere 1
pattern
"^\\S+$"
publishedValoare booleană nullOpțional

Indică dacă resursa este publicată.

brand_idȘir de caractere nullOpțional

Identificatorul mărcii.

Restricții · Șir de caractere 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
category_idȘir de caractere nullOpțional

Identificatorul categoriei.

Restricții · Șir de caractere 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"

Această operație nu acceptă un corp JSON.

Răspunsuri

Răspuns 200

dataTablou <ProductSummaryData > Obligatoriu

Datele unui răspuns reușit.

Câmpuri · data

ProductSummaryData

availabilityAvailabilityData Obligatoriu

Informații despre disponibilitate în contextul selectat.

brand_idȘir de caractere nullObligatoriu

Identificatorul mărcii.

conditionȘir de caractereObligatoriu

Starea produsului.

Restricții
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

nameȘir de caractere nullObligatoriu

Numele resursei în contextul relevant.

numberȘir de caractereObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

pricePriceData nullObligatoriu

Informații despre preț în contextul selectat.

price_versionNumăr întregObligatoriu

Versiunea curentă a prețului, pentru controlul concurenței.

primary_category_idȘir de caractere nullObligatoriu

Identificatorul categoriei principale.

primary_media_idȘir de caractere nullObligatoriu

Identificatorul fișierului media principal.

publishedValoare booleanăObligatoriu

Indică dacă resursa este publicată.

skuȘir de caractereObligatoriu

Codul unității de stoc.

slugȘir de caractere nullObligatoriu

Segmentul căii URL în limba selectată.

tax_category_idȘir de caractereObligatoriu

Identificatorul categoriei fiscale.

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
variants_enabledValoare booleanăObligatoriu

Indică dacă produsul folosește variante.

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriu

Metadatele răspunsului.

Câmpuri · meta

ContextPageMeta

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

market_codeȘir de caractereObligatoriu

Codul pieței returnat de endpointul de context.

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

paginationPagination Obligatoriu

Metadatele paginării prin cursor.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

ContextMeta

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

market_codeȘir de caractereObligatoriu

Codul pieței returnat de endpointul de context.

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatoriu

Metadatele paginării prin cursor.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100
Exemplu de răspuns

Stare HTTP

200
Răspuns reușit Schemă
400
Cerere nevalidă
401
Autentificare necesară
403
Acces refuzat
404
Resursa nu a fost găsită
409
Conflict de versiune
422
Validare eșuată
429
Limită de cereri depășită
Alte stări HTTP (7)
405
Metodă nepermisă
413
Cerere prea mare
415
Format neacceptat
500
Eroare de server
502
Eroare de gateway API
503
Serviciu indisponibil
504
Timp de așteptare depășit

Catalog de erori: ErrorResponse

Antete

401

WWW-AuthenticateȘir de caractereOpțional

Schema de autentificare cerută de server.

405

AllowȘir de caractereOpțional

Metodele HTTP acceptate de această resursă.

429, 503

Retry-AfterNumăr întregOpțional

Întârzierea minimă înainte de reîncercare, în secunde.

minimum: 0