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    

Onboarding Process

Overview

Before you read through all of the Catalog API documentation, let's take a second to understand what integrating with Weedmaps looks like at a high level. The following sections outline the steps you will need to take in order to integrate with us, from how to get your credentials to obtaining your verified integration.

Obtaining Credentials

It goes without saying that you cannot do anything with the Weedmaps Catalog API until you've received a unique set of credentials. In order to get those, you must first apply to be an integrator and sign some paperwork. Please email [email protected] with the following information to get started:

  • Who you are
  • The point-of-sale (POS) provider you represent
  • Your role within the company

While you await a response from our team, please feel free to read over the documentation. You'll also want to make sure to have a user account on Weedmaps.com. Upon approval, our team will ensure you receive your credentials as well as a test retailer (Listing) associated to the user account you created.

Understanding the API

Our team has written great documentation on how to integrate with us. While we're more than willing to help troubleshoot the issues you come across, please wait until after you've received your credentials and have read over all the documentation before contacting us.

If you've done both of those things and the docs don't have what you're looking for, feel free to reach out to the team via email or our predetermined line of communication, and we'll do our best to help.

Verifying Your Integration

Obtaining your credentials is only the start of the onboarding process. Before your integration becomes available on Weedmaps, you must verify it with our team by completing a predefined set of tasks. This back-and-forth will make up the majority of our onboarding communication.

Once your team has reached the point where they feel your integration is complete, you will schedule a video call with us to demonstrate the integration and various user scenarios. All of the tasks must be achieved on the call in order to pass the verification process. These tasks may look something like the following:

  • Create a Custom Brand
  • Create a Flower Product
  • Apply Tags to a Product
  • Apply a Strain Tag to a Product
  • Create a T-Shirt Product
  • Create a Concentrates Product
  • Apply Lab (Batch) Data to a Product
  • Link to a Master Product
  • Create a Product with Custom Variants
  • Create an Online Orderable Product
  • Create a Product Image for a Product
  • Un-Publish a Catalog Item
  • Discontinue a Product Line

*These items are subject to change at any time and may not reflect the final list you're sent.

Going Live

Upon passing our verification process, you will enter a beta launch phase. Our team will manually connect your integration with at least one real Listing of your choosing. We do this to ensure your hard work transfers properly as you move from your test environment to production data.

There is no required amount of Listings or elapsed time needed in the beta phase. You can officially go live when you feel you're ready, although we do reserve the right to hold off if something needs to be addressed beforehand.

Going live will add you to the list of available integrators in the Weedmaps UI. A Listing can then manually select you (see image below) to set up the connection between you and them.

📘

One User, Multiple Listings

If a Weedmaps user has multiple Listings under their account, they must select your POS on each of those Listings.

Updated 11 months ago

Onboarding Process


Suggested Edits are limited on API Reference Pages

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