Duomenų schemos: Variantai ir parinktys

Duomenų schemos: Variantai ir parinktys. API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Duomenų schemos

Sąrašas · Prekės variantai — Variantai ir parinktys — Atsakymas

ApiResponse_list_ProductVariantData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataMasyvas <ProductVariantData > Privalomas: Atsakymo pavyzdys · ApiResponse_list_ProductVariantData__.

Pavyzdys: [{"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Sąrašas · Parinktys — Variantai ir parinktys — Atsakymas

ApiResponse_list_VariantOptionData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataMasyvas <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Privalomas: Atsakymo pavyzdys · ApiResponse_list_VariantOptionData__.

Pavyzdys: [{"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Sąrašas · Parinkčių reikšmės — Variantai ir parinktys — Atsakymas

ApiResponse_list_VariantValueData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataMasyvas <VariantValueData > Privalomas: Atsakymo pavyzdys · ApiResponse_list_VariantValueData__.

Pavyzdys: [{"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Gauti · Prekės variantai — Variantai ir parinktys — Atsakymas

ApiResponse_ProductVariantData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataProductVariantData Privalomas: Atsakymo pavyzdys · ProductVariantData.

Pavyzdys: {"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 Privalomas: Atsakymo metaduomenys.

Pavyzdys: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Papildomi laukai: Ne

Gauti · Parinktys — Variantai ir parinktys — Atsakymas

ApiResponse_VariantOptionData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Privalomas: Atsakymo pavyzdys · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Pavyzdys: {"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 Privalomas: Atsakymo metaduomenys.

Pavyzdys: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Papildomi laukai: Ne

Gauti · Parinkčių reikšmės — Variantai ir parinktys — Atsakymas

ApiResponse_VariantValueData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataVariantValueData Privalomas: Atsakymo pavyzdys · VariantValueData.

Pavyzdys: {"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 Privalomas: Atsakymo metaduomenys.

Pavyzdys: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Papildomi laukai: Ne

Gauti · Parinktys — Variantai ir parinktys — Atsakymas

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"

Pavyzdys: "2026-01-01T12:00:00Z"

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Pavyzdys: "example"

nameEilutė nullPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Example"

numberEilutėPrivalomas

Žmogui rodomas užsakymo arba prašymo numeris.

Pavyzdys: "example"

positionSveikasis skaičiusPrivalomas

Pozicija surikiuotame rinkinyje.

Pavyzdys: 1

selection_typeEilutėPrivalomas

Leidžiamas savybės reikšmių pasirinkimo būdas.

Apribojimai

enum: ["button", "dropdown"]

Pavyzdys: "button"

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

Pavyzdys: "2026-01-01T12:00:00Z"

value_presentation_typeEilutėPrivalomas

Žinyno reikšmių pateikimo būdas.

Apribojimai

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

Pavyzdys: "text"

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Gauti · Prekės variantai — Variantai ir parinktys — Atsakymas

ProductVariantData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

activeLoginė reikšmėPrivalomas: Ar išteklius aktyvus.

Pavyzdys: true
created_atEilutėPrivalomas: Sukūrimo laikas.

format: "date-time"

Pavyzdys: "2026-01-01T12:00:00Z"
idEilutėPrivalomas: Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (ProductVariantData).

Pavyzdys: "example"
is_defaultLoginė reikšmėPrivalomas: Ar tai numatytasis pasirinkimas.

Pavyzdys: true
media_idsMasyvas <Eilutė> Privalomas: Jau esamų medijos failų identifikatoriai.

Pavyzdys: ["example"]
positionSveikasis skaičiusPrivalomas: Pozicija surikiuotame rinkinyje.

Pavyzdys: 1
pricingVariantPricingData Privalomas: Kainodaros konfigūracija ir lygiagrečių pakeitimų kontrolės versijos.

Pavyzdys: {"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_idEilutė nullPrivalomas: Pagrindinio medijos failo identifikatorius.

Pavyzdys: "example"
product_idEilutėPrivalomas: Produkto identifikatorius.

Pavyzdys: "example"
skuEilutėPrivalomas: Atsargų apskaitos vieneto kodas.

Pavyzdys: "example"
updated_atEilutėPrivalomas: Paskutinio atnaujinimo laikas.

format: "date-time"

Pavyzdys: "2026-01-01T12:00:00Z"
valuesMasyvas <VariantChoiceData > Privalomas: Žinyno reikšmės.

Pavyzdys: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionSveikasis skaičiusPrivalomas: Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Žinyno reikšmės

VariantChoiceData · Schema · Duomenų schemos: Variantai ir parinktys

option_idEilutėPrivalomas: Varianto parinkties identifikatorius.

Pavyzdys: "example"
option_nameEilutė nullPrivalomas: Varianto parinkties pavadinimas.

Pavyzdys: "example"
valueEilutė nullPrivalomas: Aplinkine schema aprašyta reikšmė.

Pavyzdys: "example"
value_idEilutėPrivalomas: Žinyno reikšmės identifikatorius.

Pavyzdys: "example"

Papildomi laukai: Ne

Sukurti · Prekės variantai — Variantai ir parinktys — Užklausos turinys

VariantCreate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

activeLoginė reikšmėNeprivalomas

Ar išteklius aktyvus.

Numatytoji reikšmė: true

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

is_defaultLoginė reikšmėNeprivalomas

Ar tai numatytasis pasirinkimas.

media_idsMasyvas <Eilutė> Neprivalomas

Jau esamų medijos failų identifikatoriai.

maxItems: 20

Masyvas:minLength: 1maxLength: 63

pricingVariantPrice Neprivalomas

Kainodaros konfigūracija ir lygiagrečių pakeitimų kontrolės versijos.

skuEilutėNeprivalomas

Atsargų apskaitos vieneto kodas.

minLength: 1maxLength: 100

Apribojimai

pattern: "^\\S+$"

value_idsMasyvas <Eilutė> Privalomas

Žinyno reikšmių identifikatoriai.

minItems: 1maxItems: 250

Masyvas:minLength: 1maxLength: 63

Pavyzdys: ["example"]

Papildomi laukai: Ne

Sukurti · Parinktys — Variantai ir parinktys — Užklausos turinys

VariantOptionCreate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

minLength: 1maxLength: 120

Apribojimai

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

Pavyzdys: "Example"

selection_typeEilutėNeprivalomas

Leidžiamas savybės reikšmių pasirinkimo būdas.

Apribojimai

enum: ["button", "dropdown"]

Numatytoji reikšmė: "button"

value_presentation_typeEilutėNeprivalomas

Žinyno reikšmių pateikimo būdas.

Apribojimai

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

Numatytoji reikšmė: "text"

Papildomi laukai: Ne

Atnaujinti · Parinktys — Variantai ir parinktys — Užklausos turinys

VariantOptionUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

nameEilutė nullNeprivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Eilutė:minLength: 1maxLength: 120

Apribojimai · Eilutė 1

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

Pavyzdys: "Example"

selection_typeEilutėNeprivalomas

Leidžiamas savybės reikšmių pasirinkimo būdas.

Apribojimai

enum: ["button", "dropdown"]

value_presentation_typeEilutėNeprivalomas

Žinyno reikšmių pateikimo būdas.

Apribojimai

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

Papildomi laukai: Ne

Kainodaros konfigūracija ir lygiagrečių pakeitimų kontrolės versijos

VariantPrice · Schema · Duomenų schemos: Variantai ir parinktys

amountEilutė nullPrivalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

Eilutė:maxLength: 20

Apribojimai · Eilutė 1

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

Pavyzdys: "0.00"

currencyEilutėPrivalomas

Sumos valiutos kodas.

Apribojimai

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

Pavyzdys: "PLN"

expected_price_list_versionSveikasis skaičiusPrivalomas

Anksčiau perskaityta kainoraščio versija, būtina šiam įrašymui.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

expected_product_versionSveikasis skaičiusPrivalomas

Anksčiau perskaityta produkto versija, būtina šiam įrašymui.

minimum: 0maximum: 9223372036854775807

Pavyzdys: 1

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 0maximum: 9223372036854775807

Pavyzdys: 0

kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai

enum: ["base_adjustment", "market_fixed"]

Pavyzdys: "base_adjustment"

price_list_idEilutėPrivalomas

Kainoraščio identifikatorius.

minLength: 1maxLength: 63

Pavyzdys: "example"

Papildomi laukai: Ne

Kainodaros konfigūracija ir lygiagrečių pakeitimų kontrolės versijos

VariantPricingData · Schema · Duomenų schemos: Variantai ir parinktys

base_adjustmentMoneyData Privalomas: Kainos korekcija bazinės kainos atžvilgiu.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullPrivalomas: Pasirinktos rinkos kaina.

Pavyzdys: null
pricePriceData nullPrivalomas: Kainos informacija pasirinktame kontekste.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionSveikasis skaičiusPrivalomas: Dabartinė produkto versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1
versionSveikasis skaičiusPrivalomas: Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Atnaujinti · Prekės variantai — Variantai ir parinktys — Užklausos turinys

VariantUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

activeLoginė reikšmėNeprivalomas

Ar išteklius aktyvus.

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

is_defaultLoginė reikšmėNeprivalomas

Ar tai numatytasis pasirinkimas.

media_idsMasyvas <Eilutė> Neprivalomas

Jau esamų medijos failų identifikatoriai.

maxItems: 20

Masyvas:minLength: 1maxLength: 63

pricingVariantPrice Neprivalomas

Kainodaros konfigūracija ir lygiagrečių pakeitimų kontrolės versijos.

Pavyzdys:

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

skuEilutėNeprivalomas

Atsargų apskaitos vieneto kodas.

minLength: 1maxLength: 100

Apribojimai

pattern: "^\\S+$"

Pavyzdys: "example"

Papildomi laukai: Ne

Sukurti · Parinkčių reikšmės — Variantai ir parinktys — Užklausos turinys

VariantValueCreate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

color_hexEilutė nullNeprivalomas

Spalva šešioliktainiu kodu.

Apribojimai · Eilutė 1

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

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

valueEilutėPrivalomas

Aplinkine schema aprašyta reikšmė.

minLength: 1maxLength: 180

Apribojimai

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

Pavyzdys: "Example"

Papildomi laukai: Ne

Gauti · Parinkčių reikšmės — Variantai ir parinktys — Atsakymas

VariantValueData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

color_hexEilutė nullPrivalomas: Spalva šešioliktainiu kodu.

Pavyzdys: "#008855"
created_atEilutėPrivalomas: Sukūrimo laikas.

format: "date-time"

Pavyzdys: "2026-01-01T12:00:00Z"
idEilutėPrivalomas: Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (VariantValueData).

Pavyzdys: "example"
image_media_idEilutė nullPrivalomas: Pasirinkto paveikslėlio failo identifikatorius.

Pavyzdys: null
numberEilutėPrivalomas: Žmogui rodomas užsakymo arba prašymo numeris.

Pavyzdys: "example"
option_idEilutėPrivalomas: Varianto parinkties identifikatorius.

Pavyzdys: "example"
positionSveikasis skaičiusPrivalomas: Pozicija surikiuotame rinkinyje.

Pavyzdys: 1
sku_codeEilutėPrivalomas: Atsargų apskaitos vieneto kodas.

Pavyzdys: "example"
updated_atEilutėPrivalomas: Paskutinio atnaujinimo laikas.

format: "date-time"

Pavyzdys: "2026-01-01T12:00:00Z"
valueEilutė nullPrivalomas: Aplinkine schema aprašyta reikšmė.

Pavyzdys: "example"
versionSveikasis skaičiusPrivalomas: Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Atnaujinti · Parinkčių reikšmės — Variantai ir parinktys — Užklausos turinys

VariantValueUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

color_hexEilutė nullNeprivalomas

Spalva šešioliktainiu kodu.

Apribojimai · Eilutė 1

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

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

valueEilutė nullNeprivalomas

Aplinkine schema aprašyta reikšmė.

Eilutė:minLength: 1maxLength: 180

Apribojimai · Eilutė 1

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

Pavyzdys: "Example"

Papildomi laukai: Ne