REST web service interface

GET categories/{id}

Updated, 2012-06-19 14:28

Returns the details of a category

Resource Information

Rate Limited? No
Authentication Optional
Response Formats json,xml
HTTP Methods GET
Response Object Category

Resource URL

https://ecommerce.dexero.com/service/rest/2/merchant/catalog/categories/{id}.format

Parameters

Parameter Description
id The system identification number or identifier defined by user.
Example Values : 166
locale Language
Example Values : en, fr

Example Request

https://ecommerce.dexero.com/service/rest/2/merchand/catalogue/categories/78.json

Example Response

XML JSON
{
  "category" : {
    "id" : 78,
    "parent_id" : 0,
    "locale" : "fr",
    "order_pos" : 7,
    "name" : "Femmes",
    "identifier" : "women78"
  }
}

Response Object "Category"

Field Data Type Description
id int The unique identification number of the category. The ID is automatically generated and can not be changed.
parent_id int The unique identification number of the parent category.
locale string The language of the description of the category
order_pos int The position in the ordering of the list.
name string The name of the category
identifier string The unique identifier defined by a user.