GuidesAPI EndpointsChangelog
Log In
API Endpoints
Start typing to search…
These docs are for v2024.01. Click to read the latest docs for v2025.01.

/2024-01/partners/menus/{menu_id}/items

post https://api-g.weedmaps.com/wm/2024-01/partners/menus//items

Create an item for a given menu

Log in to see full request history
Path Params
int32
required
Body Params
string
required

Unique external identifier for this menu item; max of 256 characters

string

Name for this menu item

string

Description for this menu item

string

Image URL for this menu item; will be downloaded asynchronously once per unique URL

int32

Integer timestamp of last image update; used to force re-download of a previously cached image

float

The quantity that should be sent via Orders API for every one of these items in the cart; defaults to 1 on an item without variants

int32

The amount for this menu item available for purchase; a value of 0 will not unpublish the item

int32

Items per pack for this menu item

boolean

Whether or not this item is visible on weedmaps.com; items with inventory_quantity of zero will continue to show up to consumers until published is set to false

boolean

Whether or not this menu item can be purchased online

string
Defaults to recreational

The license requirements to purchase this menu item

string

The genetics classification for this menu item

string

The custom brand name for this menu item, which will be used to autolink to a matching brand on WM (if applicable); cannot be combined with brand_id

int32

The brand associated to this menu item; cannot be combined with brand_name

string

Similar to an external_id, this represents the product ID in your system; Weedmaps can then use this ID to link to your products to ours once that link has been established at least once

int32

The product ID for this menu item, where this product's associations may be used for display on WM in place of the ones directly on this item, such as categories, strain, or tags; may skip providing a brand_id attribute when this is provided

int32

The strain ID for this menu item; cannot be combined with strain_name

string

The strain name for this menu item, which will be used to autolink to a matching strain on WM (if applicable); cannot be combined with strain_id

category_ids[]
array of int32s

The category IDs for this menu item; cannot be combined with category_names

category_ids[]
category_names[]
array of strings

The category names for this menu item, where WM will attempt to automatically link exact categories; the first name in the list has the highest priority to match

category_names[]
cannabinoids[][id]
array of int32s

Unique ID for this cannabinoid; cannot be combined with slug

cannabinoids[][id]
cannabinoids[][slug]
array of strings

Unique slug for this cannabinoid; cannot be combined with id

cannabinoids[][slug]
cannabinoids[][percentage][min]
array of floats
required

Minimum percent value for this measurement within 0.0..99.99; can be the same as max

cannabinoids[][percentage][min]*
cannabinoids[][percentage][max]
array of floats
required

Maximum percent value for this measurement within 0.0..99.99; can be the same as min

cannabinoids[][percentage][max]*
cannabinoids[][milligrams][min]
array of floats
required

Minimum milligram value for this measurement within 0.0..10000.0; can be the same as max

cannabinoids[][milligrams][min]*
cannabinoids[][milligrams][max]
array of floats
required

Maximum milligram value for this measurement within 0.0..10000.0; can be the same as min

cannabinoids[][milligrams][max]*
terpenes[][id]
array of int32s

Unique ID for this terpene; cannot be combined with slug

terpenes[][id]
terpenes[][slug]
array of strings

Unique slug for this terpene; cannot be combined with id

terpenes[][slug]
terpenes[][percentage][min]
array of floats
required

Minimum percent value for this measurement within 0.0..99.99; can be the same as max

terpenes[][percentage][min]*
terpenes[][percentage][max]
array of floats
required

Maximum percent value for this measurement within 0.0..99.99; can be the same as min

terpenes[][percentage][max]*
terpenes[][milligrams][min]
array of floats
required

Minimum milligram value for this measurement within 0.0..10000.0; can be the same as max

terpenes[][milligrams][min]*
terpenes[][milligrams][max]
array of floats
required

Maximum milligram value for this measurement within 0.0..10000.0; can be the same as min

terpenes[][milligrams][max]*
tag_ids[]
array of int32s

The tag IDs for this menu item; cannot be combined with tag_names

tag_ids[]
tag_names[]
array of strings

The tag names for this menu item, which will be used to autolink to matching tags on WM (if applicable); cannot be combined with tag_ids

tag_names[]
boolean

Whether or not the weight compliance value is guessed or predetermined

float
required

Weight used during checkout to determine if cart follows compliance limits

string
required

The unit of measurement of this weight

string
required

The price amount for this menu item

string
required

The ISO currency code of this price

variants[][external_id]
array of strings
required

The unique ID of the menu item from the third party used for uniqueness and orders integrations; max of 256 characters; does not need to be unique to this item

variants[][external_id]*
variants[][sku]
array of strings

Unique external identifier of this variant for stock keeping

variants[][sku]
variants[][compliance][precalculated]
array of booleans

Whether or not the weight compliance value is approximated or exact

variants[][compliance][precalculated]
variants[][compliance][weight][value]
array of floats
required

Weight used during checkout to determine if cart follows compliance limits; defaults to the weight of this variant

variants[][compliance][weight][value]*
variants[][compliance][weight][unit]
array of strings
required

The unit of measurement for this weight

variants[][compliance][weight][unit]*
variants[][inventory_quantity]
array of int32s

The amount of this variant available for purchase

variants[][inventory_quantity]
variants[][cart_quantity_multiplier]
array of floats

The quantity that should be sent via Orders API for every one of these variants in the cart

variants[][cart_quantity_multiplier]
variants[][price][amount]
array of strings
required

The price amount for this variant

variants[][price][amount]*
variants[][price][currency]
array of strings
required

The ISO currency code for this price

variants[][price][currency]*
variants[][weight][value]
array of floats
required

The decimal value for this weight

variants[][weight][value]*
variants[][weight][unit]
array of strings
required

The unit of measurement for this weight

variants[][weight][unit]*
string
required

The way in which the sale is applied to this menu item

int32
required
0 to 100

The sale amount as defined by the type; within 0..99

Headers
string

A valid bearer token for the client or user accessing the API. Format: "Bearer TOKEN_VALUE"

Responses

Updated over 1 year ago

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago