Skip to content

Latest commit

 

History

History
235 lines (179 loc) · 5.71 KB

categories.md

File metadata and controls

235 lines (179 loc) · 5.71 KB
Raw

Categories

This endpoint allows you to list, create, retrieve, update and delete your categories.

The category object

Attributes

Key Type Description
name string Required. The category's name
permalink_slug string The category's permalink slug.
parent_id integer The Unique identifier of the parent category, if any.
locations array The category's locations, if any.
priority integer The category's priority.
status boolean Has the value true if the category is enabled or the value false if the category is disabled.
description string An arbitrary string attached to the category.
thumb string The URL where the category's thumbnail can be accessed.

Category object example

{
  "name": "Appetizer",
  "permalink_slug": "appetizer",
  "parent_id": null,
  "locations": [],
  "priority": null,
  "status": true,
  "description": "Sed consequat, sapien in scelerisque egestas",
  "thumb": null
}

List categories

Returns a list of categories you’ve previously created.

Required abilities: categories:read

POST /api/categories

Parameters

Key Type Description
page integer The page number.

Response

Status: 201 Created
[
  {
    "name": "Appetizer",
    "permalink_slug": "appetizer",
    "parent_id": null,
    "locations": [],
    "priority": null,
    "status": true,
    "description": "Sed consequat, sapien in scelerisque egestas",
    "thumb": null
  }
]

Create a category

Creates a new category.

Required abilities: categories:write

POST /api/categories

Parameters

Key Type Description
name string Required. The category's name
permalink_slug string The category's permalink slug.
parent_id integer The Unique identifier of the parent category, if any.
locations array The category's locations, if any.
priority integer The category's priority.
status boolean Has the value true if the category is enabled or the value false if the category is disabled.
description string An arbitrary string attached to the category.
thumb string The URL where the category's thumbnail can be accessed.

Payload example

{
  "name": "Appetizer",
  "status": true
}

Response

Status: 201 Created
{
  "name": "Appetizer",
  "permalink_slug": "appetizer",
  "parent_id": null,
  "locations": [],
  "priority": null,
  "status": true,
  "description": "Sed consequat, sapien in scelerisque egestas",
  "thumb": null
}

Retrieve a category

Retrieves a category.

Required abilities: categories:read

GET /api/categories/:category_id

Parameters

No parameters.

Response

Status: 200 OK
{
  "name": "Appetizer",
  "permalink_slug": "appetizer",
  "parent_id": null,
  "locations": [],
  "priority": null,
  "status": true,
  "description": "Sed consequat, sapien in scelerisque egestas",
  "thumb": null
}

Update a category

Updates a category.

Required abilities: categories:write

PATCH /api/categories/:category_id

Parameters

Key Type Description
name string Required. The category's name
permalink_slug string The category's permalink slug.
parent_id integer The Unique identifier of the parent category, if any.
locations array The category's locations, if any.
priority integer The category's priority.
status boolean Has the value true if the category is enabled or the value false if the category is disabled.
description string An arbitrary string attached to the category.
thumb string The URL where the category's thumbnail can be accessed.

Payload example

{
  "description": "Vivamus interdum erat ac aliquam porttitor. ",
  "parent_id": 2
}

Response

Status: 200 OK
{
  "name": "Appetizer",
  "permalink_slug": "appetizer",
  "parent_id": null,
  "locations": [],
  "priority": null,
  "status": true,
  "description": "Sed consequat, sapien in scelerisque egestas",
  "thumb": null
}

Delete a category

Permanently deletes a category. It cannot be undone.

Required abilities: categories:write

DELETE /api/categories/:category_id

Parameters

No parameters.

Response

Returns an object with a deleted parameter on success. If the category ID does not exist, this call returns an error.

Status: 200 OK
{
  "id": 1,
  "object": "category",
  "deleted": true
}