API - UpdateCategory

The UpdateCategory POST has now been replaced with the UpdateContent POST. This POST will eventually be removed from the API. Please use UpdateContent to update content.

Overview

Endpoint URL https://www.yournetosite.com.au/do/WS/NetoAPI
Method POST
Headers
NETOAPI_ACTION UpdateCategory
NETOAPI_KEY Your Neto API Secure Key (generate this in your Neto control panel)
Description Use this call to update categories. A successful call to UpdateCategory returns the unique identifier (CategoryID) for the updated category, and the date and time the order was updated (CurrentTime)
XSD Schema UpdateCategory XSD   |   UpdateCategory Response XSD

UpdateCategory Post

UpdateCategory Elements

Element Name Type Description Example Neto Version
<Category> Contains the child elements below.
The following are mandatory for an UpdateCategory POST
<CategoryID> integer The unique ID for the order/invoice. Used for lookups and updates. 1 v5.3+
The following are optional  for an UpdateCategory POST
<CategoryName> string The name of the category T-shirt v5.3+
<ParentCategoryID> integer The id of the parent category. For category hierarchy purposes. Use GetCategory to get a list of category ID's. 12 v5.3+
<SortOrder> integer The sort order of the category in relation to other categories. 3 v5.3+
<Active> boolean Flag to determine if category appears on website or not. True
False
v5.3+
<OnSiteMap> boolean Flag to determine if category appears on XML sitemap or not. True
False
v5.3+
<OnMenu> boolean Flag to determine if category appears on menus or not. True
False
v5.3+
<CategoryReference> string_50 Category reference field Home Pending Release
<ShortDescription1> string_255 Category short description field 1 Pending Release
<ShortDescription2> string_255 Category short description field 2 Pending Release
<ShortDescription3> string_255 Category short description field 3 Pending Release
<Description1> string Category Description Field 1 Pending Release
<Description2> string Category Description Field 2 Pending Release
<Description3> string Category Description Field 3 Pending Release

Responses

Sample UpdateCategory Response (Success)

Category Added

Sample UpdateCategory Response (Error)

Required field missing, Category not added

Sample UpdateCategory Response (Warning)

Non required field in wrong format, field ignored, Category added

UpdateCategory Response Elements

<CategoryID> integer The unique ID for the category. 1
<CurrentTime> datetime The time the request was made. 2014-04-20 06:02:30
<Ack> string The acknowledgement message. Success, Error or Warning
<Messages> Contains messages child elements (see below).

<Messages>

<Message> string The error message returned. Request Error
<SeverityCode> string The severity code. Error
<Description> string The description of the error. Internal server error.