Overview
General
Set Email
Subscribe Email Info
Send Brand
Send Category
Add To Cart
Add To Wishlist
Checkout Ids
Click Image
Comment On Product
Remove From Cart
Save Order
Send Product
Set Cart Url
Visit Help Page
CSV Feed
PHP SDK
API Integration
Add Subscriber
Remove subscriber
Subscriber status
Send Email
Feedback
Discounts
Generate Discounts
Unsubscribed Emails
API For Partners
sendCategory Function
This function must be called when a visitor goes to a category page. In this case, the category page is the page that displays the category details and the list of subcategories belonging to the first or the page that lists the products of a certain category.
sendCategory Function Parameters
Field | Type | Required | Description |
---|---|---|---|
id | number | True | The category identifier |
name | text | True | The category name |
url | text | True | The category url |
parent | number, false | True | ID of parent category. If there isn’t any parent category, send false value. |
breadcrumb | array | True | Array containing all the parent categories of the category to which the product belongs (in this array you must not add the product category). If the category does not have a parent category (category.parent is set false), send an empty array. Each parent category is sent as object and contains the following properties: id, name, parent. |
category_breadcrumb.id | number | True | Category id |
category_breadcrumb.name | text | True | Category name |
category_breadcrumb.parent | number, false | True | Id of parent category. If there isn’t any parent category, send false value. |
callback_function | function | False | With this parameter you can define a function that runs itself after the action’s parent function executes |
Examples
Sending a category without a parent
var _ra = _ra || {}; _ra.sendCategoryInfo = { "id": 20, "name": "Shoes", "url": "https://www.domain.com/men/shoes/sport-shoes", "parent": false, "breadcrumb": [] }; if (_ra.ready !== undefined) { _ra.sendCategory(_ra.sendCategoryInfo); }
Sending a category with one subcategory level
var _ra = _ra || {}; _ra.sendCategoryInfo = { "id": 21, "name": "Sneakers", "url": "https://www.domain.com/men/shoes/sport-shoes", "parent": 20, "breadcrumb": [ {"id": 20, "name": "Shoes", "parent": false} ] }; if (_ra.ready !== undefined) { _ra.sendCategory(_ra.sendCategoryInfo); }
Sending a category with two subcategory levels
var _ra = _ra || {}; _ra.sendCategoryInfo = { "id": 21, "name": "Sneakers", "url": "https://www.domain.com/men/shoes/sport-shoes", "parent": 20, "breadcrumb": [ {"id": 20, "name": "Shoes", "parent": 19}, {"id": 19, "name": "Men", "parent": false} ] }; if (_ra.ready !== undefined) { _ra.sendCategory(_ra.sendCategoryInfo); }