Category

Authentication

• HTTP Authentication, scheme: bearer

Category

Create category

Code samples

const data = JSON.stringify({
  name: 'Shoes',
  parentId: '17a54659-a06a-464f-a914-190cee7d4b1a',
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open('POST', 'https://fakestoreapi.ru/category');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Bearer {access-token}');

xhr.send(data);

POST /category

Body parameter

{
  "name": "Shoes",
  "parentId": "17a54659-a06a-464f-a914-190cee7d4b1a"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateCategoryDto	true	none

Responses

Status	Meaning	Description	Schema
201	Created	Category created	None
5XX	Unknown	Server error	None
4XX	Unknown	Check response message	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Get root categories

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open('GET', 'https://fakestoreapi.ru/category');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);

GET /category

Parameters

Name	In	Type	Required	Description
l	query	number	false	Items limit on page ( from 1 to 50 )
p	query	number	false	Items page ( min 1 )

Example responses

200 Response

{
  "tree": [
    {
      "_uuid": "17a54659-a06a-464f-a914-190cee7d4b1a",
      "name": "Shoes",
      "Childrens": [{}],
      "hasChildren": true,
      "hasProduct": false
    }
  ],
  "pagination": {
    "total": 240,
    "page": 1,
    "limit": 10,
    "totalPage": 24,
    "isLastPage": false
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Root categories received	RootCategoriesDetail
5XX	Unknown	Server error	None
4XX	Unknown	Check response message	None

This operation does not require authentication

Get subcategories

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open('GET', 'https://fakestoreapi.ru/category/string/children');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);

GET /category/{id}/children

Parameters

Name	In	Type	Required	Description
id	path	string	true	Parent category id
all	query	boolean	false	Retrieve all subcategories at all levels, or just the current one.

Example responses

200 Response

[
  {
    "_uuid": "17a54659-a06a-464f-a914-190cee7d4b1a",
    "name": "Shoes",
    "Childrens": [{}],
    "hasChildren": true,
    "hasProduct": false
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Subcategories received	Inline
5XX	Unknown	Server error	None
4XX	Unknown	Check response message	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	CategoryDetails	false	none	none
» _uuid	string	true	none	Category id
» name	string	true	none	Category name
» Childrens	CategoryDetails	false	none	Field for retrieve subcategories at all level
» hasChildren	boolean	false	none	Is category has children
» hasProduct	boolean	false	none	Is category has product

This operation does not require authentication

Update category

Code samples

const data = JSON.stringify({
  name: 'Shoes',
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open('PATCH', 'https://fakestoreapi.ru/category/string');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Bearer {access-token}');

xhr.send(data);

PATCH /category/{id}

Body parameter

{
  "name": "Shoes"
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	Category id
body	body	UpdateCategoryDto	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Category updated	None
5XX	Unknown	Server error	None
4XX	Unknown	Check response message	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Remove category by id

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open('DELETE', 'https://fakestoreapi.ru/category/string?all=true');
xhr.setRequestHeader('Authorization', 'Bearer {access-token}');

xhr.send(data);

DELETE /category/{id}

Parameters

Name	In	Type	Required	Description
id	path	string	true	Category id
all	query	boolean	true	none

Responses

Status	Meaning	Description	Schema
200	OK	Category deleted	None
5XX	Unknown	Server error	None
4XX	Unknown	Check response message	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer