Preskoči na vsebino
ShopentlyLearn

Podatkovne sheme: Različice izdelkov in možnosti

Podatkovne sheme: Različice izdelkov in možnosti. Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Podatkovne sheme

Prikaži seznam · Različice izdelka — Različice izdelkov in možnosti — Odgovor

ApiResponse_list_ProductVariantData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataPolje elementov <ProductVariantData > Obvezno

Primer odgovora · ApiResponse_list_ProductVariantData__.

Primer: [{"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 Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

Prikaži seznam · Možnosti — Različice izdelkov in možnosti — Odgovor

ApiResponse_list_VariantOptionData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataPolje elementov <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Obvezno

Primer odgovora · ApiResponse_list_VariantOptionData__.

Primer: [{"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 Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

Prikaži seznam · Vrednosti možnosti — Različice izdelkov in možnosti — Odgovor

ApiResponse_list_VariantValueData__ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataPolje elementov <VariantValueData > Obvezno

Primer odgovora · ApiResponse_list_VariantValueData__.

Primer: [{"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 Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

Pridobi · Različice izdelka — Različice izdelkov in možnosti — Odgovor

ApiResponse_ProductVariantData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataProductVariantData Obvezno

Primer odgovora · ProductVariantData.

Primer: {"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 Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

Pridobi · Možnosti — Različice izdelkov in možnosti — Odgovor

ApiResponse_VariantOptionData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Obvezno

Primer odgovora · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Primer: {"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 Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

Pridobi · Vrednosti možnosti — Različice izdelkov in možnosti — Odgovor

ApiResponse_VariantValueData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataVariantValueData Obvezno

Primer odgovora · VariantValueData.

Primer: {"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 Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

Pridobi · Možnosti — Različice izdelkov in možnosti — Odgovor

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
created_atNizObvezno

Čas nastanka.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Primer: "example"
nameNiz nullObvezno

Ime vira v ustreznem kontekstu.

Primer: "Example"
numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "example"
positionCelo številoObvezno

Položaj v urejeni zbirki.

Primer: 1
selection_typeNizObvezno

Dovoljeni način izbire vrednosti lastnosti.

Omejitve
enum
["button", "dropdown"]
Primer: "button"
updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
value_presentation_typeNizObvezno

Način prikaza vrednosti slovarja.

Omejitve
enum
["text", "color", "image"]
Primer: "text"
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Pridobi · Različice izdelka — Različice izdelkov in možnosti — Odgovor

ProductVariantData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
activeLogična vrednostObvezno

Ali je vir aktiven.

Primer: true
created_atNizObvezno

Čas nastanka.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (ProductVariantData).

Primer: "example"
is_defaultLogična vrednostObvezno

Ali je to privzeta izbira.

Primer: true
media_idsPolje elementov <Niz> Obvezno

Identifikatorji že obstoječih medijskih datotek.

Primer: ["example"]
positionCelo številoObvezno

Položaj v urejeni zbirki.

Primer: 1
pricingVariantPricingData Obvezno

Nastavitve cen in njihove različice za nadzor sočasnosti.

Primer: {"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_idNiz nullObvezno

Identifikator primarne medijske datoteke.

Primer: "example"
product_idNizObvezno

Identifikator izdelka.

Primer: "example"
skuNizObvezno

Koda enote za vodenje zaloge.

Primer: "example"
updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
valuesPolje elementov <VariantChoiceData > Obvezno

Vrednosti slovarja.

Primer: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Vrednosti slovarja

VariantChoiceData · Shema · Podatkovne sheme: Različice izdelkov in možnosti
option_idNizObvezno

Identifikator možnosti različice izdelka.

Primer: "example"
option_nameNiz nullObvezno

Ime možnosti različice izdelka.

Primer: "example"
valueNiz nullObvezno

Vrednost, opisana z okoliško shemo.

Primer: "example"
value_idNizObvezno

Identifikator vrednosti slovarja.

Primer: "example"

Dodatna polja: Ne

Ustvari · Različice izdelka — Različice izdelkov in možnosti — Telo zahteve

VariantCreate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
activeLogična vrednostIzbirno

Ali je vir aktiven.

Privzeto: true
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
is_defaultLogična vrednostIzbirno

Ali je to privzeta izbira.

media_idsPolje elementov <Niz> Izbirno

Identifikatorji že obstoječih medijskih datotek.

maxItems: 20
Polje elementov:minLength: 1maxLength: 63
pricingVariantPrice Izbirno

Nastavitve cen in njihove različice za nadzor sočasnosti.

skuNizIzbirno

Koda enote za vodenje zaloge.

minLength: 1maxLength: 100
Omejitve
pattern
"^\\S+$"
value_idsPolje elementov <Niz> Obvezno

Identifikatorji vrednosti slovarja.

minItems: 1maxItems: 250
Polje elementov:minLength: 1maxLength: 63
Primer: ["example"]

Dodatna polja: Ne

Ustvari · Možnosti — Različice izdelkov in možnosti — Telo zahteve

VariantOptionCreate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
nameNizObvezno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 120
Omejitve
pattern
"^[^\\x00]*$"
Primer: "Example"
selection_typeNizIzbirno

Dovoljeni način izbire vrednosti lastnosti.

Omejitve
enum
["button", "dropdown"]
Privzeto: "button"
value_presentation_typeNizIzbirno

Način prikaza vrednosti slovarja.

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

Dodatna polja: Ne

Posodobi · Možnosti — Različice izdelkov in možnosti — Telo zahteve

VariantOptionUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
nameNiz nullIzbirno

Ime vira v ustreznem kontekstu.

Niz:minLength: 1maxLength: 120
Omejitve · Niz 1
pattern
"^[^\\x00]*$"
Primer: "Example"
selection_typeNizIzbirno

Dovoljeni način izbire vrednosti lastnosti.

Omejitve
enum
["button", "dropdown"]
value_presentation_typeNizIzbirno

Način prikaza vrednosti slovarja.

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

Dodatna polja: Ne

Nastavitve cen in njihove različice za nadzor sočasnosti

VariantPrice · Shema · Podatkovne sheme: Različice izdelkov in možnosti
amountNiz nullObvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

Niz:maxLength: 20
Omejitve · Niz 1
pattern
"^-?(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Primer: "0.00"
currencyNizObvezno

Koda valute zneska.

Omejitve
pattern
"^[A-Z]{3}$"
Primer: "PLN"
expected_price_list_versionCelo številoObvezno

Predhodno prebrana različica cenika, zahtevana za ta zapis.

minimum: 1maximum: 9223372036854775807
Primer: 1
expected_product_versionCelo številoObvezno

Predhodno prebrana različica izdelka, zahtevana za ta zapis.

minimum: 0maximum: 9223372036854775807
Primer: 1
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 0maximum: 9223372036854775807
Primer: 0
kindNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["base_adjustment", "market_fixed"]
Primer: "base_adjustment"
price_list_idNizObvezno

Identifikator cenika.

minLength: 1maxLength: 63
Primer: "example"

Dodatna polja: Ne

Nastavitve cen in njihove različice za nadzor sočasnosti

VariantPricingData · Shema · Podatkovne sheme: Različice izdelkov in možnosti
base_adjustmentMoneyData Obvezno

Prilagoditev glede na osnovno ceno.

Primer: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullObvezno

Cena za izbrani trg.

Primer: null
pricePriceData nullObvezno

Podatki o ceni v izbranem kontekstu.

Primer: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionCelo številoObvezno

Trenutna različica izdelka za nadzor sočasnosti.

Primer: 1
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Posodobi · Različice izdelka — Različice izdelkov in možnosti — Telo zahteve

VariantUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
activeLogična vrednostIzbirno

Ali je vir aktiven.

expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
is_defaultLogična vrednostIzbirno

Ali je to privzeta izbira.

media_idsPolje elementov <Niz> Izbirno

Identifikatorji že obstoječih medijskih datotek.

maxItems: 20
Polje elementov:minLength: 1maxLength: 63
pricingVariantPrice Izbirno

Nastavitve cen in njihove različice za nadzor sočasnosti.

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

Koda enote za vodenje zaloge.

minLength: 1maxLength: 100
Omejitve
pattern
"^\\S+$"
Primer: "example"

Dodatna polja: Ne

Ustvari · Vrednosti možnosti — Različice izdelkov in možnosti — Telo zahteve

VariantValueCreate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
color_hexNiz nullIzbirno

Barva v šestnajstiškem zapisu.

Omejitve · Niz 1
pattern
"^#[0-9A-Fa-f]{6}$"
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
valueNizObvezno

Vrednost, opisana z okoliško shemo.

minLength: 1maxLength: 180
Omejitve
pattern
"^[^\\x00]*$"
Primer: "Example"

Dodatna polja: Ne

Pridobi · Vrednosti možnosti — Različice izdelkov in možnosti — Odgovor

VariantValueData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
color_hexNiz nullObvezno

Barva v šestnajstiškem zapisu.

Primer: "#008855"
created_atNizObvezno

Čas nastanka.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki. (VariantValueData).

Primer: "example"
image_media_idNiz nullObvezno

Identifikator izbrane slikovne datoteke.

Primer: null
numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

Primer: "example"
option_idNizObvezno

Identifikator možnosti različice izdelka.

Primer: "example"
positionCelo številoObvezno

Položaj v urejeni zbirki.

Primer: 1
sku_codeNizObvezno

Koda enote za vodenje zaloge.

Primer: "example"
updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
Primer: "2026-01-01T12:00:00Z"
valueNiz nullObvezno

Vrednost, opisana z okoliško shemo.

Primer: "example"
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

Posodobi · Vrednosti možnosti — Različice izdelkov in možnosti — Telo zahteve

VariantValueUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
color_hexNiz nullIzbirno

Barva v šestnajstiškem zapisu.

Omejitve · Niz 1
pattern
"^#[0-9A-Fa-f]{6}$"
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
valueNiz nullIzbirno

Vrednost, opisana z okoliško shemo.

Niz:minLength: 1maxLength: 180
Omejitve · Niz 1
pattern
"^[^\\x00]*$"
Primer: "Example"

Dodatna polja: Ne