Przejdź do treści
ShopentlyLearn

Modele produktów

Schematy produktów Shopently API: lista, szczegóły, tworzenie, edycja, ceny i dostępność. Sprawdź typy pól oraz ograniczenia danych.

Schematy danych

Pobierz listę produktów — Odpowiedź

ApiResponse_list_ProductSummaryData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
dataTablica <ProductSummaryData > Wymagane

Przykład odpowiedzi · ApiResponse_list_ProductSummaryData__.

Przykład: [{"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 Wymagane

Metadane odpowiedzi.

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

Dodatkowe pola: Nie

Pobierz produkt — Odpowiedź

ApiResponse_ProductDetailData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
dataProductDetailData Wymagane

Przykład odpowiedzi · ProductDetailData.

Przykład: {"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 Wymagane

Metadane odpowiedzi.

Przykład: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Dodatkowe pola: Nie

Informacje o dostępności w wybranym kontekście

AvailabilityData · Schemat · Modele produktów
available_fromTekst nullWymagane

Początek dostępności.

Tekst:format: "date-time"
Przykład: null
available_untilTekst nullWymagane

Koniec dostępności.

Tekst:format: "date-time"
Przykład: null
is_availableWartość logicznaWymagane

Czy pozycja jest dostępna w tym kontekście.

Przykład: true

Dodatkowe pola: Nie

Informacje o cenie w wybranym kontekście

PriceData · Schemat · Modele produktów
amountTekstWymagane

Kwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.

Przykład: "0.00"
currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia
pattern
"^[A-Z]{3}$"
Przykład: "PLN"
minor_unitsLiczba całkowitaWymagane

Liczba cyfr części ułamkowej używanych przez walutę.

minimum: 0maximum: 4
Przykład: 2
tax_includedWartość logicznaWymagane

Czy przesyłana cena zawiera podatek.

Przykład: true

Dodatkowe pola: Nie

Informacje o cenniku

PriceListData · Schemat · Modele produktów
currencyTekstWymagane

Kod waluty kwoty.

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (PriceListData).

tax_includedWartość logicznaWymagane

Czy przesyłana cena zawiera podatek.

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Dodatkowe pola: Nie

Utwórz produkt — Treść żądania

ProductCreate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
brand_idTekst nullOpcjonalne

Identyfikator marki.

Tekst:minLength: 1maxLength: 63
conditionTekstOpcjonalne

Stan produktu.

Ograniczenia
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Wartość domyślna: "new"
descriptionTekst nullOpcjonalne

Opis w wybranym języku.

Tekst:maxLength: 100000
feature_value_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych wartości cech.

maxItems: 1000
Tablica:minLength: 1maxLength: 63
identifiersProductIdentifiers nullOpcjonalne

Kody identyfikacyjne produktu.

market_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych rynków.

maxItems: 1000
Tablica:minLength: 1maxLength: 63
media_idsTablica <Tekst> Opcjonalne

Identyfikatory istniejących już zasobów mediów.

maxItems: 20
Tablica:minLength: 1maxLength: 63
meta_descriptionTekst nullOpcjonalne

Opis dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 160
meta_keywordsTablica <Tekst> nullOpcjonalne

Słowa kluczowe dla wyszukiwarek w wybranym języku.

Tablica:maxItems: 20
Tablica / Tablica:maxLength: 50
meta_titleTekst nullOpcjonalne

Tytuł dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 70
nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

minLength: 1maxLength: 300
Przykład: "Example"
pricingProductPrice Opcjonalne

Konfiguracja ceny i jej wersje do kontroli współbieżności.

primary_category_idTekst nullOpcjonalne

Identyfikator kategorii głównej.

Tekst:minLength: 1maxLength: 63
publishedWartość logicznaOpcjonalne

Czy zasób jest opublikowany.

Wartość domyślna: false
skuTekstWymagane

Kod jednostki magazynowej SKU.

minLength: 1maxLength: 100
Ograniczenia
pattern
"^\\S+$"
Przykład: "example"
slugTekst nullOpcjonalne

Fragment ścieżki URL w wybranym języku.

Tekst:maxLength: 160
tax_category_idTekst nullOpcjonalne

Identyfikator kategorii podatkowej.

Tekst:minLength: 1maxLength: 63
variant_value_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych wartości wariantów.

maxItems: 250
Tablica:minLength: 1maxLength: 63
variants_enabledWartość logicznaOpcjonalne

Czy produkt korzysta z wariantów.

Wartość domyślna: false

Dodatkowe pola: Nie

Pobierz produkt — Odpowiedź

ProductDetailData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
availabilityAvailabilityData Wymagane

Informacje o dostępności w wybranym kontekście.

Przykład: {"available_from":null,"available_until":null,"is_available":true}
brand_idTekst nullWymagane

Identyfikator marki.

Przykład: null
conditionTekstWymagane

Stan produktu.

Ograniczenia
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Przykład: "new"
created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"
Przykład: "2026-01-01T12:00:00Z"
descriptionTekst nullWymagane

Opis w wybranym języku.

Przykład: "example"
featuresTablica <FeatureSelectionData > Wymagane

Cechy produktu.

Przykład: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (ProductDetailData).

Przykład: "example"
identifiersObiektDodatkowe pola: TekstWymagane

Kody identyfikacyjne produktu.

Przykład: {}
mediaTablica <ProductMediaData > Wymagane

Informacje o przypisanych mediach.

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

Opis dla wyszukiwarek w wybranym języku.

Przykład: "example"
meta_keywordsTablica <Tekst> nullWymagane

Słowa kluczowe dla wyszukiwarek w wybranym języku.

Przykład: ["example"]
meta_titleTekst nullWymagane

Tytuł dla wyszukiwarek w wybranym języku.

Przykład: "example"
nameTekst nullWymagane

Nazwa zasobu we właściwym kontekście.

Przykład: "Example"
numberTekstWymagane

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

Przykład: "example"
pricePriceData nullWymagane

Informacje o cenie w wybranym kontekście.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionLiczba całkowitaWymagane

Bieżąca wersja ceny do kontroli współbieżności.

Przykład: 1
primary_category_idTekst nullWymagane

Identyfikator kategorii głównej.

Przykład: "example"
primary_media_idTekst nullWymagane

Identyfikator głównego zasobu mediów.

Przykład: "example"
publishedWartość logicznaWymagane

Czy zasób jest opublikowany.

Przykład: false
skuTekstWymagane

Kod jednostki magazynowej SKU.

Przykład: "example"
slugTekst nullWymagane

Fragment ścieżki URL w wybranym języku.

Przykład: "example"
tax_category_idTekstWymagane

Identyfikator kategorii podatkowej.

Przykład: "example"
updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"
Przykład: "2026-01-01T12:00:00Z"
variants_enabledWartość logicznaWymagane

Czy produkt korzysta z wariantów.

Przykład: false
versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Kody identyfikacyjne produktu

ProductIdentifiers · Schemat · Modele produktów
eanTekst nullOpcjonalne

Identyfikator produktu EAN.

Tekst:minLength: 1maxLength: 100
isbnTekst nullOpcjonalne

Identyfikator ISBN.

Tekst:minLength: 1maxLength: 100
mpnTekst nullOpcjonalne

Numer katalogowy producenta.

Tekst:minLength: 1maxLength: 100
upcTekst nullOpcjonalne

Identyfikator produktu UPC.

Tekst:minLength: 1maxLength: 100

Dodatkowe pola: Nie

Informacje o przypisanych mediach

ProductMediaData · Schemat · Modele produktów
alt_textTekst nullWymagane

Tekst alternatywny zdjęcia.

Przykład: "example"
idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (ProductMediaData).

Przykład: "example"
is_primaryWartość logicznaWymagane

Czy jest to pozycja główna.

Przykład: true
kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["image", "video", "model_3d"]
Przykład: "image"
mime_typeTekstWymagane

Typ zawartości zasobu multimedialnego.

Przykład: "image/jpeg"
positionLiczba całkowitaWymagane

Pozycja w uporządkowanej kolekcji.

Przykład: 1
urlTekst nullWymagane

Adres zasobu.

Przykład: "https://example.invalid/product.jpg"

Dodatkowe pola: Nie

Konfiguracja ceny i jej wersje do kontroli współbieżności

ProductPrice · Schemat · Modele produktów
amountTekst nullWymagane

Kwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.

Tekst:maxLength: 19
Ograniczenia · Tekst 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Przykład: "0.00"
currencyTekstWymagane

Kod waluty kwoty.

Ograniczenia
pattern
"^[A-Z]{3}$"
Przykład: "PLN"
expected_price_list_versionLiczba całkowitaWymagane

Odczytana wcześniej wersja cennika wymagana przy tym zapisie.

minimum: 1maximum: 9223372036854775807
Przykład: 1
expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 0maximum: 9223372036854775807
Przykład: 0
kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia
enum
["base", "market_fixed"]
Przykład: "base"
price_list_idTekstWymagane

Identyfikator cennika.

minLength: 1maxLength: 63
Przykład: "example"
tax_includedWartość logicznaWymagane

Czy przesyłana cena zawiera podatek.

Przykład: true

Dodatkowe pola: Nie

Pobierz listę produktów — Odpowiedź

ProductSummaryData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
availabilityAvailabilityData Wymagane

Informacje o dostępności w wybranym kontekście.

Przykład: {"available_from":null,"available_until":null,"is_available":true}
brand_idTekst nullWymagane

Identyfikator marki.

Przykład: null
conditionTekstWymagane

Stan produktu.

Ograniczenia
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Przykład: "new"
created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"
Przykład: "2026-01-01T12:00:00Z"
idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (ProductSummaryData).

Przykład: "example"
nameTekst nullWymagane

Nazwa zasobu we właściwym kontekście.

Przykład: "Example"
numberTekstWymagane

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

Przykład: "example"
pricePriceData nullWymagane

Informacje o cenie w wybranym kontekście.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionLiczba całkowitaWymagane

Bieżąca wersja ceny do kontroli współbieżności.

Przykład: 1
primary_category_idTekst nullWymagane

Identyfikator kategorii głównej.

Przykład: "example"
primary_media_idTekst nullWymagane

Identyfikator głównego zasobu mediów.

Przykład: "example"
publishedWartość logicznaWymagane

Czy zasób jest opublikowany.

Przykład: false
skuTekstWymagane

Kod jednostki magazynowej SKU.

Przykład: "example"
slugTekst nullWymagane

Fragment ścieżki URL w wybranym języku.

Przykład: "example"
tax_category_idTekstWymagane

Identyfikator kategorii podatkowej.

Przykład: "example"
updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"
Przykład: "2026-01-01T12:00:00Z"
variants_enabledWartość logicznaWymagane

Czy produkt korzysta z wariantów.

Przykład: false
versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Zmień produkt — Treść żądania

ProductUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
brand_idTekst nullOpcjonalne

Identyfikator marki.

Tekst:minLength: 1maxLength: 63
conditionTekstOpcjonalne

Stan produktu.

Ograniczenia
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionTekst nullOpcjonalne

Opis w wybranym języku.

Tekst:maxLength: 100000
Przykład: null
expected_variant_price_versionsObiektDodatkowe pola: Liczba całkowita
minimum: 0maximum: 9223372036854775807
Opcjonalne

Odczytane wcześniej wersje cen przypisane do identyfikatorów wariantów.

maxProperties: 250
Ograniczenia
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807
Przykład: 1
feature_value_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych wartości cech.

maxItems: 1000
Tablica:minLength: 1maxLength: 63
identifiersProductIdentifiers nullOpcjonalne

Kody identyfikacyjne produktu.

market_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych rynków.

maxItems: 1000
Tablica:minLength: 1maxLength: 63
media_idsTablica <Tekst> Opcjonalne

Identyfikatory istniejących już zasobów mediów.

maxItems: 20
Tablica:minLength: 1maxLength: 63
meta_descriptionTekst nullOpcjonalne

Opis dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 160
meta_keywordsTablica <Tekst> nullOpcjonalne

Słowa kluczowe dla wyszukiwarek w wybranym języku.

Tablica:maxItems: 20
Tablica / Tablica:maxLength: 50
meta_titleTekst nullOpcjonalne

Tytuł dla wyszukiwarek w wybranym języku.

Tekst:maxLength: 70
nameTekst nullOpcjonalne

Nazwa zasobu we właściwym kontekście.

Tekst:maxLength: 300
Przykład: null
pricingProductPrice Opcjonalne

Konfiguracja ceny i jej wersje do kontroli współbieżności.

Przykład: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idTekst nullOpcjonalne

Identyfikator kategorii głównej.

Tekst:minLength: 1maxLength: 63
publishedWartość logicznaOpcjonalne

Czy zasób jest opublikowany.

skuTekstOpcjonalne

Kod jednostki magazynowej SKU.

minLength: 1maxLength: 100
Ograniczenia
pattern
"^\\S+$"
Przykład: "example"
slugTekst nullOpcjonalne

Fragment ścieżki URL w wybranym języku.

Tekst:maxLength: 160
tax_category_idTekst nullOpcjonalne

Identyfikator kategorii podatkowej.

Tekst:minLength: 1maxLength: 63
variant_value_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych wartości wariantów.

maxItems: 250
Tablica:minLength: 1maxLength: 63
variants_enabledWartość logicznaOpcjonalne

Czy produkt korzysta z wariantów.

Dodatkowe pola: Nie