Schematy danych
Pobierz listę produktów — Odpowiedź
ApiResponse_list_ProductSummaryData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
dataTablica <ProductSummaryData> WymaganePrzykład odpowiedzi · ApiResponse_list_ProductSummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMetaWymaganeMetadane odpowiedzi.
Dodatkowe pola: Nie
Pobierz produkt — Odpowiedź
ApiResponse_ProductDetailData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
dataProductDetailDataWymaganePrzykład odpowiedzi · ProductDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaWymaganeMetadane odpowiedzi.
Dodatkowe pola: Nie
Informacje o dostępności w wybranym kontekście
AvailabilityData · Schemat · Modele produktów
available_fromTekst nullWymaganePoczątek dostępności.
Tekst:format:"date-time"available_untilTekst nullWymaganeKoniec dostępności.
Tekst:format:"date-time"is_availableWartość logicznaWymaganeCzy pozycja jest dostępna w tym kontekście.
Dodatkowe pola: Nie
Informacje o cenie w wybranym kontekście
PriceData · Schemat · Modele produktów
amountTekstWymaganeKwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.
currencyTekstWymaganeKod waluty kwoty.
Ograniczenia
pattern"^[A-Z]{3}$"
minor_unitsLiczba całkowitaWymaganeLiczba cyfr części ułamkowej używanych przez walutę.
minimum:0maximum:4tax_includedWartość logicznaWymaganeCzy przesyłana cena zawiera podatek.
Dodatkowe pola: Nie
Informacje o cenniku
PriceListData · Schemat · Modele produktów
currencyTekstWymaganeKod waluty kwoty.
idTekstWymaganeIdentyfikator zasobu; zachowaj wartość zwróconą przez API. (PriceListData).
tax_includedWartość logicznaWymaganeCzy przesyłana cena zawiera podatek.
versionLiczba całkowitaWymaganeWersja 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 nullOpcjonalneIdentyfikator marki.
Tekst:minLength:1maxLength:63conditionTekstOpcjonalneStan produktu.
Ograniczenia
enum["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionTekst nullOpcjonalneOpis w wybranym języku.
Tekst:maxLength:100000feature_value_idsTablica <Tekst> OpcjonalneIdentyfikatory wybranych wartości cech.
maxItems:1000Tablica:minLength:1maxLength:63identifiersProductIdentifiersnullOpcjonalneKody identyfikacyjne produktu.
market_idsTablica <Tekst> OpcjonalneIdentyfikatory wybranych rynków.
maxItems:1000Tablica:minLength:1maxLength:63media_idsTablica <Tekst> OpcjonalneIdentyfikatory istniejących już zasobów mediów.
maxItems:20Tablica:minLength:1maxLength:63meta_descriptionTekst nullOpcjonalneOpis dla wyszukiwarek w wybranym języku.
Tekst:maxLength:160meta_keywordsTablica <Tekst> nullOpcjonalneSłowa kluczowe dla wyszukiwarek w wybranym języku.
Tablica:maxItems:20Tablica / Tablica:maxLength:50meta_titleTekst nullOpcjonalneTytuł dla wyszukiwarek w wybranym języku.
Tekst:maxLength:70nameTekstWymaganeNazwa zasobu we właściwym kontekście.
minLength:1maxLength:300pricingProductPriceOpcjonalneKonfiguracja ceny i jej wersje do kontroli współbieżności.
primary_category_idTekst nullOpcjonalneIdentyfikator kategorii głównej.
Tekst:minLength:1maxLength:63publishedWartość logicznaOpcjonalneCzy zasób jest opublikowany.
skuTekstWymaganeKod jednostki magazynowej SKU.
minLength:1maxLength:100Ograniczenia
pattern"^\\S+$"
slugTekst nullOpcjonalneFragment ścieżki URL w wybranym języku.
Tekst:maxLength:160tax_category_idTekst nullOpcjonalneIdentyfikator kategorii podatkowej.
Tekst:minLength:1maxLength:63variant_value_idsTablica <Tekst> OpcjonalneIdentyfikatory wybranych wartości wariantów.
maxItems:250Tablica:minLength:1maxLength:63variants_enabledWartość logicznaOpcjonalneCzy produkt korzysta z wariantów.
Dodatkowe pola: Nie
Pobierz produkt — Odpowiedź
ProductDetailData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
availabilityAvailabilityDataWymaganeInformacje o dostępności w wybranym kontekście.
brand_idTekst nullWymaganeIdentyfikator marki.
conditionTekstWymaganeStan produktu.
Ograniczenia
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_atTekstWymaganeData i czas utworzenia.
format:"date-time"descriptionTekst nullWymaganeOpis w wybranym języku.
featuresTablica <FeatureSelectionData> WymaganeCechy produktu.
idTekstWymaganeIdentyfikator zasobu; zachowaj wartość zwróconą przez API. (ProductDetailData).
identifiersObiektDodatkowe pola: TekstWymaganeKody identyfikacyjne produktu.
mediaTablica <ProductMediaData> WymaganeInformacje o przypisanych mediach.
meta_descriptionTekst nullWymaganeOpis dla wyszukiwarek w wybranym języku.
meta_keywordsTablica <Tekst> nullWymaganeSłowa kluczowe dla wyszukiwarek w wybranym języku.
meta_titleTekst nullWymaganeTytuł dla wyszukiwarek w wybranym języku.
nameTekst nullWymaganeNazwa zasobu we właściwym kontekście.
numberTekstWymaganeNumer zamówienia lub zgłoszenia widoczny dla użytkownika.
pricePriceDatanullWymaganeInformacje o cenie w wybranym kontekście.
price_versionLiczba całkowitaWymaganeBieżąca wersja ceny do kontroli współbieżności.
primary_category_idTekst nullWymaganeIdentyfikator kategorii głównej.
primary_media_idTekst nullWymaganeIdentyfikator głównego zasobu mediów.
publishedWartość logicznaWymaganeCzy zasób jest opublikowany.
skuTekstWymaganeKod jednostki magazynowej SKU.
slugTekst nullWymaganeFragment ścieżki URL w wybranym języku.
tax_category_idTekstWymaganeIdentyfikator kategorii podatkowej.
updated_atTekstWymaganeData i czas ostatniej aktualizacji.
format:"date-time"variants_enabledWartość logicznaWymaganeCzy produkt korzysta z wariantów.
versionLiczba całkowitaWymaganeWersja zasobu używana do kontroli współbieżności.
Dodatkowe pola: Nie
Kody identyfikacyjne produktu
ProductIdentifiers · Schemat · Modele produktów
eanTekst nullOpcjonalneIdentyfikator produktu EAN.
Tekst:minLength:1maxLength:100isbnTekst nullOpcjonalneIdentyfikator ISBN.
Tekst:minLength:1maxLength:100mpnTekst nullOpcjonalneNumer katalogowy producenta.
Tekst:minLength:1maxLength:100upcTekst nullOpcjonalneIdentyfikator produktu UPC.
Tekst:minLength:1maxLength:100
Dodatkowe pola: Nie
Informacje o przypisanych mediach
ProductMediaData · Schemat · Modele produktów
alt_textTekst nullWymaganeTekst alternatywny zdjęcia.
idTekstWymaganeIdentyfikator zasobu; zachowaj wartość zwróconą przez API. (ProductMediaData).
is_primaryWartość logicznaWymaganeCzy jest to pozycja główna.
kindTekstWymaganeRodzaj struktury danych określony dozwolonymi wartościami.
Ograniczenia
enum["image", "video", "model_3d"]
mime_typeTekstWymaganeTyp zawartości zasobu multimedialnego.
positionLiczba całkowitaWymaganePozycja w uporządkowanej kolekcji.
urlTekst nullWymaganeAdres zasobu.
Dodatkowe pola: Nie
Konfiguracja ceny i jej wersje do kontroli współbieżności
ProductPrice · Schemat · Modele produktów
amountTekst nullWymaganeKwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.
Tekst:maxLength:19Ograniczenia · Tekst 1
pattern"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
currencyTekstWymaganeKod waluty kwoty.
Ograniczenia
pattern"^[A-Z]{3}$"
expected_price_list_versionLiczba całkowitaWymaganeOdczytana wcześniej wersja cennika wymagana przy tym zapisie.
minimum:1maximum:9223372036854775807expected_versionLiczba całkowitaWymaganeWersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.
minimum:0maximum:9223372036854775807kindTekstWymaganeRodzaj struktury danych określony dozwolonymi wartościami.
Ograniczenia
enum["base", "market_fixed"]
price_list_idTekstWymaganeIdentyfikator cennika.
minLength:1maxLength:63tax_includedWartość logicznaWymaganeCzy przesyłana cena zawiera podatek.
Dodatkowe pola: Nie
Pobierz listę produktów — Odpowiedź
ProductSummaryData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
availabilityAvailabilityDataWymaganeInformacje o dostępności w wybranym kontekście.
brand_idTekst nullWymaganeIdentyfikator marki.
conditionTekstWymaganeStan produktu.
Ograniczenia
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_atTekstWymaganeData i czas utworzenia.
format:"date-time"idTekstWymaganeIdentyfikator zasobu; zachowaj wartość zwróconą przez API. (ProductSummaryData).
nameTekst nullWymaganeNazwa zasobu we właściwym kontekście.
numberTekstWymaganeNumer zamówienia lub zgłoszenia widoczny dla użytkownika.
pricePriceDatanullWymaganeInformacje o cenie w wybranym kontekście.
price_versionLiczba całkowitaWymaganeBieżąca wersja ceny do kontroli współbieżności.
primary_category_idTekst nullWymaganeIdentyfikator kategorii głównej.
primary_media_idTekst nullWymaganeIdentyfikator głównego zasobu mediów.
publishedWartość logicznaWymaganeCzy zasób jest opublikowany.
skuTekstWymaganeKod jednostki magazynowej SKU.
slugTekst nullWymaganeFragment ścieżki URL w wybranym języku.
tax_category_idTekstWymaganeIdentyfikator kategorii podatkowej.
updated_atTekstWymaganeData i czas ostatniej aktualizacji.
format:"date-time"variants_enabledWartość logicznaWymaganeCzy produkt korzysta z wariantów.
versionLiczba całkowitaWymaganeWersja zasobu używana do kontroli współbieżności.
Dodatkowe pola: Nie
Zmień produkt — Treść żądania
ProductUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.
brand_idTekst nullOpcjonalneIdentyfikator marki.
Tekst:minLength:1maxLength:63conditionTekstOpcjonalneStan produktu.
Ograniczenia
enum["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionTekst nullOpcjonalneOpis w wybranym języku.
Tekst:maxLength:100000expected_variant_price_versionsObiektDodatkowe pola: Liczba całkowitaOpcjonalneminimum:0maximum:9223372036854775807Odczytane wcześniej wersje cen przypisane do identyfikatorów wariantów.
maxProperties:250Ograniczenia
propertyNames{"maxLength": 63, "minLength": 1}
expected_versionLiczba całkowitaWymaganeWersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.
minimum:1maximum:9223372036854775807feature_value_idsTablica <Tekst> OpcjonalneIdentyfikatory wybranych wartości cech.
maxItems:1000Tablica:minLength:1maxLength:63identifiersProductIdentifiersnullOpcjonalneKody identyfikacyjne produktu.
market_idsTablica <Tekst> OpcjonalneIdentyfikatory wybranych rynków.
maxItems:1000Tablica:minLength:1maxLength:63media_idsTablica <Tekst> OpcjonalneIdentyfikatory istniejących już zasobów mediów.
maxItems:20Tablica:minLength:1maxLength:63meta_descriptionTekst nullOpcjonalneOpis dla wyszukiwarek w wybranym języku.
Tekst:maxLength:160meta_keywordsTablica <Tekst> nullOpcjonalneSłowa kluczowe dla wyszukiwarek w wybranym języku.
Tablica:maxItems:20Tablica / Tablica:maxLength:50meta_titleTekst nullOpcjonalneTytuł dla wyszukiwarek w wybranym języku.
Tekst:maxLength:70nameTekst nullOpcjonalneNazwa zasobu we właściwym kontekście.
Tekst:maxLength:300pricingProductPriceOpcjonalneKonfiguracja ceny i jej wersje do kontroli współbieżności.
primary_category_idTekst nullOpcjonalneIdentyfikator kategorii głównej.
Tekst:minLength:1maxLength:63publishedWartość logicznaOpcjonalneCzy zasób jest opublikowany.
skuTekstOpcjonalneKod jednostki magazynowej SKU.
minLength:1maxLength:100Ograniczenia
pattern"^\\S+$"
slugTekst nullOpcjonalneFragment ścieżki URL w wybranym języku.
Tekst:maxLength:160tax_category_idTekst nullOpcjonalneIdentyfikator kategorii podatkowej.
Tekst:minLength:1maxLength:63variant_value_idsTablica <Tekst> OpcjonalneIdentyfikatory wybranych wartości wariantów.
maxItems:250Tablica:minLength:1maxLength:63variants_enabledWartość logicznaOpcjonalneCzy produkt korzysta z wariantów.
Dodatkowe pola: Nie