Get a category details | Brevo API Documentation

Retrieve the full details of a single ecommerce category by its unique ID. The response includes the category name, URL, creation and modification timestamps, and deletion status. Returns a 404 error if no category matches the provided ID.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

idstringRequired

Category ID

Response

Category details

createdAtstring

Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ)

idstringformat: "string"

Category ID for which you requested the details

isDeletedboolean

category deleted from the shop's database

modifiedAtstring

Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ)

namestringformat: "string"

Name of the category for which you requested the details

urlstringformat: "string"

URL to the category

Errors

400

Bad Request Error

404

Not Found Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.ecommerce.getCategoryInfo("id");
8	}
9	main();

1	{
2	"createdAt": "2017-05-12T12:30:00Z",
3	"id": "C11",
4	"isDeleted": true,
5	"modifiedAt": "2017-05-12T12:30:00Z",
6	"name": "Electronics",
7	"url": "http://mydomain.com/category/clothing"
8	}

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.ecommerce.getCategoryInfo("id");
8	}
9	main();

1	{
2	"createdAt": "2017-05-12T12:30:00Z",
3	"id": "C11",
4	"isDeleted": true,
5	"modifiedAt": "2017-05-12T12:30:00Z",
6	"name": "Electronics",
7	"url": "http://mydomain.com/category/clothing"
8	}