Modele kategorii

Schematy kategorii Shopently API: odczyt, tworzenie i edycja. Sprawdź strukturę hierarchii, typy pól i ograniczenia danych.

Schematy danych

Pobierz kategorię — Odpowiedź

ApiResponse_CategoryDetailData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataCategoryDetailData Wymagane: Przykład odpowiedzi · CategoryDetailData.

Przykład: {"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}
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane: Metadane odpowiedzi.

Przykład: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Dodatkowe pola: Nie

Pobierz listę kategorii — Odpowiedź

ApiResponse_list_CategorySummaryData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataTablica <CategorySummaryData > Wymagane: Przykład odpowiedzi · ApiResponse_list_CategorySummaryData__.

Przykład: [{"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}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane: Metadane odpowiedzi.

Przykład: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

Utwórz kategorię — Treść żądania

CategoryCreate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

descriptionTekst nullOpcjonalne: Opis w wybranym języku.

Tekst:maxLength: 50000
introductionTekst nullOpcjonalne: Tekst wprowadzający w wybranym języku.

Tekst:maxLength: 5000
is_visibleWartość logicznaOpcjonalne: Czy zasób jest widoczny.

Wartość domyślna: false
market_idsTablica <Tekst> Opcjonalne: Identyfikatory wybranych rynków.

maxItems: 1000
Tablica:minLength: 1maxLength: 63
meta_descriptionTekst nullOpcjonalne: Opis dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 160
meta_keywordsTablica <Tekst> nullOpcjonalne: Słowa kluczowe dla wyszukiwarek w wybranym języku.

Tablica:maxItems: 20
Tablica / Tablica:maxLength: 50
meta_titleTekst nullOpcjonalne: Tytuł dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 70
nameTekstWymagane: Nazwa zasobu we właściwym kontekście.

minLength: 1maxLength: 200

Przykład: "Example"
parent_idTekst nullOpcjonalne: Identyfikator kategorii nadrzędnej.

Tekst:minLength: 1maxLength: 63
slugTekst nullOpcjonalne: Fragment ścieżki URL w wybranym języku.

Tekst:maxLength: 160

Dodatkowe pola: Nie

Pobierz kategorię — Odpowiedź

CategoryDetailData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

created_atTekstWymagane: Data i czas utworzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"
descriptionTekst nullWymagane: Opis w wybranym języku.

Przykład: "example"
idTekstWymagane: Identyfikator zasobu; zachowaj wartość zwróconą przez API. (CategoryDetailData).

Przykład: "example"
introductionTekst nullWymagane: Tekst wprowadzający w wybranym języku.

Przykład: "example"
is_availableWartość logicznaWymagane: Czy pozycja jest dostępna w tym kontekście.

Przykład: true
is_visibleWartość logicznaWymagane: Czy zasób jest widoczny.

Przykład: false
meta_descriptionTekst nullWymagane: Opis dla wyszukiwarek w wybranym języku.

Przykład: "example"
meta_keywordsTablica <Tekst> nullWymagane: Słowa kluczowe dla wyszukiwarek w wybranym języku.

Przykład: ["example"]
meta_titleTekst nullWymagane: Tytuł dla wyszukiwarek w wybranym języku.

Przykład: "example"
nameTekst nullWymagane: Nazwa zasobu we właściwym kontekście.

Przykład: "Example"
numberTekstWymagane: Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

Przykład: "example"
parent_idTekst nullWymagane: Identyfikator kategorii nadrzędnej.

Przykład: null
slugTekst nullWymagane: Fragment ścieżki URL w wybranym języku.

Przykład: "example"
updated_atTekstWymagane: Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"
versionLiczba całkowitaWymagane: Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Pobierz listę kategorii — Odpowiedź

CategorySummaryData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

created_atTekstWymagane: Data i czas utworzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"
idTekstWymagane: Identyfikator zasobu; zachowaj wartość zwróconą przez API. (CategorySummaryData).

Przykład: "example"
is_availableWartość logicznaWymagane: Czy pozycja jest dostępna w tym kontekście.

Przykład: true
is_visibleWartość logicznaWymagane: Czy zasób jest widoczny.

Przykład: false
nameTekst nullWymagane: Nazwa zasobu we właściwym kontekście.

Przykład: "Example"
numberTekstWymagane: Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

Przykład: "example"
parent_idTekst nullWymagane: Identyfikator kategorii nadrzędnej.

Przykład: null
slugTekst nullWymagane: Fragment ścieżki URL w wybranym języku.

Przykład: "example"
updated_atTekstWymagane: Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"
versionLiczba całkowitaWymagane: Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Zmień kategorię — Treść żądania

CategoryUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

descriptionTekst nullOpcjonalne: Opis w wybranym języku.

Tekst:maxLength: 50000
expected_versionLiczba całkowitaWymagane: Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807

Przykład: 1
introductionTekst nullOpcjonalne: Tekst wprowadzający w wybranym języku.

Tekst:maxLength: 5000
is_visibleWartość logicznaOpcjonalne: Czy zasób jest widoczny.
market_idsTablica <Tekst> Opcjonalne: Identyfikatory wybranych rynków.

maxItems: 1000
Tablica:minLength: 1maxLength: 63
meta_descriptionTekst nullOpcjonalne: Opis dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 160
meta_keywordsTablica <Tekst> nullOpcjonalne: Słowa kluczowe dla wyszukiwarek w wybranym języku.

Tablica:maxItems: 20
Tablica / Tablica:maxLength: 50
meta_titleTekst nullOpcjonalne: Tytuł dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 70
nameTekst nullOpcjonalne: Nazwa zasobu we właściwym kontekście.

Tekst:maxLength: 200

Przykład: "Example"
parent_idTekst nullOpcjonalne: Identyfikator kategorii nadrzędnej.

Tekst:minLength: 1maxLength: 63
slugTekst nullOpcjonalne: Fragment ścieżki URL w wybranym języku.

Tekst:maxLength: 160

Dodatkowe pola: Nie