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    

Getting Started

Getting Started

Our documentation is split up into two parts: Guides and API Reference. Links for both can be found in the navigation at the top of every page. Guides, the section you are currently on, provides in-depth detail about our API, its various endpoints, and how to use them. The API Reference section allows you to see how a call to a particular endpoint might look in various languages. You can even test it out right in the browser.

Understanding the Documentation

Throughout the documentation, you will see URL examples such as /catalog/v1/catalogs/CATALOG_ID?scope_by[organization_id]=ORGANIZATION_ID. This is the endpoint to fetch a Catalog and request its information. The URL breaks down like this:

  • /catalog/v1 — This is a shortened version of the base URL, https://api-g.weedmaps.com/catalog/v1, which is needed for every call made.
  • catalogs — This refers to the resource's endpoint where the request is being sent. If you were sending a request to the Product endpoint, this would be products.
  • CATALOG_ID — The identification number of the Catalog you are fetching. This will be a universally unique identifier (UUID) such as 04961542-b975-4878-a40d-1f01184a5314. When a URL example includes text in all caps such as CATALOG_ID, that signifies it is to be replaced with information you supply.
  • scope_by[organization_id]=ORGANIZATION_ID — Nearly all of our endpoints require scope_by[organization_id] for the call to be successful. ORGANIZATION_ID should be replaced with your organization's UUID.

Frequently Asked Questions

Answers to frequently asked questions can be found on our FAQ page.

OAuth

Weedmaps uses OAuth 2.0 as the primary authorization mechanism. For more information about OAuth 2.0, refer to https://tools.ietf.org/html/rfc6749.

Before you're able to integrate with the Catalog API, you must request an access token. This access token must be submitted with all requests. Weedmaps' Network Partner APIs can only be accessed via HTTPS, regardless of environment.

Content Negotiation

Unless otherwise specified in this documentation, data is sent and received in JSON format, specifically the version specified at https://jsonapi.org/format/#content-negotiation. Integrators should specify application/vnd.api+json in the Accept header and the Content-Type header for all requests to the server. For whitelisting purposes, each request must also have a User-Agent header set, identifying your application.

Beginning Your Integration

To begin your integration, you will want to first visit our OAuth page. Once you have OAuth set up, our Integrator Guide will walk you through the basics of setting up your integration. It will take you from establishing your first Catalog for each test business Listing to displaying items for sale on Weedmaps.

Testing Your Integration

As an Integrator, you will receive an onboarding package via email. The onboarding package contains the information you need to set up your test integration.

The onboarding package contains the following information:

  • The Production API Endpoint URL
  • A URL for the test business Listing on Weedmaps
    • The WMID for the test business Listing
    • The email address of the Listing Owner who “owns” the test business Listing (typically this is someone at your organization who has created an account on Weedmaps)
  • Your OAuth application Client ID and Secret

Updated 5 months ago

Getting Started


Suggested Edits are limited on API Reference Pages

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