id | Integer | a unique identifier for the banner ad. |
name | String | the name or title of the banner ad. |
description | String | a description or additional information about the banner ad. |
image | String | the URL of the image for the banner ad. |
image_web | String | the URL of the image for the web version of the banner ad. |
type | Integer | Banner Ad Type of Clicks: It define the click action. Banner Ad Types - (0) None: The banner will not be clickable.
- (1) Product: The banner will open a product details page.
- (2) Subcategory: The banner will open a product list of subcategory or open subcategory page.
- (4) Brand: The banner will open a product list of brand or open brand page.
- (5) Custom list: The banner will open a product list of custom list.
- (6) Category: The banner will open a product list of category or open category page.
- (7) Link: The banner will open a link in the website or any external website link.
|
active | Boolean | the ad is active or deactivate to show on website. |
dev_key | String | a color key or code of background the banner ad. |
item_id | Integer | The ID of the item depends on the type of click action. - If the type is Product the item ID will be the ID of the product.
- If the type is Subcategory the item ID will be the ID of the subcategory.
- If the type is Brand the item ID will be the ID of the brand.
- If the type is Custom List the item ID will be the ID of the custom list.
- If the type is Category the item ID will be the ID of the category.
- If the type is Link the item ID will be empty.
|
link | String | When clicked and type is Link the banner ad redirects to URL. |
item_data | Object | An resource-specific data based on the selected item's type (Product, Subcategory, Brand, Custom List, or Category); for Link type, the object will be empty. |