Categories
[base module url]/categories
This endpoint is used to retrieve categories configured in the shopping cart. Up to 50 records will be returned at a time within the "categories" envelope
Sort parameters ( ?sort=param,param,etc )
Default: +order
Parameter | Info | Asc/Desc |
---|---|---|
order | admin specified ordering | Y |
id | id number | Y |
created | Creation time | Y |
Filter parameters ( ?parameter=value¶meter=value&etc )
Default: none
Parameter | Info |
---|---|
page | Sets the current page to retrieve ( returned in sets of 50 ) |
created_on_after | created time >= the supplied time value. See supported time formats |
Sample Response
The "next_page" will contain an integer for the next page number to retrieve the next set of results using ?page. If "next_page" is false, there are no more pages of results to retrieve
{
"categories": [
{
"id": "581",
"parent_id": null,
"name": "Category 1",
"slug": "category-1",
"description": "Description of this category",
"active": true,
"order": "0",
"created": "2011-12-08T18:12:35-0700",
"created_ip": "127.0.0.1",
"created_user_id": "2",
"modified": "2011-12-09T09:51:34-0700",
"modified_user_id": "2"
},
{
"id": "397",
"parent_id": null,
"name": "Category 2",
"slug": "category-2",
"description": "",
"active": false,
"order": "1",
"created": "2011-09-12T12:46:59-0600",
"created_ip": "127.0.0.1",
"created_user_id": "2",
"modified": "2015-02-04T09:26:01-0700",
"modified_user_id": "2"
},
{
"id": "588",
"parent_id": "581",
"name": "Category 1 Sub 1",
"slug": "category-1-sub-1",
"description": "",
"active": false,
"order": "2",
"created": "2011-12-08T18:12:36-0700",
"created_ip": "127.0.0.1",
"created_user_id": "2",
"modified": "2015-02-12T08:55:54-0700",
"modified_user_id": "2"
},
....
],
"next_page": 2
}