Products

products_list

Retrieves a list of accessible Products.

Endpoint

GET /api/v1.5/products/

Response

{
    "count": 356,
    "next": "https://<domain>/api/v1.5/products/?page=2",
    "previous": null,
    "results": [
        {
            "uuid": "<uuid>",
            "name": "",
            "sku": "",
            "product_type": "",
            "is_published": <true|false>,
            "brand_uuid": "<uuid>"
        }
    ]
}

Response Fields (List)

Field	Type	Description
`uuid`	uuid	Unique identifier for the product
`name`	string	Product name
`sku`	string	Stock keeping unit
`product_type`	string	Product category (e.g., FLOWER, GUMMY, VAPE)
`is_published`	boolean	Whether the product is published and visible
`brand_uuid`	uuid	UUID of the brand this product belongs to

products_get

Retrieves the details of a Product.

Endpoint

GET /api/v1.5/products/<uuid>/

Response

{
    "uuid": "<uuid>",
    "sku": "",
    "description": "",
    "name": "",
    "label_type": "",
    "container_type": "",
    "published_on": "2020-06-18",
    "available_on": "2020-06-18",
    "discontinued_on": null,
    "brand": {
      "uuid": "<uuid>",
      "name": "",
      "company": "",
      "slug": "",
      "description": "",
      "website": "",
      "updated_on": "",
      "state": "",
      "country": "",
      "images": {
        "thumbnail": {
            "name": "",
            "url": "<url>",
            "mime_type": "image/jpeg",
            "size_bytes": 8919.0,
            "updated_on": "2020-06-18T07:59:08.886941Z"
        },
        "primary": {
            "name": "",
            "url": "<url>",
            "mime_type": "image/jpeg",
            "size_bytes": 8919.0,
            "updated_on": "2020-06-18T07:59:08.821675Z"
        },
        "banner": {
            "name": "",
            "url": "<url>",
            "mime_type": "image/jpeg",
            "size_bytes": 13867.0,
            "updated_on": "2020-06-18T07:59:08.932368Z"
        }
      }, 
      "brand_video": {
        "name": "",
        "url": "<url>",
        "mime_type": "",
        "size_bytes": "",
        "updated_on": "2021-02-10T05:35:04.607692Z",
        "uploaded_by": "",
        "description": "",
        "length_in_minutes": "",
        "video_source_link": "<url>"
      }
    },
    "product_type": "",
    "usage": "",
    "variety": "",
    "strain": "",
    "chemotype": "<Optional, for New Jersey brands>",
    "product_line": "",
    "package_size": {
        "name": "",
        "value": "",
        "unit": ""
    },
    "upc": "",
    "servings": "",
    "serving_size": {
        "name": "",
        "value": "",
        "unit": ""
    },
    "gross_weight": {
        "name": "<Only for Arizona brands>",
        "value": "",
        "unit": ""
    },
    "product_packaging_approval_number": "<Only for Missouri brands>",
    "additional_ingredients":  "",
    "expected_total_cbd": {
        "name": "",
        "value": "",
        "unit": ""
    },
    "expected_total_thc": {
        "name": "",
        "value": "",
        "unit": ""
    },
    "thc_cbd_ratio": "",
    "tests_description": "",
    "updated_on": "2021-01-28T20:34:42.675497Z",
    "about_ingredients": "",
    "special_diet": [],
    "allergen": [],
    "testing_methodology": "",
    "usage_recommendation": "",
    "ingredients": [
      {"name": "ingredient1"},
      {"name": "ingredient2"},
      {"name": "ingredient3"}
    ],
    "documents": [
        {
          "name": "",
          "url": "<url>",
          "mime_type": "",
          "size_bytes": "",
          "updated_on": "2021-02-10T05:35:04.607692Z",
          "uploaded_by": ""
        }
    ],
    "videos": [
        {
          "name": "",
          "url": "<url>",
          "mime_type": "",
          "size_bytes": "",
          "updated_on": "2021-02-10T05:35:04.607692Z",
          "uploaded_by": ""
        }
    ],
    "images": {
        "thumbnail": {
            "name": "",
            "url": "<url>",
            "mime_type": "image/jpeg",
            "size_bytes": 8919.0,
            "updated_on": "2020-06-18T07:59:08.886941Z"
        },
        "primary": {
            "name": "",
            "url": "<url>",
            "mime_type": "image/jpeg",
            "size_bytes": 8919.0,
            "updated_on": "2020-06-18T07:59:08.821675Z"
        },
        "banner": {
            "name": "",
            "url": "<url>",
            "mime_type": "image/jpeg",
            "size_bytes": 13867.0,
            "updated_on": "2020-06-18T07:59:08.932368Z"
        }
    },
    "barcode": "",
    "dosages": [
      {
        "name": "",
        "quantity": "",
        "quantity_unit": "",
        "serving_size": "",
        "serving_size_unit": "",
        "thc": "",
        "thc_unit": "",
        "cbd": "",
        "cbd_unit": ""
      }
    ]
}

