Skemi tad-data: Prodotti

Skemi tad-data: Prodotti. L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

Elenka — Prodotti — Risposta

ApiResponse_list_ProductSummaryData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <ProductSummaryData > Obbligatorju: Eżempju ta’ tweġiba · ApiResponse_list_ProductSummaryData__.

Eżempju: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju: Metadata tat-tweġiba.

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

Oqsma addizzjonali: Le

Ikseb — Prodotti — Risposta

ApiResponse_ProductDetailData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataProductDetailData Obbligatorju: Eżempju ta’ tweġiba · ProductDetailData.

Eżempju: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Oqsma addizzjonali: Le

Informazzjoni dwar id-disponibbiltà fil-kuntest magħżul

AvailabilityData · Skema · Skemi tad-data: Prodotti

available_fromString nullObbligatorju: Bidu tad-disponibbiltà.

String:format: "date-time"

Eżempju: null
available_untilString nullObbligatorju: Tmiem tad-disponibbiltà.

String:format: "date-time"

Eżempju: null
is_availableBooleanObbligatorju: Jekk l-oġġett huwiex disponibbli f’dan il-kuntest.

Eżempju: true

Oqsma addizzjonali: Le

Informazzjoni tal-prezz fil-kuntest magħżul

PriceData · Skema · Skemi tad-data: Prodotti

amountStringObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

Eżempju: "0.00"

currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet

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

Eżempju: "PLN"

minor_unitsNumru sħiħObbligatorju

Numru ta’ ċifri deċimali użati mill-munita.

minimum: 0maximum: 4

Eżempju: 2

tax_includedBooleanObbligatorju

Jekk il-prezz sottomess jinkludix it-taxxa.

Eżempju: true

Oqsma addizzjonali: Le

Informazzjoni tal-lista tal-prezzijiet

PriceListData · Skema · Skemi tad-data: Prodotti

currencyStringObbligatorju: Kodiċi tal-munita tal-ammont.
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (PriceListData).
tax_includedBooleanObbligatorju: Jekk il-prezz sottomess jinkludix it-taxxa.
versionNumru sħiħObbligatorju: Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Oqsma addizzjonali: Le

Oħloq — Prodotti — Kontenut tat-talba

ProductCreate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

brand_idString nullMhux obbligatorju

Identifikatur tal-marka.

String:minLength: 1maxLength: 63

conditionStringMhux obbligatorju

Kundizzjoni tal-prodott.

Restrizzjonijiet

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Valur predefinit: "new"

descriptionString nullMhux obbligatorju

Deskrizzjoni fil-lingwa magħżula.

String:maxLength: 100000

feature_value_idsArray <String> Mhux obbligatorju

Identifikaturi tal-valuri magħżula tal-karatteristiċi.

maxItems: 1000

Array:minLength: 1maxLength: 63

identifiersProductIdentifiers nullMhux obbligatorju

Kodiċijiet ta’ identifikazzjoni tal-prodott.

market_idsArray <String> Mhux obbligatorju

Identifikaturi tas-swieq magħżula.

maxItems: 1000

Array:minLength: 1maxLength: 63

media_idsArray <String> Mhux obbligatorju

Identifikaturi ta’ assi tal-midja li diġà jeżistu.

maxItems: 20

Array:minLength: 1maxLength: 63

meta_descriptionString nullMhux obbligatorju

Deskrizzjoni għall-magni tat-tiftix fil-lingwa magħżula.

String:maxLength: 160

meta_keywordsArray <String> nullMhux obbligatorju

Kliem ewlieni għall-magni tat-tiftix fil-lingwa magħżula.

Array:maxItems: 20

Array / Array:maxLength: 50

meta_titleString nullMhux obbligatorju

Titlu għall-magni tat-tiftix fil-lingwa magħżula.

String:maxLength: 70

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

minLength: 1maxLength: 300

Eżempju: "Example"

pricingProductPrice Mhux obbligatorju

Konfigurazzjoni tal-prezzijiet u l-verżjonijiet tal-konkorrenza tagħha.

primary_category_idString nullMhux obbligatorju

Identifikatur tal-kategorija ewlenija.

String:minLength: 1maxLength: 63

publishedBooleanMhux obbligatorju

Jekk ir-riżorsa hijiex ippubblikata.

Valur predefinit: false

skuStringObbligatorju

Kodiċi tal-unità ta’ ġestjoni tal-istokk.

minLength: 1maxLength: 100

Restrizzjonijiet

pattern: "^\\S+$"

Eżempju: "example"

slugString nullMhux obbligatorju

Segment tal-mogħdija URL fil-lingwa magħżula.

String:maxLength: 160

tax_category_idString nullMhux obbligatorju

Identifikatur tal-kategorija tat-taxxa.

String:minLength: 1maxLength: 63

variant_value_idsArray <String> Mhux obbligatorju

Identifikaturi tal-valuri magħżula tal-varjanti.

maxItems: 250

Array:minLength: 1maxLength: 63

variants_enabledBooleanMhux obbligatorju

Jekk il-prodott jużax varjanti.

Valur predefinit: false

Oqsma addizzjonali: Le

