get https://{accountName}.{environment}.com.br/api/catalog/pvt/category/
Retrieves general information about a Category
Response body has the following properties:
Attribute | Type | Description |
---|---|---|
Id | integer | Category ID |
Name | string | Category Name |
FatherCategoryId | integer | ID of the father category, apply in case of category and subcategory |
Title | string | Category Title |
Description | string | Describes details about the Category |
Keywords | string | Substitutes words for the Category |
IsActive | boolean | Shows if the Category is active or not |
LomadeeCampaignCode | string | Shows the specific code for the LomadeeCampaign |
AdWordsRemarketingCode | string | Shows the specific code for the AdWords remarketing platform |
ShowInStoreFront | boolean | Shows if is on side and upper menu |
ShowBrandFilter | boolean | If Category has Brand filter |
ActiveStoreFrontLink | boolean | If the Category has an active link on the website |
GlobalCategoryId | integer | Google Global Category ID |
StockKeepingUnitSelectionMode | string | Shows how the SKU will be exhibit |
Score | integer | Score for search ordination |
LinkId | string | Text Link |
HasChildren | boolean | If the Category has a Category Child |
Response body example:
{
"Id": 1,
"Name": "Home Appliances",
"FatherCategoryId": null,
"Title": "Home Appliances",
"Description": "Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.",
"Keywords": "Kitchen, Laundry, Appliances",
"IsActive": true,
"LomadeeCampaignCode": "",
"AdWordsRemarketingCode": "",
"ShowInStoreFront": true,
"ShowBrandFilter": true,
"ActiveStoreFrontLink": true,
"GlobalCategoryId": 3367,
"StockKeepingUnitSelectionMode": "LIST",
"Score": null,
"LinkId": "Alimentacao",
"HasChildren": true
}