Response Fields (Detail)

Field	Type	Description
`uuid`	uuid	Unique identifier for the product
`sku`	string	Stock keeping unit
`name`	string	Product name
`description`	string	Product description (HTML supported)
`label_type`	string	Label type
`container_type`	string	Container type (bottle, jar, pouch, etc.)
`published_on`	date or null	When the product was published
`available_on`	date or null	When the product became available
`discontinued_on`	date or null	When the product was discontinued
`brand`	object	Full brand details (nested)
`product_type`	string	Product category (e.g., FLOWER, GUMMY)
`usage`	string	Usage type: `R` (Recreational) or `M` (Medical)
`variety`	string	Cannabis variety (e.g., IND, STV, HYB)
`strain`	string	Cannabis strain name
`chemotype`	string	Chemotype classification (optional, for New Jersey brands)
`product_line`	string	Product line name
`package_size`	object	Package size with `name`, `value`, and `unit`
`upc`	string	Universal Product Code
`servings`	string	Number of servings
`serving_size`	object	Serving size with `name`, `value`, and `unit`
`gross_weight`	object	Gross weight (only for Arizona brands)
`expected_total_thc`	object	Expected THC content with `name`, `value`, and `unit`
`expected_total_cbd`	object	Expected CBD content with `name`, `value`, and `unit`
`thc_cbd_ratio`	string	THC to CBD ratio (e.g., “5:1”)
`barcode`	string	Product barcode
`dosages`	array	Dosage options with quantity, THC, and CBD per serving
`ingredients`	array	List of ingredient objects with `name`
`documents`	array	Associated document files
`videos`	array	Associated video files
`images`	object	Product images (thumbnail, primary, banner)
`updated_on`	datetime	When the product was last updated

Request Body’s values restrictions

Unit’s value for `package_size` and `serving_size` should be one of the following, otherwise it will return a 400 error

milligram
gram
milliliter
liter
ounces
pounds

Unit’s value for `expected_total_cbd` and `expected_total_thc` should be one of the following, otherwise it will return a 400 error

percentage
milligram_per_gram
microgram_per_gram
parts_per_million
milligram_per_kilogram
milligram_per_milliliter
gram_per_milliliter
parts_per_billion
water_activity
ph
cfu_per_gram

Product Type’s value should be one of the following, otherwise it will return a 400 error

