Objekt och objektfält för skriptanpassningar

Avatar
Daniel Gamvik
Uppdaterad
Följ

Nedan listas objekt och objektfält som finns tillgängliga för innehållsanpassning i systemet. För varje fält presenteras även ett exempel på fältvärde. De objekt som är märkta med Globalt objekt är alltid åtkomliga, och kan kommas åt från alla sidor. Tänk dock på att inte alla fält är tillgängliga på både servern och klienten. För mer information om hur du använder dig av objekt och fält för att skapa dynamiskt innehåll hänvisas till artikeln Hur skapar och visar jag dynamiskt innehåll i widgets och skript?.

Gå direkt till:
Article, ArticleVariant, Cart, Component, Group, Order, Page, Search, Site, Sys, Tag, Trademark, User

Article
Egenskaper för aktuell artikel

Namn och beskrivning Returtyp med exempel Tillgänglighet
Attributes["nyckel"]
Eventuellt attribut på artikeln eller vald variant enligt attributtypens ERP-kod som nyckel. Som standard returneras värdet om inget annat anges.		 Objekt Endast server 
{
    Title: "Titel",
    Value: "Värde"
}
CurrentPriceInclVAT
Artikelns aktuella pris inklusive moms		 Decimaltal Server och klient 
199,90
Fields["nyckel"]
Eventuellt extrafält på artikeln enligt fältets namn som nyckel. Som standard returneras fältets värde om inget annat anges. För de fasta extrafälten används nycklarna "FIXED-1", "FIXED-2" osv.		 Objekt Endast server 
{
    Title: "Fältets titel",
    Description: "Fältets beskrivning",
    Value: "Värde",
    ValueTitle: "Eventuell titel för värdet"
}
HasVariants
Flagga för om artikeln har flera varianter		 Booleskt värde Server och klient 
True
ID
Artikelnummer för artikeln		 Sträng Server och klient 
A12345-01
Images
Sökvägar till artikelns normalbilder		 Array (sträng) Server och klient 
[
    "/images/2.123/adidas-mjuka-byxor.png",
    "/images/2.456/adidas-mjuka-byxor-röd-m.jpg"
]
IsOutOfStock
Flagga för om alla artikelns varianter är slut i lager		 Booleskt värde Endast server 
False
PriceValidTo
Datum och tid för när aktuellt pris upphör att gälla		 Datum och tid (nullbar) Server och klient 
2022-01-10 14:39:00
RegularPriceInclVAT
Artikelns ordinarie pris, om ett annat pris gäller för tillfället, inklusive moms		 Decimaltal (nullbar) Server och klient 
299,90
Tags
Eventuella taggar som artikeln märkts med. Som standard returneras taggens nyckel om inget annat anges.		 Array (objekt) Server och klient 
[
    {
        Key: "NYCKEL",
        Title: "Taggens titel",
        Path: "/sv/tag/title"
    }
]
Title
Artikelns titel (eventuellt inklusive varumärke om inställning är gjord)		 Sträng Server och klient 
Adidas Mjuka byxor
Trademark
Artikelns varumärke		 Sträng Server och klient 
Adidas

ArticleVariant
Egenskaper för aktuell artikelvariant

Namn och beskrivning Returtyp med exempel Tillgänglighet
CurrentPriceInclVAT
Artikelvariantens aktuella pris inklusive moms		 Decimaltal Server och klient 
199,90
ID
Artikelnummer för artikelvarianten		 Sträng Server och klient 
A12345-01-G
IsOutOfStock
Flagga för om artikeln är slut i lager		 Booleskt värde Endast server 
True
IsSubscriptionArticle
Flagga för om artikelvarianten startar en prenumeration vid köp		 Booleskt värde Server och klient 
True
ManufacturerID
Tillverkarens artikelnummer för varianten		 Sträng Server och klient 
M12345XZ
PriceValidTo
Datum och tid för när aktuellt pris upphör att gälla		 Datum och tid (nullbar) Server och klient 
2022-01-10 14:39:00
QuantityInStock
Lagersaldo för internetlager		 Decimaltal (nullbar) Endast server 
73,00
RegularPriceInclVAT
Artikelvariantens ordinarie pris, om ett annat pris gäller för tillfället, inklusive moms		 Decimaltal (nullbar) Server och klient 
299,90
SupplierID
Leverantörens artikelnummer för varianten		 Sträng Server och klient 
S67890-01
Title
Artikelvariantens titel		 Sträng Server och klient 
Adidas Mjuka träningsbyxor - Grå

Cart  Globalt objekt
Information om besökarens varukorg. På orderbekräftelsesidan innehåller objektet information om de artiklar som finns i aktuell order. Detta objekt kan nås från alla sidor i systemet.

