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

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
dataProductFileListData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
dataReleaseListData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

ApiResponse_UploadData_

ApiResponse_UploadData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
dataUploadData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"request_id":"example"}

Dodatkowe pola: Nie

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Odpowiedź: opublikowana reguła dostępu, data pierwszej publikacji i wybrane zamówienia.
dataAudienceData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"request_id":"example-request"}

Dodatkowe pola: Nie

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

AudienceChange

AudienceChange · Żądanie zmiany reguły dostępu do jednego pliku cyfrowego.
audienceAudienceSelection Wymagane

Jawna reguła dostępu do przesłanego współdzielonego pliku cyfrowego.

Przykład: {"mode":"all_purchasers"}
expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807
Przykład: 1

Dodatkowe pola: Nie

AudienceData

AudienceData · Opublikowana reguła dostępu, data pierwszej publikacji i wybrane zamówienia.
anchor_atTekstWymagane

Czas pierwszej publikacji. Zmiana odbiorców nie zeruje tej daty.

format: "date-time"
Przykład: "2026-11-03T12:00:00Z"
effective_atTekstWymagane

Czas publikacji tej rewizji reguły odbiorców.

format: "date-time"
Przykład: "2026-11-03T12:00:00Z"
file_idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. · file_id

Przykład: "00000000-0000-4000-8000-000000000007"
file_version_idTekstWymagane

Identyfikator konkretnej, niezmiennej wersji zawartości pliku objętej regułą.

Przykład: "00000000-0000-4000-8000-000000000010"
historical_access_preservedWartość logicznaOpcjonalne

Wcześniej przyznany dostęp pozostaje przy zawężaniu reguły odbiorców.

Wartość domyślna: truePrzykład: true
idTekstWymagane

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

Przykład: "00000000-0000-4000-8000-000000000009"
lookback_daysLiczba całkowita nullWymagane

1–3650 dni przed pierwszą publikacją; wymagane tylko dla recent_and_new.

Przykład: null
modeTekstWymagane

Jawna reguła dostępu do przesłanego współdzielonego pliku cyfrowego. new_purchases / recent_and_new / selected / all_purchasers.

Przykład: "all_purchasers"
next_cursorTekst nullWymagane

Znacznik kontynuacji dla następnej strony albo null.

Przykład: null
order_idsTablica <Tekst> Wymagane

Różne uprawnione, opłacone zamówienia zawierające ten produkt; wymagane tylko dla dostępu selected.

Przykład: []
product_versionLiczba całkowitaWymagane

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

Przykład: 3
revisionLiczba całkowitaWymagane

Kolejna rewizja reguły odbiorców pliku.

Przykład: 1

Dodatkowe pola: Nie

AudienceSelection

AudienceSelection · Odbiorcy pliku: nowe zakupy, ostatnie i przyszłe zakupy, wybrane zamówienia albo wszyscy kupujący.
lookback_daysLiczba całkowita nullOpcjonalne

1–3650 dni przed pierwszą publikacją; wymagane tylko dla recent_and_new.

Liczba całkowita:minimum: 1maximum: 3650
modeTekstWymagane

Jawna reguła dostępu do przesłanego współdzielonego pliku cyfrowego. new_purchases / recent_and_new / selected / all_purchasers.

Ograniczenia
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Przykład: "new_purchases"
order_idsTablica <Tekst> Opcjonalne

Różne uprawnione, opłacone zamówienia zawierające ten produkt; wymagane tylko dla dostępu selected.

maxItems: 1000
Ograniczenia · Tablica 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Wartość domyślna: []

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

FileAssign

FileAssign · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
audienceAudienceSelection nullOpcjonalne

Jawna reguła dostępu do przesłanego współdzielonego pliku cyfrowego.

Przykład: {"mode":"new_purchases"}
expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807
Przykład: 1
labelTekstOpcjonalne

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

maxLength: 300
Wartość domyślna: ""
upload_idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. · upload_id

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000001"

Dodatkowe pola: Nie

FileCategory

FileCategory · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
Tekst
Ograniczenia
enum
["internal", "customer_document", "digital"]

Dodatkowe pola: Tak

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: 30
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

ProductFileData

ProductFileData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
categoryFileCategory Wymagane

Kategoria pliku: internal / customer_document / digital

Przykład: "digital"
created_atTekstWymagane

Data i czas utworzenia.

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

Identyfikator zasobu; zachowaj wartość zwróconą przez API. · current_version_id

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000001"
file_idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. · file_id

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000001"
filenameTekstWymagane

Plik

Przykład: "manual.pdf"
idTekstWymagane

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

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000001"
labelTekstWymagane

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

Przykład: "Manual"
mime_typeTekstWymagane

Typ zawartości zasobu multimedialnego.

Przykład: "application/pdf"
sha256TekstWymagane

SHA-256 (hex, 64)

Przykład: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesLiczba całkowitaWymagane

Rozmiar w bajtach

Przykład: 46
stateTekstWymagane

Status

Przykład: "active"
version_numberLiczba całkowitaWymagane

Wersja

Przykład: 1

Dodatkowe pola: Nie

ProductFileListData

ProductFileListData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
filesTablica <ProductFileData > Wymagane

Pliki produktu

Przykład: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_versionLiczba całkowitaWymagane

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

Przykład: 2

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: 30
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
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

ProductVersion

