Preconfigured actions

Return to Introduction  Previous page  Next page

Format of preconfigured actions for e-commerce software

1. 'Add to cart' action. Is generated when an item is added to the cart.

Action name: AddToCart.

 

Variable

Type

Description

productId

String

A shopping cart specific identifier of a product.

productName

String

Product name

categoryName

String

Product category name

 

2. 'Delete from cart' action. Takes place whenever a product item gets removed from the shopping cart.

Action name: DeleteFromCart.

 

Variable

Type

Description

productId

String

ID of a product deleted from the shopping cart

productName

String

Product name

categoryName

String

Product category name

 

3. 'Cart changed' action. Is generated when cart items are added, removed or updated, or when the cart is cleared (manually or as a result of checkout).

Action name: CartChanged.

 

Variable

Type

Description

itemsCount

Integer

Updated number of items in the cart

total

Double

Updated cart total value (a decimal number without currency signs and thousand separators)

 

4. 'Featured product selected' action. Is performed when the product details page of a featured product is viewed by a customer.

Action name: FeaturedProductSelected.

 

Variable

Type

Description

productId

String

A shopping cart specific identifier of a product

productName

String

Name of a product

categoryName

String

Name of a product category

 

5. 'Bestseller selected' action. Is performed when the product details page of a 'bestseller' product is viewed by a customer.

Action name: BestsellerSelected.

 

Variable

Type

Description

productId

String

A shopping cart specific identifier of a product

productName

String

Name of a product

categoryName

String

Name of a product category

 

6. 'Order' action. Is performed whenever an order is “Processed”, i.e. purchased. If there are several items in the order, the order action is generated for each of them.

Action name: Order.

 

Variable

Type

Description

billing_firstname

String

Visitor's billing first name

billing_lastname

String

Visitor's billing last name

profile_id

String

Visitor's Profile ID

billing_company

String

Visitor's billing company

billing_country

String

Visitor's billing country

billing_state

String

Visitor's billing state

billing_city

String

Visitor's billing city

billing_address

String

Visitor's billing address

billing_zipcode

String

Visitor's billing Zip code

billing_fax

String

Visitor's billing fax

billing_phone

String

Visitor's billing phone

email

String

Visitor's email address

orderId

String

A shopping cart specific identifier of the order

productId

String

A shopping cart specific identifier of a product

productName

String

Name of a product

categoryName

String

Name of a product category

total

Double

Order total value (a decimal number without currency signs and thousand separators)

quantity

Integer

Quantity of product items

 

7. 'Registration' action. Is performed whenever a customer creates a profile and becomes a registered user.

Action name: Register.

 

Variable

Type

Description

billing_firstname

String

Visitor's billing first name

billing_lastname

String

Visitor's billing last name

profile_id

String

Visitor's Profile ID

billing_company

String

Visitor's billing company

billing_country

String

Visitor's billing country

billing_state

String

Visitor's billing state

billing_city

String

Visitor's billing city

billing_address

String

Visitor's billing address

billing_zipcode

String

Visitor's billing Zip code

billing_fax

String

Visitor's billing fax

billing_phone

String

Visitor's billing phone

email

String

Visitor's email address

 

8. 'Login' action. Is generated whenever a user logs in (no matter if the login occurs as a result of submitting user authentication info via the login form or automatically as a result of submitting personal details at registration).

Action name: Login.

 

Variable

Type

Description

billing_firstname

String

Visitor's billing first name

billing_lastname

String

Visitor's billing last name

profile_id

String

Visitor's Profile ID

billing_company

String

Visitor's billing company

billing_country

String

Visitor's billing country

billing_state

String

Visitor's billing state

billing_city

String

Visitor's billing city

billing_address

String

Visitor's billing address

billing_zipcode

String

Visitor's billing Zip code

billing_fax

String

Visitor's billing fax

billing_phone

String

Visitor's billing phone

email

String

Visitor's email address

 

9. 'Filled contact form' action. Is generated when a user submits the 'Contact us' form.

Action name: FilledContactForm.

 

Variable

Type

Description

billing_firstname

String

Visitor's billing first name

billing_lastname

String

Visitor's billing last name

billing_company

String

Visitor's billing company

billing_country

String

Visitor's billing country

billing_state

String

Visitor's billing state

billing_city

String

Visitor's billing city

billing_address

String

Visitor's billing address

billing_zipcode

String

Visitor's billing Zip code

billing_fax

String

Visitor's billing fax

billing_phone

String

Visitor's billing phone

email

String

Visitor's email address

enquiry

String

Visitor's enquiry according to the submitted contact form

 

10. 'Site search' action. Takes place when a user performs a search on the site.

Action name: SiteSearch.

 

Variable

Type

Description

searchPhrase

String

Search phrase used by the visitor

 

11. 'Advanced search' action. Is generated when a visitor uses 'Advanced search' to find a product on the site.

Action name: AdvancedSearch.

 

Variable

Type

Description

searchPhrase

String

Search phrase used by the visitor

categoryName

String

Name of the category where AdvancedSearch is done

 

12. 'View legal info' action. Is performed when a user views a page with the store's legal info (e.g. Terms and Conditions, Privacy Statement).

Action name: ViewLegalInfo.

 

Variable

Type

Description

pageName

String

Name of the legal info page (shopping cart specific)

 

13. 'View help' action. Is generated when a user views the 'Help' page.

Action name: ViewHelp.

 

Variable

Type

Description

pageURL

String

URL of the help page viewed first/last/by the visitor

 

14. 'Add to wish list' action. Takes place when a user adds a product to a Wish list.

Action name: AddToWishList.

 

Variable

Type

Description

productId

String

A shopping cart specific identifier of a product

productName

String

Name of a product

categoryName

String

Name of the product category from which a product was added to the wish list

 

15. 'Write a review' action. Is generated when a user posts a review.

Action name: WriteReview.

 

Variable

Type

Description

productId

String

A shopping cart specific identifier of a product.

productName

String

Name of a product

categoryName

String

Name of a product category

reviewText

String

Text of the review