Datu shēmas: Varianti un opcijas

Datu shēmas: Varianti un opcijas. API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Datu shēmas

Saraksts · Produkta varianti — Varianti un opcijas — Atbilde

ApiResponse_list_ProductVariantData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataMasīvs <ProductVariantData > Obligāts: Atbildes piemērs · ApiResponse_list_ProductVariantData__.

Piemērs: [{"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 Obligāts: Atbildes metadati.

Piemērs: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildu lauki: Nē

Saraksts · Opcijas — Varianti un opcijas — Atbilde

ApiResponse_list_VariantOptionData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataMasīvs <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Obligāts: Atbildes piemērs · ApiResponse_list_VariantOptionData__.

Piemērs: [{"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 Obligāts: Atbildes metadati.

Piemērs: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildu lauki: Nē

Saraksts · Opciju vērtības — Varianti un opcijas — Atbilde

ApiResponse_list_VariantValueData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataMasīvs <VariantValueData > Obligāts: Atbildes piemērs · ApiResponse_list_VariantValueData__.

Piemērs: [{"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 Obligāts: Atbildes metadati.

Piemērs: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildu lauki: Nē

Iegūt · Produkta varianti — Varianti un opcijas — Atbilde

ApiResponse_ProductVariantData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataProductVariantData Obligāts: Atbildes piemērs · ProductVariantData.

Piemērs: {"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 Obligāts: Atbildes metadati.

Piemērs: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Papildu lauki: Nē

Iegūt · Opcijas — Varianti un opcijas — Atbilde

ApiResponse_VariantOptionData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Obligāts: Atbildes piemērs · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Piemērs: {"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 Obligāts: Atbildes metadati.

Piemērs: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Papildu lauki: Nē

Iegūt · Opciju vērtības — Varianti un opcijas — Atbilde

ApiResponse_VariantValueData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataVariantValueData Obligāts: Atbildes piemērs · VariantValueData.

Piemērs: {"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 Obligāts: Atbildes metadati.

Piemērs: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Papildu lauki: Nē

Iegūt · Opcijas — Varianti un opcijas — Atbilde

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

created_atVirkneObligāts

Izveides laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Piemērs: "example"

nameVirkne nullObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"

numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "example"

positionVesels skaitlisObligāts

Pozīcija sakārtotā kolekcijā.

Piemērs: 1

selection_typeVirkneObligāts

Atļautais īpašību vērtību izvēles režīms.

Ierobežojumi

enum: ["button", "dropdown"]

Piemērs: "button"

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

value_presentation_typeVirkneObligāts

Vārdnīcas vērtību attēlošanas veids.

Ierobežojumi

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

Piemērs: "text"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Iegūt · Produkta varianti — Varianti un opcijas — Atbilde

ProductVariantData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

activeLoģiska vērtībaObligāts: Vai resurss ir aktīvs.

Piemērs: true
created_atVirkneObligāts: Izveides laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"
idVirkneObligāts: Resursa identifikators; saglabājiet to atgrieztajā formā. (ProductVariantData).

Piemērs: "example"
is_defaultLoģiska vērtībaObligāts: Vai šī ir noklusējuma izvēle.

Piemērs: true
media_idsMasīvs <Virkne> Obligāts: Jau esošu multivides resursu identifikatori.

Piemērs: ["example"]
positionVesels skaitlisObligāts: Pozīcija sakārtotā kolekcijā.

Piemērs: 1
pricingVariantPricingData Obligāts: Cenu konfigurācija un tās vienlaicīgu izmaiņu versijas.

Piemērs: {"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_idVirkne nullObligāts: Galvenā multivides resursa identifikators.

Piemērs: "example"
product_idVirkneObligāts: Produkta identifikators.

Piemērs: "example"
skuVirkneObligāts: Krājumu uzskaites vienības kods.

Piemērs: "example"
updated_atVirkneObligāts: Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"
valuesMasīvs <VariantChoiceData > Obligāts: Vārdnīcas vērtības.

Piemērs: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionVesels skaitlisObligāts: Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Vārdnīcas vērtības

VariantChoiceData · Shēma · Datu shēmas: Varianti un opcijas

option_idVirkneObligāts: Varianta opcijas identifikators.

Piemērs: "example"
option_nameVirkne nullObligāts: Varianta opcijas nosaukums.

Piemērs: "example"
valueVirkne nullObligāts: Apkārtējā shēmā aprakstītā vērtība.

Piemērs: "example"
value_idVirkneObligāts: Vārdnīcas vērtības identifikators.

Piemērs: "example"

Papildu lauki: Nē

Izveidot · Produkta varianti — Varianti un opcijas — Pieprasījuma saturs

VariantCreate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

activeLoģiska vērtībaNeobligāts

Vai resurss ir aktīvs.

Noklusējums: true

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

is_defaultLoģiska vērtībaNeobligāts

Vai šī ir noklusējuma izvēle.

media_idsMasīvs <Virkne> Neobligāts

Jau esošu multivides resursu identifikatori.

maxItems: 20

Masīvs:minLength: 1maxLength: 63

pricingVariantPrice Neobligāts

Cenu konfigurācija un tās vienlaicīgu izmaiņu versijas.

skuVirkneNeobligāts

Krājumu uzskaites vienības kods.

minLength: 1maxLength: 100

Ierobežojumi

pattern: "^\\S+$"

value_idsMasīvs <Virkne> Obligāts

Vārdnīcas vērtību identifikatori.

minItems: 1maxItems: 250

Masīvs:minLength: 1maxLength: 63

Piemērs: ["example"]

Papildu lauki: Nē

Izveidot · Opcijas — Varianti un opcijas — Pieprasījuma saturs

VariantOptionCreate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

minLength: 1maxLength: 120

Ierobežojumi

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

Piemērs: "Example"

selection_typeVirkneNeobligāts

Atļautais īpašību vērtību izvēles režīms.

Ierobežojumi

enum: ["button", "dropdown"]

Noklusējums: "button"

value_presentation_typeVirkneNeobligāts

Vārdnīcas vērtību attēlošanas veids.

Ierobežojumi

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

Noklusējums: "text"

Papildu lauki: Nē

Atjaunināt · Opcijas — Varianti un opcijas — Pieprasījuma saturs

VariantOptionUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

nameVirkne nullNeobligāts

Resursa nosaukums attiecīgajā kontekstā.

Virkne:minLength: 1maxLength: 120

Ierobežojumi · Virkne 1

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

Piemērs: "Example"

selection_typeVirkneNeobligāts

Atļautais īpašību vērtību izvēles režīms.

Ierobežojumi

enum: ["button", "dropdown"]

value_presentation_typeVirkneNeobligāts

Vārdnīcas vērtību attēlošanas veids.

Ierobežojumi

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

Papildu lauki: Nē

Cenu konfigurācija un tās vienlaicīgu izmaiņu versijas

VariantPrice · Shēma · Datu shēmas: Varianti un opcijas

amountVirkne nullObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Virkne:maxLength: 20

Ierobežojumi · Virkne 1

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

Piemērs: "0.00"

currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi

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

Piemērs: "PLN"

expected_price_list_versionVesels skaitlisObligāts

Iepriekš nolasītā cenrāža versija, kas nepieciešama rakstīšanai.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

expected_product_versionVesels skaitlisObligāts

Iepriekš nolasītā produkta versija, kas nepieciešama rakstīšanai.

minimum: 0maximum: 9223372036854775807

Piemērs: 1

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 0maximum: 9223372036854775807

Piemērs: 0

kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi

enum: ["base_adjustment", "market_fixed"]

Piemērs: "base_adjustment"

price_list_idVirkneObligāts

Cenrāža identifikators.

minLength: 1maxLength: 63

Piemērs: "example"

Papildu lauki: Nē

Cenu konfigurācija un tās vienlaicīgu izmaiņu versijas

VariantPricingData · Shēma · Datu shēmas: Varianti un opcijas

base_adjustmentMoneyData Obligāts: Cenas korekcija attiecībā pret bāzes cenu.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullObligāts: Cena izvēlētajā tirgū.

Piemērs: null
pricePriceData nullObligāts: Cenas informācija izvēlētajā kontekstā.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionVesels skaitlisObligāts: Pašreizējā produkta versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1
versionVesels skaitlisObligāts: Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Atjaunināt · Produkta varianti — Varianti un opcijas — Pieprasījuma saturs

VariantUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

activeLoģiska vērtībaNeobligāts

Vai resurss ir aktīvs.

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

is_defaultLoģiska vērtībaNeobligāts

Vai šī ir noklusējuma izvēle.

media_idsMasīvs <Virkne> Neobligāts

Jau esošu multivides resursu identifikatori.

maxItems: 20

Masīvs:minLength: 1maxLength: 63

pricingVariantPrice Neobligāts

Cenu konfigurācija un tās vienlaicīgu izmaiņu versijas.

Piemērs:

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

skuVirkneNeobligāts

Krājumu uzskaites vienības kods.

minLength: 1maxLength: 100

Ierobežojumi

pattern: "^\\S+$"

Piemērs: "example"

Papildu lauki: Nē

Izveidot · Opciju vērtības — Varianti un opcijas — Pieprasījuma saturs

VariantValueCreate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

color_hexVirkne nullNeobligāts

Krāsa heksadecimālā koda formā.

Ierobežojumi · Virkne 1

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

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

valueVirkneObligāts

Apkārtējā shēmā aprakstītā vērtība.

minLength: 1maxLength: 180

Ierobežojumi

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

Piemērs: "Example"

Papildu lauki: Nē

Iegūt · Opciju vērtības — Varianti un opcijas — Atbilde

VariantValueData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

color_hexVirkne nullObligāts: Krāsa heksadecimālā koda formā.

Piemērs: "#008855"
created_atVirkneObligāts: Izveides laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"
idVirkneObligāts: Resursa identifikators; saglabājiet to atgrieztajā formā. (VariantValueData).

Piemērs: "example"
image_media_idVirkne nullObligāts: Izvēlētā attēla resursa identifikators.

Piemērs: null
numberVirkneObligāts: Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "example"
option_idVirkneObligāts: Varianta opcijas identifikators.

Piemērs: "example"
positionVesels skaitlisObligāts: Pozīcija sakārtotā kolekcijā.

Piemērs: 1
sku_codeVirkneObligāts: Krājumu uzskaites vienības kods.

Piemērs: "example"
updated_atVirkneObligāts: Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"
valueVirkne nullObligāts: Apkārtējā shēmā aprakstītā vērtība.

Piemērs: "example"
versionVesels skaitlisObligāts: Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Atjaunināt · Opciju vērtības — Varianti un opcijas — Pieprasījuma saturs

VariantValueUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

color_hexVirkne nullNeobligāts

Krāsa heksadecimālā koda formā.

Ierobežojumi · Virkne 1

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

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

valueVirkne nullNeobligāts

Apkārtējā shēmā aprakstītā vērtība.

Virkne:minLength: 1maxLength: 180

Ierobežojumi · Virkne 1

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

Piemērs: "Example"

Papildu lauki: Nē