Categories

Endpoints for working with categories.

Get categories

GET /api/internal/v1/partners/:partner_id/categories

Paginate all the categories of the partner with possibility to search by the category name.

Path Parameters

Name	Type	Description
partner_id	integer	The id of the partner.

Query Parameters

Name	Type	Description
page	integer	The number of the displayed page. Default is 1
search	string	Search categories by name.

200

Get category

GET /api/internal/v1/partners/:partner_id/categories/:category_id

Get a specific category

Path Parameters

Name	Type	Description
partner_id	integer	The id of the partner.
category_id	integer	The id of the category.

200

Create category

POST /api/internal/v1/partners/:partner_id/categories

Create a new category.

Path Parameters

Name	Type	Description
partner_id	integer	The id of the partner.

Request Body

Name	Type	Description
name	string	The name of the new category. Must be a string between 2 and 255 characters.

200

Update category

PUT /api/internal/v1/partners/:partner_id/categories/:category_id

Update the given category.

Path Parameters

Name	Type	Description
partner_id	integer	The id of the partner.
category_id	integer	The id of the category to be updated.

Request Body

Name	Type	Description
name	string	The new name of the category. Must be a string between 2 and 255 characters.

200

Delete category

DELETE /api/internal/v1/partners/:partner_id/categories/:category_id

Delete the given category.

Path Parameters

Name	Type	Description
partner_id	integer	The id of the partner.
category_id	integer	The id of the category to be deleted.

200