BADDER
BALM
BATH_BOMB
BATH_SALTS
BHO
BLUNT
BODY_OIL
BREATH_STRIPS
BROWNIE
BUBBLE_HASH
BUCCAL_POUCHES
BUDDER
CAPSULE
CBD_CIGARETTES
CHEW
CHOCOLATE
CIGARETTE
CLEANSER
CO2_OIL
COFFEE_POD
CONCENTRATE
COOKIE
COOKING_OIL
CRACKER
CREAM
CRUMBLE
CRUSHED_DIAMONDS
CURED_BUDDER
CURED_CRUMBLE
CURED_SUGAR
CURED_SUGAR_AND_SAUCE
DECARB_OIL
DIAMONDS
DISPOSABLE_VAPE
DISSOLVABLE
DISTILLATE
DRINK_MIX
DRY_HERB_VAPE
E_LIQUID
EDIBLE
EXTRACT
FACE_MASK
FLOWER
GEL
GRANOLA
GUMMY
HARD_CANDY
HASH
HONEY
HONEY_OIL_EXTRACT
INFUSED_BEER
INFUSED_BEVERAGE
INFUSED_BLUNT
INFUSED_CARBONATED_BEVERAGE
INFUSED_FLOWER
INFUSED_PREROLL
INFUSED_ROLLING_PAPER
INHALER
JOINT
KIEF
LIVE_BUDDER
LIVE_DIAMONDS_AND_SAUCE
LIVE_RESIN
LIVE_ROSIN
LIVE_SAUCE
LIVE_SUGAR
LIVE_SUGAR_AND_SAUCE
LOZENGES
LUBE
MASSAGE_OIL
MINTS
MOON_ROCKS
NANO_INFUSED_EDIBLE
NANO_INFUSED_GUMMY
NANO_INFUSED_LIQUID
NANO_INFUSED_PREROLL
OIL
PHO
PRE_GROUND
PRE_ROLLS
RESIN
ROLLER_BALL_GEL_PEN
ROSIN
RSO_OIL
SALVE
SAUCE
SHAKE
SHATTER
SPREAD
SUBLINGUAL
SUBLINGUAL_SPRAY
SUBLINGUAL_TABLET
SUGAR
SUPPOSITORY
SYRINGE
TABLET
TEA
TERPENE_SAUCE
TINCTURE
TOPICAL_CREAM
TRANSDERMAL_GEL
TRANSDERMAL_PATCH
TROCHE
VAPE
WAX

Usage’s value should be one of the following, otherwise it will return a 400 error

R (Recreational)
M (Medical)

Variety’s value should be one of the following, otherwise it will return a 400 error

IND (Indica)
STV (Sativa)
HYB (Hybrid)
HSD (Sativa Dominant)
HID (Indica Dominant)
CBD (CBD)
CBN (CBN)
CBN_CBD_THC (CBN / CBD / THC)
CBG_CBD_THC (CBG / CBD / THC)
THCV_CBD_THC (THCV / CBD / THC)
CBD_THC (CBD / THC)

Chemotype’s value should be one of the following, otherwise it will return a 400 error

high_thc_high_cbd (High THC, High CBD)
high_thc_moderate_cbd (High THC, Moderate CBD)
high_thc_low_cbd (High THC, Low CBD)
moderate_thc_high_cbd (Moderate THC, High CBD)
moderate_thc_moderate_cbd (Moderate THC, Moderate CBD)
moderate_thc_low_cbd (Moderate THC, Low CBD)
low_thc_high_cbd (Low THC, High CBG)
low_thc_moderate_cbd (Low THC, Moderate CBD)
low_thc_low_cbd (Low THC, Low CBD)

THC & CBD ratio must have either 0 or 1 space around colon (“THC:CBD” or “TCH : CBD”)

Container Type’s value should be one of the following, otherwise it will return a 400 error

bottle
can
capsule
cartridge
jar
pen
pouch
syringe
tube

`serving_size` and `servings` fields are required for the following product types

BREATH_STRIPS
BROWNIE
CAPSULE
CHEW
CHOCOLATE
COFFEE_POD
COOKIE
COOKING_OIL
CRACKER
CREAM
DISSOLVABLE
DRINK_MIX
EDIBLE
GRANOLA
GUMMY
HARD_CANDY
HONEY
INFUSED_BEER
INFUSED_BEVERAGE
INFUSED_CARBONATED_BEVERAGE
INHALER
LOZENGES
NANO_INFUSED_EDIBLE
NANO_INFUSED_GUMMY
SPREAD
SUBLINGUAL
SUBLINGUAL_SPRAY
SUBLINGUAL_TABLET
SUGAR
SUPPOSITORY
TABLET
TEA
TINCTURE
TRANSDERMAL_PATCH