Namn och beskrivning Returtyp med exempel Tillgänglighet
Articles
De artiklar som finns i varukorgen		 Objekt Endast klient 
[
    {
        ID: "A1234-5",
        VariantID: "A1234-5-EU",
        EAN: "7350053850033",
        Trademark: "Sony",
        Title: "Sony DVD Spelare",
        Weight: 1000 /* centimeter (cm) */,
        WeightPoints: 123,
        DimensionWidth: 100 /* gram (g) */,
        DimensionHeight: 100 /* gram (g) */,
        DimensionDepth: 100 /* gram (g) */,
        Path: "/sv/articles/1.20.30/sony-dvd-spelare",
        ImagePath: "/images/2.1234/sony-dvd-spelare.png",
        Quantity: 1.00,
        SumInclVAT: 13398.00,
        SumVAT: 2679.60,
        GroupPath:
        [
            "Hemunderhållning",
            "DVD"
        ],
        Tags:
        [
            "elektronik",
            "julkampanj"
        ]
    }
]
Campaigns
De kampanjer som finns i varukorgen. Både automatiska kampanjer och rabattkoder finns representerade. Attributet "Automatic" returnerar en flagga som säger om kampanjen är automatisk eller ej.		 Objekt Endast klient 
[
    {
        Automatic: true,
        Title: "5% på allt!",
        ValueInclVAT: 20.00,
        ValueVAT: 4.00
    }
]
DeliveryFeeText
Formaterad leveransavgift för aktuell varukorg. Aktuellt momsläge avgör momsinkludering. Inget returneras om avgiften inte kan beräknas.		 Sträng Server och klient 
29 kr
ID
ID för varukorgen för användning i externa system.		 Sträng Server och klient 
4L2MK
IsFreeDelivery
Flagga för om varukorgens innehåll ger fri frakt.		 Booleskt värde Server och klient 
True
LeftToFreeDeliveryText
Formaterad summa för hur mycket som återstår för att uppnå fri frakt för varukorgen. Aktuellt momsläge avgör momsinkludering.		 Sträng Server och klient 
199 kr
Quantity
Antal artiklar i varukorgen		 Decimaltal Server och klient 
1,00
SumInclVAT
Totalsumman inklusive moms för varukorgen		 Decimaltal Server och klient 
100,00
SumVAT
Varukorgens momsbelopp		 Decimaltal Server och klient 
25,00
Volume
Den totala volymen, även om vissa artiklar saknar dimensioner, i kubikcentimeter (cm³)		 Decimaltal Server och klient 
300,00
VolumeExplicit
Den totala volymen, om alla artiklar har dimensioner, i kubikcentimeter (cm³)		 Decimaltal (nullbar) Server och klient 
300,00
Weight
Den totala vikten i gram (g)		 Decimaltal Server och klient 
100,00
WeightPoints
Den totala viktpoängen		 Decimaltal Server och klient 
2 000,00

Component
Egenskaper för aktuell skript- och taggkomponent. Komponenter kan skapas och administreras via administrationsverktyget.

Namn och beskrivning Returtyp med exempel Tillgänglighet
Name
Komponentens namn. Kan exempelvis användas för att komma åt egna klientfunktioner.		 Sträng Endast server 
component18
Settings["nyckel"]
Inställningsvärde enligt angiven nyckel		 Objekt Endast server 
värde
Title
Komponentens titel		 Sträng Endast server 
Komponent 1

Group
Egenskaper för aktuell varugrupp

Namn och beskrivning Returtyp med exempel Tillgänglighet
Fields["nyckel"]
Eventuellt extrafält på varugruppen enligt fältets namn som nyckel. Som standard returneras fältets värde om inget annat anges.		 Objekt Endast server 
{
    Title: "Fältets titel",
    Description: "Fältets beskrivning",
    Value: "Värde",
    ValueTitle: "Eventuell titel för värdet"
}
Heading
Varugruppens sidrubrik		 Sträng Server och klient 
Fina träningsbyxor
ID
Varugruppens ERP-kod		 Sträng Server och klient 
SHOES
InternalID
Varugruppens interna ID		 Heltal Server och klient 
168
Parents
Varugruppens föräldragrupper. Som standard returneras gruppens titel om inget annat anges.		 Array (objekt) Server och klient 
{
    ID: "Varugruppens ERP-kod",
    InternalID: "Varugruppens interna ID",
    Title: "Varugruppens titel",
    Path: "/sv/articles/123/titel"
}
Path
Sökväg till varugruppens sida		 Sträng Server och klient 
/sv/articles/168/traningsbyxor
Title
Varugruppens titel		 Sträng Server och klient 
Träningsbyxor

Order
Egenskaper för aktuell order. För information om vilka artiklar som finns i ordern, se objektet Cart. Skript som registreras för att köras på orderbekräftelsesidan körs endast en gång.

Namn och beskrivning Returtyp med exempel Tillgänglighet
DeliveryDate
Eventuellt leveransdatum		 Datum och tid (nullbar) Server och klient 
2022-01-10 14:39:00
DeliveryFeeInclVAT
Leveransavgift för ordern		 Decimaltal Server och klient 
10,00
DeliveryFeeVAT
Momsdelen av leveransavgiften		 Decimaltal Server och klient 
8,00
ID
Orderns ordernummer i systemet		 Heltal Server och klient 
1234
PaymentFeeInclVAT
Betalsättsavgift för ordern		 Decimaltal Server och klient 
10,00
PaymentFeeVAT
Momsdelen av betalsättsavgiften		 Decimaltal Server och klient 
8,00
SumInclVAT
Orderns totala summa inklusive moms		 Decimaltal Server och klient 
125,00
SumVAT
Momsdelen av orderns totala summa		 Decimaltal Server och klient 
25,00

