REST web service interface

GET categories

Updated, 2012-06-19 14:28

Returns a list of categories

Resource Information

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

Resource URL

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

Parameters

Parameter Description
locale Language
Example Values : fr, en

Example Request

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

Example Response

XML JSON 
{
  "categories" : {
    "total" : 3,
    "category" : [
      {
        "id" : 78,
        "parent_id" : 0,
        "locale" : "fr",
        "order_pos" : 7,
        "name" : "Femmes",
        "identifier" : "women78"
      },
      {
        "id" : 79,
        "parent_id" : 78,
        "locale" : "fr",
        "order_pos" : 1,
        "name" : "Chaussures",
        "identifier" : "shoes79"
      },
      {
        "id" : 85,
        "parent_id" : 78,
        "locale" : "fr",
        "order_pos" : 2,
        "name" : "Sandales",
        "identifier" : "sandales85"
      }
    ]
  }
}

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.