Modele cech i wartości

Schematy cech i ich wartości w Shopently API. Poznaj pola słowników, strukturę odpowiedzi i dane przyjmowane podczas zapisu.

Schematy danych

Pobierz cechę — Odpowiedź

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

dataFeatureData Wymagane: Przykład odpowiedzi · FeatureData.

Przykład: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"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 wartość cechy — Odpowiedź

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

dataFeatureValueData Wymagane: Przykład odpowiedzi · FeatureValueData.

Przykład: {"created_at":"2026-01-01T12:00:00Z","feature_id":"example","id":"example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","value":"example","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ę cech — Odpowiedź

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

dataTablica <FeatureData > Wymagane: Przykład odpowiedzi · ApiResponse_list_FeatureData__.

Przykład: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"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

Pobierz listę wartości cechy — Odpowiedź

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

dataTablica <FeatureValueData > Wymagane: Przykład odpowiedzi · ApiResponse_list_FeatureValueData__.

Przykład: [{"created_at":"2026-01-01T12:00:00Z","feature_id":"example","id":"example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","value":"example","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 cechę — Treść żądania

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

nameTekstWymagane

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

minLength: 1maxLength: 120

Ograniczenia

pattern: "^[^\\x00]*$"

Przykład: "Example"

positionLiczba całkowitaOpcjonalne

Pozycja w uporządkowanej kolekcji.

minimum: 0maximum: 2147483647

Dodatkowe pola: Nie

Pobierz cechę — Odpowiedź

FeatureData · 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. (FeatureData).

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"
positionLiczba całkowitaWymagane: Pozycja w uporządkowanej kolekcji.

Przykład: 1
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

Cechy produktu

FeatureSelectionData · Schemat · Modele cech i wartości

feature_idTekstWymagane: Identyfikator cechy.

Przykład: "example"
feature_nameTekst nullWymagane: Nazwa cechy.

Przykład: "example"
valueTekst nullWymagane: Wartość opisana przez otaczający schemat.

Przykład: "example"
value_idTekstWymagane: Identyfikator wartości słownikowej.

Przykład: "example"

Dodatkowe pola: Nie

Zmień cechę — Treść żądania

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

expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807

Przykład: 1

nameTekst nullOpcjonalne

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

Tekst:minLength: 1maxLength: 120

Ograniczenia · Tekst 1

pattern: "^[^\\x00]*$"

Przykład: "Example"

positionLiczba całkowitaOpcjonalne

Pozycja w uporządkowanej kolekcji.

minimum: 0maximum: 2147483647

Dodatkowe pola: Nie

Utwórz wartość cechy — Treść żądania

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

expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807

Przykład: 1

positionLiczba całkowitaOpcjonalne

Pozycja w uporządkowanej kolekcji.

minimum: 0maximum: 2147483647

valueTekstWymagane

Wartość opisana przez otaczający schemat.

minLength: 1maxLength: 180

Ograniczenia

pattern: "^[^\\x00]*$"

Przykład: "Example"

Dodatkowe pola: Nie

Pobierz wartość cechy — Odpowiedź

FeatureValueData · 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"
feature_idTekstWymagane: Identyfikator cechy.

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

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

Przykład: "example"
positionLiczba całkowitaWymagane: Pozycja w uporządkowanej kolekcji.

Przykład: 1
updated_atTekstWymagane: Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"
valueTekst nullWymagane: Wartość opisana przez otaczający schemat.

Przykład: "example"
versionLiczba całkowitaWymagane: Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Zmień wartość cechy — Treść żądania

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

expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807

Przykład: 1

positionLiczba całkowitaOpcjonalne

Pozycja w uporządkowanej kolekcji.

minimum: 0maximum: 2147483647

valueTekst nullOpcjonalne

Wartość opisana przez otaczający schemat.

Tekst:minLength: 1maxLength: 180

Ograniczenia · Tekst 1

pattern: "^[^\\x00]*$"

Przykład: "Example"

Dodatkowe pola: Nie