Category Resource

Categories are identifiable containers for items, shown to differenciate and categorize items in a guild's store. Each category can hold up to 30 items.

caution

CRBT store categories not to be confused with Discord's category channels.

Get Category

GET/guilds/{guild.id}/economy/categories/{category.id}

Returns a Category object for the given ID.

Create Category

POST/guilds/{guild.id}/economy/categories

Create a store category. Returns the created Category object on success.

JSON params

Field	Type	Description
label	string	The display name of the category.
emoji	string	The emoji of the category.

Modify Category

PATCH/guilds/{guild.id}/economy/categories/{category.id}

Modify a store category. Returns the updated Category object on success.

info

All parameters to this endpoint are optional.

JSON params

Field	Type	Description
label?	string	The display name of the category.
emoji?	string	The emoji of the category.

Delete Category

DELETE/guilds/{guild.id}/economy/categories/{category.id}

Delete a store category. Returns a 204 No Content response on success.

Category Object

Category Structure

Field	Type	Description
id	snowflake	The ID of the category.
guild_id	string	The ID of the guild which this category belongs to.
label	string	The display name of the category.
emoji	string	The emoji of the category.
items	Item[]	The items a category can hold (max 30).

Example Category

{
  "id": "1086633399390572544",
  "guild_id": "782584672298729473",
  "label": "Seasonal",
  "emoji": "🍁",
  "items": [
    {
      "id": "1086693705814904834",
      "guild_id": "782584672298729473",
      "name": "Winter",
      "emoji": "❄️",
      "description": null,
      "price": 1,
      "category_id": "1086633399390572544",
      "type": 1,
      "stock": null,
      "available_until": null,
      "value": "967854051654000690"
    }
  ]
}