Tulostaa listan verkkokaupan myydyimmistä tuotteista.

Kuvaus

Poiketen tuotelistojen oletustulostuksesta, tagin tuottama sisältö tulostetaan ul-muotoisena listana. Merkkausmuotoa on mahdollista muuttaa asettamalla type-attribuutille haluttu arvo.

Tagi tulostaa kaikkien versioiden suosituimpia tuotteita. Listalla ei kuitenkaan näytetä tuotteita, jotka eivät ole näkyvillä asiakkaan käyttämässä versiossa.

Syntaksi

{TopSellers(
    category: int,
        subcategories: boolean,
    brand: int,
    campaign: int,
    id: int,
    keyword: string,
    filters: string,
    timelimit: string,
    similar_to: int,
    compatible_to: int,
    crosssales_for: int,
    timelimit: int,
    prelimit: int,
    pagination: boolean,
    type: string,
        list_type: string,
        list_classes: string,
    crosssales_for: string,
    helper: string
)}

Näkyvyys

Toimii näkyvyydessä: globaali

Näkymä helper-attribuutissa: tuote

Globaalin näkyvyyden tageja on mahdollista käyttää missä tahansa sivupohjassa ja minkä tahansa tagin sisällä.

Attribuutit

category:

Määrittää tuoteryhmät, joista tuotteet haetaan.

Sallitut arvot: putkimerkeillä erotellut tuoteryhmien ID-numerot. Arvolla 'ALL' tuotteet haetaan kaikista tuoteryhmistä.

Esim. category: '2|34|5'

subcategories:

Määrittää haetaanko tuotteita myös category-attribuutilla määriteltyjen tuoteryhmien aliryhmistä.

Attribuutti on käytössä vain, mikäli category-attribuutilla on arvo.

Sallitut arvot: true/false. Oletusarvo true.

brand:

Määrittää tuotemerkit, joiden tuotteet haetaan.

Sallitut arvot: putkimerkeillä erotellut tuotemerkkien ID-numerot. Arvolla 'ALL' tuotteet haetaan kaikista tuotemerkeistä.

Esim. brand: '2|34|5'

campaign:

Määrittää kampanjat, joista tuotteet haetaan.

Sallitut arvot: putkimerkeillä erotellut kampanjoiden ID-numerot. Arvolla 'ALL' tuotteet haetaan kaikista kampanjoista.

Esim. campaign: '2|34|5'

id:

Määrittää ID-numeroiden perusteella listalle haettavat tuotteet.

Sallitut arvot: putkimerkeillä erotetut tuotteiden ID-numerot

keyword:

Hakusanat, joiden perusteella tuotteet valikoidaan listalle.

Katso käyttöoppaasta kuvaus haun toimintaperiaatteesta.

Sallitut arvot: hakusanat välilyönneillä erotettuina

Esim. keyword: 'paidat housut Jamppa'

filters:

Asettaa tulostettavalle listalle valmiita suodattimia, joiden perusteella listalle sisällytettävät tuotteet valikoidaan.

Sallitut arvot:

  • 'discounted': alennustuotteet (siis tuotteet jotka kuuluvat johonkin aktiiviseen alennuskampanjaan)
  • 'regularly_priced': normaalihintaiset tuotteet
  • 'featured': mainostettavat tuotteet

    Tuote merkitään mainostettavaksi tuotelomakkeen kohdassa Näkyvyys ja mainostus > Mainosta tuotetta.

  • 'has_images': vain tuotteet joilla on tuotekuva
  • 'preorder': ennakkotilattavat tuotteet (tuotteet joiden rajoitettu saatavuusaika ei ole vielä alkanut)
  • 'released': kaikki muut kuin ennakkotilattavat tuotteet viimeisen vuoden ajalta

    timelimit-attribuuttia käyttämällä voit asettaa suodattimen hakemaan tuotteita valitsemaltasi ajanjaksolta.

  • 'in_stock': varastossa olevat tuotteet
  • 'out_of_stock': varastosta loppuneet tuotteet
  • 'available': saatavilla olevat tuotteet
  • 'unavailable': tuotteet, jotka ovat loppuneet varastosta ja joiden myyntiä ei jatketa
  • 'navigable': tuote on navigoitavissa

    Tämä tarkoittaa että tuote kuuluu johonkin tuoteryhmään eikä mikään taso sen tuoteryhmähierarkiassa ole suljettu aktiivisessa kauppaversiossa.

  • 'not_in_cart': tuotteet, joita ei ole ostoskorissa