ProductVersion · Ta operacja została wycofana i zwraca 409 bez zmiany danych. Dostęp ustawisz osobno dla każdego pliku cyfrowego w operacji wyboru odbiorców.
expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807
Przykład: 1

Dodatkowe pola: Nie

ReleaseData

ReleaseData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
changelogTekstWymagane

Opis zmian

Przykład: "Manual update"
filesTablica <ReleaseFileData > Wymagane

Pliki produktu

Przykład: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idTekstWymagane

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

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000001"
manifest_sha256Tekst nullWymagane

Wydania cyfrowe · SHA-256

Przykład: "1111111111111111111111111111111111111111111111111111111111111111"
published_atTekst nullWymagane

Opublikuj wydanie · UTC

Tekst:format: "date-time"
Przykład: null
release_sequenceLiczba całkowita nullWymagane

Wydania cyfrowe · Pozycja w uporządkowanej kolekcji.

Przykład: null
stateTekstWymagane

Status

Przykład: "active"
version_labelTekstWymagane

Wersja

Przykład: "1.0"
withdrawn_atTekst nullWymagane

Wycofaj ofertę · UTC

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

Dodatkowe pola: Nie

ReleaseDraft

ReleaseDraft · Ta operacja została wycofana i zwraca 409 bez zmiany danych. Dostęp ustawisz osobno dla każdego pliku cyfrowego w operacji wyboru odbiorców.
changelogTekstOpcjonalne

Opis zmian

maxLength: 20000
Wartość domyślna: ""
expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807
Przykład: 1
version_idsTablica <Tekst> Wymagane

Wersja · UUID[]

minItems: 1maxItems: 20
Tablica:format: "uuid"
Przykład: ["00000000-0000-4000-8000-000000000001"]
version_labelTekstWymagane

Wersja

minLength: 1maxLength: 64
Przykład: "1.0"

Dodatkowe pola: Nie

ReleaseFileData

ReleaseFileData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
file_idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. · file_id

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000001"
sort_orderLiczba całkowitaWymagane

Pozycja w uporządkowanej kolekcji.

Przykład: 0
version_idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. · version_id

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000001"

Dodatkowe pola: Nie

ReleaseListData

ReleaseListData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
current_release_idTekst nullWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. · current_release_id

Tekst:format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000001"
product_versionLiczba całkowitaWymagane

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

Przykład: 2
releasesTablica <ReleaseData > Wymagane

Wydania cyfrowe

Przykład: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_daysLiczba całkowita nullWymagane

Liczba dni (days; null)

Przykład: 365
update_modeTekstWymagane

Dostęp do przyszłych plików po zakupie: none / period / unlimited

Przykład: "period"
update_monthsLiczba całkowita nullWymagane

Miesiące (months; null)

Przykład: null

Dodatkowe pola: Nie

UpdatePolicy

UpdatePolicy · Ta operacja została wycofana i zwraca 409 bez zmiany danych. Dostęp ustawisz osobno dla każdego pliku cyfrowego w operacji wyboru odbiorców.
daysLiczba całkowita nullOpcjonalne

Liczba dni (1–3650; mode=period; months=null)

Liczba całkowita:minimum: 1maximum: 3650
Przykład: 365
expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807
Przykład: 1
modeTekstWymagane

Dostęp do przyszłych plików po zakupie: none / period / unlimited

Ograniczenia
enum
["none", "period", "unlimited"]
Przykład: "period"
monthsLiczba całkowita nullOpcjonalne

Miesiące (1–120; mode=period; days=null)

Liczba całkowita:minimum: 1maximum: 120
Przykład: null

Dodatkowe pola: Nie

UploadCreate

UploadCreate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
filenameTekstWymagane

Plik

minLength: 1maxLength: 255
Przykład: "manual.pdf"
product_idTekst nullOpcjonalne

Identyfikator produktu.

Ograniczenia · Tekst 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Przykład: "example"
sha256TekstWymagane

SHA-256 (hex, 64)

Ograniczenia
pattern
"^[0-9a-f]{64}$"
Przykład: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesLiczba całkowitaWymagane

Rozmiar w bajtach

minimum: 1maximum: 262144000
Przykład: 46

Dodatkowe pola: Nie

UploadData

UploadData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API. Pliki przesyłasz jako multipart/form-data po utworzeniu upload_id, a następnie przypisujesz do produktu. Pobranie wymaga tokenu Bearer i uprawnienia dla category; odpowiedź zawiera bajty pliku, bez publicznego adresu i hasła. Dla mode=period wybierz days (1–3650) albo dotychczasowe months, nigdy oba pola. Warunki są zapamiętywane przy zakupie; zwrot odbiera dostęp tylko do zwróconej pozycji.
categoryFileCategory Wymagane

Kategoria pliku: internal / customer_document / digital

Przykład: "digital"
expires_atTekstWymagane

Data i czas wygaśnięcia tokenu.

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

Plik

Przykład: "manual.pdf"
idTekstWymagane

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

format: "uuid"
Przykład: "00000000-0000-4000-8000-000000000001"
product_idTekst nullWymagane

Identyfikator produktu.

Przykład: "example"
received_bytesLiczba całkowitaWymagane

Przesyłanie… · Rozmiar w bajtach

Przykład: 46
sha256TekstWymagane

SHA-256 (hex, 64)

Przykład: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesLiczba całkowitaWymagane

Rozmiar w bajtach

Przykład: 46
statusTekstWymagane

Status obsługiwany przez daną operację.

Przykład: "ready"

Dodatkowe pola: Nie