Obiekty lokalne

Niniejszy artykuł przedstawia wykaz obiektów lokalnych dostępnych w sklepie. Obiekty mogą być wykorzystywane w szablonach graficznych sklepu.
Odwołanie do obiektu w szablonie następuje poprzez jego nazwę zmiennej nadaną w momencie dodania obiektu do szablonu.
Dla każgdego obiektu opisano:

  • opcje konfiguracyjne
  • strony, na których może być użyty
  • właściwości obiektu
Wskazówka
Obiekty lokalne domyślnie nie są dostępne w sklepie. Obiekt należy dodać, oraz aktywować na wybranych stronach.
Obiekty lokalne są importowane wraz z szablonem.
Obiekt udostępnia informacje o aktualnej stronie.

Nowości i promocje

Obiekt zwraca listę towarów wg właściwości, np. nowości, promocje, itd.

Konfiguracja

Konfiguracja

Dostępne opcje konfiguracyjne:

  • Pokaż towary tylko ze zdjęciem
  • Zawężaj do wybranej grupy
  • Ilość
  • Typ

Pokaż towary tylko ze zdjęciem – Towary tylko ze zdjęciem. Wartość domyślna: true.

Zawężaj do wybranej grupy – Towary tylko z wybranej grupy. Wartość domyślna: true.

Ilość – Liczba towarów.
Wartość minimalna: 1.
Wartość maksymalna: 50.
Wartość domyślna: 12.

Typ – Towary wg właściwości. Wartość domyślna: 1 – Promocja. Dostępne wartości:

  1. Promocja
  2. Nowość
  3. Najczęściej oglądane
  4. Najczęściej kupowane
  5. Cross-Selling
  6. Towar z gazetki
  7. Towar polecany
  8. Wyprzedaż
  9. Superjakość
  10. Supercena
  11. Najlepiej oceniany
  12. Rekomendacja sprzedawcy
  13. Dostępność–Zapowiedź
  14. Towary sugerowane (sugerowane do sprzedaży z ERP)
  15. Nagroda

Dostępny na stronach

Obiekt może być dodany na wszystkich dostępnych stronach w sklepie.
Obiekt może być dodany wielokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.
Obiekt posiada dwie właściwości:

  1. productnew.Products – lista towarów,
  2. productnew.Type – typ obiektu opisany liczbą zgodnie z kolejnością w panelu administracyjnym (1-promocja, 2-nowość itd.),

Właściwość Products posiada następujące właściwości:

  1. productnew.Products.AskForPrice – czy włączono opcję zapytaj o cenę,
  2. productnew.Products.Availability – informacje na temat dostępności,
    • Date – służy do wyświetlenia informacji na temat ustawionej daty dla danego towaru (np. przy zapowiedzi produktu),
    • ImageUrl – url obrazu,
    • Status – Id statusu dostępności,
    • Text – opis tekstowy dla danego statusu,
    • Type – wyświetla typ dostępności,
  3. productnew.Products.Brand – informacje na temat marki, zawiera:
    • Heading – tytuł,
    • Id – numer Id,
    • ImageId – id obrazu,
    • Name – nazwa,
    • Url – adres Url,
    • UrlWithManufacturer – adres do produktów danego producenta,
  4. productnew.Products.Code – kod produktu,
  5. productnew.Products.DecimalUnit – czy jednostki mogą być liczbami niecałkowitymi,
  6. productnew.Products.DefaultGroup – grupa domyślna,
  7. productnew.Products.Flags – zwraca flagi (np. nowość, wyprzedaż),
  8. productnew.Products.HasAttributes – czy posiada atrybuty,
  9. productnew.Products.HasOtherUnits – czy przedmiot ma inne jednostki sprzedażowe (np. para, pojedynczy produkt),
  10. productnew.Products.Id – numer Id,
  11. productnew.Products.ImageId – numer Id obrazu,
  12. productnew.Products.Link – link,
  13. productnew.Products.Manufacturer – w skład tej właściwości wchodzą Name, Id, Heading, ImageId, Url, Website,
  14. productnew.Products.Name – nazwa,
  15. productnew.Products.NameNoHtml – nazwa bez znaczników HTML,
  16. productnew.Products.NoDiscount – informacja czy produkt może być objęty zniżką,
  17. productnew.Products.PreviousPrice – poprzednia cena,
  18. productnew.Products.Price – cena,
  19. productnew.Products.Rating – średnia ocena,
  20. productnew.Products.RatingCount – ilość ocen,
  21. productnew.Products.RegularPrice – cena normalna,
  22. productnew.Products.SaleUnit – jednostka sprzedażowa (np. para),
  23. productnew.Products.UnitPriceRatio – przelicznik ceny za jednostkę miary,
  24. productnew.Products.UnitPriceUnit – możliwa jednostka przeliczeniowa (np. litry na mililitry, gramy na kilogramy itd.). Jeżeli wartość jest nullem nie wyświetlamy ceny jednostkowej,
  25. productnew.Products.Url – adres URL,
  26. productnew.Products.Weight – waga,

Siatka towarów

Obiekt zwraca listę towarów wg wybranego kryterium źródła danych.

Konfiguracja

Konfiguracja

Dostępne opcje konfiguracyjne:

  • Pokaż towary tylko ze zdjęciem
  • Ilość
  • Typ
  • Wartość

Pokaż towary tylko ze zdjęciem – Towary tylko ze zdjęciem. Wartość domyślna: true.

Ilość – Liczba towarów. Wartość minimalna: 1. Wartość maksymalna: 50. Wartość domyślna: 12.

Typ – Towary wg źródła. Wartość domyślna: 1 – Wybór ręczny. Dostępne wartości:

  1. Ręczny
  2. Grupa towarowa
  3. Producent
  4. Marka
  5. Ostatnio oglądane

Wartość – W zależności od wartości parametru Typ przyjmuje wartości:

  1. Id towarów oddzielone przecinkiem
  2. Id grupy
  3. Id producenta
  4. Id marki

Wartość domyślna: Pusty ciąg znaków.

Dostępny na stronach

