Modele wariantów i opcji

Schematy wariantów produktów, opcji i ich wartości w Shopently API. Poznaj struktury odczytu, tworzenia i edycji danych.

Schematy danych

Pobierz listę wariantów produktu — Odpowiedź

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

dataTablica <ProductVariantData > Wymagane: Przykład odpowiedzi · ApiResponse_list_ProductVariantData__.

Przykład: [{"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"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

Pobierz listę opcji wariantów — Odpowiedź

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

dataTablica <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Wymagane: Przykład odpowiedzi · ApiResponse_list_VariantOptionData__.

Przykład: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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 opcji wariantów — Odpowiedź

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

dataTablica <VariantValueData > Wymagane: Przykład odpowiedzi · ApiResponse_list_VariantValueData__.

Przykład: [{"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","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

Pobierz wariant produktu — Odpowiedź

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

dataProductVariantData Wymagane: Przykład odpowiedzi · ProductVariantData.

Przykład: {"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"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 opcję wariantów — Odpowiedź

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

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Wymagane: Przykład odpowiedzi · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Przykład: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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ść opcji wariantów — Odpowiedź

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

dataVariantValueData Wymagane: Przykład odpowiedzi · VariantValueData.

Przykład: {"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","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 opcję wariantów — Odpowiedź

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

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

selection_typeTekstWymagane

Dozwolony sposób wyboru wartości cechy.

Ograniczenia

enum: ["button", "dropdown"]

Przykład: "button"

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

value_presentation_typeTekstWymagane

Sposób prezentacji wartości słownikowych.

Ograniczenia

enum: ["text", "color", "image"]

Przykład: "text"

versionLiczba całkowitaWymagane

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

Przykład: 1

Dodatkowe pola: Nie

Pobierz wariant produktu — Odpowiedź

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

activeWartość logicznaWymagane: Czy zasób jest aktywny.

Przykład: true
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. (ProductVariantData).

Przykład: "example"
is_defaultWartość logicznaWymagane: Czy jest to wybór domyślny.

Przykład: true
media_idsTablica <Tekst> Wymagane: Identyfikatory istniejących już zasobów mediów.

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

Przykład: 1
pricingVariantPricingData Wymagane: Konfiguracja ceny i jej wersje do kontroli współbieżności.

Przykład: {"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1}
primary_media_idTekst nullWymagane: Identyfikator głównego zasobu mediów.

Przykład: "example"
product_idTekstWymagane: Identyfikator produktu.

Przykład: "example"
skuTekstWymagane: Kod jednostki magazynowej SKU.

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

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"
valuesTablica <VariantChoiceData > Wymagane: Wartości słownikowe.

Przykład: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionLiczba całkowitaWymagane: Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Wartości słownikowe

VariantChoiceData · Schemat · Modele wariantów i opcji

option_idTekstWymagane: Identyfikator opcji wariantu.

Przykład: "example"
option_nameTekst nullWymagane: Nazwa opcji wariantu.

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

Utwórz wariant produktu — Treść żądania

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

activeWartość logicznaOpcjonalne

Czy zasób jest aktywny.

Wartość domyślna: true

expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807

Przykład: 1

is_defaultWartość logicznaOpcjonalne

Czy jest to wybór domyślny.

media_idsTablica <Tekst> Opcjonalne

Identyfikatory istniejących już zasobów mediów.

maxItems: 20

Tablica:minLength: 1maxLength: 63

pricingVariantPrice Opcjonalne

Konfiguracja ceny i jej wersje do kontroli współbieżności.

skuTekstOpcjonalne

Kod jednostki magazynowej SKU.

minLength: 1maxLength: 100

Ograniczenia

pattern: "^\\S+$"

value_idsTablica <Tekst> Wymagane

Identyfikatory wartości słownikowych.

minItems: 1maxItems: 250

Tablica:minLength: 1maxLength: 63

Przykład: ["example"]

Dodatkowe pola: Nie

Utwórz opcję wariantów — Treść żądania

VariantOptionCreate · 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"

selection_typeTekstOpcjonalne

Dozwolony sposób wyboru wartości cechy.

Ograniczenia

enum: ["button", "dropdown"]

Wartość domyślna: "button"

value_presentation_typeTekstOpcjonalne

Sposób prezentacji wartości słownikowych.

Ograniczenia

enum: ["text", "color", "image"]

Wartość domyślna: "text"

Dodatkowe pola: Nie

Zmień opcję wariantów — Treść żądania

VariantOptionUpdate · 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"

selection_typeTekstOpcjonalne

Dozwolony sposób wyboru wartości cechy.

Ograniczenia

enum: ["button", "dropdown"]

value_presentation_typeTekstOpcjonalne

Sposób prezentacji wartości słownikowych.

Ograniczenia

enum: ["text", "color", "image"]

Dodatkowe pola: Nie

Konfiguracja ceny i jej wersje do kontroli współbieżności

VariantPrice · Schemat · Modele wariantów i opcji

amountTekst nullWymagane

Kwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.

Tekst:maxLength: 20

Ograniczenia · Tekst 1

pattern: "^-?(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Przykład: "0.00"

currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia

pattern: "^[A-Z]{3}$"

Przykład: "PLN"

expected_price_list_versionLiczba całkowitaWymagane

Odczytana wcześniej wersja cennika wymagana przy tym zapisie.

minimum: 1maximum: 9223372036854775807

Przykład: 1

expected_product_versionLiczba całkowitaWymagane

Odczytana wcześniej wersja produktu wymagana przy tym zapisie.

minimum: 0maximum: 9223372036854775807

Przykład: 1

expected_versionLiczba całkowitaWymagane

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

minimum: 0maximum: 9223372036854775807

Przykład: 0

kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia

enum: ["base_adjustment", "market_fixed"]

Przykład: "base_adjustment"

price_list_idTekstWymagane

Identyfikator cennika.

minLength: 1maxLength: 63

Przykład: "example"

Dodatkowe pola: Nie

Konfiguracja ceny i jej wersje do kontroli współbieżności

VariantPricingData · Schemat · Modele wariantów i opcji

base_adjustmentMoneyData Wymagane: Korekta ceny względem ceny bazowej.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullWymagane: Cena dla wybranego rynku.

Przykład: null
pricePriceData nullWymagane: Informacje o cenie w wybranym kontekście.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionLiczba całkowitaWymagane: Bieżąca wersja produktu do kontroli współbieżności.

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

Przykład: 1

Dodatkowe pola: Nie

Zmień wariant produktu — Treść żądania

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

activeWartość logicznaOpcjonalne

Czy zasób jest aktywny.

expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807

Przykład: 1

is_defaultWartość logicznaOpcjonalne

Czy jest to wybór domyślny.

media_idsTablica <Tekst> Opcjonalne

Identyfikatory istniejących już zasobów mediów.

maxItems: 20

Tablica:minLength: 1maxLength: 63

pricingVariantPrice Opcjonalne

Konfiguracja ceny i jej wersje do kontroli współbieżności.

Przykład:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}

skuTekstOpcjonalne

Kod jednostki magazynowej SKU.

minLength: 1maxLength: 100

Ograniczenia

pattern: "^\\S+$"

Przykład: "example"

Dodatkowe pola: Nie

Utwórz wartość opcji wariantów — Treść żądania

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

color_hexTekst nullOpcjonalne

Kolor zapisany kodem szesnastkowym.

Ograniczenia · Tekst 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807

Przykład: 1

valueTekstWymagane

Wartość opisana przez otaczający schemat.

minLength: 1maxLength: 180

Ograniczenia

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

Przykład: "Example"

Dodatkowe pola: Nie

Pobierz wartość opcji wariantów — Odpowiedź

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

color_hexTekst nullWymagane: Kolor zapisany kodem szesnastkowym.

Przykład: "#008855"
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. (VariantValueData).

Przykład: "example"
image_media_idTekst nullWymagane: Identyfikator wybranego zasobu zdjęcia.

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

Przykład: "example"
option_idTekstWymagane: Identyfikator opcji wariantu.

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

Przykład: 1
sku_codeTekstWymagane: Kod jednostki magazynowej SKU.

Przykład: "example"
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ść opcji wariantów — Treść żądania

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

color_hexTekst nullOpcjonalne

Kolor zapisany kodem szesnastkowym.

Ograniczenia · Tekst 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807

Przykład: 1

valueTekst nullOpcjonalne

Wartość opisana przez otaczający schemat.

Tekst:minLength: 1maxLength: 180

Ograniczenia · Tekst 1

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

Przykład: "Example"

Dodatkowe pola: Nie