Andmeskeemid: Variandid ja valikud

Andmeskeemid: Variandid ja valikud. API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

Loend · Tootevariandid — Variandid ja valikud — Vastus

ApiResponse_list_ProductVariantData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <ProductVariantData > Kohustuslik: Vastuse näide · ApiResponse_list_ProductVariantData__.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

Näide: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Loend · Valikud — Variandid ja valikud — Vastus

ApiResponse_list_VariantOptionData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Kohustuslik: Vastuse näide · ApiResponse_list_VariantOptionData__.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

Näide: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Loend · Valikute väärtused — Variandid ja valikud — Vastus

ApiResponse_list_VariantValueData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <VariantValueData > Kohustuslik: Vastuse näide · ApiResponse_list_VariantValueData__.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

Näide: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Hangi · Tootevariandid — Variandid ja valikud — Vastus

ApiResponse_ProductVariantData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataProductVariantData Kohustuslik: Vastuse näide · ProductVariantData.

Näide: {"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 Kohustuslik: Vastuse metaandmed.

Näide: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Lisaväljad: Ei

Hangi · Valikud — Variandid ja valikud — Vastus

ApiResponse_VariantOptionData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Kohustuslik: Vastuse näide · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Näide: {"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 Kohustuslik: Vastuse metaandmed.

Näide: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Lisaväljad: Ei

Hangi · Valikute väärtused — Variandid ja valikud — Vastus

ApiResponse_VariantValueData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataVariantValueData Kohustuslik: Vastuse näide · VariantValueData.

Näide: {"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 Kohustuslik: Vastuse metaandmed.

Näide: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Lisaväljad: Ei

Hangi · Valikud — Variandid ja valikud — Vastus

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Näide: "example"

nameString nullKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Example"

numberStringKohustuslik

Kasutajale mõeldud tellimuse või pöördumise number.

Näide: "example"

positionTäisarvKohustuslik

Asukoht järjestatud kogumis.

Näide: 1

selection_typeStringKohustuslik

Omaduseväärtuste lubatud valimisviis.

Piirangud

enum: ["button", "dropdown"]

Näide: "button"

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

value_presentation_typeStringKohustuslik

Sõnastikuväärtuste esitamise viis.

Piirangud

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

Näide: "text"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Hangi · Tootevariandid — Variandid ja valikud — Vastus

ProductVariantData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

activeTõeväärtusKohustuslik: Kas ressurss on aktiivne.

Näide: true
created_atStringKohustuslik: Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"
idStringKohustuslik: Ressursi identifikaator; säilita see tagastatud kujul. (ProductVariantData).

Näide: "example"
is_defaultTõeväärtusKohustuslik: Kas see on vaikevalik.

Näide: true
media_idsMassiiv <String> Kohustuslik: Olemasolevate meediafailide identifikaatorid.

Näide: ["example"]
positionTäisarvKohustuslik: Asukoht järjestatud kogumis.

Näide: 1
pricingVariantPricingData Kohustuslik: Hinnaseadistus ja selle samaaegsuse kontrolli versioonid.

Näide: {"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_idString nullKohustuslik: Peamise meediafaili identifikaator.

Näide: "example"
product_idStringKohustuslik: Toote identifikaator.

Näide: "example"
skuStringKohustuslik: Laoarvestusühiku kood.

Näide: "example"
updated_atStringKohustuslik: Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"
valuesMassiiv <VariantChoiceData > Kohustuslik: Sõnastikuväärtused.

Näide: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionTäisarvKohustuslik: Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Sõnastikuväärtused

VariantChoiceData · Skeem · Andmeskeemid: Variandid ja valikud

option_idStringKohustuslik: Variandivaliku identifikaator.

Näide: "example"
option_nameString nullKohustuslik: Variandivaliku nimi.

Näide: "example"
valueString nullKohustuslik: Ümbritsevas skeemis kirjeldatud väärtus.

Näide: "example"
value_idStringKohustuslik: Sõnastikuväärtuse identifikaator.

Näide: "example"

Lisaväljad: Ei

Loo · Tootevariandid — Variandid ja valikud — Päringu sisu

VariantCreate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

activeTõeväärtusValikuline

Kas ressurss on aktiivne.

Vaikeväärtus: true

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1

is_defaultTõeväärtusValikuline

Kas see on vaikevalik.

media_idsMassiiv <String> Valikuline

Olemasolevate meediafailide identifikaatorid.

maxItems: 20

Massiiv:minLength: 1maxLength: 63

pricingVariantPrice Valikuline

Hinnaseadistus ja selle samaaegsuse kontrolli versioonid.

skuStringValikuline

Laoarvestusühiku kood.

minLength: 1maxLength: 100

Piirangud

pattern: "^\\S+$"

value_idsMassiiv <String> Kohustuslik

Sõnastikuväärtuste identifikaatorid.

minItems: 1maxItems: 250

Massiiv:minLength: 1maxLength: 63

Näide: ["example"]

Lisaväljad: Ei

Loo · Valikud — Variandid ja valikud — Päringu sisu

VariantOptionCreate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 120

Piirangud

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

Näide: "Example"

selection_typeStringValikuline

Omaduseväärtuste lubatud valimisviis.

Piirangud

enum: ["button", "dropdown"]

Vaikeväärtus: "button"

value_presentation_typeStringValikuline

Sõnastikuväärtuste esitamise viis.

Piirangud

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

Vaikeväärtus: "text"

Lisaväljad: Ei

Muuda · Valikud — Variandid ja valikud — Päringu sisu

VariantOptionUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1

nameString nullValikuline

Ressursi nimi vastavas kontekstis.

String:minLength: 1maxLength: 120

Piirangud · String 1

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

Näide: "Example"

selection_typeStringValikuline

Omaduseväärtuste lubatud valimisviis.

Piirangud

enum: ["button", "dropdown"]

value_presentation_typeStringValikuline

Sõnastikuväärtuste esitamise viis.

Piirangud

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

Lisaväljad: Ei

Hinnaseadistus ja selle samaaegsuse kontrolli versioonid

VariantPrice · Skeem · Andmeskeemid: Variandid ja valikud

amountString nullKohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

String:maxLength: 20

Piirangud · String 1

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

Näide: "0.00"

currencyStringKohustuslik

Summa valuutakood.

Piirangud

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

Näide: "PLN"

expected_price_list_versionTäisarvKohustuslik

Selle muudatuse jaoks nõutav varem loetud hinnakirja versioon.

minimum: 1maximum: 9223372036854775807

Näide: 1

expected_product_versionTäisarvKohustuslik

Selle muudatuse jaoks nõutav varem loetud toote versioon.

minimum: 0maximum: 9223372036854775807

Näide: 1

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 0maximum: 9223372036854775807

Näide: 0

kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud

enum: ["base_adjustment", "market_fixed"]

Näide: "base_adjustment"

price_list_idStringKohustuslik

Hinnakirja identifikaator.

minLength: 1maxLength: 63

Näide: "example"

Lisaväljad: Ei

Hinnaseadistus ja selle samaaegsuse kontrolli versioonid

VariantPricingData · Skeem · Andmeskeemid: Variandid ja valikud

base_adjustmentMoneyData Kohustuslik: Hinna korrigeerimine baashinna suhtes.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullKohustuslik: Valitud turu hind.

Näide: null
pricePriceData nullKohustuslik: Hinnateave valitud kontekstis.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionTäisarvKohustuslik: Toote kehtiv versioon samaaegsuse kontrolliks.

Näide: 1
versionTäisarvKohustuslik: Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Muuda · Tootevariandid — Variandid ja valikud — Päringu sisu

VariantUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

activeTõeväärtusValikuline

Kas ressurss on aktiivne.

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1

is_defaultTõeväärtusValikuline

Kas see on vaikevalik.

media_idsMassiiv <String> Valikuline

Olemasolevate meediafailide identifikaatorid.

maxItems: 20

Massiiv:minLength: 1maxLength: 63

pricingVariantPrice Valikuline

Hinnaseadistus ja selle samaaegsuse kontrolli versioonid.

Näide:

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

skuStringValikuline

Laoarvestusühiku kood.

minLength: 1maxLength: 100

Piirangud

pattern: "^\\S+$"

Näide: "example"

Lisaväljad: Ei

Loo · Valikute väärtused — Variandid ja valikud — Päringu sisu

VariantValueCreate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

color_hexString nullValikuline

Kuueteistkümnendkoodina esitatud värv.

Piirangud · String 1

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

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1

valueStringKohustuslik

Ümbritsevas skeemis kirjeldatud väärtus.

minLength: 1maxLength: 180

Piirangud

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

Näide: "Example"

Lisaväljad: Ei

Hangi · Valikute väärtused — Variandid ja valikud — Vastus

VariantValueData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

color_hexString nullKohustuslik: Kuueteistkümnendkoodina esitatud värv.

Näide: "#008855"
created_atStringKohustuslik: Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"
idStringKohustuslik: Ressursi identifikaator; säilita see tagastatud kujul. (VariantValueData).

Näide: "example"
image_media_idString nullKohustuslik: Valitud pildifaili identifikaator.

Näide: null
numberStringKohustuslik: Kasutajale mõeldud tellimuse või pöördumise number.

Näide: "example"
option_idStringKohustuslik: Variandivaliku identifikaator.

Näide: "example"
positionTäisarvKohustuslik: Asukoht järjestatud kogumis.

Näide: 1
sku_codeStringKohustuslik: Laoarvestusühiku kood.

Näide: "example"
updated_atStringKohustuslik: Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"
valueString nullKohustuslik: Ümbritsevas skeemis kirjeldatud väärtus.

Näide: "example"
versionTäisarvKohustuslik: Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Muuda · Valikute väärtused — Variandid ja valikud — Päringu sisu

VariantValueUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

color_hexString nullValikuline

Kuueteistkümnendkoodina esitatud värv.

Piirangud · String 1

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

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1

valueString nullValikuline

Ümbritsevas skeemis kirjeldatud väärtus.

String:minLength: 1maxLength: 180

Piirangud · String 1

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

Näide: "Example"

Lisaväljad: Ei