products_create

Create a new Product for the specified brand with the provided brand_uuid. If brand_uuid is not provided, the product will be created for the default brand associated with your account.

Fields

brand_uuid
sku
name (required)
available_on
label_name
container_type
discontinued_on
product_type (required)
usage
variety
strain
chemotype
product_line
package_size (required)
upc
servings (conditionally required)
serving_size (conditionally required)
expected_total_cbd
expected_total_thc
thc_cbd_ratio
barcode
product_packaging_approval_number
additional_ingredients
description (HTML supported)
photo_thumbnail (Base64 string)
photo_primary (Base64 string)
photo_banner (Base64 string)
description_asset_uuid
photo_thumbnail_asset_uuid
photo_banner_asset_uuid
photo_primary_asset_uuid

Endpoint

POST /api/v1.5/products/create/

Request

{
  "sku": "",
  "name": "Demo Product",
  "label_name": "Demo Product Label Name",
  "container_type": "bottle",
  "available_on": "2020-05-31",
  "discontinued_on": "2020-05-31",
  "product_type": "FLOWER",
  "usage": "",
  "variety": "",
  "strain": "",
  "chemotype": "High THC, High CBD <Optional, for New Jersey brands>",
  "product_line": "",
  "package_size": {
    "name": "",
    "value": "1",
    "unit": "milligram"
  },
  "upc": "",
  "servings": "2",
  "serving_size": {
    "name": "",
    "value": "1.5",
    "unit": "milligram"
  },
  "expected_total_cbd": {
    "name": "",
    "value": "1.000",
    "unit": "percentage"
  },
  "expected_total_thc": {
    "name": "",
    "value": "1.000",
    "unit": "percentage"
  },
  "thc_cbd_ratio": "",
  "barcode": "",
  "description": "<strong>New description</strong>",
  "photo_thumbnail": "<File converted into a Base64 string>",
  "photo_primary": "<File converted into a Base64 string>",
  "photo_banner": "<File converted into a Base64 string>",
  "description_asset_uuid": "<uuid>",
  "photo_thumbnail_asset_uuid": "<uuid>",
  "photo_banner_asset_uuid": "<uuid>",
  "photo_primary_asset_uuid": "<uuid>",
  "product_packaging_approval_number": "<Only for Missouri brands>",
  "additional_ingredients":  ""
}

products_update

Update a Product.

Fields

sku
name (required)
label_name
container_type
available_on
discontinued_on
product_type (required)
usage
variety
strain
chemotype
product_line
package_size (required)
upc
servings (conditionally required)
serving_size (conditionally required)
expected_total_cbd
expected_total_thc
thc_cbd_ratio
barcode
product_packaging_approval_number
additional_ingredients
description_asset_uuid
photo_thumbnail_asset_uuid
photo_banner_asset_uuid
photo_primary_asset_uuid
description (HTML supported)
photo_thumbnail (Base64 string)
photo_primary (Base64 string)
photo_banner (Base64 string)

Endpoint

PUT /api/v1.5/products/<uuid>/update/

Request

{
  "sku": "",
  "name": "Updated Demo Product",
  "label_name": "Demo Product Label Name",
  "container_type": "bottle",
  "available_on": "2020-05-31",
  "discontinued_on": "2020-05-31",
  "product_type": "FLOWER",
  "usage": "",
  "variety": "",
  "strain": "",
  "chemotype": "High THC, High CBD <Optional, for New Jersey brands>",
  "product_line": "",
  "package_size": {
    "name": "",
    "value": "1",
    "unit": "milligram"
  },
  "upc": "",
  "servings": "2",
  "serving_size": {
    "name": "",
    "value": "1.5",
    "unit": "milligram"
  },
  "expected_total_cbd": {
    "name": "",
    "value": "1.000",
    "unit": "percentage"
  },
  "expected_total_thc": {
    "name": "",
    "value": "1.000",
    "unit": "percentage"
  },
  "thc_cbd_ratio": "",
  "barcode": "",
  "description_asset_uuid": "<uuid>",
  "photo_thumbnail_asset_uuid": "<uuid>",
  "photo_banner_asset_uuid": "<uuid>",
  "photo_primary_asset_uuid": "<uuid>",
  "description": "<strong>New description</strong>",
  "photo_thumbnail": "<File converted into a Base64 string>",
  "photo_primary": "<File converted into a Base64 string>",
  "photo_banner": "<File converted into a Base64 string>",
  "product_packaging_approval_number": "<Only for Missouri brands>",
  "additional_ingredients":  ""
}