Jos haluat käyttää useampaa suodatinta, erota arvot toisistaan putkimerkeillä.

Esim. filters: 'discounted|released'

timelimit:

Asettaa aikavälin, jolta tuotteita haetaan listalle.

Sallitut arvot:

  • Päivät: '-n days'
  • Viikot: '-n weeks'
  • Kuukaudet: '-n months'

Esim. timelimit: '-3 months'

Arvolla 0 voit asettaa aikarajoituksen kokonaan pois päältä.

similar_to:

Määrittää tuotteet, joiden kanssa samankaltaisiksi merkittyjä tuotteita listalle halutaan hakea.

Sallitut arvot: putkimerkeillä erotetut tuotteiden ID-numerot tai jokin valmiista suodattimista:
  • 'cart': valikoidaan ristiinmyynnit ostoskorissa olevien tuotteiden perusteella
  • 'last_viewed': valikoidaan ristiinmyynnit asiakkaan viimeksi katsomien tuotteiden perusteella
  • 'last_bought': valikoidaan ristiinmyynnit asiakkaan viimeksi ostamien tuotteiden perusteella (asiakkaan on oltava kirjautunut sisään)

Jos valmiit suodattimet eivät tuota tuloksia, attribuutti yrittää hakea ristiinmyyntejä näkyvyyden tuotteiden perusteella. Voit estää tämän attribuuttimäärityksellä fallback:false.

Esim.: similar_to: '1|14|24' tai similar_to: 'cart'

compatible_to:

Määrittää tuotteet, joiden kanssa yhteensopivia tuotteita listalle halutaan hakea.

Sallitut arvot: putkimerkeillä erotetut tuotteiden ID-numerot tai jokin valmiista suodattimista:
  • 'cart': valikoidaan ristiinmyynnit ostoskorissa olevien tuotteiden perusteella
  • 'last_viewed': valikoidaan ristiinmyynnit asiakkaan viimeksi katsomien tuotteiden perusteella
  • 'last_bought': valikoidaan ristiinmyynnit asiakkaan viimeksi ostamien tuotteiden perusteella (asiakkaan on oltava kirjautunut sisään)

Jos valmiit suodattimet eivät tuota tuloksia, attribuutti yrittää hakea ristiinmyyntejä näkyvyyden tuotteiden perusteella. Voit estää tämän attribuuttimäärityksellä fallback:false.

Esim. compatible_to: '1|34|2' tai compatible_to: 'cart'

crosssales_for:

Määrittää tuotteet, joiden kanssa yhdessä ostettuja tuotteita listalle halutaan hakea.

Sallitut arvot: putkimerkeillä erotetut tuotteiden ID-numerot tai jokin valmiista suodattimista:
  • 'cart': valikoidaan ristiinmyynnit ostoskorissa olevien tuotteiden perusteella
  • 'last_viewed': valikoidaan ristiinmyynnit asiakkaan viimeksi katsomien tuotteiden perusteella
  • 'last_bought': valikoidaan ristiinmyynnit asiakkaan viimeksi ostamien tuotteiden perusteella (asiakkaan on oltava kirjautunut sisään)

Jos valmiit suodattimet eivät tuota tuloksia, attribuutti yrittää hakea ristiinmyyntejä näkyvyyden tuotteiden perusteella. Voit estää tämän attribuuttimäärityksellä fallback:false.

Esim. crosssales_for: '1|2|3' tai crosssales_for: 'last_viewed'

limit:

Asettaa tulostuvan listan enimmäispituuden.

limit-attribuutin arvojen perusteella määrittyvät myös sivutustyökalujen rajausvaihtoehdot.

Sallitut arvot: putkimerkein eroteltu lista kokonaislukuja.

Listan ensimmäinen kokonaisluku toimii oletusarvona {PaginationLimit}-tagin tuottamassa rajausvalikossa.

