> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.getmeadow.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List all menu products
> Fetch the menu for an organization
This endpoint needs to be retrieved using `daffodil.getmeadow.com` or `daffodil-staging.getmeadow.com` (staging sandbox) instead of the api subdomain.
Example URL: `https://daffodil.getmeadow.com/api/v1/menu`
This endpoint will return all products. No pagination is necessary
# Inventory
Please see our [Inventory Guide](/guides/inventory) for more information.
## OpenAPI
````yaml GET /api/v1/menu
openapi: 3.0.1
info:
title: Meadow Open API
description: The API to connect to the Meadow platform
version: 1.0.0
servers:
- url: https://api-staging.getmeadow.com
- url: https://api.getmeadow.com
security:
- meadowConsumer: []
meadowClient: []
paths:
/api/v1/menu:
get:
description: Fetch the menu for an organization
parameters:
- name: type
in: query
description: >-
Request a menu for one of three types: `delivery`, `pickup` or
`in-store`. If `type` is not passed in, the menu for `delivery` will
be returned.
Each Meadow client essentially has three different menus. If you
intend to support an order flow for more than one type, you should
pull each menu by sending in this parameter.
required: false
schema:
type: string
responses:
'200':
description: Menu response
content:
application/json:
schema:
type: object
properties:
id:
type: number
description: The ID of the product
name:
type: string
description: The name of the product
unit:
type: string
description: Either `gram` or `item`
strainType:
type: string
description: >-
One of `sativa`, `indica`, `hybrid`, `hybrid-sativa`,
`hybrid-indica`, `cbd`, `mixed`, or `none`
thcAmount:
type: string
description: The amount of THC in the product
nullable: true
thcAmountEach:
type: string
description: The amount of THC per each of the product
nullable: true
thcUnit:
type: string
description: Either `%` or `mg`
nullable: true
cbdAmount:
type: string
description: The amount of CBD in the product
nullable: true
cbdAmountEach:
type: string
description: The amount of CBD per each of the product
nullable: true
cbdUnit:
type: string
description: Either `%` or `mg`
nullable: true
description:
type: string
description: A text description about the product
nullable: true
isFeatured:
type: boolean
description: Whether the product is featured or not
inStock:
type: boolean
description: >-
Whether there is at least one option of this product in
stock currently
options:
type: array
description: All of the pricing options for a product
items:
type: object
properties:
id:
type: number
description: >-
The ID of this product option. This value will be
used for placing orders
name:
type: string
description: The name of this option
nullable: true
amount:
type: number
description: ' The amount of the underlying unit of this product'
price:
type: number
description: The price in cents of this option
salesPrice:
type: number
description: The sales price if one exists
nullable: true
upc:
type: string
description: The UPC code for this option
nullable: true
maxQuantity:
type: number
description: >-
The maximum number that is purchaseable based on
current inventory
photos:
type: array
description: Array of the photos for a product
items:
type: object
properties:
fullPath:
type: string
description: The URL to use to display the photo
primaryCategory:
type: object
description: The primary category of the product
properties:
name:
type: string
description: The name of the primary category
brand:
type: object
description: The brand of the product
properties:
name:
type: string
description: The name of the brand
subCategories:
type: array
description: Array of the sub-categories for the product
items:
type: object
properties:
name:
type: string
description: The name of the sub-category
example:
data:
- id: 398
organizationId: 1
name: Blue Dream Pre-roll
unit: item
strainType: sativa
strainName: ''
percentThc: ''
percentCbd: ''
thcAmount: null
thcAmountEach: null
thcUnit: null
cbdAmount: null
cbdAmountEach: null
cbdUnit: null
description: ''
createdAt: '2018-09-16T17:22:10.145Z'
isActive: true
isFeatured: false
archivedAt: null
inventoryType: option
unitPlural: items
isCompliant: false
options:
- id: 1114
productId: 398
name: Bliss
amount: 1
price: 5000
salesPrice: null
createdAt: '2018-09-16T10:22:10.173-07:00'
upc: null
content: '112.5'
maxQuantity: 0
- id: 1110
productId: 398
name: Arouse
amount: 1
price: 5000
salesPrice: null
createdAt: '2018-09-16T10:22:10.173-07:00'
upc: null
content: '112.5'
maxQuantity: 50
- id: 1112
productId: 398
name: Calm
amount: 1
price: 4500
salesPrice: null
createdAt: '2018-09-16T10:22:10.173-07:00'
upc: null
content: '112.5'
maxQuantity: 49
- id: 1113
productId: 398
name: Sleep
amount: 1
price: 5000
salesPrice: null
createdAt: '2018-09-16T10:22:10.173-07:00'
upc: null
content: '112.5'
maxQuantity: 27
photos:
- id: 259
productId: 398
path: 2018/8/9d62c632-01a1-488b-b795-267748ff3b4b.jpeg
createdAt: '2018-09-16T17:29:16.358Z'
format: jpg
fullPath: >-
https://meadow-test.imgix.net/2018/8/9d62c632-01a1-488b-b795-267748ff3b4b.jpeg?auto=format,compress&cs=csrgb&fit=max&h=640&w=640
productGroups: []
primaryCategory:
id: 56
name: Vape
order: 1
cannabisType: concentrated
brand:
id: 37
name: Dosist
subCategories:
- id: 55
name: Vape Cartridge
- id: 95
name: Disposable
- id: 165
name: Vapes
inStock: true
- id: 423
organizationId: 1
name: 7 Pre-rolled Smokes
unit: item
strainType: mixed
strainName: ''
percentThc: ''
percentCbd: ''
thcAmount: null
thcAmountEach: null
thcUnit: null
cbdAmount: null
cbdAmountEach: null
cbdUnit: null
description: |-
7 pre-rolled smokes
0.5 grams each
3.5 grams total
createdAt: '2018-09-17T03:08:35.288Z'
isActive: true
isFeatured: false
archivedAt: null
inventoryType: option
unitPlural: items
isCompliant: false
options:
- id: 1184
productId: 423
name: Indica
amount: 1
price: 4000
salesPrice: null
createdAt: '2018-09-16T20:08:35.31-07:00'
upc: null
content: '3.5'
maxQuantity: 23
- id: 2247
productId: 423
name: BOGO 50% off
amount: 2
price: 8000
salesPrice: 6000
createdAt: '2021-05-14T12:39:41.798852-07:00'
upc: null
content: '7'
maxQuantity: 11
photos:
- id: 284
productId: 423
path: 2018/8/1b9cb619-b0e6-4d66-b2d2-fcefa98fb4b4.jpeg
createdAt: '2018-09-17T03:08:32.509Z'
format: jpg
fullPath: >-
https://meadow-test.imgix.net/2018/8/1b9cb619-b0e6-4d66-b2d2-fcefa98fb4b4.jpeg?auto=format,compress&cs=csrgb&fit=max&h=640&w=640
productGroups: []
primaryCategory:
id: 2
name: Pre-Rolls
order: 2
cannabisType: non-concentrated
brand:
id: 88
name: Lowell Herb Co
subCategories:
- id: 45
name: Top Shelf
inStock: true
meta:
categories:
- id: 1
name: Flowers
order: 0
cannabisType: non-concentrated
- id: 56
name: Vape
order: 1
cannabisType: concentrated
- id: 2
name: Pre-Rolls
order: 2
cannabisType: non-concentrated
- id: 4
name: Concentrates
order: 3
cannabisType: concentrated
- id: 3
name: Edibles
order: 4
cannabisType: concentrated
- id: 5
name: Topicals
order: 5
cannabisType: concentrated
- id: 17
name: Clones
order: 6
cannabisType: immature-plant
- id: 7
name: Accessories
order: 7
cannabisType: none
- id: 138
name: Meadow Select
order: 8
cannabisType: none
- id: 6
name: Seeds
order: 9
cannabisType: none
4XX:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
servers:
- url: https://daffodil-staging.getmeadow.com
- url: https://daffodil.getmeadow.com
components:
schemas:
APIError:
required:
- error
- message
type: object
properties:
error:
type: object
properties:
message:
type: string
example: A description of the error code
code:
type: string
example: CODE_OF_ERROR_WILL_BE_HERE
securitySchemes:
meadowConsumer:
type: apiKey
name: X-Consumer-Key
description: The key assigned to your company and provided via Meadow
in: header
meadowClient:
type: apiKey
name: X-Client-Key
description: The key generated and provided by our mutual client
in: header
````