Interaction Event Options in the SalesforceInteractions Namespace

1interface ActionEvent<InteractionType extends Interaction> {
2    interaction: InteractionType;
3    debug?: boolean;
4    flags?: boolean;
5    user?: User;
6    account?: Account;
7    source?: Source;
8    consents?: Consent[];
9    explain?: boolean; // If true, then return additional information in the response about why campaigns did or did not render. Requires authentication.
10    pageView?: boolean; // If true, indicates that the event was triggered from a page load.
11    time?: number; // The date and time of the event (in milliseconds) elapsed since the UNIX epoch. This field is optional and will be auto-populated with the current time if null.
12    performance?: PerformanceMetrics;
13    campaignStats?: CampaignStat[],
14}

1{
2    interaction: Interaction,
3    ...
4}

1interface Interaction {
2  name: string;
3}

1interface CatalogObjectInteraction extends Interaction {
2    name: CatalogObjectInteractionName;
3    catalogObject: CatalogObject;
4}
5
6interface CatalogObject {
7    type: string;
8    id: string;
9    attributes?: { [key: string]: any };
10    relatedCatalogObjects?: { [catalogObjectType: string]: string[] };
11}
12
13enum CatalogObjectInteractionName {
14    ViewCatalogObject = 'View Catalog Object',
15    ViewCatalogObjectDetail = 'View Catalog Object Detail',
16    QuickViewCatalogObject = 'Quick View Catalog Object',
17    ShareCatalogObject = 'Share Catalog Object',
18    ReviewCatalogObject = 'Review Catalog Object', // This Interaction is not supported in Marketing Cloud Personalization
19    CommentCatalogObject = 'Comment Catalog Object',
20    FavoriteCatalogObject = 'Favorite Catalog Object'
21}

1"catalogObject": {
2    "id": "test_product_one",
3    "type": "Product",
4    "attributes": {
5        "location": {
6            "longlat": [-71.1502415, 42.3571222],
7            "city": "Boston",
8            "stateProvinceCode": "MA",
9            "postalCode": "02134",
10            "countryNumericCode": "840"
11        }
12    }
13}

1"catalogObject": {
2    "id": "test_product_two",
3    "type": "Product",
4    "attributes": {
5        "location": {
6            "longlat": [144.963058, -37.813629],
7            "city": "Melbourne",
8            "stateProvinceCode": "VIC",
9            "postalCode": "3005",
10            "countryNumericCode": "036"
11        }
12    }
13}

1"catalogObject": {
2    "id": "test_product_three",
3    "type": "Product",
4    "attributes": {
5        "location": {
6            "longlat": [139.691711, 35.689487],
7            "city": "Tokyo",
8            "stateProvinceCode": "13",
9            "postalCode": "100-0004",
10            "countryNumericCode": "392"
11        }
12    }
13}

1enum CartInteractionName {
2    AddToCart = 'Add To Cart',
3    RemoveFromCart = 'Remove From Cart',
4    ReplaceCart = 'Replace Cart'
5}
6
7interface CartInteraction extends Interaction {
8    name: CartInteractionName;
9}
10
11interface AddToCartInteraction extends CartInteraction {
12    name: CartInteractionName.AddToCart;
13    lineItem: LineItem;
14}
15
16interface RemoveFromCartInteraction extends CartInteraction {
17    name: CartInteractionName.RemoveFromCart;
18    lineItem: LineItem;
19}
20
21interface ReplaceCartInteraction extends CartInteraction {
22    name: CartInteractionName.ReplaceCart;
23    lineItems: LineItem[];
24}

