post https://{accountName}.{environment}.com.br/api/catalog/pvt/category
Creates a new Category.
Request body example
{
"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": null,
"AdWordsRemarketingCode": null,
"ShowInStoreFront": true,
"ShowBrandFilter": true,
"ActiveStoreFrontLink": true,
"GlobalCategoryId": 800,
"StockKeepingUnitSelectionMode": "SPECIFICATION",
"Score": null
}
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
}
Request body has the following properties:
| Attribute | Type | Description | Required? |
|---|---|---|---|
Id | integer | Category ID | No |
Name | string | Category name (150 characters max) | Yes |
Keywords | string | Substitute words for the Category | No |
Title | string | Text used in title tag for Category page | No |
Description | string | Text used in meta description tag for Category page | No |
AdWordsRemarketingCode | string | Shows the specific code for the AdWords remarketing platform | No |
LomadeeCampaignCode | string | Shows the specific code for the LomadeeCampaign | No |
FatherCategoryId | integer | ID of the parent category, apply in case of category and subcategory | No |
GlobalCategoryId | integer | google_product_category for Google Merchant Center | No |
ShowInStoreFront | boolean | If true, Category is shown in the top and side menu | No |
IsActive | boolean | If true, Category page becomes available in store | No |
ActiveStoreFrontLink | boolean | If true, Category links become active in store | No |
ShowBrandFilter | boolean | If true, Category page displays a Brand filter | No |
Score | integer | Score for search sorting order | No |
StockKeepingUnitSelectionMode | string | Product display mode (see table below) | No |
See more details in our Help Center article: Filling in Category registration fields.
Product display modes (StockKeepingUnitSelectionMode parameter)
StockKeepingUnitSelectionMode parameter)Value | Description |
|---|---|
LIST | List of SKUs |
COMBO | Combo Boxes |
RADIO | Icons with radio selection (radio box) |
SPECIFICATION | Following definition of SKU specification |
Request body example
{
"Name": "Home Appliances",
"Keywords": "Kitchen, Laundry, Appliances",
"Title": "Home Appliances",
"Description": "Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.",
"AdWordsRemarketingCode": null,
"LomadeeCampaignCode": null,
"FatherCategoryId": null,
"GlobalCategoryId": 222,
"ShowInStoreFront": true,
"IsActive": true,
"ActiveStoreFrontLink": true,
"ShowBrandFilter": true,
"Score": null,
"StockKeepingUnitSelectionMode": "SPECIFICATION"
}
Response has the following properties:
| Attribute | Type | Description |
|---|---|---|
Id | integer | Category numerical identifier |
Name | string | Category name |
FatherCategoryId | integer | ID of the parent category, apply in case of category and subcategory |
Title | string | Text used in title tag for Category page |
Description | string | Text used in meta description tag for Category page |
Keywords | string | Substitute words for the Category |
IsActive | boolean | If true, Category page becomes available in store |
LomadeeCampaignCode | string | Shows the specific code for the LomadeeCampaign |
AdWordsRemarketingCode | string | Shows the specific code for the AdWords remarketing platform |
ShowInStoreFront | boolean | If true, Category is shown in the top and side menu |
ShowBrandFilter | boolean | If true, Category page displays a Brand filter |
ActiveStoreFrontLink | boolean | If true, Category links become active in store |
GlobalCategoryId | integer | google_product_category for Google Merchant Center |
StockKeepingUnitSelectionMode | string | Product display mode (see table below) |
Score | integer | Score for search sorting order |
LinkId | string | Text Link |
HasChildren | boolean | If the Category has a Category Child |