Pāriet uz saturu
ShopentlyLearn

Datu shēmas: Produkti

Datu shēmas: Produkti. API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Datu shēmas

Saraksts — Produkti — Atbilde

ApiResponse_list_ProductSummaryData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataMasīvs <ProductSummaryData > Obligāts

Atbildes piemērs · ApiResponse_list_ProductSummaryData__.

Piemērs: [{"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 Obligāts

Atbildes metadati.

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

Papildu lauki: Nē

Iegūt — Produkti — Atbilde

ApiResponse_ProductDetailData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataProductDetailData Obligāts

Atbildes piemērs · ProductDetailData.

Piemērs: {"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 Obligāts

Atbildes metadati.

Piemērs: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Papildu lauki: Nē

Pieejamības informācija izvēlētajā kontekstā

AvailabilityData · Shēma · Datu shēmas: Produkti
available_fromVirkne nullObligāts

Pieejamības sākums.

Virkne:format: "date-time"
Piemērs: null
available_untilVirkne nullObligāts

Pieejamības beigas.

Virkne:format: "date-time"
Piemērs: null
is_availableLoģiska vērtībaObligāts

Vai vienums ir pieejams šajā kontekstā.

Piemērs: true

Papildu lauki: Nē

Cenas informācija izvēlētajā kontekstā

PriceData · Shēma · Datu shēmas: Produkti
amountVirkneObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Piemērs: "0.00"
currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi
pattern
"^[A-Z]{3}$"
Piemērs: "PLN"
minor_unitsVesels skaitlisObligāts

Valūtas izmantoto ciparu skaits aiz komata.

minimum: 0maximum: 4
Piemērs: 2
tax_includedLoģiska vērtībaObligāts

Vai iesniegtā cena ietver nodokli.

Piemērs: true

Papildu lauki: Nē

Cenrāža informācija

PriceListData · Shēma · Datu shēmas: Produkti
currencyVirkneObligāts

Summas valūtas kods.

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (PriceListData).

tax_includedLoģiska vērtībaObligāts

Vai iesniegtā cena ietver nodokli.

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Papildu lauki: Nē

Izveidot — Produkti — Pieprasījuma saturs

ProductCreate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
brand_idVirkne nullNeobligāts

Zīmola identifikators.

Virkne:minLength: 1maxLength: 63
conditionVirkneNeobligāts

Produkta stāvoklis.

Ierobežojumi
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Noklusējums: "new"
descriptionVirkne nullNeobligāts

Apraksts izvēlētajā valodā.

Virkne:maxLength: 100000
feature_value_idsMasīvs <Virkne> Neobligāts

Izvēlēto īpašību vērtību identifikatori.

maxItems: 1000
Masīvs:minLength: 1maxLength: 63
identifiersProductIdentifiers nullNeobligāts

Produkta identifikācijas kodi.

market_idsMasīvs <Virkne> Neobligāts

Izvēlēto tirgu identifikatori.

maxItems: 1000
Masīvs:minLength: 1maxLength: 63
media_idsMasīvs <Virkne> Neobligāts

Jau esošu multivides resursu identifikatori.

maxItems: 20
Masīvs:minLength: 1maxLength: 63
meta_descriptionVirkne nullNeobligāts

Meklētājprogrammas apraksts izvēlētajā valodā.

Virkne:maxLength: 160
meta_keywordsMasīvs <Virkne> nullNeobligāts

Meklētājprogrammas atslēgvārdi izvēlētajā valodā.

Masīvs:maxItems: 20
Masīvs / Masīvs:maxLength: 50
meta_titleVirkne nullNeobligāts

Meklētājprogrammas virsraksts izvēlētajā valodā.

Virkne:maxLength: 70
nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

minLength: 1maxLength: 300
Piemērs: "Example"
pricingProductPrice Neobligāts

Cenu konfigurācija un tās vienlaicīgu izmaiņu versijas.

primary_category_idVirkne nullNeobligāts

Galvenās kategorijas identifikators.

Virkne:minLength: 1maxLength: 63
publishedLoģiska vērtībaNeobligāts

Vai resurss ir publicēts.

Noklusējums: false
skuVirkneObligāts

Krājumu uzskaites vienības kods.

minLength: 1maxLength: 100
Ierobežojumi
pattern
"^\\S+$"
Piemērs: "example"
slugVirkne nullNeobligāts

URL ceļa segments izvēlētajā valodā.

Virkne:maxLength: 160
tax_category_idVirkne nullNeobligāts

Nodokļu kategorijas identifikators.

Virkne:minLength: 1maxLength: 63
variant_value_idsMasīvs <Virkne> Neobligāts

Izvēlēto variantu vērtību identifikatori.

maxItems: 250
Masīvs:minLength: 1maxLength: 63
variants_enabledLoģiska vērtībaNeobligāts

Vai produkts izmanto variantus.

Noklusējums: false

Papildu lauki: Nē

Iegūt — Produkti — Atbilde

ProductDetailData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
availabilityAvailabilityData Obligāts

Pieejamības informācija izvēlētajā kontekstā.

Piemērs: {"available_from":null,"available_until":null,"is_available":true}
brand_idVirkne nullObligāts

Zīmola identifikators.

Piemērs: null
conditionVirkneObligāts

Produkta stāvoklis.

Ierobežojumi
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Piemērs: "new"
created_atVirkneObligāts

Izveides laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
descriptionVirkne nullObligāts

Apraksts izvēlētajā valodā.

Piemērs: "example"
featuresMasīvs <FeatureSelectionData > Obligāts

Produkta īpašības.

Piemērs: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (ProductDetailData).

Piemērs: "example"
identifiersObjektsPapildu lauki: VirkneObligāts

Produkta identifikācijas kodi.

Piemērs: {}
mediaMasīvs <ProductMediaData > Obligāts

Pievienotās multivides informācija.

Piemērs: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionVirkne nullObligāts

Meklētājprogrammas apraksts izvēlētajā valodā.

Piemērs: "example"
meta_keywordsMasīvs <Virkne> nullObligāts

Meklētājprogrammas atslēgvārdi izvēlētajā valodā.

Piemērs: ["example"]
meta_titleVirkne nullObligāts

Meklētājprogrammas virsraksts izvēlētajā valodā.

Piemērs: "example"
nameVirkne nullObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"
numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "example"
pricePriceData nullObligāts

Cenas informācija izvēlētajā kontekstā.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionVesels skaitlisObligāts

Pašreizējā cenas versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1
primary_category_idVirkne nullObligāts

Galvenās kategorijas identifikators.

Piemērs: "example"
primary_media_idVirkne nullObligāts

Galvenā multivides resursa identifikators.

Piemērs: "example"
publishedLoģiska vērtībaObligāts

Vai resurss ir publicēts.

Piemērs: false
skuVirkneObligāts

Krājumu uzskaites vienības kods.

Piemērs: "example"
slugVirkne nullObligāts

URL ceļa segments izvēlētajā valodā.

Piemērs: "example"
tax_category_idVirkneObligāts

Nodokļu kategorijas identifikators.

Piemērs: "example"
updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
variants_enabledLoģiska vērtībaObligāts

Vai produkts izmanto variantus.

Piemērs: false
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Produkta identifikācijas kodi

ProductIdentifiers · Shēma · Datu shēmas: Produkti
eanVirkne nullNeobligāts

Produkta EAN identifikators.

Virkne:minLength: 1maxLength: 100
isbnVirkne nullNeobligāts

ISBN identifikators.

Virkne:minLength: 1maxLength: 100
mpnVirkne nullNeobligāts

Ražotāja detaļas numurs.

Virkne:minLength: 1maxLength: 100
upcVirkne nullNeobligāts

Produkta UPC identifikators.

Virkne:minLength: 1maxLength: 100

Papildu lauki: Nē

Pievienotās multivides informācija

ProductMediaData · Shēma · Datu shēmas: Produkti
alt_textVirkne nullObligāts

Attēla alternatīvais teksts.

Piemērs: "example"
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (ProductMediaData).

Piemērs: "example"
is_primaryLoģiska vērtībaObligāts

Vai šis ir galvenais vienums.

Piemērs: true
kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi
enum
["image", "video", "model_3d"]
Piemērs: "image"
mime_typeVirkneObligāts

Multivides satura tips.

Piemērs: "image/jpeg"
positionVesels skaitlisObligāts

Pozīcija sakārtotā kolekcijā.

Piemērs: 1
urlVirkne nullObligāts

Resursa URL.

Piemērs: "https://example.invalid/product.jpg"

Papildu lauki: Nē

Cenu konfigurācija un tās vienlaicīgu izmaiņu versijas

ProductPrice · Shēma · Datu shēmas: Produkti
amountVirkne nullObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Virkne:maxLength: 19
Ierobežojumi · Virkne 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Piemērs: "0.00"
currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi
pattern
"^[A-Z]{3}$"
Piemērs: "PLN"
expected_price_list_versionVesels skaitlisObligāts

Iepriekš nolasītā cenrāža versija, kas nepieciešama rakstīšanai.

minimum: 1maximum: 9223372036854775807
Piemērs: 1
expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 0maximum: 9223372036854775807
Piemērs: 0
kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi
enum
["base", "market_fixed"]
Piemērs: "base"
price_list_idVirkneObligāts

Cenrāža identifikators.

minLength: 1maxLength: 63
Piemērs: "example"
tax_includedLoģiska vērtībaObligāts

Vai iesniegtā cena ietver nodokli.

Piemērs: true

Papildu lauki: Nē

Saraksts — Produkti — Atbilde

ProductSummaryData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
availabilityAvailabilityData Obligāts

Pieejamības informācija izvēlētajā kontekstā.

Piemērs: {"available_from":null,"available_until":null,"is_available":true}
brand_idVirkne nullObligāts

Zīmola identifikators.

Piemērs: null
conditionVirkneObligāts

Produkta stāvoklis.

Ierobežojumi
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Piemērs: "new"
created_atVirkneObligāts

Izveides laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (ProductSummaryData).

Piemērs: "example"
nameVirkne nullObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"
numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "example"
pricePriceData nullObligāts

Cenas informācija izvēlētajā kontekstā.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionVesels skaitlisObligāts

Pašreizējā cenas versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1
primary_category_idVirkne nullObligāts

Galvenās kategorijas identifikators.

Piemērs: "example"
primary_media_idVirkne nullObligāts

Galvenā multivides resursa identifikators.

Piemērs: "example"
publishedLoģiska vērtībaObligāts

Vai resurss ir publicēts.

Piemērs: false
skuVirkneObligāts

Krājumu uzskaites vienības kods.

Piemērs: "example"
slugVirkne nullObligāts

URL ceļa segments izvēlētajā valodā.

Piemērs: "example"
tax_category_idVirkneObligāts

Nodokļu kategorijas identifikators.

Piemērs: "example"
updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
variants_enabledLoģiska vērtībaObligāts

Vai produkts izmanto variantus.

Piemērs: false
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Atjaunināt — Produkti — Pieprasījuma saturs

ProductUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
brand_idVirkne nullNeobligāts

Zīmola identifikators.

Virkne:minLength: 1maxLength: 63
conditionVirkneNeobligāts

Produkta stāvoklis.

Ierobežojumi
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionVirkne nullNeobligāts

Apraksts izvēlētajā valodā.

Virkne:maxLength: 100000
Piemērs: null
expected_variant_price_versionsObjektsPapildu lauki: Vesels skaitlis
minimum: 0maximum: 9223372036854775807
Neobligāts

Iepriekš nolasītās cenu versijas, kuru atslēga ir varianta identifikators.

maxProperties: 250
Ierobežojumi
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807
Piemērs: 1
feature_value_idsMasīvs <Virkne> Neobligāts

Izvēlēto īpašību vērtību identifikatori.

maxItems: 1000
Masīvs:minLength: 1maxLength: 63
identifiersProductIdentifiers nullNeobligāts

Produkta identifikācijas kodi.

market_idsMasīvs <Virkne> Neobligāts

Izvēlēto tirgu identifikatori.

maxItems: 1000
Masīvs:minLength: 1maxLength: 63
media_idsMasīvs <Virkne> Neobligāts

Jau esošu multivides resursu identifikatori.

maxItems: 20
Masīvs:minLength: 1maxLength: 63
meta_descriptionVirkne nullNeobligāts

Meklētājprogrammas apraksts izvēlētajā valodā.

Virkne:maxLength: 160
meta_keywordsMasīvs <Virkne> nullNeobligāts

Meklētājprogrammas atslēgvārdi izvēlētajā valodā.

Masīvs:maxItems: 20
Masīvs / Masīvs:maxLength: 50
meta_titleVirkne nullNeobligāts

Meklētājprogrammas virsraksts izvēlētajā valodā.

Virkne:maxLength: 70
nameVirkne nullNeobligāts

Resursa nosaukums attiecīgajā kontekstā.

Virkne:maxLength: 300
Piemērs: null
pricingProductPrice Neobligāts

Cenu konfigurācija un tās vienlaicīgu izmaiņu versijas.

Piemērs: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idVirkne nullNeobligāts

Galvenās kategorijas identifikators.

Virkne:minLength: 1maxLength: 63
publishedLoģiska vērtībaNeobligāts

Vai resurss ir publicēts.

skuVirkneNeobligāts

Krājumu uzskaites vienības kods.

minLength: 1maxLength: 100
Ierobežojumi
pattern
"^\\S+$"
Piemērs: "example"
slugVirkne nullNeobligāts

URL ceļa segments izvēlētajā valodā.

Virkne:maxLength: 160
tax_category_idVirkne nullNeobligāts

Nodokļu kategorijas identifikators.

Virkne:minLength: 1maxLength: 63
variant_value_idsMasīvs <Virkne> Neobligāts

Izvēlēto variantu vērtību identifikatori.

maxItems: 250
Masīvs:minLength: 1maxLength: 63
variants_enabledLoģiska vērtībaNeobligāts

Vai produkts izmanto variantus.

Papildu lauki: Nē