GuidesAPI EndpointsChangelog
Log In
Guides

Getting Started with the Orders API

🚧

WIP - With Team


This guide walks you through how to use the Weedmaps Orders API, which covers order-related callbacks and status update endpoints.

Note: This guide assumes you already have a Live Menu Integration in place through your point-of-sale (POS) system.

Overview

If your retail clients are Weedmaps Orders enabled and have an active Live Menu Integration, all online orders placed through Weedmaps will automatically flow to your integrated POS system via callback events.

As an integration partner, it is your responsibility to:

  • Handle incoming order events
  • Acknowledge and process orders within your POS
  • Send order status updates back to Weedmaps to keep customers informed in real-time.

The primary payload used in this integration is the Order object—a JSON-formatted representation of an order within the Weedmaps ecosystem. You will use this object for both receiving new orders and reporting updates.

🔗

OpenAPI Specification

You can access our OpenAPI specification document at this URL.

Understanding API Endpoints

Throughout this documentation, you’ll see endpoint patterns like:

/oos/2025-07/merchants/{merchantId}/orders/{orderId}

This breaks down as follows:

  • /oos/2025-07 — Base path for the Orders API version 2025-07.
  • merchantId — Unique identifier for a retailer location.
  • orderId — Unique identifier for a specific order.

Base URL:

All Orders API calls use:
https://api-g.weedmaps.com/oos/2025-07


Authentication

Weedmaps uses OAuth 2.0 for authentication across all APIs.

  • Access Token Requirement: Every request must include a valid access token.
  • Secure Protocol: All API calls must be made over HTTPS—unencrypted requests will be rejected.

More details can be found in our API Usage documentation:

Summary Checklist

StepAction
1️⃣Ensure you have a Live Menu Integration
2️⃣Register for the Orders API
3️⃣Set up callback URLs to receive order events
4️⃣Implement order status updates via the API
5️⃣Authenticate every request with an access token

What’s Next

Let's get familiar with Callbacks 📞