products_update_partially

Update part of a Product.

Endpoint

PATCH /api/v1.5/products/<uuid>/update/

Request

Add only the fields you need to update

{
  "name": "Updated Demo Product"
}

products_publish

Update product’s status to Published.

Endpoint

POST /api/v1.5/products/<uuid>/publish/

Publish Required Fields

description
usage
photo_thumbnail
photo_banner
photo_primary

products_unpublish

Update product’s status to un-published.

Endpoint

POST /api/v1.5/products/<uuid>/unpublish/

Products cannot be un-published if it has associated LucidIDs.

associate_supplemental_photos

Associate supplemental photos with product.

Endpoint

POST /api/v1.5/products/<product-uuid>/supplemental-photos/

Fields

uuid of image assets (required)

Request

{
  "uuid": "<uuid>"
}

Response

200

associate_videos

Associate videos with product.

Endpoint

POST /api/v1.5/products/<product-uuid>/videos/

Fields

uuid of video assets (required)

Request

{
  "uuid": "<uuid>"
}

Response

200

associate_documents

Associate documents with product.

Endpoint

POST /api/v1.5/products/<product-uuid>/documents/

Fields

uuid of document assets (required)

Request

{
  "uuid": "<uuid>"
}

Response

200

dissociate_supplemental_photos

Dissociate supplemental photos with product.

Endpoint

POST /api/v1.5/products/<product-uuid>/supplemental-photos/delete/

Fields

uuid of image assets (required)

Request

{
  "uuid": "<uuid>"
}

Response

200

dissociate_videos

Dissociate videos with product.

Endpoint

POST /api/v1.5/products/<product-uuid>/videos/delete/

Fields

uuid of video assets (required)

Request

{
  "uuid": "<uuid>"
}

Response

200

dissociate_documents

Dissociate documents with product.

Endpoint

POST /api/v1.5/products/<product-uuid>/documents/delete/

Fields

uuid of document assets (required)

Request

{
  "uuid": "<uuid>"
}

Response

200

Products

products_list

Response Fields (List)

products_get

Response Fields (Detail)

Request Body’s values restrictions

Unit’s value for package_size and serving_size should be one of the following, otherwise it will return a 400 error

Unit’s value for expected_total_cbd and expected_total_thc should be one of the following, otherwise it will return a 400 error

Product Type’s value should be one of the following, otherwise it will return a 400 error

Usage’s value should be one of the following, otherwise it will return a 400 error

Variety’s value should be one of the following, otherwise it will return a 400 error

Chemotype’s value should be one of the following, otherwise it will return a 400 error

THC & CBD ratio must have either 0 or 1 space around colon (“THC:CBD” or “TCH : CBD”)

Container Type’s value should be one of the following, otherwise it will return a 400 error

serving_size and servings fields are required for the following product types

products_create

Fields

products_update

Fields

products_update_partially

products_publish

Publish Required Fields

products_unpublish

Products cannot be un-published if it has associated LucidIDs.

associate_supplemental_photos

Fields

associate_videos

Fields

associate_documents

Fields

dissociate_supplemental_photos

Fields

dissociate_videos

Fields

dissociate_documents

Fields

Unit’s value for `package_size` and `serving_size` should be one of the following, otherwise it will return a 400 error

Unit’s value for `expected_total_cbd` and `expected_total_thc` should be one of the following, otherwise it will return a 400 error

`serving_size` and `servings` fields are required for the following product types