Brand

Suggest Edits

Information

A brand is any manufacturer, distributor, or seller of Products. Two main types of brands exist: Master and Custom.

Master Brand

Weedmaps provides the opportunity for organizations to provide curated content for a brand that they own. Weedmaps may also curate content for a brand that is common in the industry. A curated brand is called a "Master" brand and designated by the attribute is_master: true.

A Master brand is discoverable by any integration and can help reduce the burden of data upload when used as a reference. Referencing a Master brand may also help improve search results. For more information on linking your information to a Master brand see Product Variant.

A Master brand is already listed on Weedmaps with a company profile and information about its Products. A full Master brands directory is located at https://weedmaps.com/brands/all.

Custom Brand

Although a Master brand provides a great way to get curated content through referencing instead of data upload, not every brand will already exist on Weedmaps. When a dispensary or other retail seller needs to add brand content that doesn't already exist, a Custom (non-master) brand can be created and is designated by the attribute is_master: false. Resources referencing a Custom brand must be created on behalf of the same organization that created the Custom brand.

Below are Custom brand examples:

  • Sally's House of Wax
  • Green MJ Wellness Products
  • My Dispensary's Prerolls

API Requests

Master Brand

The request types and routes available for this resource as well as details on how to structure your requests are below. See API Reference - Brand for examples on how the requests might look in various languages and to test the requests in the browser.

RequestRouteDescription
GET/catalog/v1/brandsRequest the information for all Master brands
GET/catalog/v1/brands/:idRequest the information for a particular Master brand

📘

A previous version of this information referenced "Verified" brands. Backward compatibility is maintained as a Master brand is a superset of what is still considered a Verified brand. Switching API usage from "Verified" to "Master" is strongly recommended but not required.

Master GET Index

To fetch all Master Brands, send a request to
/catalog/v1/brands?scope_by[organization_id]=ORGANIZATION_ID&filter[is_master]=true. By default, we only return the first 10 results from the request. You can adjust the number of returned results with page[size], or adjust the returned page with page[page].

Path

scope_by[organization_id] string
Required. Organization UUID.

page[size] int32
Optional. Number of elements per page.

page[page] int32
Optional. Number of the page.

filter[is_master] string
Required. Filters by is_master value. Set to true to return only Master Brands.

filter[discontinued] string
Optional. Filters by whether a Brand is discontinued or not. Set to true or false.

filter[name] string
Optional. Filters by Brand name.

filter[name][search] string
Optional. Allows for searching by Brand name.

Master GET Show

To fetch a Master Brand, send a request to
/catalog/v1/brands/BATCH_ID?scope_by[organization_id]=ORGANIZATION_ID.

Path

scope_by[organization_id] string
Required. Organization UUID.

brand_id string
Required. Master Brand UUID you want to fetch.

Custom Brand

The request types and routes available for this resource as well as details on how to structure your requests are below. See API Reference - Brand for examples on how the requests might look in various languages and to test the requests in the browser.

RequestRouteDescription
POST/catalog/v1/brandsCreate a new Custom brand (see Note 1 below)
GET/catalog/v1/brandsRequest the information for all Custom brands
GET/catalog/v1/brands/:idRequest the information for a particular Custom brand
PATCH/catalog/v1/brands/:idUpdate the information for an existing Custom brand (see Note 2 below)

📘

Posting a Custom brand does not make it a Master brand. To inquire about a brand being listed on Weedmaps as a Master brand, please contact our Sales and Support staff:

🚧

Brands cannot be deleted, as it can cause problems for historical data. Instead, send a PATCH request to set a discontinued_at timestamp to designate it as no longer active.

Custom POST

To create a Brand, send a payload with the below structure to
/catalog/v1/brands?scope_by[organization_id]=ORGANIZATION_ID.

{
  "data": {
    "type": "brands",
    "attributes": {
      "name": "My Brand"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "ORGANIZATION_ID"
          }
      }
    }
  }
}

Path

scope_by[organization_id] string
Required. Organization UUID.

Attributes

id string
Optional. UUID for the resource.

name string
Required. The human-readable name of the Brand.

is_master boolean
Required. Defaults to false. Designates whether it is a Master or Custom Brand. Not updateable directly.

type string
Required. Must be brands.

Relationships

Organization

organization_id string
Required. Related Organization UUID.

type string
Required. Must be organizations.

Custom GET Index

To fetch all Custom Brands, send a request to
/catalog/v1/brands?scope_by[organization_id]=ORGANIZATION_ID&filter[is_master]=false. By default, we only return the first 10 results from the request. You can adjust the number of returned results with page[size], or adjust the returned page with page[page].

Path

scope_by[organization_id] string
Required. Organization UUID.

page[size] int32
Optional. Number of elements per page.

page[page] int32
Optional. Number of the page.

filter[is_master] string
Required. Filters by is_master value. Set to false to return only Custom Brands.

filter[discontinued] string
Optional. Filters by whether a Brand is discontinued or not. Set to true or false.

filter[name] string
Optional. Filters by Brand name.

filter[name][search] string
Optional. Allows for searching by Brand name.

Custom GET Show

To fetch a Custom Brand, send a request to
/catalog/v1/brands/BRAND_ID?scope_by[organization_id]=ORGANIZATION_ID.

Path

scope_by[organization_id] string
Required. Organization UUID.

brand_id string
Required. Brand UUID you want to fetch.

Custom PATCH

To update a Custom Brand, send a payload with the below structure to
/catalog/v1/brands/BRAND_ID?scope_by[organization_id]=ORGANIZATION_ID.

{
  "data": {
    "type": "brands",
    "attributes": {
      "discontinued_at": "TIMESTAMP"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "ORGANIZATION_ID"
          }
      }
    }
  }
}

Path

scope_by[organization_id] string
Required. Organization UUID.

brand_id string
Required. Brand UUID you want to update.

Attributes

id string
Required. UUID for the resource.

discontinued_at string
Optional. When this record was discontinued (ISO-8601).

Relationships

Organization

organization_id string
Required. Related Organization UUID.

type string
Required. Must be organizations.

Updated 11 months ago