1interface Order {
2    id: string;
3    lineItems?: LineItem[];
4    totalValue?: number;
5    currency?: string;
6    attributes?: { [key: string]: any };
7}
8
9enum OrderInteractionName {
10    Purchase = 'Purchase',
11    Preorder = 'Preorder',
12    Cancel = 'Cancel',
13    Ship = 'Ship',
14    Deliver = 'Deliver',
15    Return = 'Return',
16    Exchange = 'Exchange'
17}
18
19interface OrderInteraction extends Interaction {
20    name: OrderInteractionName;
21    order: Order;
22}
23
24interface PurchaseOrderInteraction extends OrderInteraction {
25    name: OrderInteractionName.Purchase;
26    order: Order;
27}
28
29interface PreorderOrderInteraction extends OrderInteraction {
30    name: OrderInteractionName.Preorder;
31    order: Order
32}
33
34interface CancelOrderInteraction extends OrderInteraction {
35    name: OrderInteractionName.Cancel;
36    order: Order
37}
38
39interface ShipOrderInteraction extends OrderInteraction {
40    name: OrderInteractionName.Ship;
41    order: Order
42}
43
44interface DeliverOrderInteraction extends OrderInteraction {
45    name: OrderInteractionName.Deliver;
46    order: Order
47}
48
49interface ReturnOrderInteraction extends OrderInteraction {
50    name: OrderInteractionName.Return;
51    order: Order
52}
53
54interface ExchangeOrderInteraction extends OrderInteraction {
55    name: OrderInteractionName.Exchange;
56    order: Order
57}

1interface LineItem {
2  catalogObjectType: string;
3  catalogObjectId: string;
4  quantity: number;
5  price: number;
6  currency?: string;
7  attributes?: { [key: string]: any }; // Include sku under attributes
8}

1// Example: Without SKU
2{
3	interaction: {
4		name: "Add To Cart",
5		lineItem: {
6			catalogObjectType: "Product",
7			catalogObjectId: "product-1",
8			quantity: 1,
9			price: 9.99,
10			currency: "USD",
11			attributes: {
12				giftWrapping: 1
13			}
14		}
15	}
16}
17
18// Example: With SKU
19{
20	interaction: {
21		name: "Add To Cart",
22		lineItem: {
23			catalogObjectType: "Product",
24			quantity: 1,
25			price: 9.99,
26			currency: "USD",
27			attributes: {
28				sku: {
29					id: "sku12345"
30				}
31			}
32		}
33	}
34}

1interface Source {
2    channel?: string,
3    application?: string,
4    pageType?: string,
5    url?: string,
6    urlReferrer?: string,
7    locale?: string,
8    contentZones?: string,
9    configVersion?: number,
10    userAgent?: string,
11    clientIp?: string,
12    operatingSystem?: string // only applicable for mobile events
13    operatingSystemVersion?: string // only applicable for mobile events
14    device?: string // only applicable for mobile events
15    surveyId?: string // set through the Survey Gear
16    surveyStartTime?: string // set through the Survey Gear
17}

1interface User {
2  anonymousId?: string;
3  identities?: {
4    [key: string]: string,
5  };
6  attributes?: {
7    [key: string]: string | number | boolean,
8  };
9  profileObjects?: {
10    [profileObjectType: string]: ProfileObject[],
11  };
12}

1interface ProfileObject {
2  id: string;
3  relatedCatalogObjects?: { [catalogObjectType: string]: string[] };
4  attributes?: { [key: string]: string | number | boolean };
5}

1"profileObjects": {
2    "Lease": [
3        {
4            "id": "55X1V44",
5            "relatedCatalogObjects": {
6                "Color": ["red", "blue"],
7                "Make": ["car company"]
8            },
9            "attributes": {
10                "duration": 365,
11                "startDate": 1641502977863
12            }
13        }
14    ]
15}

1interface Account {
2  id?: string;
3  attributes?: {
4    [key: string]: string | number | boolean,
5  };
6}

1interface Performance {
2  sdkLoadTimeMs?: number;
3  sdkParseTimeMs?: number;
4  pageLoadTimeMs?: number;
5  networkTimeMs?: number;
6}

1{
2    ...
3    {
4        campaignStats: CampaignStat[]
5    }
6    ...
7}

1{
2    experienceId: string,
3    stat: "Impression" | "Click" | "Dismissal",
4    control: boolean,
5    catalog: {
6        <ItemType>: string[]
7    }
8}

1...
2catalog: {
3    Product: ["product1", "product2"]
4}
5...