Create 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:

AttributeTypeDescriptionRequired?
IdintegerCategory IDNo
NamestringCategory name (150 characters max)Yes
KeywordsstringSubstitute words for the CategoryNo
TitlestringText used in title tag for Category pageNo
DescriptionstringText used in meta description tag for Category pageNo
AdWordsRemarketingCodestringShows the specific code for the AdWords remarketing platformNo
LomadeeCampaignCodestringShows the specific code for the LomadeeCampaignNo
FatherCategoryIdintegerID of the parent category, apply in case of category and subcategoryNo
GlobalCategoryIdintegergoogle_product_category for Google Merchant CenterNo
ShowInStoreFrontbooleanIf true, Category is shown in the top and side menuNo
IsActivebooleanIf true, Category page becomes available in storeNo
ActiveStoreFrontLinkbooleanIf true, Category links become active in storeNo
ShowBrandFilterbooleanIf true, Category page displays a Brand filterNo
ScoreintegerScore for search sorting orderNo
StockKeepingUnitSelectionModestringProduct display mode (see table below)No

See more details in our Help Center article: Filling in Category registration fields.

Product display modes (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:

AttributeTypeDescription
IdintegerCategory numerical identifier
NamestringCategory name
FatherCategoryIdintegerID of the parent category, apply in case of category and subcategory
TitlestringText used in title tag for Category page
DescriptionstringText used in meta description tag for Category page
KeywordsstringSubstitute words for the Category
IsActivebooleanIf true, Category page becomes available in store
LomadeeCampaignCodestringShows the specific code for the LomadeeCampaign
AdWordsRemarketingCodestringShows the specific code for the AdWords remarketing platform
ShowInStoreFrontbooleanIf true, Category is shown in the top and side menu
ShowBrandFilterbooleanIf true, Category page displays a Brand filter
ActiveStoreFrontLinkbooleanIf true, Category links become active in store
GlobalCategoryIdintegergoogle_product_category for Google Merchant Center
StockKeepingUnitSelectionModestringProduct display mode (see table below)
ScoreintegerScore for search sorting order
LinkIdstringText Link
HasChildrenbooleanIf the Category has a Category Child
Language
Authentication
URL
Click Try It! to start a request and see the response here!