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    

Integrator Guide

Introduction

A series of Weedmaps resources must be retrieved and created with this API to integrate your platform. This guide will take you through each step in the process. Along the way, we will use the API Reference to generate cURL commands which, when run in your terminal, will perform the necessary API requests.

Here is an example of what the generated cURL command would look like for creating a Brand:

curl --globoff \
  --request POST \
  --url 'https://api-g.weedmaps.com/catalog/v1/brands?scope_by[organization_id]=7aaee038-06fb-4539-a134-6382bc1985bd' \
  --header 'accept: application/vnd.api+json' \
  --header 'authorization: Bearer [ACCESS TOKEN HERE]' \
  --header 'content-type: application/vnd.api+json' \
  --data '{
    "data": {
        "attributes": {
        "name": "The A-Team",
        "is_master": false
      },
      "relationships": {
        "organization": {
            "data": {
            "type": "organizations",
            "id": "7aaee038-06fb-4539-a134-6382bc1985bd"
          }
        }
      },
      "type": "brands"
    }
  }'

📘

If you have not already, be sure to go through the OAuth guide as you will need an access_token to proceed.

There are six parts to this guide listed below. At the end of the guide, you will have your first product displaying for sale on your test listing page.

Updated about a month ago

Integrator Guide


Suggested Edits are limited on API Reference Pages

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