Plik JSON - katalog produktów
Link do pobrania informacji produktowych
https://api.deante.pl/api/products?key=KLUCZ_API
Definicja składowych pliku
enum Brand{ Deante Neo}enum ImageType{ packshot additionalPackshot decor}enum ProductType{ product set}enum FileType{ instruction technicalDrawing model3d warrantyCard declaration hygienicCertificate}interface Image { src: String type: ImageType}interface File { src: String type: FileType}interface PackageValue { value: Number unit: 'mm' | 'g'}interface Category { id: String name: String main?: Boolean}interface Designer { name: String description: String}interface Property { name: String value: String | Number scope: String}interface Feature { name: String description: String image: String}interface Product { id: String // "BQA_021M" brand: Brand // "Deante" producer: String // "Deante" productType: ProductType // "product" url: String // "https://deante.pl/produkt/agawa-bateria-umywalkowa-BQG_020M" name: String // "Bateria umywalkowa wysoka" collection: String // "ARNIKA" finishes: String[] // [ "chrom", "nero" ] ean: String // "5908212092057" cn: String // "84818011" pkwiu: String // "28.14.20.0" prices: Object typeof { currency: String // "PLN" netPrice: Number // 649.59 - Cennikowa cena netto grossPrice: Number // 799.99 - Cennikowa cena brutto vat: Number // 23 - Wartość procentowa hasPromotion: Boolean // hasPromotion === false => promotion: null promotion?: Object typeof { netPrice: Number // 568.29 - Promocyjna cena netto grossPrice: Number // 699.00 - Promocyjna cena brutto } }, categories: Category[] images: Image[] videos: String[] files: File[] description: String package: Object typeof {{ height: PackageValue width: PackageValue depth: PackageValue weight: PackageValue } isDesigned: Boolean // isDesigned === false => designers: null designers?: Designer[] properties: Property[] features: Feature[] warranty: Number recommendedProducts: String[]}
Dostępne pola
Product.id
Kod produktu Deante. Służy jako uniwersalny identyfikator produktu.
Product.brand
Marka produktu. Pole typu enum Brand. Dostępne są jedynie wartości Deante oraz Neo.
Product.producer
Producent produktu. Pole wskazujące producenta produktu.
Product.productType
Rodzaj produktu. Określa czy obiekt przedstawia pojedynczy produkt, czy zestaw składający się z kilku produktów.
Product.url
Link do karty produktowej w serwisie deante.pl
Product.name
Nazwa produktu Deante. Opisuje typ produktu i jego najważniejsze cechy.
Product.collection
Seria produktu Deante. Wszystkie produkty z serii są spójne stylistycznie. Cechę tę można wykorzystać do stworzenia rekomendacji dla klientów odwiedzających sklep internetowy.
Product.finishes
Wykończenia produktu Deante. Przedstawia listę głównych kolorów produktu.
Product.ean
Kod kreskowy EAN-13. Unikalny kod kreskowy nadrukowywany na pudełku produktu.
Product.cn
Kod CN. Kod celny produktu.
Product.pkwiu
Kod PKWiU. Numer klasyfikacji produktu według Polskiej Klasyfikacji Wyrobów i Usług
Product.prices
Nazwa cechy | Typ cechy | Opis |
---|---|---|
currency | String | Waluta w jakiej wysyłana jest cena (domyślnie: PLN) |
netPrice | Number | Cennikowa cena netto |
grossPrice | Number | Cennikowa cena brutto |
vat | Number | Procentowa wartość podatku VAT |
hasPromotion | Boolean | Oznaczenie czy produkt aktualnie znajduje się na promocji (domyślnie: false) |
promotion | Object | Null | Opcjonalnie Obiekt zawierający ceny promocyjne (domyślnie: null) |
promotion.netPrice | Number | Promocyjna cena netto |
promotion.grossPrice | Number | Promocyjna cena brutto |
Product.categories
Kategorie produktu. Lista wszystkich obiektów klasy Category, określających do jakiej kategorii przypisany jest produkt.
Category
Nazwa cechy | Typ cechy | Opis |
---|---|---|
id | String | Pełna ścieżka kategorii, spełniająca rolę identyfikatora |
name | String | Nazwa kategorii |
main | Boolean | Wartość określająca, czy dana kategoria jest główną kategorią produktu (domyślnie: false) |
Product.images
Zdjęcia produktowe. Lista wszystkich obiektów klasy Image, określających zdjęcia przedstawiające produkt.
Image
Nazwa cechy | Typ cechy | Opis |
---|---|---|
src | String | URL do zasobu w domenie https://media.deante.pl |
type | ImageType | Pole typu enum ImageType, określające rodzaj danego zdjęcia. |
ImageType
Dostępne wartości:
- packshot - Zdjęcie główne
- additionalPackshot - Zdjęcie dodatkowe
- decor - Zdjęcie aranżowane
Product.videos
Materiały video. Lista linków do materiałów video - platforma Youtube.
Product.files
Pliki do pobrania. Lista wszystkich obiektów klasy File, przechowujących informacje o pliku.
File
Nazwa cechy | Typ cechy | Opis |
---|---|---|
src | String | URL umożliwiający pobranie zasobu z domeny https://pc21.deante.pl |
type | FileType | Pole typu enum FileType, określające rodzaj danego pliku. |
FileType
Dostępne wartości:
- instruction - Instrukcja do produktu. Może przedstawiać różne informacje, takie jak przykładowo sposób montażu, lub pielęgnacji
- technicalDrawing - Rysunek techniczny, przedstawiający dokładne wymiary produktu
- model3d - Model 3D produktu. Deante udostępnia bryły w różnych formatach pliku, takich jak: .3ds, .dwg, .skp, .obj, .dxf, .gsm, .blend, .stp, .rfa, .fbx, .stl, .ifc
- warrantyCard - Karta gwarancyjna, opisująca dokładne warunki gwarancji produktu
- declaration - Deklaracja właściwości użytkowych
- hygienicCertificate - Atest higieniczny
Product.description
Opis produktu. Opisuje ogólne cechy produktu, przedstawiając je w sposób mniej techniczny, a bardziej czytelny dla przeciętnego użytkownika
Product.package
Dane o opakowaniu. Zawiera informacje o wymiarach jak i wadze brutto paczki (z produktem w środku).
Nazwa cechy | Typ cechy | Opis |
---|---|---|
height | PackageValue | Wysokość opakowania |
width | PackageValue | Szerokość opakowania |
depth | PackageValue | Głębokość opakowania |
weight | PackageValue | Waga brutto opakowania |
PackageValue
Nazwa cechy | Typ cechy | Opis |
---|---|---|
value | Number | Wartość liczbowa dla danego pola |
unit | String | Określa jednostkę opisującą pole value. Dostępne wartości to: mm - milimetry | g - gramy |
Product.isDesigned
Pole typu TRUE | FALSE, określające czy produkt jest produktem projektowanym
Product.designers
Lista projektantów. Przechowuje wszystkie obiekty typu Designer, opisujące wszystkich projektantów, którzy zaprojektowali dany produkt. Wartość pola jest ściśle zależna od pola isDesigned, i przybiera wartość null w momencie, gdy isDesigned posiada wartość FALSE
Designer
Nazwa cechy | Typ cechy | Opis |
---|---|---|
name | String | Imię i nazwisko projektanta |
description | String | Opis projektanta |
Product.properties
Cechy produktu. Lista wszystkich obiektów klasy Property, określających różne cechy danego produktu. Wszystkie dostępne cechy produktowe można znaleźć tutaj
Property
Nazwa cechy | Typ cechy | Opis |
---|---|---|
name | String | Nazwa cechy produktowej |
value | String | Number | Wartość cechy produktowej |
scope | String | Definiuje do jakiej grupy cech należy dana cecha |
Product.features
Wyróżniki produktu. Lista wszystkich obiektów klasy Feature, określających specjalne cechy marketingowe wyróżniające dany produkt.
Feature
Nazwa cechy | Typ cechy | Opis |
---|---|---|
name | String | Nazwa wyróżnika produktowego |
description | String | Opis wyróżnika produktowego |
image | String | URL do zdjęcia wyróżnika w domenie https://media.deante.pl |
Product.warranty
Gwarancja produktu. Określa na ile lat obowiązuje gwarancja na dany produkt.
Product.recommendedProducts
Produkty powiązane. Lista kodów produktów powiązanych, lub polecanych w komplecie do danego produktu.