Przejdź do treści
ShopentlyLearn

Pobierz kategorię

Pobierz kategorię przez Shopently API. Identyfikator category_id. Przykłady cURL, PHP i Python.

GET/api/v1/categories/{category_id}

Uwierzytelnianie
Bearer
Dostępne od planu
STANDARD
Wymagane uprawnienia
catalog.category:read

Przykłady kodu

Przykład żądania

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

Przykład odpowiedzi 200

JSON
{
  "data": {
    "created_at": "2026-01-01T12:00:00Z",
    "description": "example",
    "id": "example",
    "introduction": "example",
    "is_available": true,
    "is_visible": false,
    "meta_description": "example",
    "meta_keywords": [
      "example"
    ],
    "meta_title": "example",
    "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",
    "request_id": "example"
  }
}

Jak to działa

  • Twórz i edytuj kategorie z prawidłowymi identyfikatorami kategorii nadrzędnych oraz wybranym kontekstem języka i rynku.
  • Przed edycją lub usunięciem pobierz aktualną wersję.
  • Usunięcie musi respektować istniejące powiązania.
  • Dla używanej kategorii API może zwrócić resource.in_use; najpierw rozwiąż zależności za pomocą obsługiwanych operacji.

Parametry

Parametry ścieżki

category_idTekstWymagane

Identyfikator kategorii.

Ograniczenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Przykład: "example"

Parametry zapytania

localeTekst nullOpcjonalne

Język wybrany dla tego żądania.

Tekst:minLength: 2maxLength: 20
market_idTekst nullOpcjonalne

Identyfikator rynku zwrócony przez endpoint kontekstu.

Ograniczenia · Tekst 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeTekst nullOpcjonalne

Kod rynku zwrócony przez endpoint kontekstu.

Tekst:minLength: 1maxLength: 16

Ta operacja nie przyjmuje treści JSON.

Odpowiedzi

Odpowiedź 200

dataCategoryDetailData Wymagane

Dane poprawnej odpowiedzi.

Pola · data
created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"
descriptionTekst nullWymagane

Opis w wybranym języku.

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API.

introductionTekst nullWymagane

Tekst wprowadzający w wybranym języku.

is_availableWartość logicznaWymagane

Czy pozycja jest dostępna w tym kontekście.

is_visibleWartość logicznaWymagane

Czy zasób jest widoczny.

meta_descriptionTekst nullWymagane

Opis dla wyszukiwarek w wybranym języku.

meta_keywordsTablica <Tekst> nullWymagane

Słowa kluczowe dla wyszukiwarek w wybranym języku.

meta_titleTekst nullWymagane

Tytuł dla wyszukiwarek w wybranym języku.

nameTekst nullWymagane

Nazwa zasobu we właściwym kontekście.

numberTekstWymagane

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

parent_idTekst nullWymagane

Identyfikator kategorii nadrzędnej.

slugTekst nullWymagane

Fragment ścieżki URL w wybranym języku.

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"
versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Pola · meta

ContextPageMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTekstWymagane

Język wybrany dla tego żądania.

market_codeTekstWymagane

Kod rynku zwrócony przez endpoint kontekstu.

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100
Przykład odpowiedzi

Status HTTP

200
Poprawna odpowiedź Schemat
400
Nieprawidłowe żądanie
401
Wymagane uwierzytelnienie
403
Brak uprawnień
404
Nie znaleziono zasobu
409
Konflikt wersji
422
Błąd walidacji danych
429
Przekroczono limit zapytań
Pozostałe statusy HTTP (7)
405
Niedozwolona metoda
413
Zbyt duże żądanie
415
Nieobsługiwany format
500
Błąd serwera
502
Błąd bramy API
503
Usługa niedostępna
504
Przekroczono czas odpowiedzi

Katalog błędów: ErrorResponse

Nagłówki

401

WWW-AuthenticateTekstOpcjonalne

Schemat uwierzytelniania wymagany przez serwer.

405

AllowTekstOpcjonalne

Metody HTTP obsługiwane przez ten zasób.

429, 503

Retry-AfterLiczba całkowitaOpcjonalne

Minimalny czas przed ponowieniem, w sekundach.

minimum: 0