Catalog API

The PIM Developer Hub

Welcome to the PIM developer hub. You'll find comprehensive guides and documentation to help you start working with PIM as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Understanding a Product Page on Weedmaps

Overview

Now that we understand how to create an Organization and any number of associated Catalogs, it's time to create some products. The best way to ease you into products is to go over each part of a product page as it's displayed on Weedmaps. This gives you a better understanding of how the parts work together to display a product for sale. We will give a brief overview of each part while giving greater detail in the guide.

Product Page

Each product for sale on Weedmaps has its own page. This displays all of the product details ranging from the dispensary that is selling it to the Batch information with the THC/CBD amounts. As we go through this guide, we will be creating all of the needed resources for our test listing to display a product for sale. At the end, your test listing should have a similarly displayed product.

1. Dispensary

The dispensary name, Hank's Dank, is displayed as a link back to its menu. This is the Listing (location) resource we mentioned on the previous page.

While we don't create dispensaries via the Catalog API — that's done by the Listing Owners themselves through the Weedmaps UI — we will use their associated listing_wmid to create Catalogs of products for sale. When we create a Product, it's associated with the appropriate Catalog and displayed for sale on the dispensary's menu.

2. Category Tag

The Category Tag, Flower, tells you the form of the product. This could be Flower, Concentrates, Edibles, Gear, and so forth. There are two main types of tags you will learn about later on. But for now, it's important to remember that all Products must belong to at least one Category Tag like the one shown here.

3. Brand

The Brand, Brand™, is the manufacturer, distributor, or seller of the product. Just like with tags, there are two types of Brands you can associate to a product: Master and Custom. You'll learn more about this when we create a Brand via the API.

4. Product

The product, Orange Cookies, is displayed here with a blue checkmark. The blue checkmark denotes that this product is a verified (Master) product. You may hear Weedmappers lovingly call this checkmark the meatball. The difference between a Custom and Master product will be discussed in the following guides.

The description is also found on the product, giving greater detail about said product to the dispensary's customer.

5. Product Image

The Product Image shows you what the product looks like. We do have a default image that will be shown in cases when one is unavailable, although you should always try to assign a Product Image (URL) so that we may process and render it in our UI.

6. Catalog Item

A product may come in many sizes and costs. These differences are known as Product Variants. Flower products, for example, may have numerous weight breakpoints, each one representing a unique variant. Edible products, on the other hand, typically represent a singular item and therefore only need one variant.

The Catalog Item then displays the price for the selected Product Variant. That being the case, a Catalog Item needs to be created for each Product Variant that exists for a product.

In this image, the Catalog Item has a price of $242.39 and is associated with the selected variant of 1oz. If we had selected the 1g option, the Catalog Item associated with that variant would display the price as $12.99 per 1 g.

7. Variant Attribute

The Variant Attribute of "Weight Breakpoint" is displayed here as Available weights. Along with the Variant Values, this allows the product to display the varying weights that are for sale.

If a product does not have weight breakpoints, you don't need to create any Variant Attributes: There will otherwise be a single Product Attribute and Product Option assigned to each Product Variant.

8. Variant Value

The Variant Value works in conjunction with the Variant Attribute to display the different variants available for sale. This represents the actual weight value for the associated Product, such as 1g, 1/8, 1/4, and so on. We create the major weight breakpoints for you already, which we'll discuss in the next section.

9. Batch

The Batch displays the amount of THC/CBD in the product. This is another field that isn't required to create a product, although customers use this information when making their purchasing decisions. We highly recommend sending these metrics if you can.

👍

Now that we have a general overview of how the information displays on a product page, we can move on to the next step in the guide, Defining a Product Line.

Updated about a year ago

Understanding a Product Page on Weedmaps


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.