Visit Main Site
Join Partner Program
Login
     
Introduction
Authentication
Documentation
Category
GET
POST
PUT
DELETE
Products
GET
POST
PUT
DELETE
Carts
GET
POST
PATCH
DELETE
Variations
GET
POST
PUT
DELETE
Currency
GET
POST
PUT
DELETE
Tax
Tax Profile
GET
POST
PUT
DELETE
Tax Rule
GET
POST
PUT
DELETE
Tax Code
GET
POST
PUT
DELETE
Tax Zone
GET
POST
PUT
DELETE
Discount
GET
POST
PUT
DELETE
Shipping
Shipping Profile
GET
POST
PUT
DELETE
Shipping Rate
GET
POST
PUT
DELETE
Shipping Rules
GET
POST
PUT
DELETE
Customer
GET
POST
PUT
DELETE
Orders
GET
POST
PATCH
Blog
GET
POST
PUT
DELETE
Settings
GET
» Category DELETE API Documentation

Deleting a Specific Category

Endpoint:DELETE /admin/categories/{category_id}

Purpose

The DELETE/admin/categories/{category_id} API allows administrators to remove an existing product category from the system. This API helps maintain a clean and organized product catalog by enabling the deletion of outdated, redundant, or unused categories. By deleting a category, businesses can ensure that customers only see relevant and active product groupings, improving the overall shopping experience.

Path Parameters

Field
Type
Description
category_id
Integer
The unique identifier of the categories

Query Parameters 

This endpoint does not have any query parameters.

Use Case

Administrators use DELETE/admin/categories/{category_id} when a category is no longer needed or when product offerings change. This API is useful for cleaning up obsolete categories after seasonal sales, discontinuing specific product lines, or removing duplicate categories. It allows businesses to maintain an up-to-date and streamlined product catalog while ensuring that irrelevant categories do not clutter the online store.

Request Body

No data is required for the request body.

Response

Upon successful deletion, the API typically returns a confirmation response indicating that the category has been removed. The deleted category will no longer be accessible through the system, and its associated products will no longer appear under that category. This ensures that the product catalog remains accurate and reflective of the business's current offerings. If the category cannot be deleted due to dependencies, the response may include an error message specifying the issue.

DELETE
https://{your_site_domain}/api/v4/admin/categories/{category_id}
Try It Out
Terms and Conditions
Privacy Policy

© 2024 WebCommander | All Rights Reserved

contact@webcommander.com
1300 797 571

WebCommander
About Us
Features
Pricing
Compare
Partners
Contact Us
Resource
Find a Partner
Help Centre
Community
Blog
Solutions
Inventory Management
Omnichannel Sales
Ecommerce Automation
B2B Ecommerce
Headless Commerce
Website Design and Performance