Duomenų schemos: Produktai

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

Duomenų schemos

Sąrašas — Produktai — Atsakymas

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

dataMasyvas <ProductSummaryData > Privalomas: Atsakymo pavyzdys · ApiResponse_list_ProductSummaryData__.

Pavyzdys: [{"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 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 — Produktai — Atsakymas

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

dataProductDetailData Privalomas: Atsakymo pavyzdys · ProductDetailData.

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

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

Papildomi laukai: Ne

Prieinamumo informacija pasirinktame kontekste

AvailabilityData · Schema · Duomenų schemos: Produktai

available_fromEilutė nullPrivalomas: Prieinamumo pradžia.

Eilutė:format: "date-time"

Pavyzdys: null
available_untilEilutė nullPrivalomas: Prieinamumo pabaiga.

Eilutė:format: "date-time"

Pavyzdys: null
is_availableLoginė reikšmėPrivalomas: Ar elementas prieinamas šiame kontekste.

Pavyzdys: true

Papildomi laukai: Ne

Kainos informacija pasirinktame kontekste

PriceData · Schema · Duomenų schemos: Produktai

amountEilutėPrivalomas

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

Pavyzdys: "0.00"

currencyEilutėPrivalomas

Sumos valiutos kodas.

Apribojimai

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

Pavyzdys: "PLN"

minor_unitsSveikasis skaičiusPrivalomas

Valiutos naudojamų skaitmenų po kablelio skaičius.

minimum: 0maximum: 4

Pavyzdys: 2

tax_includedLoginė reikšmėPrivalomas

Ar pateikta kaina apima mokesčius.

Pavyzdys: true

Papildomi laukai: Ne

Kainoraščio informacija

PriceListData · Schema · Duomenų schemos: Produktai

currencyEilutėPrivalomas: Sumos valiutos kodas.
idEilutėPrivalomas: Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (PriceListData).
tax_includedLoginė reikšmėPrivalomas: Ar pateikta kaina apima mokesčius.
versionSveikasis skaičiusPrivalomas: Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Papildomi laukai: Ne

Sukurti — Produktai — Užklausos turinys

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

brand_idEilutė nullNeprivalomas

Prekės ženklo identifikatorius.

Eilutė:minLength: 1maxLength: 63

conditionEilutėNeprivalomas

Produkto būklė.

Apribojimai

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

Numatytoji reikšmė: "new"

descriptionEilutė nullNeprivalomas

Aprašymas pasirinkta kalba.

Eilutė:maxLength: 100000

feature_value_idsMasyvas <Eilutė> Neprivalomas

Pasirinktų savybės reikšmių identifikatoriai.

maxItems: 1000

Masyvas:minLength: 1maxLength: 63

identifiersProductIdentifiers nullNeprivalomas

Produkto identifikavimo kodai.

market_idsMasyvas <Eilutė> Neprivalomas

Pasirinktų rinkų identifikatoriai.

maxItems: 1000

Masyvas:minLength: 1maxLength: 63

media_idsMasyvas <Eilutė> Neprivalomas

Jau esamų medijos failų identifikatoriai.

maxItems: 20

Masyvas:minLength: 1maxLength: 63

meta_descriptionEilutė nullNeprivalomas

Aprašymas paieškos sistemoms pasirinkta kalba.

Eilutė:maxLength: 160

meta_keywordsMasyvas <Eilutė> nullNeprivalomas

Raktažodžiai paieškos sistemoms pasirinkta kalba.

Masyvas:maxItems: 20

Masyvas / Masyvas:maxLength: 50

meta_titleEilutė nullNeprivalomas

Antraštė paieškos sistemoms pasirinkta kalba.

Eilutė:maxLength: 70

nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

minLength: 1maxLength: 300

Pavyzdys: "Example"

pricingProductPrice Neprivalomas

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

primary_category_idEilutė nullNeprivalomas

Pagrindinės kategorijos identifikatorius.

Eilutė:minLength: 1maxLength: 63

publishedLoginė reikšmėNeprivalomas

Ar išteklius paskelbtas.

Numatytoji reikšmė: false

skuEilutėPrivalomas

Atsargų apskaitos vieneto kodas.

minLength: 1maxLength: 100

Apribojimai

pattern: "^\\S+$"

Pavyzdys: "example"

slugEilutė nullNeprivalomas

URL kelio segmentas pasirinkta kalba.

Eilutė:maxLength: 160

tax_category_idEilutė nullNeprivalomas

Mokesčių kategorijos identifikatorius.

Eilutė:minLength: 1maxLength: 63

variant_value_idsMasyvas <Eilutė> Neprivalomas

Pasirinktų varianto reikšmių identifikatoriai.

maxItems: 250

Masyvas:minLength: 1maxLength: 63

variants_enabledLoginė reikšmėNeprivalomas

Ar produktas naudoja variantus.

Numatytoji reikšmė: false

Papildomi laukai: Ne

Gauti — Produktai — Atsakymas

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

availabilityAvailabilityData Privalomas

Prieinamumo informacija pasirinktame kontekste.

Pavyzdys: {"available_from":null,"available_until":null,"is_available":true}

brand_idEilutė nullPrivalomas

Prekės ženklo identifikatorius.

Pavyzdys: null

conditionEilutėPrivalomas

Produkto būklė.

Apribojimai

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

Pavyzdys: "new"

created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"

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

descriptionEilutė nullPrivalomas

Aprašymas pasirinkta kalba.

Pavyzdys: "example"

featuresMasyvas <FeatureSelectionData > Privalomas

Produkto savybės.

Pavyzdys: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]

idEilutėPrivalomas

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

Pavyzdys: "example"

identifiersObjektasPapildomi laukai: EilutėPrivalomas

Produkto identifikavimo kodai.

Pavyzdys: {}

mediaMasyvas <ProductMediaData > Privalomas

Pridėtos medijos informacija.

Pavyzdys:

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

meta_descriptionEilutė nullPrivalomas

Aprašymas paieškos sistemoms pasirinkta kalba.

Pavyzdys: "example"

meta_keywordsMasyvas <Eilutė> nullPrivalomas

Raktažodžiai paieškos sistemoms pasirinkta kalba.

Pavyzdys: ["example"]

meta_titleEilutė nullPrivalomas

Antraštė paieškos sistemoms pasirinkta kalba.

Pavyzdys: "example"

nameEilutė nullPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Example"

numberEilutėPrivalomas

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

Pavyzdys: "example"

pricePriceData nullPrivalomas

Kainos informacija pasirinktame kontekste.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionSveikasis skaičiusPrivalomas

Dabartinė kainos versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

primary_category_idEilutė nullPrivalomas

Pagrindinės kategorijos identifikatorius.

Pavyzdys: "example"

primary_media_idEilutė nullPrivalomas

Pagrindinio medijos failo identifikatorius.

Pavyzdys: "example"

publishedLoginė reikšmėPrivalomas

Ar išteklius paskelbtas.

Pavyzdys: false

skuEilutėPrivalomas

Atsargų apskaitos vieneto kodas.

Pavyzdys: "example"

slugEilutė nullPrivalomas

URL kelio segmentas pasirinkta kalba.

Pavyzdys: "example"

tax_category_idEilutėPrivalomas

Mokesčių kategorijos identifikatorius.

Pavyzdys: "example"

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

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

variants_enabledLoginė reikšmėPrivalomas

Ar produktas naudoja variantus.

Pavyzdys: false

versionSveikasis skaičiusPrivalomas

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

Pavyzdys: 1

Papildomi laukai: Ne

Produkto identifikavimo kodai

ProductIdentifiers · Schema · Duomenų schemos: Produktai

eanEilutė nullNeprivalomas: Produkto EAN identifikatorius.

Eilutė:minLength: 1maxLength: 100
isbnEilutė nullNeprivalomas: ISBN identifikatorius.

Eilutė:minLength: 1maxLength: 100
mpnEilutė nullNeprivalomas: Gamintojo dalies numeris.

Eilutė:minLength: 1maxLength: 100
upcEilutė nullNeprivalomas: Produkto UPC identifikatorius.

Eilutė:minLength: 1maxLength: 100

Papildomi laukai: Ne

Pridėtos medijos informacija

ProductMediaData · Schema · Duomenų schemos: Produktai

alt_textEilutė nullPrivalomas

Alternatyvus paveikslėlio tekstas.

Pavyzdys: "example"

idEilutėPrivalomas

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

Pavyzdys: "example"

is_primaryLoginė reikšmėPrivalomas

Ar tai pagrindinis elementas.

Pavyzdys: true

kindEilutėPrivalomas

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

Apribojimai

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

Pavyzdys: "image"

mime_typeEilutėPrivalomas

Medijos turinio tipas.

Pavyzdys: "image/jpeg"

positionSveikasis skaičiusPrivalomas

Pozicija surikiuotame rinkinyje.

Pavyzdys: 1

urlEilutė nullPrivalomas

Ištekliaus URL.

Pavyzdys: "https://example.invalid/product.jpg"

Papildomi laukai: Ne

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

ProductPrice · Schema · Duomenų schemos: Produktai

amountEilutė nullPrivalomas

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

Eilutė:maxLength: 19

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

Pavyzdys: "base"

price_list_idEilutėPrivalomas

Kainoraščio identifikatorius.

minLength: 1maxLength: 63

Pavyzdys: "example"

tax_includedLoginė reikšmėPrivalomas

Ar pateikta kaina apima mokesčius.

Pavyzdys: true

Papildomi laukai: Ne

Sąrašas — Produktai — Atsakymas

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

availabilityAvailabilityData Privalomas

Prieinamumo informacija pasirinktame kontekste.

Pavyzdys: {"available_from":null,"available_until":null,"is_available":true}

brand_idEilutė nullPrivalomas

Prekės ženklo identifikatorius.

Pavyzdys: null

conditionEilutėPrivalomas

Produkto būklė.

Apribojimai

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

Pavyzdys: "new"

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ą. (ProductSummaryData).

Pavyzdys: "example"

nameEilutė nullPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Example"

numberEilutėPrivalomas

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

Pavyzdys: "example"

pricePriceData nullPrivalomas

Kainos informacija pasirinktame kontekste.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionSveikasis skaičiusPrivalomas

Dabartinė kainos versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

primary_category_idEilutė nullPrivalomas

Pagrindinės kategorijos identifikatorius.

Pavyzdys: "example"

primary_media_idEilutė nullPrivalomas

Pagrindinio medijos failo identifikatorius.

Pavyzdys: "example"

publishedLoginė reikšmėPrivalomas

Ar išteklius paskelbtas.

Pavyzdys: false

skuEilutėPrivalomas

Atsargų apskaitos vieneto kodas.

Pavyzdys: "example"

slugEilutė nullPrivalomas

URL kelio segmentas pasirinkta kalba.

Pavyzdys: "example"

tax_category_idEilutėPrivalomas

Mokesčių kategorijos identifikatorius.

Pavyzdys: "example"

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

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

variants_enabledLoginė reikšmėPrivalomas

Ar produktas naudoja variantus.

Pavyzdys: false

versionSveikasis skaičiusPrivalomas

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

Pavyzdys: 1

Papildomi laukai: Ne

Atnaujinti — Produktai — Užklausos turinys

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

brand_idEilutė nullNeprivalomas

Prekės ženklo identifikatorius.

Eilutė:minLength: 1maxLength: 63

conditionEilutėNeprivalomas

Produkto būklė.

Apribojimai

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

descriptionEilutė nullNeprivalomas

Aprašymas pasirinkta kalba.

Eilutė:maxLength: 100000

Pavyzdys: null

expected_variant_price_versionsObjektasPapildomi laukai: Sveikasis skaičius

minimum: 0maximum: 9223372036854775807

Neprivalomas

Anksčiau perskaitytos kainų versijos, susietos su variantų identifikatoriais.

maxProperties: 250

Apribojimai

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

expected_versionSveikasis skaičiusPrivalomas

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

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

feature_value_idsMasyvas <Eilutė> Neprivalomas

Pasirinktų savybės reikšmių identifikatoriai.

maxItems: 1000

Masyvas:minLength: 1maxLength: 63

identifiersProductIdentifiers nullNeprivalomas

Produkto identifikavimo kodai.

market_idsMasyvas <Eilutė> Neprivalomas

Pasirinktų rinkų identifikatoriai.

maxItems: 1000

Masyvas:minLength: 1maxLength: 63

media_idsMasyvas <Eilutė> Neprivalomas

Jau esamų medijos failų identifikatoriai.

maxItems: 20

Masyvas:minLength: 1maxLength: 63

meta_descriptionEilutė nullNeprivalomas

Aprašymas paieškos sistemoms pasirinkta kalba.

Eilutė:maxLength: 160

meta_keywordsMasyvas <Eilutė> nullNeprivalomas

Raktažodžiai paieškos sistemoms pasirinkta kalba.

Masyvas:maxItems: 20

Masyvas / Masyvas:maxLength: 50

meta_titleEilutė nullNeprivalomas

Antraštė paieškos sistemoms pasirinkta kalba.

Eilutė:maxLength: 70

nameEilutė nullNeprivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Eilutė:maxLength: 300

Pavyzdys: null

pricingProductPrice Neprivalomas

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

Pavyzdys:

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

primary_category_idEilutė nullNeprivalomas

Pagrindinės kategorijos identifikatorius.

Eilutė:minLength: 1maxLength: 63

publishedLoginė reikšmėNeprivalomas

Ar išteklius paskelbtas.

skuEilutėNeprivalomas

Atsargų apskaitos vieneto kodas.

minLength: 1maxLength: 100

Apribojimai

pattern: "^\\S+$"

Pavyzdys: "example"

slugEilutė nullNeprivalomas

URL kelio segmentas pasirinkta kalba.

Eilutė:maxLength: 160

tax_category_idEilutė nullNeprivalomas

Mokesčių kategorijos identifikatorius.

Eilutė:minLength: 1maxLength: 63

variant_value_idsMasyvas <Eilutė> Neprivalomas

Pasirinktų varianto reikšmių identifikatoriai.

maxItems: 250

Masyvas:minLength: 1maxLength: 63

variants_enabledLoginė reikšmėNeprivalomas

Ar produktas naudoja variantus.

Papildomi laukai: Ne