Esim. limit: '1|5|10'

prelimit:

Rajoittaa tulostuvan listan pituutta ennen sort-attribuutin mukaista sivutusta ja järjestelyä.

Attribuutin pääasiallinen käyttötapa on poimia ristiinmyynti- ja hakutuloslistoilta esim. 10 sopivinta ja tulostaa niistä rajattu määrä satunnaisia tuotteita.

Sallitut arvot: kokonaisluvut.

pagination:

Määrittää näytetäänkö sivutustyökalut.

Sallitut arvot: true/false. Oletusarvo false.

type:

Määrittää tulostuvan listan merkkaustyypin.

Sallitut arvot:
  • 'normal': Jokainen listaelementti on oma div-elementtinsä. Listalla ei ole sisältävää elementtiä.
  • 'list': Lista tulostuu HTML-listana. Käyttämällä list_type-attribuuttia voit määrittää listan tyypin.
  • 'ids': Lista ei sisällä merkkausta, vaan tagi palauttaa ainoastaan tuotteiden ID-numerot putkimerkein eroteltuina merkkijonomuodossa.
list_type:

Määrittää, tulostuuko tuotelista järjestämättömänä vai järjestettynä (numeroituvana) listana.

Attribuutti on käytössä vain silloin, kun type-attribuutilla on arvo 'list'.

Sallitut arvot:
  • 'ul': tuotelista tulostuu järjestämättömänä listana
  • 'ol': tuotelista tulostuu järjestettynä listana
list_classes:

Luokkanimet, jotka annetaan listan sisältävälle listaelementille (<ul> tai <ol>, riippuen list_type-attribuutin arvosta).

Attribuutti on käytössä vain silloin, kun type-attribuutilla on arvo 'list'.

Sallitut arvot: välilyönneillä erotetut luokkanimet merkkijonona.

Esim. list_classes: 'ekaLuokka tokaLuokka'

classes:

Luokkanimet, jotka annetaan jokaiselle listaelementille.

Sallitut arvot: luokkanimet merkkijonoina.

Erota samalle elementille annettavat luokat välilyönnillä. Erota putkimerkeillä luokat, jotka haluat antaa eri listaelementeille.

Esim. classes: 'ekaLuokka tokaLuokka | jokaToisenLuokka jokaToisenTokaLuokka'

Katso myös tarkemmat ohjeet listojen luokkanimien määrittelyyn.

helper:

Määrittää yksittäisen listaelementin sisällön ja tulostusmuodon.

Sallitut arvot: Interface- ja HTML-merkkaus, joka määrittää tulostuksen merkkauksen ja sisällön.

helper-attribuuttia on mahdollista käyttää kahdella tavalla:

  • voit kirjoittaa halutun merkkauksen suoraan attribuutin arvoksi tai
  • voit antaa attribuutin arvoksi viittauksen tiedostoon, joka sisältää halutun merkkauksen. Anna viittaus suhteessa teeman juurihakemistoon.

Katso myös helper-attribuutin tarkemmat käyttöohjeet.

before/after:

before- ja after-attribuuteilla voit määrittää sisällön, joka tulostuu ennen tagin tuottamaa sisältöä tai sen jälkeen.

Sallitut arvot: teksti, jossa voi olla HTML- ja Interface-merkkausta.

Esim.:

  • before: '<p>Tämä merkkaus näkyy ennen tagin omaa sisältöä.</p>'
  • after: '<p>Tämä taas näkyy tagin oman sisällön jälkeen.</p>'

Mikäli tagi ei tuota mitään sisältöä, myöskään before- ja after-attribuuttien sisältö ei tulostu.

escape:

Asettaa tulostuvassa sisällössä pakomerkin ennen lainausmerkkejä. Attribuutin tarkoitus on helpottaa tagin palauttaman sisällön käyttämistä JavaScriptin avulla.

Sallitut arvot: true/false. Oletusarvo false.

or:

Määrittää vaihtoehtoisen sisällön, joka näkyy mikäli tagi ei itse tuota mitään sisältöä.

Sallitut arvot: teksti, jossa voi olla HTML- ja Interface-merkkausta.

Esim. or: 'Sisältöä ei löytynyt.'