Getting Started

Suggest Edits

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 /wm/v1/listings/WMID/menu_items?page[limit]=PAGE_SIZE. This is the endpoint to fetch menu items for a given Listing WMID. The URL breaks down like this:

  • /wm/v1 — This is a shortened version of the base URL, https://api-g.weedmaps.com/wm/v1, which is needed for every call made.
  • menu_items — This refers to the resource's endpoint where the request is being sent.
  • WMID — The identification number of the Listing you're fetching data for. This will be a unique identifier such as 496154253 and will always be a 9-digit integer. When a URL example includes text in all caps such as WMID, that signifies it is to be replaced with information you supply.
  • page[limit]=PAGE_SIZE — There are a few endpoints that allow extra parameters to be passed. PAGE_SIZE should be replaced with the amount of items you wish to be returned in the response. Please be aware that there may be restrictions on what parameters you're allowed to provide.

Frequently Asked Questions

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

Authentication

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 Menu 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/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 Authentication page. Once you have that set up, our Integrator Guide will walk you through the basics of setting up your integration.

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 4 months ago