Skip to main content
PUT
/
api
/
v1
/
products
/
{productId}
cURL
curl --request PUT \
  --url https://api-staging.getmeadow.com/api/v1/products/{productId} \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Key: <api-key>' \
  --header 'X-Consumer-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "unit": "gram",
  "strainType": "sativa",
  "category": "<string>",
  "subCategories": [
    "<string>"
  ],
  "brandName": "<string>",
  "photos": [
    "<string>"
  ],
  "inventoryType": "option",
  "deletedAt": "<string>",
  "thcAmount": "<string>",
  "thcAmountEach": "<string>",
  "thcAmountRangeLow": "<string>",
  "thcAmountRangeHigh": "<string>",
  "thcUnit": "%",
  "cbdAmount": "<string>",
  "cbdAmountEach": "<string>",
  "cbdAmountRangeLow": "<string>",
  "cbdAmountRangeHigh": "<string>",
  "cbdUnit": "%"
}
'
{
  "data": {
    "id": 11867,
    "organizationId": 25,
    "brand": {
      "id": 2238,
      "name": "Awesome Cannabis",
      "createdAt": "2024-12-12T03:08:58.012Z",
      "updatedAt": "2024-12-12T03:08:58.012Z",
      "description": null
    },
    "subCategories": [
      {
        "id": 30325,
        "organizationId": 25,
        "name": "Top Shelf",
        "createdAt": "2024-12-12T03:01:11.823Z",
        "updatedAt": "2024-12-12T03:01:11.823Z"
      }
    ],
    "inventoryType": "option",
    "createdAt": "2024-12-12T04:08:00.429Z",
    "updatedAt": "2024-12-12T04:08:00.429Z",
    "isActive": false,
    "isFeatured": false,
    "photos": [
      "https://meadow.imgix.net/2024/10/1aef02cf-9150-481e-9625-760693b4186b.jpeg",
      "https://meadow.imgix.net/2022/11/67de83f8-1d72-4713-991a-87c3b29d4e93.jpeg"
    ],
    "name": "Blue Dream",
    "strainType": "hybrid-sativa",
    "isCompliant": true,
    "unit": "gram",
    "primaryCategory": {
      "id": 286,
      "name": "Flower",
      "createdAt": "2023-12-16T02:51:28.738Z",
      "updatedAt": "2023-12-16T02:51:28.738Z",
      "cannabisType": "non-concentrated"
    },
    "options": [
      {
        "id": 15472,
        "name": "Eighth",
        "amount": 3.5,
        "price": 4500,
        "salesPrice": null,
        "createdAt": "2024-12-12T04:08:00.433Z",
        "updatedAt": "2024-12-12T04:08:00.433Z",
        "upc": null,
        "content": "3.5"
      }
    ],
    "thcAmount": "12",
    "thcAmountEach": "12",
    "thcAmountRangeLow": null,
    "thcAmountRangeHigh": null,
    "thcUnit": "mg",
    "cbdAmount": null,
    "cbdAmountEach": null,
    "cbdAmountRangeLow": null,
    "cbdAmountRangeHigh": null,
    "cbdUnit": null
  }
}

Authorizations

​
X-Consumer-Key
string
header
required

The key assigned to your company and provided via Meadow

​
X-Client-Key
string
header
required

The key generated and provided by our mutual client

Path Parameters

​
productId
integer<int64>
required

ID of the product to update

Body

application/json
​
name
string

The name of the product, excluding any brand names.

​
description
string

A description for the product shown on menus. (Supports markdown)

​
unit
enum<string>

Set to gram when this product is in a category which is weighed out (i.e. "Flowers"), otherwise set to item

Available options:
gram,
item
​
strainType
enum<string>

The strain type of the cannabis product, none otherwise.

Available options:
sativa,
indica,
hybrid,
hybrid-sativa,
hybrid-indica,
cbd,
mixed,
none
​
category
string

A category name from the List categories endpoint. Please note that different client organizations may customize category names, for example renaming "Flowers" to "Flower."

​
subCategories
string[]

A list of sub category names from the List sub-categories endpoint, or a new sub category name. Pass an empty array [] to have no sub categories.

​
brandName
string

The brand of the product. Meadow will match this to an existing brand or create a new brand if it does not exist.

​
photos
string[]

URLs for the image to associate with this product. Meadow will download with a background job. Max photo size is 15MB.

​
inventoryType
enum<string>

The inventory type of this product. Please see the Inventory Guide for more information.

Available options:
option,
product,
none
​
deletedAt
string

Set to current ISO 8601 timestamp to delete product

​
thcAmount
string | null

The total amount of THC present in this product

​
thcAmountEach
string | null

The amount of THC per each unit of the product (i.e. 10mg per pre-roll in a pack of 15 pre-rolls)

​
thcAmountRangeLow
string | null

The low value of a range if this product has a range of THC value.

​
thcAmountRangeHigh
string | null

The high value of a range if this product has a range of THC value.

​
thcUnit
enum<string> | null

The unit for the THC values submitted. Must be specified if any of the THC amount fields are provided.

Available options:
%,
mg
​
cbdAmount
string | null

The total amount of CBD present in this product

​
cbdAmountEach
string | null

The amount of CBD per each unit of the product (i.e. 10mg per pre-roll in a pack of 15 pre-rolls)

​
cbdAmountRangeLow
string | null

The low value of a range if this product has a range of CBD value.

​
cbdAmountRangeHigh
string | null

The high value of a range if this product has a range of CBD value.

​
cbdUnit
enum<string> | null

The unit for the CBD values submitted. Must be specified if any of the CBD amount fields are provided.

Available options:
%,
mg

Response

Update product response

​
id
string

The ID of the new product

​
organizationId
string

The client organization's ID

​
name
string

The name of the product

​
description
string | null

The description of the product

​
unit
string

Either gram or item

​
isActive
boolean

Whether this product is shown on the menu. Client organizations must update this via Meadow.

​
isFeatured
boolean

Whether this product is shown as featured. Client organizations must update this via Meadow.

​
brand
object

The brand of this product

​
primaryCategory
object

The category of this product

​
subCategories
object[]

The names of all the sub-categories of this product (may be empty [])

​
photos
string[]

Photo URLs submitted in the request

​
options
object[]

The purchaseable options for this product

​
thcAmount
string | null

The total amount of THC present in this product

​
thcAmountEach
string | null

The amount of THC per each unit of the product (i.e. 10mg per pre-roll in a pack of 15 pre-rolls)

​
thcAmountRangeLow
string | null

The low value of a range if this product has a range of THC value.

​
thcAmountRangeHigh
string | null

The high value of a range if this product has a range of THC value.

​
thcUnit
enum<string> | null

The unit for the THC values submitted.

Available options:
%,
mg
​
cbdAmount
string | null

The total amount of CBD present in this product

​
cbdAmountEach
string | null

The amount of CBD per each unit of the product (i.e. 10mg per pre-roll in a pack of 15 pre-rolls)

​
cbdAmountRangeLow
string | null

The low value of a range if this product has a range of CBD value.

​
cbdAmountRangeHigh
string | null

The high value of a range if this product has a range of CBD value.

​
cbdUnit
enum<string> | null

The unit for the CBD values submitted.

Available options:
%,
mg