Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

magento Categories API

Category tree management including creation, retrieval, update, and deletion of catalog categories and their product assignments.

magento Categories API is one of 16 APIs that magento publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Categories. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 2.4.

Requests are made against a single base URL, https://{store_domain}/rest/{store_code}.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.4
Base URL
https://your-store.example.com/rest
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

magento Categories API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token obtained from the /V1/integration/admin/token or /V1/integration/customer/token endpoint. Include in the Authorization header as "Bearer {token}".

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Categories 5

Category tree management including creation, retrieval, update, and deletion of catalog categories and their product assignments.

GET
/V1/categories
List categories
listCategories 2 params → 200400401
POST
/V1/categories
Create a category
createCategory body → 200400401
GET
/V1/categories/{categoryId}
Get category by ID
getCategory 1 param → 200401404
PUT
/V1/categories/{categoryId}
Update a category
updateCategory 1 param body → 200400401404
DELETE
/V1/categories/{categoryId}
Delete a category
deleteCategory 1 param → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Category (12 properties), Error (2 properties), CustomAttribute (2 properties), CategoryRequest (1 property). Each schema is shown below with its type and property counts.

Category
object
A product category in the catalog category tree.
12 properties
CustomAttribute
object
A key-value pair representing a custom EAV attribute on a catalog entity.
2 properties 2 required
CategoryTree
CategoryRequest
object
Request body for creating or updating a category.
1 property 1 required
Error
object
Standard error response returned for 4xx and 5xx responses.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

magento-categories-api-openapi.yml Raw ↑

Other APIs magento publishes across the network.

Magento GraphQL API
Magento SOAP API
Adobe Commerce Webhooks
Adobe Commerce Admin UI SDK
Adobe Commerce Eventing
magento Authentication API
magento Carts API
magento Customers API
magento Inventory API
magento Invoices API
magento Orders API
magento Products API