Page  Globalt objekt
Information för aktuell sida. Detta objekt kan nås från alla sidor i systemet.

Namn och beskrivning Returtyp med exempel Tillgänglighet
ID
ID för aktuell sida. För en systemsida returneras en sträng som identiferar sidan, medan det interna namnet returneras för egna sidor.		 Sträng Server och klient 
ArticleInfo
Title
Titeln för aktuell sida		 Sträng Server och klient 
Startsidan

Search
Ger information om aktuell sökning på sökresultatssidan

Namn och beskrivning Returtyp med exempel Tillgänglighet
Query
Returnerar aktuell sökfras		 Sträng Server och klient 
byxor

Site  Globalt objekt
Information om aktuell webbplats. Detta objekt kan nås från alla sidor i systemet.

Namn och beskrivning Returtyp med exempel Tillgänglighet
ArticleCount
Antalet artiklar i aktuell webbplats		 Heltal Endast server 
100
CountryCode
ISO-kod för aktuellt land		 Sträng Server och klient 
SE
CountryName
Namn på aktuellt land, på aktuellt språk		 Sträng Server och klient 
Sverige
CurrencyCode
ISO-kod för aktuell valuta		 Sträng Server och klient 
SEK
DeliveryZoneID
ID för den aktuella fraktzonen. För information se landgrupper för frakt i admin. Om landgrupp saknas så ges 0.		 Heltal Endast server 
5
ID
ID för aktuell webbplats		 Heltal Server och klient 
1
LanguageCode
ISO-kod för aktuellt språk		 Sträng Server och klient 
sv
LanguageStrings["nyckel"]
Översättning eller innehållselement (custom) enligt angiven nyckel.		 Sträng Endast server 
Översatt text
TrademarkCount
Antalet varumärken i aktuell webbplats		 Heltal Endast server 
5

Sys  Globalt objekt
Aktuell systeminformation, såsom datum, tid och information om aktuell förfrågan. Detta objekt kan nås från alla sidor i systemet.

Namn och beskrivning Returtyp med exempel Tillgänglighet
DateTime
Aktuellt datum och tid		 Datum och tid Endast server 
2022-01-10 14:39:00
Query["nyckel"]
Värdet på en GET-parameter i aktuell URL enligt nyckel (ex: "?nyckel=värde").		 Sträng Endast server 
värde

Tag
Egenskaper för aktuell artikeltagg

Namn och beskrivning Returtyp med exempel Tillgänglighet
Fields["nyckel"]
Eventuellt extrafält på taggen enligt fältets namn som nyckel. Som standard returneras fältets värde om inget annat anges.		 Objekt Endast server 
{
    Title: "Fältets titel",
    Description: "Fältets beskrivning",
    Value: "Värde",
    ValueTitle: "Eventuell titel för värdet"
}
Heading
Taggens sidrubrik		 Sträng Server och klient 
Allt för hemmet
Title
Taggens titel		 Sträng Server och klient 
För hemmet

Trademark
Egenskaper för aktuellt varumärke

Namn och beskrivning Returtyp med exempel Tillgänglighet
Fields["nyckel"]
Eventuellt extrafält på varumärket enligt fältets namn som nyckel. Som standard returneras fältets värde om inget annat anges.		 Objekt Endast server 
{
    Title: "Fältets titel",
    Description: "Fältets beskrivning",
    Value: "Värde",
    ValueTitle: "Eventuell titel för värdet"
}
Heading
Varumärkets sidrubrik		 Sträng Server och klient 
Allt från Adidas
InternalID
Varumärkets interna ID		 Heltal Server och klient 
37
Path
Sökväg till varumärkets sida		 Sträng Server och klient 
/sv/trademarks/adidas
Title
Varumärkets titel		 Sträng Server och klient 
Adidas

User  Globalt objekt
Information om aktuell användare. Fältet "IsSignedIn" ger en flagga för om aktuell användare har loggat in. På orderbekräftelsesidan innehåller objektet information om den användare som lade aktuell order. Detta objekt kan nås från alla sidor i systemet.

Namn och beskrivning Returtyp med exempel Tillgänglighet
CustomerGroups
Eventuella kundgrupper som kunden tillhör		 Array (sträng) Endast server 
[
    "VIP",
    "B2B"
]
CustomerNumber
Kundnummer för inloggad användare		 Sträng Endast server 
K123456
Email
Användarens e-postadress		 Sträng Endast server 
bosse@e37.se
IsCompany
Flagga för om aktuell användare är ett företag/visar shoppen som ett företag		 Booleskt värde Server och klient 
False
IsSignedIn
Flagga för om aktuell användare har loggat in		 Booleskt värde Server och klient 
True
Name
Användarens namn		 Sträng Endast server 
Bo Ek

Kommentarer

0 kommentarer

Artikeln är stängd för kommentarer.

Relaterade artiklar