Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Using the API

Introduction
Authentication
Responses
Errors
Permissions
Rate Limits
Changelog

Guides

Inventory

Endpoints: Analytics

GET
List orders
GET
Retrieve an order
GET
List order returns
GET
List instore queues
GET
List inventory locations
GET
Retrieve the organization
GET
List all products
GET
List purchase orders
GET
List compliance transfers
GET
List packages
GET
Retrieve a package

Endpoints: Create Orders

Customer Matching
GET
Retrieve order status
POST
Retrieve cart pricing
POST
Create an order
GET
List payment types
POST
Upload customer document

Endpoints: Customers

GET
List customers
GET
Retrieve a customer
GET
List customer groups
PUT
Add customer to group
PUT
Remove customer from group
POST
Add loyalty points

Endpoints: Menu

GET
List all menu products
GET
List tags

Endpoints: Products & Inventory

POST
Create a product
PUT
Update a product
PUT
Update product options
GET
List categories
GET
List sub-categories
POST
Create purchase order
PUT
Update purchase order
PUT
Update UPCs

Using the API

Rate Limits

Requests under our Menu section are limited to 4 per second. All other requests will be limited to 15 per second. If you anticipate needing higher throughput, please reach out to api@getmeadow.com

Permissions

Changelog

github website

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform