Andmeskeemid: Tooted

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

Andmeskeemid

Loend — Tooted — Vastus

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

dataMassiiv <ProductSummaryData > Kohustuslik: Vastuse näide · ApiResponse_list_ProductSummaryData__.

Näide: [{"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 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 — Tooted — Vastus

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

dataProductDetailData Kohustuslik: Vastuse näide · ProductDetailData.

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

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

Lisaväljad: Ei

Saadavuse teave valitud kontekstis

AvailabilityData · Skeem · Andmeskeemid: Tooted

available_fromString nullKohustuslik: Saadavuse algus.

String:format: "date-time"

Näide: null
available_untilString nullKohustuslik: Saadavuse lõpp.

String:format: "date-time"

Näide: null
is_availableTõeväärtusKohustuslik: Kas kirje on selles kontekstis saadaval.

Näide: true

Lisaväljad: Ei

Hinnateave valitud kontekstis

PriceData · Skeem · Andmeskeemid: Tooted

amountStringKohustuslik

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

Näide: "0.00"

currencyStringKohustuslik

Summa valuutakood.

Piirangud

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

Näide: "PLN"

minor_unitsTäisarvKohustuslik

Valuuta kasutatavate kümnendkohtade arv.

minimum: 0maximum: 4

Näide: 2

tax_includedTõeväärtusKohustuslik

Kas esitatud hind sisaldab maksu.

Näide: true

Lisaväljad: Ei

Hinnakirja teave

PriceListData · Skeem · Andmeskeemid: Tooted

currencyStringKohustuslik: Summa valuutakood.
idStringKohustuslik: Ressursi identifikaator; säilita see tagastatud kujul. (PriceListData).
tax_includedTõeväärtusKohustuslik: Kas esitatud hind sisaldab maksu.
versionTäisarvKohustuslik: Ressursi versioon samaaegsuse kontrolliks.

Lisaväljad: Ei

Loo — Tooted — Päringu sisu

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

brand_idString nullValikuline

Brändi identifikaator.

String:minLength: 1maxLength: 63

conditionStringValikuline

Toote seisukord.

Piirangud

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

Vaikeväärtus: "new"

descriptionString nullValikuline

Kirjeldus valitud keeles.

String:maxLength: 100000

feature_value_idsMassiiv <String> Valikuline

Valitud omaduseväärtuste identifikaatorid.

maxItems: 1000

Massiiv:minLength: 1maxLength: 63

identifiersProductIdentifiers nullValikuline

Toote tuvastuskoodid.

market_idsMassiiv <String> Valikuline

Valitud turgude identifikaatorid.

maxItems: 1000

Massiiv:minLength: 1maxLength: 63

media_idsMassiiv <String> Valikuline

Olemasolevate meediafailide identifikaatorid.

maxItems: 20

Massiiv:minLength: 1maxLength: 63

meta_descriptionString nullValikuline

Otsingumootori kirjeldus valitud keeles.

String:maxLength: 160

meta_keywordsMassiiv <String> nullValikuline

Otsingumootori märksõnad valitud keeles.

Massiiv:maxItems: 20

Massiiv / Massiiv:maxLength: 50

meta_titleString nullValikuline

Otsingumootori pealkiri valitud keeles.

String:maxLength: 70

nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 300

Näide: "Example"

pricingProductPrice Valikuline

Hinnaseadistus ja selle samaaegsuse kontrolli versioonid.

primary_category_idString nullValikuline

Põhikategooria identifikaator.

String:minLength: 1maxLength: 63

publishedTõeväärtusValikuline

Kas ressurss on avaldatud.

Vaikeväärtus: false

skuStringKohustuslik

Laoarvestusühiku kood.

minLength: 1maxLength: 100

Piirangud

pattern: "^\\S+$"

Näide: "example"

slugString nullValikuline

URL-i teesegment valitud keeles.

String:maxLength: 160

tax_category_idString nullValikuline

Maksukategooria identifikaator.

String:minLength: 1maxLength: 63

variant_value_idsMassiiv <String> Valikuline

Valitud variandiväärtuste identifikaatorid.

maxItems: 250

Massiiv:minLength: 1maxLength: 63

variants_enabledTõeväärtusValikuline

Kas toode kasutab variante.

Vaikeväärtus: false

Lisaväljad: Ei

Hangi — Tooted — Vastus

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

availabilityAvailabilityData Kohustuslik

Saadavuse teave valitud kontekstis.

Näide: {"available_from":null,"available_until":null,"is_available":true}

brand_idString nullKohustuslik

Brändi identifikaator.

Näide: null

conditionStringKohustuslik

Toote seisukord.

Piirangud

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

Näide: "new"

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

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

descriptionString nullKohustuslik

Kirjeldus valitud keeles.

Näide: "example"

featuresMassiiv <FeatureSelectionData > Kohustuslik

Toote omadused.

Näide: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]

idStringKohustuslik

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

Näide: "example"

identifiersObjektLisaväljad: StringKohustuslik

Toote tuvastuskoodid.

Näide: {}

mediaMassiiv <ProductMediaData > Kohustuslik

Lisatud meedia teave.

Näide:

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

meta_descriptionString nullKohustuslik

Otsingumootori kirjeldus valitud keeles.

Näide: "example"

meta_keywordsMassiiv <String> nullKohustuslik

Otsingumootori märksõnad valitud keeles.

Näide: ["example"]

meta_titleString nullKohustuslik

Otsingumootori pealkiri valitud keeles.

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"

pricePriceData nullKohustuslik

Hinnateave valitud kontekstis.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionTäisarvKohustuslik

Hinna kehtiv versioon samaaegsuse kontrolliks.

Näide: 1

primary_category_idString nullKohustuslik

Põhikategooria identifikaator.

Näide: "example"

primary_media_idString nullKohustuslik

Peamise meediafaili identifikaator.

Näide: "example"

publishedTõeväärtusKohustuslik

Kas ressurss on avaldatud.

Näide: false

skuStringKohustuslik

Laoarvestusühiku kood.

Näide: "example"

slugString nullKohustuslik

URL-i teesegment valitud keeles.

Näide: "example"

tax_category_idStringKohustuslik

Maksukategooria identifikaator.

Näide: "example"

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

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

variants_enabledTõeväärtusKohustuslik

Kas toode kasutab variante.

Näide: false

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Toote tuvastuskoodid

ProductIdentifiers · Skeem · Andmeskeemid: Tooted

eanString nullValikuline: Toote EAN-identifikaator.

String:minLength: 1maxLength: 100
isbnString nullValikuline: ISBN-identifikaator.

String:minLength: 1maxLength: 100
mpnString nullValikuline: Tootja tootekood.

String:minLength: 1maxLength: 100
upcString nullValikuline: Toote UPC-identifikaator.

String:minLength: 1maxLength: 100

Lisaväljad: Ei

Lisatud meedia teave

ProductMediaData · Skeem · Andmeskeemid: Tooted

alt_textString nullKohustuslik

Pildi alternatiivtekst.

Näide: "example"

idStringKohustuslik

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

Näide: "example"

is_primaryTõeväärtusKohustuslik

Kas see on põhikirje.

Näide: true

kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud

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

Näide: "image"

mime_typeStringKohustuslik

Meedia sisutüüp.

Näide: "image/jpeg"

positionTäisarvKohustuslik

Asukoht järjestatud kogumis.

Näide: 1

urlString nullKohustuslik

Ressursi URL.

Näide: "https://example.invalid/product.jpg"

Lisaväljad: Ei

Hinnaseadistus ja selle samaaegsuse kontrolli versioonid

ProductPrice · Skeem · Andmeskeemid: Tooted

amountString nullKohustuslik

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

String:maxLength: 19

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_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", "market_fixed"]

Näide: "base"

price_list_idStringKohustuslik

Hinnakirja identifikaator.

minLength: 1maxLength: 63

Näide: "example"

tax_includedTõeväärtusKohustuslik

Kas esitatud hind sisaldab maksu.

Näide: true

Lisaväljad: Ei

Loend — Tooted — Vastus

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

availabilityAvailabilityData Kohustuslik

Saadavuse teave valitud kontekstis.

Näide: {"available_from":null,"available_until":null,"is_available":true}

brand_idString nullKohustuslik

Brändi identifikaator.

Näide: null

conditionStringKohustuslik

Toote seisukord.

Piirangud

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

Näide: "new"

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

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

idStringKohustuslik

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

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"

pricePriceData nullKohustuslik

Hinnateave valitud kontekstis.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionTäisarvKohustuslik

Hinna kehtiv versioon samaaegsuse kontrolliks.

Näide: 1

primary_category_idString nullKohustuslik

Põhikategooria identifikaator.

Näide: "example"

primary_media_idString nullKohustuslik

Peamise meediafaili identifikaator.

Näide: "example"

publishedTõeväärtusKohustuslik

Kas ressurss on avaldatud.

Näide: false

skuStringKohustuslik

Laoarvestusühiku kood.

Näide: "example"

slugString nullKohustuslik

URL-i teesegment valitud keeles.

Näide: "example"

tax_category_idStringKohustuslik

Maksukategooria identifikaator.

Näide: "example"

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

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

variants_enabledTõeväärtusKohustuslik

Kas toode kasutab variante.

Näide: false

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Muuda — Tooted — Päringu sisu

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

brand_idString nullValikuline

Brändi identifikaator.

String:minLength: 1maxLength: 63

conditionStringValikuline

Toote seisukord.

Piirangud

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

descriptionString nullValikuline

Kirjeldus valitud keeles.

String:maxLength: 100000

Näide: null

expected_variant_price_versionsObjektLisaväljad: Täisarv

minimum: 0maximum: 9223372036854775807

Valikuline

Varem loetud hinnaversioonid variandi identifikaatori järgi.

maxProperties: 250

Piirangud

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

expected_versionTäisarvKohustuslik

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

minimum: 1maximum: 9223372036854775807

Näide: 1

feature_value_idsMassiiv <String> Valikuline

Valitud omaduseväärtuste identifikaatorid.

maxItems: 1000

Massiiv:minLength: 1maxLength: 63

identifiersProductIdentifiers nullValikuline

Toote tuvastuskoodid.

market_idsMassiiv <String> Valikuline

Valitud turgude identifikaatorid.

maxItems: 1000

Massiiv:minLength: 1maxLength: 63

media_idsMassiiv <String> Valikuline

Olemasolevate meediafailide identifikaatorid.

maxItems: 20

Massiiv:minLength: 1maxLength: 63

meta_descriptionString nullValikuline

Otsingumootori kirjeldus valitud keeles.

String:maxLength: 160

meta_keywordsMassiiv <String> nullValikuline

Otsingumootori märksõnad valitud keeles.

Massiiv:maxItems: 20

Massiiv / Massiiv:maxLength: 50

meta_titleString nullValikuline

Otsingumootori pealkiri valitud keeles.

String:maxLength: 70

nameString nullValikuline

Ressursi nimi vastavas kontekstis.

String:maxLength: 300

Näide: null

pricingProductPrice Valikuline

Hinnaseadistus ja selle samaaegsuse kontrolli versioonid.

Näide:

{"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 nullValikuline

Põhikategooria identifikaator.

String:minLength: 1maxLength: 63

publishedTõeväärtusValikuline

Kas ressurss on avaldatud.

skuStringValikuline

Laoarvestusühiku kood.

minLength: 1maxLength: 100

Piirangud

pattern: "^\\S+$"

Näide: "example"

slugString nullValikuline

URL-i teesegment valitud keeles.

String:maxLength: 160

tax_category_idString nullValikuline

Maksukategooria identifikaator.

String:minLength: 1maxLength: 63

variant_value_idsMassiiv <String> Valikuline

Valitud variandiväärtuste identifikaatorid.

maxItems: 250

Massiiv:minLength: 1maxLength: 63

variants_enabledTõeväärtusValikuline

Kas toode kasutab variante.

Lisaväljad: Ei