A Category lets the store owner group his/her products to make the store easier to browse.
Property | Explanation |
---|---|
id | The unique numeric identifier for the Category |
name | List of the names of the Category, in every language supported by the store |
descripton | List of the descriptions of the Category, as HTML, in every language supported by the store |
handle | List of the url-friendly strings generated from the Category's names, in every language supported by the store |
parent | Id of the Category's parent. null if it has no parent |
subcategories | The ids of the Category's first level subcategories |
google_shopping_category | Attributes used to categorize an item. This category is selected from the Google’s taxonomy. The full list of product categories can be found here: ES - PT |
created_at | Date when the Category was created in ISO 8601 format |
updated_at | Date when the Category was last updated in ISO 8601 format |
Receive a list of all Categories.
Parameter | Explanation |
---|---|
since_id | Restrict results to after the specified ID |
language | Specify search language (required when serching for handle) |
handle | Show Categories with a given URL |
parent_id | Show Categories with a given parent category |
created_at_min | Show Categories created after date (ISO 8601 format) |
created_at_max | Show Categories created before date (ISO 8601 format) |
updated_at_min | Show Categories last updated after date (ISO 8601 format) |
updated_at_max | Show Categories last updated before date (ISO 8601 format) |
page | Page to show |
per_page | Amount of results |
fields | Comma-separated list of fields to include in the response |
HTTP/1.1 200 OK
[
{
"created_at": "2013-01-03T09:11:51-03:00",
"description": {
"en": "",
"es": "",
"pt": ""
},
"handle": {
"en": "poke-balls",
"es": "poke-balls",
"pt": "poke-balls"
},
"id": 4567,
"name": {
"en": "Poké Balls",
"es": "Poké Balls",
"pt": "Poké Balls"
},
"parent": null,
"subcategories": [],
"google_shopping_category": null,
"updated_at": "2013-03-11T09:14:11-03:00"
}
]
HTTP/1.1 200 OK
[
{
"id": 4567,
"name": {
"en": "Poké Balls",
"es": "Poké Balls",
"pt": "Poké Balls"
},
"subcategories": []
}
]
Receive a single Category
Parameter | Explanation |
---|---|
fields | Comma-separated list of fields to include in the response |
HTTP/1.1 200 OK
{
"created_at": "2013-01-03T09:11:51-03:00",
"description": {
"en": "",
"es": "",
"pt": ""
},
"handle": {
"en": "poke-balls",
"es": "poke-balls",
"pt": "poke-balls"
},
"id": 4567,
"name": {
"en": "Poké Balls",
"es": "Poké Balls",
"pt": "Poké Balls"
},
"parent": null,
"subcategories": [],
"google_shopping_category": null,
"updated_at": "2013-03-11T09:14:11-03:00"
}
Create a new Category
{
"invalid_name": "foobar"
}
HTTP/1.1 422 Unprocessable Entity
{
"name": [
"can't be blank"
]
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"message": "Unprocessable Entity",
"description": "Store has reached maximum limit of 5000 allowed categories"
}
{
"name": {
"en": "Gen I",
"es": "Gen I",
"pt": "Gen I"
},
"parent": 4567,
"google_shopping_category": "Clothing & Accessories > Jewelry"
}
HTTP/1.1 201 Created
{
"created_at": "2013-06-01T12:15:11-03:00",
"description": {
"en": "",
"es": "",
"pt": ""
},
"handle": {
"en": "gen-i",
"es": "gen-i",
"pt": "gen-i"
},
"id": 5678,
"name": {
"en": "Gen I",
"es": "Gen I",
"pt": "Gen I"
},
"parent": 4567,
"google_shopping_category": "Clothing & Accessories > Jewelry",
"subcategories": [],
"updated_at": "2013-06-01T12:15:11-03:00"
}
Modify an existing Category
{
"id": 5678,
"parent": null
}
HTTP/1.1 200 OK
{
"created_at": "2013-06-01T12:15:11-03:00",
"description": {
"en": "",
"es": "",
"pt": ""
},
"handle": {
"en": "gen-i",
"es": "gen-i",
"pt": "gen-i"
},
"id": 5678,
"name": {
"en": "Gen I",
"es": "Gen I",
"pt": "Gen I"
},
"parent": null,
"subcategories": [],
"google_shopping_category": null,
"updated_at": "2013-06-01T12:15:11-03:00"
}
Remove a Category
HTTP/1.1 200 OK
{}