Skip to content

`Category_Update`#

Description#

This function allows you to update a category.

Request Body Parameters#

Parameter	Type	Description
`category_id` `category_code` `edit_category`	Number String String	The category id being updated The category code being updated The category name being updated
`Category_Active`	Boolean	Defaults to True if omitted
`Category_Page_Title`	String	Category Page Title
`Category_Parent_Category`	String	Parent Category Code of Category
`Category_Alternate_Display_Page`	String	Alternate page code for when using multiple category page templates
`customfield_values`	Object	An object containing a `customfields` object with custom fields to update.

Response Parameters#

Parameter	Type	Description
`success`	Boolean	Boolean value indicating if the API request was successful

Example Request#

{
    "Store_code": "beta",
    "Function": "Category_Update",
    "Category_Code": "Sample",
    "Category_Name": "Sample Test Category",
    "Category_Active": true,
    "Category_Page_Title": "Sample Category Page Title",
    "Category_Parent_Category": "",
    "Category_Alternate_Display_Page": "",
    "CustomField_Values": {
        "customfields": {
            "checkbox_CUSTOMFIELD_CODE": true,
            "imageupload_CUSTOMFIELD_CODE": "graphics/en-US/somecustomfieldimage.jpg",
            "text_CUSTOMFIELD_CODE": "fffff",
            "textarea_CUSTOMFIELD_CODE": "ggggg",
            "dropdown_CUSTOMFIELD_CODE": "bbbbb",
            "multitext_CUSTOMFIELD_CODE": ["hhhhh", "iiiii"]
        },
        "cmp-cssui-cattitle": {
            "category_title_image": "graphics/en-US/somecustomfieldimage.jpg",
        },
        "cmp-cssui-pchdft": {
            "header": "",
            "footer": ""
        },
        "cmp-mv-prodctgy-meta": {
            "keywords": "",
            "description": ""
        }
    }
}

Example Response#

{
    "success": 1
}

Error Responses#

Error Code	Error Message	Error Description
MER-JSN-CAT-00032	Category not found	Value passed in Category_id, Category_Code, or Edit_Category is not found.