Ikseb — Prodotti — Risposta

ProductDetailData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

availabilityAvailabilityData Obbligatorju

Informazzjoni dwar id-disponibbiltà fil-kuntest magħżul.

Eżempju: {"available_from":null,"available_until":null,"is_available":true}

brand_idString nullObbligatorju

Identifikatur tal-marka.

Eżempju: null

conditionStringObbligatorju

Kundizzjoni tal-prodott.

Restrizzjonijiet

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Eżempju: "new"

created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

descriptionString nullObbligatorju

Deskrizzjoni fil-lingwa magħżula.

Eżempju: "example"

featuresArray <FeatureSelectionData > Obbligatorju

Karatteristiċi tal-prodott.

Eżempju: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (ProductDetailData).

Eżempju: "example"

identifiersOġġettOqsma addizzjonali: StringObbligatorju

Kodiċijiet ta’ identifikazzjoni tal-prodott.

Eżempju: {}

mediaArray <ProductMediaData > Obbligatorju

Informazzjoni dwar il-midja mehmuża.

Eżempju:

[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]

meta_descriptionString nullObbligatorju

Deskrizzjoni għall-magni tat-tiftix fil-lingwa magħżula.

Eżempju: "example"

meta_keywordsArray <String> nullObbligatorju

Kliem ewlieni għall-magni tat-tiftix fil-lingwa magħżula.

Eżempju: ["example"]

meta_titleString nullObbligatorju

Titlu għall-magni tat-tiftix fil-lingwa magħżula.

Eżempju: "example"

nameString nullObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"

numberStringObbligatorju

Numru tal-ordni jew tat-talba muri lill-bniedem.

Eżempju: "example"

pricePriceData nullObbligatorju

Informazzjoni tal-prezz fil-kuntest magħżul.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionNumru sħiħObbligatorju

Verżjoni attwali tal-prezz għall-kontroll tal-konkorrenza.

Eżempju: 1

primary_category_idString nullObbligatorju

Identifikatur tal-kategorija ewlenija.

Eżempju: "example"

primary_media_idString nullObbligatorju

Identifikatur tal-assi ewlieni tal-midja.

Eżempju: "example"

publishedBooleanObbligatorju

Jekk ir-riżorsa hijiex ippubblikata.

Eżempju: false

skuStringObbligatorju

Kodiċi tal-unità ta’ ġestjoni tal-istokk.

Eżempju: "example"

slugString nullObbligatorju

Segment tal-mogħdija URL fil-lingwa magħżula.

Eżempju: "example"

tax_category_idStringObbligatorju

Identifikatur tal-kategorija tat-taxxa.

Eżempju: "example"

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

variants_enabledBooleanObbligatorju

Jekk il-prodott jużax varjanti.

Eżempju: false

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Kodiċijiet ta’ identifikazzjoni tal-prodott

ProductIdentifiers · Skema · Skemi tad-data: Prodotti

eanString nullMhux obbligatorju: Identifikatur EAN tal-prodott.

String:minLength: 1maxLength: 100
isbnString nullMhux obbligatorju: Identifikatur ISBN.

String:minLength: 1maxLength: 100
mpnString nullMhux obbligatorju: Numru tal-parti tal-manifattur.

String:minLength: 1maxLength: 100
upcString nullMhux obbligatorju: Identifikatur UPC tal-prodott.

String:minLength: 1maxLength: 100

Oqsma addizzjonali: Le

Informazzjoni dwar il-midja mehmuża

ProductMediaData · Skema · Skemi tad-data: Prodotti

alt_textString nullObbligatorju

Test alternattiv għal stampa.

Eżempju: "example"

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (ProductMediaData).

Eżempju: "example"

is_primaryBooleanObbligatorju

Jekk dan huwiex l-oġġett ewlieni.

Eżempju: true

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["image", "video", "model_3d"]

Eżempju: "image"

mime_typeStringObbligatorju

Tip tal-kontenut tal-midja.

Eżempju: "image/jpeg"

positionNumru sħiħObbligatorju

Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 1

urlString nullObbligatorju

URL tar-riżorsa.

Eżempju: "https://example.invalid/product.jpg"

Oqsma addizzjonali: Le

Konfigurazzjoni tal-prezzijiet u l-verżjonijiet tal-konkorrenza tagħha

ProductPrice · Skema · Skemi tad-data: Prodotti

amountString nullObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

String:maxLength: 19

Restrizzjonijiet · String 1

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

Eżempju: "0.00"

currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet

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

Eżempju: "PLN"

expected_price_list_versionNumru sħiħObbligatorju

Verżjoni tal-lista tal-prezzijiet li nqrat qabel u hija meħtieġa għal din il-kitba.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 0maximum: 9223372036854775807

Eżempju: 0

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["base", "market_fixed"]

Eżempju: "base"

price_list_idStringObbligatorju

Identifikatur tal-lista tal-prezzijiet.

minLength: 1maxLength: 63

Eżempju: "example"

tax_includedBooleanObbligatorju

Jekk il-prezz sottomess jinkludix it-taxxa.

Eżempju: true

Oqsma addizzjonali: Le

