Datascheman: Varianter och alternativ

Datascheman: Varianter och alternativ. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Lista · Produktvarianter — Varianter och alternativ — Svar

ApiResponse_list_ProductVariantData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <ProductVariantData > Obligatoriskt: Exempel på svar · ApiResponse_list_ProductVariantData__.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Lista · Alternativ — Varianter och alternativ — Svar

ApiResponse_list_VariantOptionData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Obligatoriskt: Exempel på svar · ApiResponse_list_VariantOptionData__.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Lista · Alternativvärden — Varianter och alternativ — Svar

ApiResponse_list_VariantValueData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataArray <VariantValueData > Obligatoriskt: Exempel på svar · ApiResponse_list_VariantValueData__.

Exempel: [{"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Hämta · Produktvarianter — Varianter och alternativ — Svar

ApiResponse_ProductVariantData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataProductVariantData Obligatoriskt: Exempel på svar · ProductVariantData.

Exempel: {"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Hämta · Alternativ — Varianter och alternativ — Svar

ApiResponse_VariantOptionData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Obligatoriskt: Exempel på svar · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Exempel: {"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Hämta · Alternativvärden — Varianter och alternativ — Svar

ApiResponse_VariantValueData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

dataVariantValueData Obligatoriskt: Exempel på svar · VariantValueData.

Exempel: {"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 Obligatoriskt: Metadata för svaret.

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

Ytterligare fält: Nej

Hämta · Alternativ — Varianter och alternativ — Svar

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"

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

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Exempel: "example"

nameSträng nullObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Example"

numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"

positionHeltalObligatoriskt

Position i den ordnade samlingen.

Exempel: 1

selection_typeSträngObligatoriskt

Tillåtet läge för val av egenskapsvärden.

Begränsningar

enum: ["button", "dropdown"]

Exempel: "button"

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"

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

value_presentation_typeSträngObligatoriskt

Hur katalogvärden presenteras.

Begränsningar

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

Exempel: "text"

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Hämta · Produktvarianter — Varianter och alternativ — Svar

ProductVariantData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

activeBooleskt värdeObligatoriskt: Anger om resursen är aktiv.

Exempel: true
created_atSträngObligatoriskt: Tidpunkt för skapande.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
idSträngObligatoriskt: Resursens identifierare; bevara den som den returneras. (ProductVariantData).

Exempel: "example"
is_defaultBooleskt värdeObligatoriskt: Anger om detta är standardvalet.

Exempel: true
media_idsArray <Sträng> Obligatoriskt: Identifierare för redan befintliga medieresurser.

Exempel: ["example"]
positionHeltalObligatoriskt: Position i den ordnade samlingen.

Exempel: 1
pricingVariantPricingData Obligatoriskt: Priskonfiguration och dess versioner för samtidighetskontroll.

Exempel: {"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_idSträng nullObligatoriskt: Identifierare för primär medieresurs.

Exempel: "example"
product_idSträngObligatoriskt: Produktens identifierare.

Exempel: "example"
skuSträngObligatoriskt: Artikelns SKU-kod.

Exempel: "example"
updated_atSträngObligatoriskt: Tidpunkt för senaste uppdatering.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
valuesArray <VariantChoiceData > Obligatoriskt: Katalogvärden.

Exempel: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionHeltalObligatoriskt: Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Katalogvärden

VariantChoiceData · Schema · Datascheman: Varianter och alternativ

option_idSträngObligatoriskt: Variantalternativets identifierare.

Exempel: "example"
option_nameSträng nullObligatoriskt: Variantalternativets namn.

Exempel: "example"
valueSträng nullObligatoriskt: Värde som beskrivs av omgivande schema.

Exempel: "example"
value_idSträngObligatoriskt: Identifierare för ett katalogvärde.

Exempel: "example"

Ytterligare fält: Nej

Skapa · Produktvarianter — Varianter och alternativ — Begärans innehåll

VariantCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

activeBooleskt värdeValfritt

Anger om resursen är aktiv.

Standardvärde: true

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1

is_defaultBooleskt värdeValfritt

Anger om detta är standardvalet.

media_idsArray <Sträng> Valfritt

Identifierare för redan befintliga medieresurser.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Valfritt

Priskonfiguration och dess versioner för samtidighetskontroll.

skuSträngValfritt

Artikelns SKU-kod.

minLength: 1maxLength: 100

Begränsningar

pattern: "^\\S+$"

value_idsArray <Sträng> Obligatoriskt

Identifierare för katalogvärden.

minItems: 1maxItems: 250

Array:minLength: 1maxLength: 63

Exempel: ["example"]

Ytterligare fält: Nej

Skapa · Alternativ — Varianter och alternativ — Begärans innehåll

VariantOptionCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 120

Begränsningar

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

Exempel: "Example"

selection_typeSträngValfritt

Tillåtet läge för val av egenskapsvärden.

Begränsningar

enum: ["button", "dropdown"]

Standardvärde: "button"

value_presentation_typeSträngValfritt

Hur katalogvärden presenteras.

Begränsningar

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

Standardvärde: "text"

Ytterligare fält: Nej

Uppdatera · Alternativ — Varianter och alternativ — Begärans innehåll

VariantOptionUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1

nameSträng nullValfritt

Resursens namn i aktuell kontext.

Sträng:minLength: 1maxLength: 120

Begränsningar · Sträng 1

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

Exempel: "Example"

selection_typeSträngValfritt

Tillåtet läge för val av egenskapsvärden.

Begränsningar

enum: ["button", "dropdown"]

value_presentation_typeSträngValfritt

Hur katalogvärden presenteras.

Begränsningar

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

Ytterligare fält: Nej

Priskonfiguration och dess versioner för samtidighetskontroll

VariantPrice · Schema · Datascheman: Varianter och alternativ

amountSträng nullObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Sträng:maxLength: 20

Begränsningar · Sträng 1

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

Exempel: "0.00"

currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar

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

Exempel: "PLN"

expected_price_list_versionHeltalObligatoriskt

Tidigare läst prislistversion som krävs för skrivningen.

minimum: 1maximum: 9223372036854775807

Exempel: 1

expected_product_versionHeltalObligatoriskt

Tidigare läst produktversion som krävs för skrivningen.

minimum: 0maximum: 9223372036854775807

Exempel: 1

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 0maximum: 9223372036854775807

Exempel: 0

kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar

enum: ["base_adjustment", "market_fixed"]

Exempel: "base_adjustment"

price_list_idSträngObligatoriskt

Prislistans identifierare.

minLength: 1maxLength: 63

Exempel: "example"

Ytterligare fält: Nej

Priskonfiguration och dess versioner för samtidighetskontroll

VariantPricingData · Schema · Datascheman: Varianter och alternativ

base_adjustmentMoneyData Obligatoriskt: Prisjustering i förhållande till grundpriset.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullObligatoriskt: Pris för vald marknad.

Exempel: null
pricePriceData nullObligatoriskt: Prisinformation i vald kontext.

Exempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionHeltalObligatoriskt: Aktuell produktversion för samtidighetskontroll.

Exempel: 1
versionHeltalObligatoriskt: Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Uppdatera · Produktvarianter — Varianter och alternativ — Begärans innehåll

VariantUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

activeBooleskt värdeValfritt

Anger om resursen är aktiv.

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1

is_defaultBooleskt värdeValfritt

Anger om detta är standardvalet.

media_idsArray <Sträng> Valfritt

Identifierare för redan befintliga medieresurser.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Valfritt

Priskonfiguration och dess versioner för samtidighetskontroll.

Exempel:

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

skuSträngValfritt

Artikelns SKU-kod.

minLength: 1maxLength: 100

Begränsningar

pattern: "^\\S+$"

Exempel: "example"

Ytterligare fält: Nej

Skapa · Alternativvärden — Varianter och alternativ — Begärans innehåll

VariantValueCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

color_hexSträng nullValfritt

Färg angiven med en hexadecimal kod.

Begränsningar · Sträng 1

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

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1

valueSträngObligatoriskt

Värde som beskrivs av omgivande schema.

minLength: 1maxLength: 180

Begränsningar

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

Exempel: "Example"

Ytterligare fält: Nej

Hämta · Alternativvärden — Varianter och alternativ — Svar

VariantValueData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

color_hexSträng nullObligatoriskt: Färg angiven med en hexadecimal kod.

Exempel: "#008855"
created_atSträngObligatoriskt: Tidpunkt för skapande.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
idSträngObligatoriskt: Resursens identifierare; bevara den som den returneras. (VariantValueData).

Exempel: "example"
image_media_idSträng nullObligatoriskt: Identifierare för vald bildresurs.

Exempel: null
numberSträngObligatoriskt: Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"
option_idSträngObligatoriskt: Variantalternativets identifierare.

Exempel: "example"
positionHeltalObligatoriskt: Position i den ordnade samlingen.

Exempel: 1
sku_codeSträngObligatoriskt: Artikelns SKU-kod.

Exempel: "example"
updated_atSträngObligatoriskt: Tidpunkt för senaste uppdatering.

format: "date-time"

Exempel: "2026-01-01T12:00:00Z"
valueSträng nullObligatoriskt: Värde som beskrivs av omgivande schema.

Exempel: "example"
versionHeltalObligatoriskt: Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Uppdatera · Alternativvärden — Varianter och alternativ — Begärans innehåll

VariantValueUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

color_hexSträng nullValfritt

Färg angiven med en hexadecimal kod.

Begränsningar · Sträng 1

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

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1

valueSträng nullValfritt

Värde som beskrivs av omgivande schema.

Sträng:minLength: 1maxLength: 180

Begränsningar · Sträng 1

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

Exempel: "Example"

Ytterligare fält: Nej