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 som 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, Group, Order, Page, Search, Site, Tag, Trademark, User

Article
Egenskaper för aktuell artikel

Fältbeskrivning Datatyp 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
Exempel:
{
    Title: "Titel",
    Value: "Värde"
}
CurrentPriceInclVAT
Artikelns aktuella pris inklusive moms		 Decimaltal Server och klient
Exempel:
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
Exempel:
{
    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		 Boolskt värde Server och klient
Exempel:
True
ID
Artikelnummer för artikeln		 Sträng Server och klient
Exempel:
A12345-01
Images
Sökvägar till artikelns normalbilder		 Array (sträng) Server och klient
Exempel:
[
    "/images/2.123/adidas-mjuka-byxor.png",
    "/images/2.456/adidas-mjuka-byxor-röd-m.jpg"
]
RegularPriceInclVAT
Artikelns ordinarie pris, om ett annat pris gäller för tillfället, inklusive moms		 Decimaltal (nullbar) Server och klient
Exempel:
299,90
Tags
Eventuella taggar som artikeln märkts med		 Array (sträng) Server och klient
Exempel:
[
    "För hemmet",
    "Unisex"
]
Title
Artikelns titel (eventuellt inklusive varumärke om inställning är gjord)		 Sträng Server och klient
Exempel:
Adidas Mjuka byxor
Trademark
Artikelns varumärke		 Sträng Server och klient
Exempel:
Adidas

ArticleVariant
Egenskaper för aktuell artikelvariant

Fältbeskrivning Datatyp Tillgänglighet
CurrentPriceInclVAT
Artikelvariantens aktuella pris inklusive moms		 Decimaltal Server och klient
Exempel:
199,90
ID
Artikelnummer för artikelvarianten		 Sträng Server och klient
Exempel:
A12345-01-G
IsOutOfStock
Flagga för om artikeln är slut i lager		 Boolskt värde Endast server
Exempel:
True
IsSubscriptionArticle
Flagga för om artikelvarianten startar en prenumeration vid köp		 Boolskt värde Server och klient
Exempel:
True
RegularPriceInclVAT
Artikelvariantens ordinarie pris, om ett annat pris gäller för tillfället, inklusive moms		 Decimaltal (nullbar) Server och klient
Exempel:
299,90
Title
Artikelvariantens titel		 Sträng Server och klient
Exempel:
Adidas Mjuka träningsbyxor - Grå

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

Fältbeskrivning Datatyp Tillgänglighet
Articles
De artiklar som finns i varukorgen		 Objekt Endast klient
Exempel:
[
    {
        ID: "A1234-5",
        VariantID: "A1234-5-EU",
        Trademark: "Sony",
        Title: "Sony DVD Spelare",
        Path: "/sv/articles/1.20.30/sony-dvd-spelare",
        GroupPath:
        [
            "Hemunderhållning",
            "DVD"
        ],
        Tags:
        [
            "elektronik",
            "julkampanj"
        ],
        Quantity: 1.00,
        SumInclVAT: 13398.00,
        SumVAT: 2679.60
    }
]
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
Exempel:
[
    {
        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
Exempel:
29 kr
IsFreeDelivery
Flagga för om varukorgens innehåll ger fri frakt.		 Boolskt värde Server och klient
Exempel:
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
Exempel:
199 kr
Quantity
Antal artiklar i varukorgen		 Decimaltal Server och klient
Exempel:
1,00
SumInclVAT
Totalsumman inklusive moms för varukorgen		 Decimaltal Server och klient
Exempel:
100,00
SumVAT
Varukorgens momsbelopp		 Decimaltal Server och klient
Exempel:
25,00

Group
Egenskaper för aktuell varugrupp

Fältbeskrivning Datatyp 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
Exempel:
{
    Title: "Fältets titel",
    Description: "Fältets beskrivning",
    Value: "Värde",
    ValueTitle: "Eventuell titel för värdet"
}
ID
Varugruppens ERP-kod		 Sträng Server och klient
Exempel:
SHOES
InternalID
Varugruppens interna ID		 Heltal Server och klient
Exempel:
168
Parents
Varugruppens föräldragrupper		 Array (sträng) Server och klient
Exempel:
[
    "Kläder",
    "Byxor"
]
Title
Varugruppens titel		 Sträng Server och klient
Exempel:
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.

Fältbeskrivning Datatyp Tillgänglighet
DeliveryFeeInclVAT
Leveransavgift för ordern		 Decimaltal Server och klient
Exempel:
10,00
ID
Orderns ordernummer i systemet		 Heltal Server och klient
Exempel:
1234
PaymentFeeInclVAT
Betalsättsavgift för ordern		 Decimaltal Server och klient
Exempel:
10,00
SumInclVAT
Orderns totala summa inklusive moms		 Decimaltal Server och klient
Exempel:
125,00
SumVAT
Momsdelen av orderns totala summa		 Decimaltal Server och klient
Exempel:
25,00

Page  Globalt objekt
Information för aktuell sida. Kan nås från alla delar av sidan.

Fältbeskrivning Datatyp 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
Exempel:
ArticleInfo
Title
Titeln för aktuell sida		 Sträng Server och klient
Exempel:
Startsidan

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

Fältbeskrivning Datatyp Tillgänglighet
Query
Returnerar aktuell sökfras		 Sträng Server och klient
Exempel:
byxor

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

Fältbeskrivning Datatyp Tillgänglighet
ArticleCount
Antalet artiklar i aktuell webbplats		 Heltal Endast server
Exempel:
100
CountryCode
ISO-kod för aktuellt land		 Sträng Server och klient
Exempel:
SE
CountryName
Namn på aktuellt land, på aktuellt språk		 Sträng Server och klient
Exempel:
Sverige
CurrencyCode
ISO-kod för aktuell valuta		 Sträng Server och klient
Exempel:
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
Exempel:
5
ID
ID för aktuell webbplats		 Heltal Server och klient
Exempel:
1
LanguageCode
ISO-kod för aktuellt språk		 Sträng Server och klient
Exempel:
sv
LanguageStrings["nyckel"]
Översättning eller innehållselement (custom) enligt angiven nyckel.		 Sträng Endast server
Exempel:
Översatt text
TrademarkCount
Antalet varumärken i aktuell webbplats		 Heltal Endast server
Exempel:
5

Tag
Egenskaper för aktuell artikeltagg

Fältbeskrivning Datatyp 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
Exempel:
{
    Title: "Fältets titel",
    Description: "Fältets beskrivning",
    Value: "Värde",
    ValueTitle: "Eventuell titel för värdet"
}
Title
Taggens titel		 Sträng Server och klient
Exempel:
För hemmet

Trademark
Egenskaper för aktuellt varumärke

Fältbeskrivning Datatyp 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
Exempel:
{
    Title: "Fältets titel",
    Description: "Fältets beskrivning",
    Value: "Värde",
    ValueTitle: "Eventuell titel för värdet"
}
Title
Varumärkets titel		 Sträng Server och klient
Exempel:
Adidas

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

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

Kommentarer

0 kommentarer

Artikeln är stängd för kommentarer.

Relaterade artiklar