Zoey REST API reference ยท Interactive version: apidocs.zoey.com
GET https://container-url.zoeysite.com/api/rest/category/tree/:categoryId
POST https://container-url.zoeysite.com/api/rest/categories/:categoryId/images
Example request body:
{
"file_mime_type": "image/jpeg",
"file_content": "/9j/4AAQSkZJRgABAgEASABIAA...",
"file_name": "api_image.jpg",
"types": [
"image",
"thumbnail",
"promo_image"
]
}
GET https://container-url.zoeysite.com/api/rest/categories/:categoryId/images
DELETE https://container-url.zoeysite.com/api/rest/categories/:categoryId/images
Example request body:
{
"file": "mediamanager/image.jpg"
}
PUT https://container-url.zoeysite.com/api/rest/categories/:categoryId/images
Example request body:
{
"main_image": "mediamanager/image.jpg",
"thumbnail": "mediamanager/thumbnail.jpg",
"promo_image": null
}
GET https://container-url.zoeysite.com/api/rest/categories/:categoryId
GET https://container-url.zoeysite.com/api/rest/categories/?limit=2&page=2&order=name&dir=ASC&filter[0][attribute]=name&filter[0][eq]=Category&id=2
Filtering this collection requires and attribute and a value.
How To Filter A Data Type in Query
Query parameters:
| Name | Example | Notes |
|---|---|---|
limit | 2 | Items per page (ex: ?limit=10) ( Optional ) |
page | 2 | Pagination (ex: ?page=1) ( Optional ) |
order | name | Attribute to sort by (ex: ?order=name) ( Optional ) |
dir | ASC | Sort Direction (ex: ?order=name&dir=DESC) Requires order. ( Optional )
|
filter[0][attribute] | name | Filter collection. ( Optional ) |
filter[0][eq] | Category | |
id | 2 | Parent Category ID (optional) |
POST https://container-url.zoeysite.com/api/rest/categories/
Example request body:
{
"parent_id": "5",
"name": "API Category",
"url_key": "api-category",
"is_active": "1",
"include_in_menu": "1",
"include_in_menu_mobile": "1",
"available_sort_by": [
"position"
],
"default_sort_by": "position"
}
PUT https://container-url.zoeysite.com/api/rest/categories/:categoryId
Example request body:
{
"available_sort_by": "name",
"default_sort_by": "name",
"account_permissions": "8"
}
DELETE https://container-url.zoeysite.com/api/rest/categories/:categoryId