v1

latestOpenAPI 3.1.02026-07-24257573.4 KB
Taxonomy

Retrieve Categories

This operation retrieves Categories from the Weedmaps Taxonomy. Results are returned in ascending order based on their Weedmaps identifier.

You can use the sort and filter query parameters to refine the results and locate specific Categories.


⚠️ Common Error

A Menu Item can only have one root Category link.

This means that our system is receiving Category identifiers that are in different Category taxonomy branches.


💡 Tip 💡

You can sync our taxonomy of Categories or map them to your internal Taxonomy.

When creating or updating a Menu Item, be sure to send us the correlated Weedmaps identifiers including the Sub-Categories.

This link can directly improve search relevance, increase consumer engagement, and it elevates the visibility of the Menu Item within the Weedmaps ecosystem.


get/categories

Query parameters

page_sizeinteger

Number of items per page for paginated lists. Maximum 150.

sort[]string[]

Optionally return resources in a specified order. Use a '-' to invert order.

filters[name][eq]string

Filter resources where name equals; cannot be combined with match

filters[name][match]string

Filter resources where name contains; cannot be combined with eq

filters[published]boolean

Filter for publicly visible resources

filters[parent][id]integer

Filter categories by the provided parent ID

filters[updated_at][after]string date-time

Filter resources after the updated_at timestamp

filters[updated_at][before]string date-time

Filter resources before the updated_at timestamp

Response

Successful Categories Retrieval

Example response

{
  "data": [
    {
      "id": 420,
      "name": "Purple Urkle",
      "parent_id": 420,
      "slug": "ice-water-hash",
      "updated_at": "2023-04-20T16:20:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 42
  }
}