Elenka — Prodotti — Risposta

ProductSummaryData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

availabilityAvailabilityData Obbligatorju

Informazzjoni dwar id-disponibbiltà fil-kuntest magħżul.

Eżempju: {"available_from":null,"available_until":null,"is_available":true}

brand_idString nullObbligatorju

Identifikatur tal-marka.

Eżempju: null

conditionStringObbligatorju

Kundizzjoni tal-prodott.

Restrizzjonijiet

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Eżempju: "new"

created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (ProductSummaryData).

Eżempju: "example"

nameString nullObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"

numberStringObbligatorju

Numru tal-ordni jew tat-talba muri lill-bniedem.

Eżempju: "example"

pricePriceData nullObbligatorju

Informazzjoni tal-prezz fil-kuntest magħżul.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionNumru sħiħObbligatorju

Verżjoni attwali tal-prezz għall-kontroll tal-konkorrenza.

Eżempju: 1

primary_category_idString nullObbligatorju

Identifikatur tal-kategorija ewlenija.

Eżempju: "example"

primary_media_idString nullObbligatorju

Identifikatur tal-assi ewlieni tal-midja.

Eżempju: "example"

publishedBooleanObbligatorju

Jekk ir-riżorsa hijiex ippubblikata.

Eżempju: false

skuStringObbligatorju

Kodiċi tal-unità ta’ ġestjoni tal-istokk.

Eżempju: "example"

slugString nullObbligatorju

Segment tal-mogħdija URL fil-lingwa magħżula.

Eżempju: "example"

tax_category_idStringObbligatorju

Identifikatur tal-kategorija tat-taxxa.

Eżempju: "example"

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

variants_enabledBooleanObbligatorju

Jekk il-prodott jużax varjanti.

Eżempju: false

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Aġġorna — Prodotti — Kontenut tat-talba

ProductUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

brand_idString nullMhux obbligatorju

Identifikatur tal-marka.

String:minLength: 1maxLength: 63

conditionStringMhux obbligatorju

Kundizzjoni tal-prodott.

Restrizzjonijiet

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

descriptionString nullMhux obbligatorju

Deskrizzjoni fil-lingwa magħżula.

String:maxLength: 100000

Eżempju: null

expected_variant_price_versionsOġġettOqsma addizzjonali: Numru sħiħ

minimum: 0maximum: 9223372036854775807

Mhux obbligatorju

Verżjonijiet tal-prezzijiet li nqraw qabel, bl-identifikatur tal-varjant bħala ċavetta.

maxProperties: 250

Restrizzjonijiet

propertyNames: {"maxLength": 63, "minLength": 1}

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

feature_value_idsArray <String> Mhux obbligatorju

Identifikaturi tal-valuri magħżula tal-karatteristiċi.

maxItems: 1000

Array:minLength: 1maxLength: 63

identifiersProductIdentifiers nullMhux obbligatorju

Kodiċijiet ta’ identifikazzjoni tal-prodott.

market_idsArray <String> Mhux obbligatorju

Identifikaturi tas-swieq magħżula.

maxItems: 1000

Array:minLength: 1maxLength: 63

media_idsArray <String> Mhux obbligatorju

Identifikaturi ta’ assi tal-midja li diġà jeżistu.

maxItems: 20

Array:minLength: 1maxLength: 63

meta_descriptionString nullMhux obbligatorju

Deskrizzjoni għall-magni tat-tiftix fil-lingwa magħżula.

String:maxLength: 160

meta_keywordsArray <String> nullMhux obbligatorju

Kliem ewlieni għall-magni tat-tiftix fil-lingwa magħżula.

Array:maxItems: 20

Array / Array:maxLength: 50

meta_titleString nullMhux obbligatorju

Titlu għall-magni tat-tiftix fil-lingwa magħżula.

String:maxLength: 70

nameString nullMhux obbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

String:maxLength: 300

Eżempju: null

pricingProductPrice Mhux obbligatorju

Konfigurazzjoni tal-prezzijiet u l-verżjonijiet tal-konkorrenza tagħha.

Eżempju:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}

primary_category_idString nullMhux obbligatorju

Identifikatur tal-kategorija ewlenija.

String:minLength: 1maxLength: 63

publishedBooleanMhux obbligatorju

Jekk ir-riżorsa hijiex ippubblikata.

skuStringMhux obbligatorju

Kodiċi tal-unità ta’ ġestjoni tal-istokk.

minLength: 1maxLength: 100

Restrizzjonijiet

pattern: "^\\S+$"

Eżempju: "example"

slugString nullMhux obbligatorju

Segment tal-mogħdija URL fil-lingwa magħżula.

String:maxLength: 160

tax_category_idString nullMhux obbligatorju

Identifikatur tal-kategorija tat-taxxa.

String:minLength: 1maxLength: 63

variant_value_idsArray <String> Mhux obbligatorju

Identifikaturi tal-valuri magħżula tal-varjanti.

maxItems: 250

Array:minLength: 1maxLength: 63

variants_enabledBooleanMhux obbligatorju

Jekk il-prodott jużax varjanti.

Oqsma addizzjonali: Le