Salesforce CDP API Developer Guide

Quick Start
Connect Data
Capture Web Interactions
Integrate your Mobile Applications
API Reference
Event Specifications
Cart Event
Catalog Event
Order Event
Custom Event
Line Item Attribute
Order Attribute
Schema Mappings
Connect MuleSoft with Customer Data Platform
Ingest Data
Extract Data
PDF

Catalog Event

Use a catalog event interaction to capture when a customer interacts with various tracking items. For example, a product or a blog post.
Field Name Field Type Description
catalogObject.attributes object A dictionary of user-supplied values.
catalogObject.id string Required. A unique ID representing the catalog object.
catalogObject.relatedCatalogObjects object A dictionary of related catalog objects.
catalogObject.type string Required. A type name representing the catalog object.

View Catalog Event Example

iOS
1ViewCatalogObjectEvent(
2    catalogObject: CatalogObject(
3        type: "Product",
4        id: "product-12",
5        attributes: [
6            "PROMO_CODE": "WINTER2022"
7        ],
8        relatedCatalogObjects: [
9            "size": ["S", "M", "L"],
10            "sku": ["1234", "5678"]
11        ]
12    )
13)
Android
1CatalogEvent.view(
2  CatalogObject(
3    id = "product-1",
4    type = "Product",
5    attributes = mapOf(
6      "PROMO_CODE" to "FALL2021"
7    ),
8    relatedCatalogObjects = mapOf(
9      "product's size" to listOf("S", "M", "L"),
10      "product-sku" to listOf("1234", "5678")
11    )
12  )
13)

Comment Catalog Event Example

iOS
1CommentCatalogObjectEvent(
2    catalogObject: CatalogObject(
3        type: "Product",
4        id: "product-12",
5        attributes: [
6            "PROMO_CODE": "WINTER2022"
7        ],
8        relatedCatalogObjects: [
9            "size": ["S", "M", "L"],
10            "sku": ["1234", "5678"]
11        ]
12    )
13)
Android
1CatalogEvent.comment(
2  CatalogObject(
3    id = "product-1",
4    type = "Product",
5    attributes = mapOf(
6      "PROMO_CODE" to "FALL2021"
7    ),
8    relatedCatalogObjects = mapOf(
9      "product's size" to listOf("S", "M", "L"),
10      "product-sku" to listOf("1234", "5678")
11    )
12  )
13)

Favorite Catalog Event Example

iOS
1FavoriteCatalogObjectEvent(
2    catalogObject: CatalogObject(
3        type: "Product",
4        id: "product-12",
5        attributes: [
6            "PROMO_CODE": "WINTER2022"
7        ],
8        relatedCatalogObjects: [
9            "size": ["S", "M", "L"],
10            "sku": ["1234", "5678"]
11        ]
12    )
13)
Android
1CatalogEvent.favorite(
2  CatalogObject(
3    id = "product-1",
4    type = "Product",
5    attributes = mapOf(
6      "PROMO_CODE" to "FALL2021"
7    ),
8    relatedCatalogObjects = mapOf(
9      "product's size" to listOf("S", "M", "L"),
10      "product-sku" to listOf("1234", "5678")
11    )
12  )
13)

Quick View Catalog Event Example

iOS
1QuickViewCatalogObjectEvent(
2    catalogObject: CatalogObject(
3        type: "Product",
4        id: "product-12",
5        attributes: [
6            "PROMO_CODE": "WINTER2022"
7        ],
8        relatedCatalogObjects: [
9            "size": ["S", "M", "L"],
10            "sku": ["1234", "5678"]
11        ]
12    )
13)
Android
1CatalogEvent.quickView(
2  CatalogObject(
3    id = "product-1",
4    type = "Product",
5    attributes = mapOf(
6      "PROMO_CODE" to "FALL2021"
7    ),
8    relatedCatalogObjects = mapOf(
9      "product's size" to listOf("S", "M", "L"),
10      "product-sku" to listOf("1234", "5678")
11    )
12  )
13)

Review Catalog Event Example

iOS
1ReviewCatalogObjectEvent(
2    catalogObject: CatalogObject(
3        type: "Product",
4        id: "product-12",
5        attributes: [
6            "PROMO_CODE": "WINTER2022"
7        ],
8        relatedCatalogObjects: [
9            "size": ["S", "M", "L"],
10            "sku": ["1234", "5678"]
11        ]
12    )
13)
Android
1CatalogEvent.review(
2  CatalogObject(
3    id = "product-1",
4    type = "Product",
5    attributes = mapOf(
6      "PROMO_CODE" to "FALL2021"
7    ),
8    relatedCatalogObjects = mapOf(
9      "product's size" to listOf("S", "M", "L"),
10      "product-sku" to listOf("1234", "5678")
11    )
12  )
13)

Share Catalog Event Example

iOS
1ShareCatalogObjectEvent(
2    catalogObject: CatalogObject(
3        type: "Product",
4        id: "product-12",
5        attributes: [
6            "PROMO_CODE": "WINTER2022"
7        ],
8        relatedCatalogObjects: [
9            "size": ["S", "M", "L"],
10            "sku": ["1234", "5678"]
11        ]
12    )
13)
Android
1CatalogEvent.share(
2  CatalogObject(
3    id = "product-1",
4    type = "Product",
5    attributes = mapOf(
6      "PROMO_CODE" to "FALL2021"
7    ),    
8    relatedCatalogObjects = mapOf(
9      "product's size" to listOf("S", "M", "L"),
10      "product-sku" to listOf("1234", "5678")
11    )
12  )
13)

View Detail Catalog Event Example

iOS
1ViewCatalogObjectDetailEvent(
2    catalogObject: CatalogObject(
3        type: "Product",
4        id: "product-12",
5        attributes: [
6            "PROMO_CODE": "WINTER2022"
7        ],
8        relatedCatalogObjects: [
9            "size": ["S", "M", "L"],
10            "sku": ["1234", "5678"]
11        ]
12    )
13)
Android
1CatalogEvent.viewDetail(
2  CatalogObject(
3    id = "product-1",
4    type = "Product",
5    attributes = mapOf(
6      "PROMO_CODE" to "FALL2021"
7    ),
8    relatedCatalogObjects = mapOf(
9      "product's size" to listOf("S", "M", "L"),
10      "product-sku" to listOf("1234", "5678")
11    )
12  )
13)