category.remove
This method is used to remove a Category
Version
v1
Arguments
This method has the path /catalog/<version>/category.remove and
follows the MicroBase API calling conventions.
| Argument | Required | Type | Example | Description |
|---|---|---|---|---|
| id | no | String | SJlkcsaQ | The id of the Category to remove. |
Response
Returns a default response:
{
"ok": true
}Errors
Expected errors that this method could return. Some errors return additional data.
| Error | Data | Description |
|---|---|---|
| category_not_found | The id not found | The Category was not found |
| category_not_empty | - | The Category has products therefore it cannot be deleted |
Example
curl --request POST \
--url 'http://localhost:3000/services/catalog/v1/category.remove?id=SJlkcsaQ \
--header 'authorization: Bearer xxxxx...' \
--header 'accept: application/json' \
--header 'content-type: application/json'