Ugrás a tartalomhoz
ShopentlyLearn

Listázás — Kategóriák

Olvassa be a(z) „Kategóriák” adatait. Az eredmény a művelet paramétereitől függ.

GET/api/v1/categories

Hitelesítés
Bearer
Elérhető ettől a csomagtól
STANDARD
Szükséges jogosultságok
catalog.category:read

Kódpéldák

Példakérés

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/categories?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/categories?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/categories?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))

Példaválasz 200

JSON
{
  "data": [
    {
      "created_at": "2026-01-01T12:00:00Z",
      "id": "example",
      "is_available": true,
      "is_visible": false,
      "name": "Example",
      "number": "example",
      "parent_id": null,
      "slug": "example",
      "updated_at": "2026-01-01T12:00:00Z",
      "version": 1
    }
  ],
  "meta": {
    "locale": "en",
    "market_code": "PL",
    "market_id": "example",
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "request_id": "example"
  }
}

Működés

  • Kategória létrehozásához vagy módosításához érvényes szülőazonosítót, valamint a kiválasztott nyelvi és piaci környezetet használja.
  • Szerkesztés vagy törlés előtt olvassa ki az aktuális verziót.
  • Törléskor a meglévő kapcsolatokat figyelembe kell venni.
  • Egy használatban lévő kategória resource.in_use hibával visszautasítható; előbb rendezze a függőségeket a támogatott műveletekkel.

Paraméterek

Lekérdezési paraméterek

limitEgész számNem kötelező

Az oldalon szereplő rekordok maximális száma.

minimum: 1maximum: 100
Alapértelmezett: 50Példa: 20
cursorKarakterlánc nullNem kötelező

Az előző oldal által visszaadott, átlátszatlan folytatási érték.

Karakterlánc:minLength: 1maxLength: 1024
localeKarakterlánc nullNem kötelező

A kéréshez kiválasztott nyelv.

Karakterlánc:minLength: 2maxLength: 20
market_idKarakterlánc nullNem kötelező

A környezetvégpont által visszaadott piacazonosító.

Korlátozások · Karakterlánc 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeKarakterlánc nullNem kötelező

A környezetvégpont által visszaadott piackód.

Karakterlánc:minLength: 1maxLength: 16
parent_idKarakterlánc nullNem kötelező

A szülőkategória azonosítója.

Korlátozások · Karakterlánc 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
is_visibleLogikai érték nullNem kötelező

Jelzi, hogy az erőforrás látható-e.

Ez a művelet nem fogad JSON-törzset.

Válaszok

Válasz 200

dataTömb <CategorySummaryData > Kötelező

A sikeres válasz adatai.

Mezők · data

CategorySummaryData

created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"
idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg.

is_availableLogikai értékKötelező

Jelzi, hogy a tétel elérhető-e ebben a környezetben.

is_visibleLogikai értékKötelező

Jelzi, hogy az erőforrás látható-e.

nameKarakterlánc nullKötelező

Az erőforrás neve az adott környezetben.

numberKarakterláncKötelező

A rendelés vagy bejelentés felhasználóknak szánt száma.

parent_idKarakterlánc nullKötelező

A szülőkategória azonosítója.

slugKarakterlánc nullKötelező

URL-útvonalszegmens a kiválasztott nyelven.

updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"
versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

metaContextPageMeta ContextMeta PageMeta RequestMeta Kötelező

A válasz metaadatai.

Mezők · meta

ContextPageMeta

localeKarakterláncKötelező

A kéréshez kiválasztott nyelv.

market_codeKarakterláncKötelező

A környezetvégpont által visszaadott piackód.

market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

paginationPagination Kötelező

A kurzoros lapozás metaadatai.

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

ContextMeta

localeKarakterláncKötelező

A kéréshez kiválasztott nyelv.

market_codeKarakterláncKötelező

A környezetvégpont által visszaadott piackód.

market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

PageMeta

paginationPagination Kötelező

A kurzoros lapozás metaadatai.

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

RequestMeta

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100
Példaválasz

HTTP-állapot

200
Sikeres válasz Séma
400
Érvénytelen kérés
401
Hitelesítés szükséges
403
Hozzáférés megtagadva
404
Az erőforrás nem található
409
Verzióütközés
422
Sikertelen ellenőrzés
429
Kérésszámkorlát túllépve
További HTTP-állapotok (7)
405
Nem engedélyezett metódus
413
Túl nagy kérés
415
Nem támogatott formátum
500
Szerverhiba
502
API-átjáróhiba
503
A szolgáltatás nem érhető el
504
Időtúllépés

Hibakatalógus: ErrorResponse

Fejlécek

401

WWW-AuthenticateKarakterláncNem kötelező

A szerver által megkövetelt hitelesítési séma.

405

AllowKarakterláncNem kötelező

Az erőforrás által támogatott HTTP-metódusok.

429, 503

Retry-AfterEgész számNem kötelező

Az újrapróbálás előtti minimális várakozás másodpercben.

minimum: 0