Category

Module endpoints

• DELETE /categories/:id​

• ​GET /categories​

• ​GET /categories/:id​

• ​PATCH /categories/:id​

• ​POST /categories​

• ​POST /categories/:id/reorder

DELETE /categories/:id

DELETE http://api.slyk.io/categories/:id

Deletes the category with given id.

Response

204 No Content

GET /categories

GET https://api.slyk.io/categories

Returns a paginated list of categories.

Available Filters

Name	Type	Example
availableProducts	custom	filter[availableProducts]=true
description	ilike	filter[description]=foo
id	= in nin	filter[id]=7938e446-1c77-4513-8cb0-8b1f2e9f47b9
order	= gte lte	filter[order]=gte:0.5
title	ilike	filter[title]=foo
visibleProducts	custom	filter[visibleProducts]=true

Available Sorts

Name	Example
createdAt	sort=createdAt sort=-createdAt
order	sort=order sort=-order
title	sort=title sort=-title

Paginate Options

Name	Description	Example
size	Defines the number of results per page. Default = 30.	page[size]=2
number	Defines the number of the page to retrieve. Default = 1	page[number]=2

Response

{
  "data": [
    {
      "createdAt": "2020-08-10T10:00:00.000Z",
      "customData": {},
      "description": "Category with music related things",
      "id": "7938e446-1c77-4513-8cb0-8b1f2e9f47b8",
      "imageUrl": "http://slyk.io/music.png",
      "title": "Music",
      "updatedAt": "2020-08-10T10:00:00.000Z"
    },
    {
      "createdAt": "2020-08-10T11:00:00.000Z",
      "customData": {},
      "description": "Category with clothes",
      "id": "7938e446-1c77-4513-8cb0-8b1f2e9f47b9",
      "imageUrl": "http://slyk.io/clothes.png",
      "title": "Clothes",
      "updatedAt": "2020-08-10T11:00:00.000Z"
    }
  ],
  "total": 2
}

GET /categories/:id

GET https://api.slyk.io/categories/:id‌

Gets the category details of the given id.

Response

{
  "data": {
    "createdAt": "2020-08-10T10:00:00.000Z",
    "customData": {},
    "description": "Category with music related things",
    "id": "7938e446-1c77-4513-8cb0-8b1f2e9f47b9",
    "imageUrl": "http://slyk.io/music.png",
    "title": "Music",
    "updatedAt": "2020-08-10T10:00:00.000Z"
  }
}

PATCH /categories/:id

PATCH https://api.slyk.io/categories/:id

Patches the category details of the given id.

Request Parameters

Field	Type	Required	Description
customData	object	false	Can store any additional information about the category.
description	string	false	Category description.
image	string	false	Category image.
order	string	false	Category order value.
title	string	false	Category title.

Request

{
  "description": "foobiz",
  "image": "foobar.png",
  "title": "foobar"
}

Response

{
  "data": {
    "createdAt": "2020-08-10T10:00:00.000Z",
    "customData": {},
    "description": "Category with music related things",
    "id": "7938e446-1c77-4513-8cb0-8b1f2e9f47b9",
    "imageUrl": "http://slyk.io/music.png",
    "title": "Music",
    "updatedAt": "2020-08-10T11:00:00.000Z"
  }
}

POST /categories

POST https://api.slyk.io/categories

Creates a new category.

Request Parameters

Field	Type	Required	Description
customData	object	false	Can store any additional information about the category.
description	string	false	Category description.
image	string	false	Category image.
order	string	false	Category order value.
title	string	true	Category title.

Request

{
  "description": "foobiz",
  "image": "foobar.png",
  "title": "foobar"
}

Response

{
  "data": {
    "createdAt": "2020-08-10T10:00:00.000Z",
    "customData": {},
    "description": "Category with music related things",
    "id": "7938e446-1c77-4513-8cb0-8b1f2e9f47b9",
    "imageUrl": "http://slyk.io/music.png",
    "title": "Music",
    "updatedAt": "2020-08-10T10:00:00.000Z"
  }
}

POST /categories/:id/reorder

POST http://api.slyk.io/categories/:id/reorder

Reorders the category with the given id.

Request Parameters

Field	Type	Required	Description
subsequentId	string	false	Subsequent category identifier.

Request

{
  "subsequentId": "174c3e0d-226f-443a-a010-12b2140de03c"
}

Response

204 No Content