Obiekt może być dodany na wszystkich dostępnych stronach w sklepie.
Obiekt może być dodany wielokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.
Obiekt posiada właściwość Products, w skład której wchodzą następujące właściwości:

  1. productlastviewed.Products.AskForPrice – czy włączono opcję zapytaj o cenę,
  2. productlastviewed.Products.Availability.Nazwa – informacje na temat dostępności, zawiera:
    • Date – zwraca datę kiedy produkt będzie dostępny (np. jeżeli produkt jest zapowiedzią),
    • ImageUrl – adres url dla obrazka,
    • Status – status,
    • Text – wartość tekstowa (np. „od ręki”),
    • Type – typ,
  3. productlastviewed.Products.Brand.Nazwa – marka, składa się z:
    • Heading – tytuł,
    • Id – numer Id,
    • ImageId – id obrazu,
    • Name – nazwa,
    • Url – adres url,
    • UrlWithManufacturer
  4. productlastviewed.Products.Code – zwraca kod produktu,
  5. productlastviewed.Products.DecimalUnit – czy jednostki mogą być liczbami niecałkowitymi,
  6. productlastviewed.Products.DefaultGroup – domyślna grupa,
  7. productlastviewed.Products.Flags – zwraca flagi dla produktów (np. promocja, nowość itd.),
  8. productlastviewed.Products.HasAttributes – czy posiada atrybuty,
  9. productlastviewed.Products.HasOtherUnits – czy przedmiot ma inne jednostki sprzedażowe (np. para, pojedynczy produkt),
  10. productlastviewed.Products.Id – id produktu,
  11. productlastviewed.Products.ImageId – zwraca Id obrazka,
  12. productlastviewed.Products.Link – link do strony produktu,
  13. productlastviewed.Products.Manufacturer.Nazwa – informacje na temat producenta, zawiera:
    • Heading – tytuł,
    • Id – id,
    • ImageId – id obrazu,
    • Name – nazwa,
    • Url – adres url,
    • Website – adres strony
  14. productlastviewed.Products.Name – nazwa,
  15. productlastviewed.Products.NameNoHtml – nazwa (pozbawiona znaczników HTML),
  16. productlastviewed.Products.NoDiscount – informacja czy produkt może być objęty zniżką
  17. productlastviewed.Products.PreviousPrice – poprzednia cena,
  18. productlastviewed.Products.Price – cena,
  19. productlastviewed.Products.Rating – średnia ocena,
  20. productlastviewed.Products.RatingCount – liczba wszystkich ocen,
  21. productlastviewed.Products.RegularPrice – cena normalna,
  22. productlastviewed.Products.SaleUnit – jednostka sprzedażowa (np. para),
  23. productlastviewed.Products.UnitPriceRatio – przelicznik ceny za jednostke miary,
  24. productlastviewed.Products.UnitPriceUnit – możliwa jednostka przeliczeniowa (np. litry na mililitry, gramy na kilogramy itd.). Jeżeli wartość jest nullem nie wyświetlamy ceny jednostkowej,
  25. productlastviewed.Products.Url – adres strony produktu (dokładniejszy niż w przypadku Link).
  26. productlastviewed.Products.Weight – waga,

Lista towarów

Obiekt zwraca listę towarów dla wybranej kategorii lub kryterium wyszukiwania.

Konfiguracja

Konfiguracja

Dostępne opcje konfiguracyjne:

  • Ilość
  • Sortuj według
  • Parametry GET
  • pageId
  • sort

Ilość – Liczba towarów. Wartość minimalna: 1. Wartość maksymalna: 50. Wartość domyślna: 12.

Sortuj według – Domyślne sortowanie listy towarów. Wartość domyślna: 1. Dostępne wartości:

  1. Najczęściej kupowane
  2. Najczęściej oglądane
  3. Nazwa (A-Z)
  4. Nazwa (Z-A)
  5. Cena rosnąco
  6. Cena malejąco
  7. Producent (A-Z)
  8. Kod towaru (A-Z)
  9. Kod towaru (Z-A)
  10. Najlepiej ocenianie
  11. Domyślnie
  12. Ostatnio dodane
  13. Ostatnio zmodyfikowane

pageId – Nazwa parametru w query string odpowiedzialna za wyświetlaną stronę (paginacja). Wartość domyślna: pageId.

sort – Nazwa parametru w query string odpowiedzialna za sortowanie. Wartość domyślna: sort.

Dostępny na stronach

Obiekt może być dodany tylko na stronach

  • która pełni funkcję strony z listą towarów
  • która pełni funkcję strony ze szczegółami towaru.
Obiekt może być dodany tylko jednokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.
Obiekt posiada następujące właściwości:

  1. productlist.FilteringOptions.Nazwa – właściwość odpowiada za opcje filtracji przedmiotów, zawiera:
    • Filters.[numer]Nazwa – odpowiada za opcje filtracji, zawiera:
      • Field – nazwa dla danego filtru,
      • Heading – tytuł danego filtru (np. Producent),
      • Values – wartości dla konkretnych filtrów, zawiera:
        • Count – liczba przedmiotów spełniających dany warunek,
        • Field – nazwa (zazwyczaj tożsama z polem field elementu nadrzędnego),
        • Selected – czy opcja została wybrana,
        • Text – nazwa danego pola,
        • TotalCount – całkowita liczba przedmiotów tego typu na liście,
        • Value – wartość pola,

        Wskazówka
        Aby dostać się do powyższych właściwości productlist.FilteringOptions.Filters.[numer].Nazwa należy użyć nr produktu w tablicy. Przykładowo, aby dostać się do pierwszego przedmiotu w nawiasie kwadratowym należy wpisać właściwą cyfrę. Należy pamiętać, że tablice numerowane są od 0.
    • Groups.[numer]Nazwa – odpowiada za opcje filtracji po kategoriach, zawiera:
      • Group – opis kategorii, zawiera:
        • Heading – alternatywna nazwa kategorii,
        • Id – id kategorii,
        • ImageId – id obrazka,
        • Name – nazwa kategorii,
        • Url – url kategorii,
      • Nodes – lista podkategorii, zawiera:
        • Count – ilość towarów,
        • Group – opis kategorii (zawiera Heading, Id, ImageId, Name, Url)
      • Parent – opis kategorii nadrzędnej (zawiera Heading, Id, ImageId, Name, Url)

      Wskazówka
      Aby dostać się do powyższych właściwości productlist.FilteringOptions.Groups.[numer].Nazwa należy użyć nr produktu w tablicy. Przykładowo, aby dostać się do pierwszego przedmiotu w nawiasie kwadratowym należy wpisać właściwą cyfrę. Należy pamiętać, że tablice numerowane są od 0.
    • MaxPrice – najwyższa cena produktów z danej listy,
    • MinPrice – najniższa cena produktów z danej listy,
    • PriceFrom – cena od (wpisana przez użytkownika),
    • PriceTo – cena do (wpisana przez użytkownika),
  2. productlist.HeaderData.Nazwa – informacje na temat nagłówka danej kategorii (np. jej tytuł, opis), zawiera:
    • Description – opis,
    • Heading – tytuł,
    • ImageId – id obrazu,
    • MetaDescription – opis meta,
    • MetaKeywords – meta słowa kluczowe,
    • MetaTitle – tytuł meta,
    • ShortDescription – krótki opis
  3. productlist.ItemsPerPage – określa liczbę produktów na stronie,
  4. productlist.PageCount – liczba stron,
  5. productlist.PageNo – numer strony,
  6. productlist.PageQueryGET – zwraca string PageQueryGET ustawiony z poziomu Panelu administratora (np. PageId),
  7. productlist.Products.[nr produktu].Nazwa – informacje o produkcie, takie jak:
    • AskForPrice – czy włączono opcję zapytaj o cenę,
    • Availability – dostępność, zawiera:
      • Date – służy do wyświetlenia informacji na temat ustawionej daty dla danego towaru (np. przy zapowiedzi produktu),
      • ImageUrl – id obrazu
      • Status – Id statusu dostępności,
      • Text – opis tekstowy dla danego statusu,
      • Type – wyświetla typ dostępności
    • Brand – informacje na temat marki, zawiera:
      • Heading – tytuł,
      • Id – numer Id,
      • ImageId – id obrazu,
      • Name – nazwa,
      • Url – adres Url,
      • UrlWithManufacturer – adres do produktów danego producenta,
    • Code – kod,
    • DecimalUnit – czy jednostki mogą być liczbami niecałkowitymi,
    • DefaultGroup – domyślna grupa,
    • Flags – zwraca flagi dla produktu (np. promocja, nowość itd.),
    • HasAttributes – czy posiada atrybuty,
    • HasOtherUnits – czy przedmiot ma inne jednostki sprzedażowe (np. para, pojedynczy produkt),
    • Id – id,
    • ImageId – id obrazu,
    • Link – link,
    • Manufacturer – informacje na temat producenta, zawiera:
      • Heading – tytuł,
      • Id – numer Id,
      • ImageId – id obrazu,
      • Name – nazwa,
      • Url – adres url,
      • Website – adres strony
    • Name – nazwa,
    • NameNoHtml – nazwa bez znacznikow HTML,
    • NoDiscount – informacja czy produkt może być objęty zniżką,
    • PreviousPrice – poprzednia cena,
    • Price – cena,
    • Rating – średnia ocena,
    • RatingCount – liczba wszystkich ocen,
    • RegularPrice – cena normalna,
    • SaleUnit – jednostka sprzedażowa (np. para),
    • ShortDescription – krótki opis,
    • StockLevel – informacja o stanie magazynowym,
    • UnitPriceRatio – przelicznik ceny za jednostkę miary,
    • UnitPriceUnit – możliwa jednostka przeliczeniowa (np. litry na mililitry, gramy na kilogramy itd.). Jeżeli wartość jest nullem nie wyświetlamy ceny jednostkowej,
    • Url – adres Url,
    • Weight – waga

    Wskazówka
    Aby dostać się do powyższych właściwości productlist.Products[nr produktu].Nazwa należy użyć nr produktu w tablicy. Przykładowo, aby dostać się do pierwszego przedmiotu w nawiasie kwadratowym należy wpisać właściwą cyfrę. Należy pamiętać, że tablice numerowane są od 0.
  8. productlist.Search – zwraca informacje na temat wyniku wyszukiwania, zawiera:
    • Brand – marka,
    • Group – zwraca string z nazwą kategorii,
    • GroupId – Id grupy,
    • Manufacturer – producent,
    • PriceFrom – cena od,
    • PriceTo – cena do,
    • Search – wartość pola wpisanego w wyszukiwarkę,
    • SearchAll – wartość pola wpisanego w wyszukiwarkę,
    • SearchAny – wyszukiwanie którejkolwiek z fraz,
    • SearchId – numer id wyszukiwania,
    • SearchWild – wyszukiwanie losowe (odpowiednik ,,szczęśliwego trafu”),
    • TotalItems – liczba przedmiotów spełniająca podane kryterium,
    • Url – adres Url
  9. productlist.SelectedSorting – wybrany sposób sortowania,
  10. productlist.SortingOptions – opcje sortowania, zawierają:
    • Text – wartość tekstowa danej właściwości wyszukiwania,
    • Value – wartość
      Wskazówka
      Pole value przyjmuje wartość od 1 do 11
  11. productlist.SortingQueryGET – podobnie jak w przypadku SortingQueryGET zwraca string ustawiony z poziomu Panelu administratora (np. PageId),
  12. productlist.TotalItems – łączna liczba przedmiotów,

