Script: Class dw.customer.CustomerActiveData
Class CustomerActiveData
- Object
- dw.object.PersistentObject
- dw.object.ExtensibleObject
- dw.object.ActiveData
- dw.customer.CustomerActiveData
- dw.object.ActiveData
- dw.object.ExtensibleObject
- dw.object.PersistentObject
Represents the active data for a Customer in Commerce Cloud Digital.
Note: this class allows access to sensitive personal and private information. Pay attention to appropriate legal and regulatory requirements when developing.
Properties
avgOrderValue : Number Read Only
The average order value of the customer, or null if none has been set or the value is no longer valid.
discountValueWithCoupon : Number Read Only
The discount value resulting from coupons, that has been applied to orders of the customer, or null if none has been set or the value is no longer valid.
discountValueWithoutCoupon : Number Read Only
The discount value resulting from promotions other than coupons, that has been applied to orders of the customer, or null if none has been set or the value is no longer valid.
giftOrders : Number Read Only
The number of orders for the Customer that contained at least one product unit marked as a gift, or null if none has been set or the value is no longer valid.
giftUnits : Number Read Only
The number of product units in orders for the customer that were marked as a gift, or null if none has been set or the value is no longer valid.
lastOrderDate : Date Read Only
The date of the last order for the customer, or null if there are no orders for the customer.
orders : Number Read Only
The orders of the customer, or null if none has been set or the value is no longer valid.
orderValue : Number Read Only
The lifetime order value of the customer, or null if none has been set or the value is no longer valid.
orderValueMonth : Number Read Only
The order value of the customer, over the most recent 30 days, or null if none has been set or the value is no longer valid.
productMastersOrdered : String[] Read Only
An array containing the master product SKUs of variation products in orders for the customer, or an empty collection if no SKUs have been set or the collection of SKUs is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products ordered by the customer.
productsAbandonedMonth : String[] Read Only
An array containing the SKUs of products in baskets abandoned by the customer in the last 30 days, or an empty collection if no SKUs have been set or the collection is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products in baskets abandoned by the customer.
productsOrdered : String[] Read Only
An array containing the SKUs of products in orders for the customer, or an empty collection if no SKUs have been set or the collection of SKUs is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products ordered by the customer.
productsViewedMonth : String[] Read Only
An array containing the SKUs of products viewed by the customer in the last 30 days, or an empty collection if no SKUs have been set or the collection is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products viewed by the customer.
returns : Number Read Only
The number of returns of the customer, or null if none has been set or the value is no longer valid.
returnValue : Number Read Only
The returned revenue of the customer, or null if none has been set or the value is no longer valid.
sourceCodeOrders : Number Read Only
The number of orders for the customer where a source code was in effect, or null if none has been set or the value is no longer valid.
topCategoriesOrdered : String[] Read Only
An array containing the IDs of up to the top 20 categories for customer orders, or an empty list if no categories have been set or the list of categories is no longer valid. The top category is the one for which the most orders for the customer contained at least one product found in that category.
visitsMonth : Number Read Only
The visits of the customer, over the most recent 30 days, or null if none has been set or the value is no longer valid.
visitsWeek : Number Read Only
The visits of the customer, over the most recent 7 days, or null if none has been set or the value is no longer valid.
visitsYear : Number Read Only
The visits of the customer, over the most recent 365 days, or null if none has been set or the value is no longer valid.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
Returns the average order value of the customer, or null if none has been set or the value is no longer valid.
getDiscountValueWithCoupon() : Number
Returns the discount value resulting from coupons, that has been applied to orders of the customer, or null if none has been set or the value is no longer valid.
getDiscountValueWithoutCoupon() : Number
Returns the discount value resulting from promotions other than coupons, that has been applied to orders of the customer, or null if none has been set or the value is no longer valid.
getGiftOrders() : Number
Returns the number of orders for the Customer that contained at least one product unit marked as a gift, or null if none has been set or the value is no longer valid.
getGiftUnits() : Number
Returns the number of product units in orders for the customer that were marked as a gift, or null if none has been set or the value is no longer valid.
getLastOrderDate() : Date
Returns the date of the last order for the customer, or null if there are no orders for the customer.
Returns the orders of the customer, or null if none has been set or the value is no longer valid.
getOrderValue() : Number
Returns the lifetime order value of the customer, or null if none has been set or the value is no longer valid.
Returns the order value of the customer, over the most recent 30 days, or null if none has been set or the value is no longer valid.
getProductMastersOrdered() : String[]
Returns an array containing the master product SKUs of variation products in orders for the customer, or an empty collection if no SKUs have been set or the collection of SKUs is no longer valid.
getProductsAbandonedMonth() : String[]
Returns an array containing the SKUs of products in baskets abandoned by the customer in the last 30 days, or an empty collection if no SKUs have been set or the collection is no longer valid.
getProductsOrdered() : String[]
Returns an array containing the SKUs of products in orders for the customer, or an empty collection if no SKUs have been set or the collection of SKUs is no longer valid.
getProductsViewedMonth() : String[]
Returns an array containing the SKUs of products viewed by the customer in the last 30 days, or an empty collection if no SKUs have been set or the collection is no longer valid.
getReturns() : Number
Returns the number of returns of the customer, or null if none has been set or the value is no longer valid.
getReturnValue() : Number
Returns the returned revenue of the customer, or null if none has been set or the value is no longer valid.
getSourceCodeOrders() : Number
Returns the number of orders for the customer where a source code was in effect, or null if none has been set or the value is no longer valid.
getTopCategoriesOrdered() : String[]
Returns an array containing the IDs of up to the top 20 categories for customer orders, or an empty list if no categories have been set or the list of categories is no longer valid.
getVisitsMonth() : Number
Returns the visits of the customer, over the most recent 30 days, or null if none has been set or the value is no longer valid.
getVisitsWeek() : Number
Returns the visits of the customer, over the most recent 7 days, or null if none has been set or the value is no longer valid.
getVisitsYear() : Number
Returns the visits of the customer, over the most recent 365 days, or null if none has been set or the value is no longer valid.
Methods inherited from class ActiveData
Methods inherited from class ExtensibleObject
Methods inherited from class PersistentObject
getCreationDate, getLastModified, getUUID
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Method Detail
getAvgOrderValue
getAvgOrderValue() : Number
Returns the average order value of the customer, or null if none has been set or the value is no longer valid.
Returns:
the average order size.
getDiscountValueWithCoupon
getDiscountValueWithCoupon() : Number
Returns the discount value resulting from coupons, that has been applied to orders of the customer, or null if none has been set or the value is no longer valid.
Returns:
the discount value resulting from coupons.
getDiscountValueWithoutCoupon
getDiscountValueWithoutCoupon() : Number
Returns the discount value resulting from promotions other than coupons, that has been applied to orders of the customer, or null if none has been set or the value is no longer valid.
Returns:
the discount value resulting from promotions other than coupons.
getGiftOrders
getGiftOrders() : Number
Returns the number of orders for the Customer that contained at least one product unit marked as a gift, or null if none has been set or the value is no longer valid.
Returns:
the number of gift orders.
getGiftUnits
getGiftUnits() : Number
Returns the number of product units in orders for the customer that were marked as a gift, or null if none has been set or the value is no longer valid.
Returns:
the number of gift product units.
getLastOrderDate
getLastOrderDate() : Date
Returns the date of the last order for the customer, or null if there are no orders for the customer.
Returns:
the date of the last order for the customer.
getOrders
getOrders() : Number
Returns the orders of the customer, or null if none has been set or the value is no longer valid.
Returns:
the orders.
getOrderValue
getOrderValue() : Number
Returns the lifetime order value of the customer, or null if none has been set or the value is no longer valid.
Returns:
the lifetime value.
getOrderValueMonth
getOrderValueMonth() : Number
Returns the order value of the customer, over the most recent 30 days, or null if none has been set or the value is no longer valid.
Returns:
the value over the last 30 days.
getProductMastersOrdered
getProductMastersOrdered() : String[]
Returns an array containing the master product SKUs of variation products in orders for the customer, or an empty collection if no SKUs have been set or the collection of SKUs is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products ordered by the customer.
Returns:
a collection containing the master product SKUs of variation products that were ordered.
getProductsAbandonedMonth
getProductsAbandonedMonth() : String[]
Returns an array containing the SKUs of products in baskets abandoned by the customer in the last 30 days, or an empty collection if no SKUs have been set or the collection is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products in baskets abandoned by the customer.
Returns:
a collection containing the SKUs of products that were abandoned.
getProductsOrdered
getProductsOrdered() : String[]
Returns an array containing the SKUs of products in orders for the customer, or an empty collection if no SKUs have been set or the collection of SKUs is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products ordered by the customer.
Returns:
a collection containing the SKUs of products that were ordered.
getProductsViewedMonth
getProductsViewedMonth() : String[]
Returns an array containing the SKUs of products viewed by the customer in the last 30 days, or an empty collection if no SKUs have been set or the collection is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products viewed by the customer.
Returns:
a collection containing the SKUs of products that were ordered.
getReturns
getReturns() : Number
Returns the number of returns of the customer, or null if none has been set or the value is no longer valid.
Returns:
the returns.
getReturnValue
getReturnValue() : Number
Returns the returned revenue of the customer, or null if none has been set or the value is no longer valid.
Returns:
the returned revenue.
getSourceCodeOrders
getSourceCodeOrders() : Number
Returns the number of orders for the customer where a source code was in effect, or null if none has been set or the value is no longer valid.
Returns:
the number of orders with source codes in effect.
getTopCategoriesOrdered
getTopCategoriesOrdered() : String[]
Returns an array containing the IDs of up to the top 20 categories for customer orders, or an empty list if no categories have been set or the list of categories is no longer valid. The top category is the one for which the most orders for the customer contained at least one product found in that category.
Returns:
a list containing the top 20 categories.
getVisitsMonth
getVisitsMonth() : Number
Returns the visits of the customer, over the most recent 30 days, or null if none has been set or the value is no longer valid.
Returns:
the visits over the last 30 days.
getVisitsWeek
getVisitsWeek() : Number
Returns the visits of the customer, over the most recent 7 days, or null if none has been set or the value is no longer valid.
Returns:
the visits over the last 7 days.
getVisitsYear
getVisitsYear() : Number
Returns the visits of the customer, over the most recent 365 days, or null if none has been set or the value is no longer valid.
Returns:
the visits over the last 365 days.