Prezentacja towaru

Obiekt zwraca szczegółowe informacje o wybranym towarze.

Konfiguracja

Konfiguracja

Dostępne opcje konfiguracyjne:

  • Zawężaj do wybranej grupy

Zawężaj do wybranej grupy – Towary tylko z wybranej grupy. Wartość domyślna: true.

Dostępny na stronach

Obiekt może być dodany tylko na stronie, która pełni funkcję strony ze szczegółami towaru.
Obiekt może być dodany tylko jednokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.

productdetails.Product.Nazwa – informacje o produkcie,zawiera:

  1. AddedDate – data dodania,
  2. AskForPrice – czy włączono opcję zapytaj o cenę,
  3. Attachments – lista załączników dodanych do produktu,
  4. productdetails.Product.Attributes – zawiera:
    • Id – Id danej właściwości,
    • Name – nazwa właściwości (np. materiał),
    • Value – wartość danej właściwości (np. tworzywo sztuczne)
  5. AttributesEditable – pole edytowalne (przykładowo treść graweru na biżuterii)
  6. AttributesPolyvalent – w skład tej właściwości wchodzą: Id, Name oraz Values (Values może posiadać ValueId oraz Value)
  7. Availability – dostępność,zawiera:
    • Date – ustawienie daty kiedy towar będzie dostępny,
    • ImageUrl – adres URL obrazu,
    • Status – status,
    • Text – opis tekstowy,
    • Type – typ,
  8. BasicUnit – domyślna jednostka sprzedaży (np. sztuka),
  9. BasicUnitRatio – przelicznik jednostki,
  10. Batch – cechy towaru, (zwraca true jeżeli towar posiada konfigurację jednak nie jest ona odrębnym towarem)
  11. Brand – marka, zawiera:
    • Heading – nazwa,
    • Id – numer Id,
    • ImageId – id obrazu,
    • Name – nazwa,
    • Url – adres Url,
    • UrlWithManufacturer – adres url Producenta,
  12. BrandProducts.Nazwa – towary danej marki, zawiera:
    • AskForPrice – czy włączono opcję zapytaj o cenę,
    • Availability – w skład tej właściwości wchodzą: Text, Type, Status, Date, ImageUrl
    • Brand – w skład tej właściwości wchodzą: Name, Id, Heading, ImageId, Url, UrlWithManufacturer
    • Code – kod produktu,
    • DecimalUnit – czy jednostki mogą być liczbami niecałkowitymi
    • DefaultGroup – grupa domyślna,
    • Flags – zwraca flagi (np. nowość, wyprzedaż),
    • HasAttributes – czy posiada atrybuty,
    • HasOtherUnits – czy przedmiot ma inne jednostki sprzedażowe (np. para, pojedynczy produkt),
    • Id – numer Id,
    • ImageId – id obrazu,
    • Link – link,
    • Manufacturer – w skład tej właściwości wchodzą Name, Id, Heading, ImageId, Url, Website,
    • Name – nazwa,
    • NameNoHtml – nazwa bez znaczników HTML,
    • NoDiscount – informacja czy produkt może być objęty zniżką,
    • PreviousPrice – poprzednia cena,
    • Price – cena,
    • Rating – średnia ocen,
    • RatingCount – liczba ocen,
    • RegularPrice – cena normalna,
    • SaleUnit – jednostka sprzedażowa,
    • UnitPriceRatio – przelicznik ceny za jednostkę miary,
    • UnitPriceUnit – możliwa jednostka przeliczeniowa (np. litry na mililitry, gramy na kilogramy itd.). Jeżeli wartość jest nullem nie wyświetlamy ceny jednostkowej,
    • Url – adres Url
    • Weight – waga,
  13. Clip – czy jest to fantom,
  14. Code – kod produktu,
  15. ControlStock – pokazuje czy stany magazynowe zostały włączone,
  16. DecimalUnit – czy jednostki mogą być liczbami niecałkowitymi,
  17. DefaultGroup – czy posiada grupę domyślną,
  18. DeliveryCost – koszt dostawy,
  19. DeliveryCostType – typ kosztu dostawy (np. gdy towar jest bardzo duży),
  20. Flags – wyświetla informacje o flagach dla danego produktu (np. promocja, nowość) – zawiera pole text (nazwa, np. Nagroda) oraz type (typ, np. Reward)
  21. HasAttributes – czy posiada atrybuty,
  22. HasDefaultUnit – posiada domyślną jednostkę,
  23. HasOtherUnits – czy przedmiot ma inne jednostki sprzedażowe (np. para, pojedynczy produkt),
  24. Hits – ilość wyświetleń danego towaru,
  25. Id – numer Id,
  26. ImageId – Id obrazu,
  27. Images[numer].Nazwa – informacje na temat obrazków dołączonych do produktu, zawiera:
    • Alt – alternatywny tekst, który wyświetli się zamiast obrazka,
    • Id – id obrazu,
    • Link – link obrazu,
    • Name – nazwa,
    • NoFollow – czy wykorzystywany jest atrybut nofollow
    • Title – tytuł,
    Wskazówka
    Aby dostać się do powyższych właściwości productdetails.Product.Images[numer].Nazwa należy użyć nr zdjęcia w tablicy. Przykładowo, aby dostać się do pierwszego przedmiotu w nawiasie kwadratowym należy wpisać właściwą cyfrę. Należy pamiętać, że tablice numerowane są od 0.
  28. Link – link,
  29. Manufacturer – w skład tej właściwości wchodzą Heading, Id, ImageId, Name, Url, Website,
  30. ManufacturerCode – kod Producenta,
  31. ManufacturerProducts – cechy tej właściwości są tożsame z w.w. właściwością BrandProducts
  32. MetaDescription – opis Meta,
  33. MetaKeywords – słowa kluczowe Meta,
  34. MetaTitle – tytuł Meta,
  35. ModifiedDate – data ostatniej modyfikacji,
  36. MoreInfoUrl – adres Url z większą ilością informacji,
  37. Name – nazwa,
  38. Name1 – nazwa,
  39. NameNoHtml – nazwa bez znaczników HTML,
  40. NoDiscount – informacja czy produkt może być objęty zniżką,
  41. ParentId – numer Id rodzica,
  42. Points – liczba punktów lojalnościowych, które klient otrzyma za zakup tego towaru,
  43. PointsPrice – koszt towaru podany w punktach lojalnościowych,
  44. PreviousPrice – poprzednia cena,
  45. Price – cena,
  46. Rating – średnia ocen,
  47. RatingCount – ilość ocen,
  48. RegularPrice – cena standardowa,
  49. RelatedProducts.Nazwa – wyświetla inne produkty powiązane z obecnie oglądanym (np. akcesoria do danego produktu), w skład tej właściwości wchodzą:
    • Accessories – akcesoria do danego produktu,
    • Crossselling – produkty powiązane z przeglądanym,
    • Custom – dodatkowy typ ustawiany w systemie ERP,
    • Substitutes – produkty zastępcze do przeglądanego produktu,
    • Suggested – produkty sugerowanego.
    Wskazówka
    Wyżej wymienione właściwości posiadają:
    • AskForPrice – czy włączono opcję zapytaj o cenę,
    • Availability – w skład tej właściwości wchodzą: Text, Type, Status, Date, ImageUrl
    • Brand – w skład tej właściwości wchodzą: Name, Id, Heading, ImageId, Url, UrlWithManufacturer
    • Code – kod produktu,
    • DecimalUnit – czy jednostki mogą być liczbami niecałkowitymi
    • DefaultGroup – grupa domyślna,
    • Flags – zwraca flagi (np. nowość, wyprzedaż),
    • HasAttributes – czy posiada atrybuty,
    • HasOtherUnits – czy przedmiot ma inne jednostki sprzedażowe (np. para, pojedynczy produkt),
    • Id – numer Id,
    • ImageId – id obrazu,
    • Link – link,
    • Manufacturer – w skład tej właściwości wchodzą Name, Id, Heading, ImageId, Url, Website,
    • Name – nazwa,
    • NameNoHtml – nazwa bez znaczników HTML,
    • NoDiscount – informacja czy produkt może być objęty zniżką,
    • PreviousPrice – poprzednia cena,
    • Price – cena,
    • Rating – średnia ocen,
    • RatingCount – liczba ocen,
    • RegularPrice – cena normalna,
    • SaleUnit – jednostka sprzedażowa,
    • UnitPriceRatio – przelicznik ceny za jednostkę miary,
    • UnitPriceUnit – możliwa jednostka przeliczeniowa (np. litry na mililitry, gramy na kilogramy itd.). Jeżeli wartość jest nullem nie wyświetlamy ceny jednostkowej,
    • Url – adres Url,
    • Weight – waga
  50. SaleUnit – jednostka sprzedażowa,
  51. Sets – informacje o zestawach, zawiera:
    • PreviousPrice – wcześniejsza cena,
    • Price – cena,
    • Products – lista produktów wchodzących w skład zestawu,
    • SetId – id zestawu
    • SetName – nazwa zestawu
  52. ShortDescription – krótki opis,
  53. StockLevel – stany magazynowe, zawiera:
    • Control – czy włączone są stany magazynowe,
    • ImageUrl – adres URL obrazu,
    • QuantityControl – ,
    • Text – opis dla stanu,
    • Type – typ,
    • Value – wartość,
  54. SubtotalPreviousPrice – cena bez VAT produktu przed obniżką,
  55. SubtotalPrice – cena bez VAT,
  56. SubtotalRegularPrice – cena netto,
  57. Supplies – właściwości fantoma, zawiera:
    • AttributeNames – zawiera nazwy poszczególnych fantomów (tj. opcji danego towaru, takich jak np. kolor), w skład tej właściwości wchodzi Id oraz Name (nazwa danej opcji
    • Key – lista Id kolejnych właściwości prowadząca do opcji która jest nadrzędna
    • Supplies – informacje na temat opcji, zawiera:
      • Key – klucz,
      • Product – informacje na temat konkretnego produktu
      • StockLevel – stany magazynowe, zawiera:
        • Control – czy włączone są stany magazynowe,
        • ImageUrl – adres URL obrazu,
        • QuantityControl – ,
        • Text – opis dla stanu,
        • Type – typ,
        • Value – wartość,
      • SupplyId – numer Id produktu zawierającego daną value(wartość),
      • Value – wartość danej właściwości towaru (np. rozmiar „M”/”L”)
      • ValueId – Id wartości,
  58. SuppliesJSON – zwraca string JSON z productdetails.Supplies,
  59. Symbol – symbol (w formie stringa),
  60. TotalPreviousPrice – poprzednia cena brutto,
  61. TotalPrice – cena z podatkiem VAT,
  62. TotalRegularPrice – cena produktu brutto,
  63. UPC – zwraca kod EAN z ERP,
  64. UnitPriceRatio – – przelicznik ceny za jednostke miary,
  65. UnitPriceUnit – możliwa jednostka przeliczeniowa (np. litry na mililitry, gramy na kilogramy itd.). Jeżeli wartość jest nullem nie wyświetlamy ceny jednostkowej,
  66. Units – jednostka sprzedażowa, zawiera:
    • Default – czy jest to wartość domyślna,
    • Id – Id danej jednostki,
    • Name – nazwa jednostki (np. para),
    • Ratio – przelicznik ceny przy zmianie jednostki,
  67. Url – adres URL,
  68. VAT – stawka VAT,
  69. WasteMgmtCost – koszt gospodarowania odpadami,
  70. Weight -waga,
  71. YouTubeVideos – załączone pliki video Youtube,

Nagłówek

Obiekt zwraca menu kategorii i stron.

Konfiguracja

Konfiguracja

Dostępne opcje konfiguracyjne:

  • Poziom rozwinięcia
  • Ilość poziomów
  • Typ

Poziom rozwinięcia – Głębokość do jakiej maksymalnie może rozwinąć się menu.
Tylko dla Typ=8.
Wartość minimalna: 0
Wartość maksymalna: 10
Wartość domyślna: 0.

Ilość poziomów – ść poziomów na temat których obiekt przetrzymuje dane.

Typ – Grupy wg wyboru. Wartość domyślna: 1. Dostępne wartości:

  1. Grupy najwyższego poziomu
  2. Podgrupy począwszy od
  3. Wybrane
  4. Zawężaj menu do wybranej grupy

Dostępny na stronach

Obiekt może być dodany na wszystkich dostępnych stronach w sklepie.
Obiekt może być dodany tylko jednokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.

header.Nodes[numer] – wyświetla informacje na temat menu, zawiera:

  • Count – liczba przedmiotów dostępna w danej kategorii menu,
  • Groups – jeżeli zawiera podmenu, to wyświetla pola wymienione w tym punkcie oraz dodatkowe pola HasChildren oraz Nodes
  • Heading – nazwa dostępna po najechaniu kursorem,
  • Id – numer Id,
  • ImageId – Id obrazu,
  • Name – wyświetlana nazwa,
  • Products.[numer] – wyświetla informacje dotyczące produktów (productdetails)
  • Url – adres Url

Obiekt zwraca listę producentów oraz marek.

Konfiguracja

Konfiguracja

Obiekt nie posiada opcji konfiguracyjnych.

Dostępny na stronach

Obiekt może być dodany na wszystkich dostępnych stronach w sklepie.
Obiekt może być dodany tylko jednokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.
  1. manufacturersbrands.Brands – marka, zawiera:
    • Heading – tytuł,
    • Id – Id,
    • ImageId – id obrazka,
    • Name – nazwa,
    • Url – adres Url,
  2. manufacturersbrands.Manufacturers – producenci, zawiera:
    • Heading – tytuł,
    • Id – Id,
    • ImageId – id obrazka,
    • Name – nazwa,
    • Url – adres Url,
    • UrlWithManufacturer – adres Url,

Tekst

Obiekt zwraca tekst wpisany w panelu administracyjnym.

Konfiguracja

Konfiguracja

Dostępne opcje konfiguracyjne:

  • Język
  • Treść
Język – Dla jakiego języka będzie wyświetlany wpisany poniżej tekst.

Treść – Treść wyświetlana przez obiekt dla danego języka.

Dostępny na stronach

Obiekt może być dodany na wszystkich dostępnych stronach w sklepie.
Obiekt może być dodany wielokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.
Obiekt posiada tylko jedną właściwość:

  1. text.Content – treść wpisana w panelu administracyjnym

Opinie

Obiekt zwraca oceny, opinie dla wybranego towaru.

Konfiguracja

Konfiguracja

Dostępne opcje konfiguracyjne:
Parametry GET

  • pageId
pageId – Nazwa parametru w query string odpowiedzialna za wyświetlaną stronę(paginacja).
Wartość domyślna: rvPageId.

Dostępny na stronach

Obiekt może być dodany tylko na stronie, która pełni funkcję strony ze szczegółami towaru.
Obiekt może być dodany tylko jednokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.
  1. productuserreviews.ItemsPerPage – dopuszczalna liczba opinii na każdej stronie,
  2. productuserreviews.PageCount – liczba stron,
  3. productuserreviews.PageNo – numer strony na której obecnie się znajdujemy,
  4. productuserreviews.PageQueryGET – zwraca string PageQueryGET ustawiony z poziomu Panelu administratora (np. PageId),
  5. productuserreviews.Reviews – przetrzymuje recenzje danego produktu, w skład tej właściwości wchodzą:
    • CreatedDate – kiedy recenzja została napisana,
    • Rating – ocena (w formie graficznej gwiazdek),
    • Author – autor recenzji,
    • Comment – komentarz/opis oceny,
    • RegisteredAuthor – czy autor recenzji był zalogowany
  6. productuserreviews.TotalItems – łączna liczba opinii
Uwaga
Obiekt zwraca właściwości, gdy włączona jest funkcja oceniana towarów.

Porównywarka towarów

Obiekt zwraca listę towarów dodanych do porównania.

Konfiguracja

Konfiguracja

Obiekt nie posiada opcji konfiguracyjnych.

Dostępny na stronach

Obiekt może być dodany tylko na stronie, która pełni funkcję strony z porównywarką towarów.
Obiekt może być dodany tylko jednokrotnie na stronie.

Właściwości

Właściwośc

Obiekt ten przetrzymuje informacje na temat porównywanych produktów. Produkty posiadają wszystkie atrybuty, informacje i właściwości wymienione w obiekcie productdetails.

Wskazówka
Nazwa obiektu jest przykładowa.

Profil klienta

Obiekt zwraca szczegółowe informacje o zalogowanym kliencie.

Konfiguracja

Konfiguracja

Dostępne opcje konfiguracyjne:
Parametry GET

  • orderPageId
  • orderId
  • reviewPageId
  • reviewAwaitingPageId
  • historyPageId
  • complaintsPageId
  • complaintId
  • loyaltyPageId

orderPageId – Nazwa parametru w query string odpowiedzialna za wyświetlaną stronę (paginacja).
Wartość domyślna: ordPageId.

orderId – Nazwa parametru w query string odpowiedzialna za wyświetlanie szczegółów zamówienia.
Wartość domyślna: orderId.

reviewPageId – Nazwa parametru w query string odpowiedzialna za wyświetlaną stronę (paginacja).
Wartość domyślna: rvPageId.

reviewAwaitingPageId – Nazwa parametru w query string odpowiedzialna za wyświetlaną stronę (paginacja).
Wartość domyślna: rvAwPageId.

historyPageId – Nazwa parametru w query string odpowiedzialna za wyświetlaną stronę (paginacja).
Wartość domyślna: hsPageId.

complaintsPageId – Nazwa parametru w query string odpowiedzialna za wyświetlaną stronę (paginacja).
Wartość domyślna:complaintsPageId.

complaintId – Nazwa parametru w query string odpowiedzialna za wyświetlaną stronę.
Wartość domyślna: complaintId.

loyaltyPageId – Nazwa parametru w query string odpowiedzialna za wyświetlaną stronę (paginacja).
Wartość domyślna: ltyPageId.

Dostępny na stronach

Obiekt może być dodany tylko na stronie, która pełni funkcję strony z profilem klienta.
Obiekt może być dodany tylko jednokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.
  1. customerprofile.Complaint – przetrzymuje szczegóły na temat reklamacji,
  2. customerprofile.ComplaintQueryGET – zwraca string ComplaintQueryGET ustawiony z poziomu Panelu administratora (np.PageId)
  3. customerprofile.ComplaintsActive – zwraca informacje związane z trwającymi właśnie reklamacjami i zwrotami (zawiera pola typowe dla przedmiotu oraz dodatkowe pola ComplaintId, które zwraca Id zgłoszenia, oraz CreatedDate – datę otwarcia reklamacji)
    • Complaints – zawiera informacje o reklamacjach i zwrotach,
    • ItemsPerPage – ilość przedmiotów które mają być wyświetlane na stronie,
    • PageCount – ilość stron,
    • PageNo – numer strony,
    • PageQueryGET – zwraca string PageQueryGET ustawiony z poziomu Panelu administratora (np. PageId),
    • TotalItems – łącznie przedmiotów
  4. customerprofile.ComplaintsExecuted – informacje na temat rozstrzygniętych reklamacji i zwrotów, zawiera:
    • Complaints – zawiera informacje o reklamacjach i zwrotach,
    • ItemsPerPage – ilość reklamacji na stronie,
    • PageCount – ilość stron,
    • PageNo – numer strony,
    • PageQueryGET – zwraca string PageQueryGET ustawiony z poziomu Panelu administratora (np. PageId),
    • TotalItems – łączna liczba,
  5. customerprofile.Discounts.Nazwa – informacje na temat zniżek przysługujących Klientowi, zawiera:
    • CustomerGroups – ulubione kategorie danego Klienta,
    • CustomerProducts – ulubione produkty danego Klienta,
    • FirstOrder – jeśli zwraca true to jest to pierwsze zamówienie Klienta zaś w Panelu Administracyjnym znajduje się obniżka dla pierwszych zamówień,
    • Groups – zniżka grupowa (dotyczy danej grupy produktów, np. obuwia damskiego). Zawiera Count, HasChildren, Heading, Id, ImageId, Name oraz Url,
    • OrderValue – wartość zamówienia (po przeliczeniu zniżki),
    • Products – produkty, na które klient ma zniżkę,
    • Regular – standardowa obniżka (jeżeli została taka przypisana w Panelu Administracyjnym),
  6. customerprofile.Employees – lista pracowników jakich posiada sklep,
  7. customerprofile.History – zawiera informacje na temat działań na koncie, np. logowań (i nieudanych prób logowania) czy zmiany danych, zawiera:
    • Items – zawiera następujące informacje:
      • Category – rodzaj wykonanej akcji (np. Logowanie),
      • Date – data wykonania akcji,
      • Event – opis akcji (np. Logowanie poprawne),
      • User – kto wykonał akcję,
      • UserType – typ użytkownika, który wykonał akcję
    • ItemsPerPage – ilość akcji wyświetlanych na jednej stronie,
    • PageCount – ilość stron,
    • PageNo – numer strony,
    • PageQueryGet – zwraca string PageQueryGET ustawiony z poziomu Panelu administratora (np. PageId),
    • TotalItems – łączna liczba akcji,
  8. customerprofile.LoyaltyHistory – historia wydawanych i zdobywanych punktów lojalnościowych, zawiera:
    • Items – informacje odnośnie płatności punktami lojalnościowymi
    • ItemsPerPage – ilość akcji wyświetlanych na jednej stronie,
    • PageCount – ilość stron,
    • PageNo – numer strony,
    • PageQueryGet – zwraca string PageQueryGET ustawiony z poziomu Panelu administratora (np. PageId),
    • TotalItems – łączna liczba akcji,
  9. customerprofile.Newsletter – informacje o subskrypcji newslettera oraz Id języka,
  10. customerprofile.Order.Nazwa – zawiera informacje na temat złożonego zamówienia, zawiera:
    • Attributes – atrybuty nagłówkowe zamówienia,
    • CanAccept – czy zamówienie może być zaakceptowane,
    • CanCancel – czy zamówienie może być anulowane,
    • CanEdit – czy zamówienie można edytować,
    • CanRestorePayment – jeżeli wartość true, to umożliwia to umożliwia ponowne opłacenie towaru (np. w przypadku awarii Banku, nieudanej płatności itp.),
    • Currency – zwraca walutę,
    • Customer.Nazwa – zwraca informacje dotyczące Klienta:
      • Company – czy Klient jest firmą,
      • DeliveryAddress.Nazwa – zwraca informacje na temat adresu dostawy:
        • City,
        • Country,
        • Name,
        • Name2,
        • PhoneNo,
        • State,
        • Street,
        • StreetNo,
        • UnitNo,
        • ZipCode
      • Email – zwraca adres mailowy,
      • Employee.Nazwa – zwraca informacje na temat pracownika, zawiera:
        • Email – adres mailowy,
        • Name – nazwa,
        • Name2 – dodatkowe pole nazwa,
        • PhoneNo – numer telefonu
      • Invoice – czy wybrano fakturę,
      • InvoiceAddress – zawiera dane adresowe na jakie ma być wystawiona faktura. Zawiera te same pola co DeliveryAddress
      • RegisteredUser – czy użytkownik jest zarejestrowany,
      • SSN – numer PESEL,
      • TIN – numer NIP,
      • VATEU – zwraca kraj właściwy dla VAT,
    • Date – data złożenia zamówienia,
    • Delivery – wybrany sposób dostawy,
    • DeliveryDate – zawiera liczbę (zazwyczaj dni) w ciągu których towar zostanie dostarczony,
    • Discount – zniżka,
    • Documents – załączone dokumenty/pliki,
    • ERPOrderNumber – numer zamówienia z ERPa,
    • EditingAllowed – jeśli true to zamówienie jest w trakcie edycji,
    • ExpectedDate – dzień dostarczenia towaru ,
    • ExpirationDate – dzień do którego towar zostanie dostarczony,
    • Id – numer Id,
    • IsEdited – jeśli true to zamówienie zostało wyedytowane,
    • ItemsPerPage – ilość towarów na stronie na szczegółach zamówienia,
    • LanguageId – Id języka,
    • NotDeterminedDeliveryCost – wyświetla informacje czy koszt dostawy został zdefiniowany,
    • Note – dodatkowe informacje,
    • OrderTotalValue – łączna wartość zamowienia,
    • PageCount – ilość stron z towarami na szczegółach zamówienia,
    • PageNo – numer strony z towarami na szczegółach zamówienia,
    • Payment.Nazwa – informacje odnośnie płatności, zawiera:
      • Description – opis,
      • DueDateText – określa termin/moment płatności,
      • MethodId – Id danej metody,
      • MethodIdText – opis danego Id,
      • MethodType – typ metody,
      • Name – nazwa,
      • OnlineNumber – Id transakcji z platnosci online,
      • TotalValue – łączny koszt,
    • Points – punkty lojalnościowe otrzymane za złożenie zamówienia,
    • PointsPaid – punkty lojalnościowe wydane w tym zamówieniu,
    • ProcessedDate – data wysłania,
    • Products[numer].Nazwa – ,
      • Attributes – atrybuty elementu zamówienia,
      • CanComplain – czy można złożyć reklamację,
      • CanReturn – czy można zwrócić towar,
      • Code – kod produktu,,
      • DefaultGroup – grupa domyślna produktu,
      • Description – pole opis (np. rozmiar buta),
      • Id – numer Id,
      • ImageId – Id obrazu,
      • IsDeleted – czy usunięty,
      • IsEdited – czy wyedytowany,
      • IsModified – czy modyfikowany,
      • IsSetElement – czy jest częścią zestawu,
      • IsSetParent – czy przedmiot jest przedmiotem głównym,
      • Link – link,
      • NameNoHtml – nazwa bez tagów HTML,
      • No – numer,
      • Price – cena,
      • Quantity – ilość zakupionego towaru,
      • ReturnedQuantity – ilość zwróconego towaru,
      • SetName – nazwa zestawu,
      • SubtotalPrice – cena bez VAT,
      • SubtotalValue – cena całkowita (cena * ilość) bez VAT,
      • TotalPrice – cena z podatkiem VAT,
      • TotalValue – ,
      • Unit – jednostka sprzedażowa (np. para),
      • Url – adres URL,
      • VAT – wartość podatku VAT,
      • Value – wartość brutto towaru,
      • WasteMgmtCost – koszty gospodarowania odpadami,
    • ProductsSubtotalValue – cena towarów bez podatku VAT,
    • ProductsTotalValue – łączna cena towarów w koszyku,
    • ProductsValue – wartość towarów,
    • ProductsValueBeforeDiscount – wartość towarów przed zniżką,
    • ProductsVatValue – wartość podatku VAT (w złotówkach),
    • RecalculationRequired – czy wymagane przeliczenie zamówienia,
    • ReportUrl – wygenerowany link do raportu,
    • SelectedDeliveryDate – wybrana przez klienta data dostawy,
    • Status – status,
    • StatusText – opis tekstowy statusu,
    • SubtotalPrices – czy wyświetlane ceny są cenami netto,
    • TotalItems – ilość wszystkich towarów z zamówienia,
    • Weight – waga,
  11. customerprofile.OrderDetPageQueryGET – zwraca string OrderDetPageQueryGET ustawiony w panelu administracyjnym,
  12. customerprofile.OrderQueryGET – zwraca string OrderQueryGET ustawiony z poziomu Panelu administratora (np.PageId),
  13. customerprofile.Orders – połączenie danych z customerprofile.Active i customerprofile.Executed,
  14. customerprofile.OrdersActive.Nazwa – informacje na temat aktywnych zamówień, zawiera:
    • ItemsPerPage – ilość przedmiotów wyświetlanych na jednej stronie,
    • Orders[numer].Nazwa – zawiera następujące informacje:
      • Date – data złożenia zamówienia,
      • OrderId – numer Id zamówienia,
      • Status – status,
      • StatusText – opis tekstowy statusu (np. oczekuje na potwierdzenie)
    • PageCount – ilość stron,
    • PageNo – numer strony,
    • PageQueryGet – zwraca string PageQueryGET ustawiony z poziomu Panelu administratora (np. PageId),
    • TotalItems – łączna liczba aktywnych zamówień,
  15. customerprofile.OrdersExecuted – zamówienia zrealizowane,
  16. customerprofile.ProductsToRate – produkty zakupione ale jeszcze nie ocenione,
  17. customerprofile.Reviews – zawiera informacje na temat opinii napisanych przez użytkownika,
  18. customerprofile.WishList – lista towarów znajdujących się na liście życzeń/przechowalni,
Uwaga
Obiekt zwraca właściwości tylko dla za logowanego użytkownika.

Blog

Obiekt zwraca wpisy z bloga.

Konfiguracja

Konfiguracja

Dostępne opcje konfiguracyjne:
Parametry GET

  • pageId

pageId – Nazwa parametru w query string odpowiedzialna za wyświetlaną stronę (paginacja).
Wartość domyślna: pageId.

Dostępny na stronach

Obiekt może być dodany na wszystkich dostępnych stronach w sklepie.
Obiekt może być dodany tylko jednokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.
Obiekt posiada następujące właściwości:

  1. blog.LatestPosts[numer].Nazwa – zwraca informacje na temat ostatnich postów, zawiera:
    • Content – zawartość wpisu (jego treść),
    • Heading – tytuł,
    • Id – numer Id,
    • ImageUrl – URL obrazu,
    • PublishedDate – data publikacji,
    • Url – adres URL,
    • Tags[numer].Nazwa – tagi, zawiera:
      • Text – tekst,
      • Url – adres URL,
      • Weight – waga,
  2. blog.PostDetails – informacje o szczegółach posta, zawiera:
    • Content – treść,
    • Heading – nagłówek,
    • Id – id,
    • ImageUrl – url obrazka,
    • MetaDescription – meta opis,
    • MetaKeywords – meta słowa kluczowe,
    • MetaTitle – meta tytuł,
    • Next – informacje o następnym poście, zawiera:
      • Heading – nagłówek,
      • Id – id,
      • PublishedDate – data publikacji,
      • Url – url,
    • Previous – informacje o poprzednim poście (analogicznie do Next),
    • PublishedDate – data publikacji,
    • Tags – informacje o tagach, zawiera:
      • Text – nazwa taga,
      • Url – url do listy postów z danym tagiem,
      • Weight – waga,
    • Url – url,
  3. blog.PostList – informacje o liście postów, zawiera:
    • ItemsPerPage – ilość wpisów wyświetlanych na jednej stronie,
    • PageCount – ilość stron,
    • PageNo – numer strony,
    • PageQueryGET – zwraca string PageQueryGET ustawiony z poziomu Panelu administratora (np. PageId),
    • TotalItems – łączna liczba postów ,
    • Posts – zawiera informacje na temat wpisów na stronie. Właściwość ta zawiera dokładnie te same elementy co LatestPosts.[numer].Nazwa.
Uwaga
Obiekt zwraca właściwość LatestPosts zawsze.
Właściwość PostList aktywuje się na stronie, która pełni funkcję listy wpisów na blogu, na pozostałych stronach właściwość zwraca null.
Właściwość PostDetails aktywuje się na stronie, która pełni funkcję szczegółów wpisu na blogu, na pozostałych stronach właściwość zwraca null.

Zamówienie

Obiekt zwraca dane o zamówieniu oraz informacje niezbędne do złożenia zamówienia (np. sposoby dostawy i płatności).

Konfiguracja

Konfiguracja

Obiekt nie posiada opcji konfiguracyjnych.

Dostępny na stronach

Obiekt może być dodany tylko na stronie, która pełni funkcję strony gdzie składa się zamówienie.
Obiekt może być dodany tylko jednokrotnie na stronie.

Właściwości

Właściwośc

Wskazówka
Nazwa obiektu jest przykładowa.
  1. cart.Attributes – atrybuty nagłówkowe zamówienia,
  2. cart.AuthenticationRequired – czy wymagana jest aby użytkownik był zalogowany,
  3. cart.CartEmpty – czy koszyk jest pusty,
  4. cart.Changes – zwraca true jeśli dokonano zmiany w koszyku (np. dodanie produktu jako użytkownik zalogowany, wylogowanie i ponowne dodanie produktu jako zalogowany użytkownik),
  5. cart.CompanyOnly – jeśli true to zamówienie można złożyć tylko jako firma,
  6. cart.Coupon – zwraca użyty kod rabatowy,
  7. cart.Currency – waluta w koszyku,
  8. cart.Customer.Nazwa – na tę właściwość składa się:
    • Company – czy Klient jest firmą,
    • CustomerDetailsEditable – czy można edytować dane,
    • DeliveryAddress.Nazwa – właściwość odpowiada za możliwość zmiany adresu dostawy, składa się z:
      • City,
      • Country,
      • Name,
      • Name2,
      • PhoneNo,
      • State,
      • Street,
      • StreetNo,
      • UnitNo,
      • ZipCode,
    • Email – zwraca adres e-mail,
    • Id – numer Id,
    • Invoice – czy Klient chce aby wystawiona została faktura,
    • InvoiceAddres.Nazwa – właściwość odpowiada za możliwość wybrania danych do faktury, takich jak:
      • City,
      • Country,
      • Name,
      • Name2,
      • PhoneNo,
      • State,
      • Street,
      • StreetNo
      • UnitNo
      • ZipCode
    • SSN – numer PESEL,
    • TIN – numer NIP,
    • VATEU – numer VATEU,
  9. cart.DeliveryMethods[numer].Nazwa – informacje na temat sposobów dostawy, zawiera:
    • DateText – opis sposobu dostawy,
    • Description – opis,
    • FreeDeliveryFrom – opcja darmowej dostawy od określonej kwoty,
    • ImageUrl – url do obrazu,
    • Name – nazwa,
    • TotalValue – wartość sposobu dostawy (cena),
    • Payments[numer] – informacje na temat sposobu płatności dostępnego dla wybranego sposobu dostawy. Zawiera:
      • AdditionalDataHTML – ,
      • Description – opis,
      • DueDateText – określa termin płatności,
      • Id – numer Id,
      • ImageUrl – adres URL obrazu,
      • Name – Nazwa,
      • TotalValue – kwota,
  10. cart.Demo – gdy true, nie można składać zamówień,
  11. cart.Discount – wartość rabatu wyrażona w procentach,
  12. cart.EditedOrderId – id wyedytowanego zamówienia,
  13. cart.NotDeterminedDeliveryCost – zwraca true jeżeli koszt dostawy zostanie ustalony przez obsługę sklepu ,
  14. cart.Note – informacje/uwagi dodatkowe wpisane przez Klienta,
  15. cart.OrderStep – nazwa kroku w zamówieniu,
  16. cart.OrderTotalValue – łączna wartość do zapłaty,
  17. cart.PlacedOrder – wszystkie dane odnośnie danego zamówienia,
  18. cart.Points – punkty lojalnościowe, które klient otrzyma za złożenie tego zamówienia,
  19. cart.PointsPaid – punkty lojalnościowe wydane przy składaniu tego zamówienia,
  20. cart.PointsPrice – cena zamówienia (netto lub brutto w zależności od rodzaju klienta – prywatny lub firma) przy użyciu punktów lojalnościowych,
  21. cart.PointsPriceTotalValue – cena brutto zamówienia przy użyciu punktów lojalnościowych,
  22. cart.PreOrder – czy produkt jest zapowiedzią (nie jest jeszcze dostępny),
  23. cart.Products[numer].Nazwa – informacje o produkcie/produktach w koszyku, zawiera:
    • AskForPrice – czy włączono opcję zapytaj o cenę,
    • BasicUnit – podstawowa jednostka,
    • BasicUnitRatio – przelicznik jednostki,
    • Changed – jeśli wartość zwraca true należy dokonać ponownego przeliczenia koszyka,
    • Code – kod produktu,
    • DecimalUnit – czy jednostka może być liczbą niecałkowitą,
    • DefaultGroup – do jakiej grupy domyślnej przedmiot należy,
    • Description – opis przedmiotu (np. rozmiar buta),
    • Id – numer Id,
    • ImageId – id obrazu,
    • IsSetElement – czy należy do zestawu,
    • IsSetParent – czy przedmiot jest główną częścią np. zestawu,
    • Link – link,
    • NameNoHtml – nazwa bez znaczników HTML,
    • No – numer przedmiotu w koszyku,
    • PointsPrice – cena towaru po użyciu punktów lojalnościowych,
    • Price – cena,
    • Quanity – ilość danego przedmiotu w koszyku,
    • SaleUnit – jednostka sprzedażowa,
    • SetName – nazwa zestawu,
    • Status.Nazwa – zawiera:
      • Date – jeżeli produkt jest zapowiedzią, to w tym miejscu znajduje się data kiedy stanie się on dostępny,
      • ImageUrl – adres URL obrazu,
      • Status – status,
      • Text – opis tekstowy,
      • Type – typ,
    • SubtotalPrice – cena bez VAT,
    • SubtotalValue – wartość bez VAT (produkt * ilość),
    • SubtotalValueBeforeDiscount – wartość bez VAT (produkt * ilość) przed obniżką,
    • TotalPrice – cena z podatkiem VAT,
    • TotalValue – cena za towary (cena * ilość),
    • TotalValueBeforeDiscount – cena za towary przed obniżką,
    • UnitPriceRatio – przelicznik ceny za jednostkę miary,
    • UnitPriceUnit – możliwa jednostka przeliczeniowa (np. litry na mililitry, gramy na kilogramy itd.). Jeżeli wartość jest nullem nie wyświetlamy ceny jednostkowej,
    • Url – adres URL,
    • VAT – stawka VAT,
    • Value – suma zamówienia brutto,
    • ValueBeforeDiscount – wartość przed rabatem,
    • WasteMgmCost -koszty gospodarowania odpadami,
    • Weight – waga,
  24. cart.ProductsMinimumTotalValue – minimalna cena zamówienia,
  25. cart.ProductsSubtotalValue – cena towarów (produkt * ilość) bez podatku VAT,
  26. cart.ProductsSubtotalValueBeforeDiscount – cena towarów (produkt * ilość) bez podatku VAT przed rabatem,
  27. cart.ProductsTotalValue – łączna cena towarów w koszyku,
  28. cart.ProductsTotalValueBeforeDiscount – łączna cena towarów bez rabatu,
  29. cart.ProductsValue – wartość towarów,
  30. cart.ProductsValueBeforeDiscount – cena towarów przed rabatem,
  31. cart.SelectedDelivery.Nazwa – wybrany sposób dostawy, zawiera:
    • CollectionPointId – numer Id punktu dostawy,
    • CollectionPointTypeId – numer Id typu punktu dostawy,
    • CollectionPointTypeText – opis tekstowy typu punktu odbioru (np. „Personal”),
    • DateText – opis,
    • Description – opis danej metody dostawy (jeżeli opis został uzupełniony w Panelu Administratora),
    • FreeDeliveryFrom – darmowa dostawa (od określonej kwoty),
    • MethodId – numer Id metody dostawy,
    • Name – nazwa sposobu dostawy,
    • PhoneRequired – czy wymagane jest podanie numeru telefonu,
    • SelectedDate – data dostawy wybrana przez klienta,
    • Time – ilość dni, którą należy dodać do dzisiejszej daty, aby uzyskać najwcześniejszą możliwą do wyboru datę dostawy,
    • TotalValue – cena całkowita kosztu dostawy,
    • Payment.Nazwa – informacje odnośnie płatności, zawiera:
      • AdditionalDataHTML – dodatkowo przekazany HTML,
      • Description – opis danej metody płatności (jeżeli opis został uzupełniony w Panelu Administratora),
      • DueDateText – opis (np. w formie tekstu lub liczby) terminu płatności,
      • Id – numer Id,
      • ImageUrl – url obrazka,
      • MethodId – Id danej metody,
      • MethodIdText – nazwa dla danego ID,
      • MethodType – typ metody dostawy,
      • Name – nazwa,
      • TotalValue – koszt całkowity płatności (np. dodatkowa opłata związana z przedpłatą),
  32. cart.SelectedDeliveryPaymentId – Id wybranej metody,
  33. cart.SubtotalPrices – czy ceny w koszyku pokazywane są z podatkiem VAT,
  34. cart.ThirdPartyHTML – zawiera kod wprowadzony z poziomu Panelu Administratora,
  35. cart.ThirdPartyScripts – zawiera kod wprowadzony z poziomu Panelu Administatora,
  36. cart.VATValue – wartość podatku VAT w koszyku,

Dodatkowe właściwości dla wersji Enterprise

Właściwości obiektów dostępne tylko w sklepach w wersji Enterprise.

Dostępne w wersji Enterprise

Towary

Właściwości:

  • Batch
  • SubtotalPreviousPrice
  • SubtotalPrice
  • SubtotalRegularPrice
  • TotalPreviousPrice
  • TotalPrice
  • TotalRegularPrice

Zamówienie, koszyk

Właściwości:

  • ProductsSubtotalValue
  • ProductsSubtotalValueBeforeDiscount
  • ProductsTotalValue
  • ProductsTotalValueBeforeDiscount
  • SubtotalPrices

Reklamacje, zwroty

Właściwości:

  • SubtotalPrice
  • SubtotalPrices
  • SubtotalValue
  • TotalPrice
  • TotalValue

Kontrahenci

Właściwości:

  • VATEU

Config

Właściwości:

  • VATEU

Config.Currencies

Dla wersji Enterpise zwraca listę walut przesłanych z systemu ERP.
Dla pozostałych wersji zwraca domyślną walutę.
Obiekt zwraca szczegółowe informacje o wybranym towarze.

Czy ten artykuł był pomocny?