Sample Responses
Product API
GET Endpoints
{
"resultCode":"SUCCESS",
"resultReason":null,
"resultDetail":null,
"data":{
"page_count":1,
"total_count":2065,
"product_list":[
{
"product_id":"73041793-a5ce-4aba-881b-fd019e830ab9",
"product_status":"ACTIVE",
"last_updated_at":"2025-01-17T08:59:49.717-08:00",
"sellable_quantity":110.0,
"sellable_quantity_detail":[
{
"inventory_type":"ADULT",
"location":"RETAIL",
"location_id":"dee1e014-6ff7-11e9-b685-0280fd4571a6",
"sellable_quantity":30.0
},
{
"inventory_type":"ADULT",
"location":"FOHSUB2",
"location_id":"0bbb2428-01d1-4e2b-8dca-48351dbd62a8",
"sellable_quantity":30.0
},
{
"inventory_type":"MEDICAL",
"location":"TNC-LOSANGELES",
"location_id":"b8602b0a-06b7-451e-bc5f-5d4835490457",
"sellable_quantity":30.0
},
{
"inventory_type":"ADULT",
"location":"FOH 2",
"location_id":"bcc2b084-6653-40df-9e3b-99be75a61881",
"sellable_quantity":20.0
}
],
"category_type":"PILL",
"product_configurable_fields":{
"name":"100MG THC SOFT GEL - (10 COUNT) RUNNIE NGS E ",
"uom":"MILLIGRAMS",
"brand":"ABX",
"size":"10 Count",
"amount":1012,
"classification":"HYBRID",
"total_mg_thc":1.0,
"total_mg_cbd":5.0,
"subtype":"CHEWABLE",
"doses":0,
"mg_per_dose":0.0,
"total_flower_weight_g":0.0,
"external_id":"1",
"total_concentrate_weight_g":0.0
},
"pricing":{
"price_type":"TIER",
"price_sell":null,
"discounted_price":null,
"discount_amount":null,
"discount_percent":null,
"tier_name":"Demo Unit 01",
"tier_method":"UNIT",
"tier_pricing_detail":[
{
"start_value":1.0,
"price_per_value":33.0
},
{
"start_value":3.0,
"price_per_value":8.0
},
{
"start_value":7.0,
"price_per_value":6.0
},
{
"start_value":14.0,
"price_per_value":5.5
},
{
"start_value":28.0,
"price_per_value":5.0
}
]
},
"discounts":[
{
"discount_id":"c618b468-1fda-40be-ba8b-0d309e09bf4a",
"discount_title":"15% OFF VETERAN",
"discount_affinity":"Cart",
"discount_amount":15.0,
"discount_method":"PERCENT",
"discount_stackable":"No",
"discount_condition_detail":[
{
"discount_condition_type":"Customer Group",
"discount_condition_value":"VETERAN"
}
]
}
],
"attributes":{
"general":[
"INDICA",
"ABC"
],
"flavors":[
"MINT",
"MINT ",
"LEMON"
],
"effects":[
"HAPPY",
"RELAXING"
],
"ingredients":[
"MCT",
"GELATIN",
"WATER",
"GLYCERIN",
"CANNABIS OIL",
"MCT"
],
"internal_tags":[
]
},
"product_barcodes":[
{
"created_date":"2022-06-29T06:30:21.000-07:00",
"sku":"ABX1234",
"type":"USER_DEFINED"
}
],
"e_commerce":{
"all_images":[
"https://store-treez-development.s3.us-west-2.amazonaws.com/productImages/brand/launch/66a09da5-f0a0-4f7f-a6a0-db6c5e06bef7.jpg"
],
"primary_image":"https://store-treez-development.s3.us-west-2.amazonaws.com/productImages/brand/launch/66a09da5-f0a0-4f7f-a6a0-db6c5e06bef7.jpg",
"menu_title":"100MG THC SOFT GEL - (10 COUNT) RUINGÉ",
"product_description":"Potent THC cannabis oil in an easy-to-consume, precisely-dosed soft gel capsule. Batch-to-batch consistency of active THC in a price-effective solution for everyday use. 100mg THC is considered the highest dose available for most experienced cannabis users.v a",
"minimum_visible_inventory_level":2,
"hide_from_menu":false
},
"autoupdate_lab_results":true,
"lab_results":[
{
"result_type":"ALPHA_TERPINENE",
"amount":{
"minimum_value":"10.00",
"maximum_value":"10.00"
},
"amount_type":"MG"
}
],
"above_threshold":true,
"merged_from_product_ids":[
],
"external_references":[
]
}
]
}
}
GET Endpoint Based on Product Fields
{
"resultCode":"SUCCESS",
"resultReason":null,
"resultDetail":null,
"data":{
"total_count":1,
"product_fields":{
"FLOWER":{
"amount":{
"required":true,
"data_type":"DECIMAL"
},
"brand":{
"required":false,
"data_type":"ALPHANUMERIC"
},
"classification":{
"required":false,
"data_type":"ALPHABETS",
"accepted_values":[
"SATIVA",
"INDICA",
"CBD",
"I/S",
"KUSH",
"NONE",
"S/I",
"HYBRID"
]
},
"external_id":{
"required":false,
"data_type":"ALPHANUMERIC"
},
"menu_title":{
"required":false,
"data_type":"ALPHANUMERIC"
},
"name":{
"required":true,
"data_type":"ALPHANUMERIC"
},
"subtype":{
"required":true,
"data_type":"ALPHABETS",
"accepted_values":[
"PRE-PACK SMALLS",
"BAG",
"PRE-GROUND",
"PRE-PACK",
"KIEF",
"INFUSED"
]
},
"total_concentrate_weight_g":{
"required":true,
"data_type":"DECIMAL"
},
"total_flower_weight_g":{
"required":true,
"data_type":"DECIMAL"
},
"uom":{
"required":true,
"data_type":"ALPHABETS",
"accepted_values":[
"MILLIGRAMS",
"GRAMS",
"OUNCES"
]
},
"discount":{
"required":false,
"data_type":"OBJECT",
"accepted_values":[
"PERCENT",
"DOLLAR",
"COST",
"BOGO"
]
}
}
}
}
}
POST/PUT Endpoint
{
"resultCode": "SUCCESS",
"resultReason": null,
"resultDetail": null,
"data": {
"product_id": "2e132d26-a9b4-495a-a3d8-65d92b28f5b5",
"product_status": "ACTIVE",
"last_updated_at": "2021-01-11T15:40:19.583-08:00",
"sellable_quantity": 0.0,
"sellable_quantity_detail": [],
"category_type": "FLOWER",
"product_configurable_fields": {
"name": "Blue Dream",
"uom": "GRAMS",
"brand": null,
"size": null,
"amount": 3.5,
"classification": null,
"total_mg_thc": 0.0,
"total_mg_cbd": 0.0,
"subtype": "PRE-PACK"
},
"pricing": {
"price_type": "FLAT",
"price_sell": 45.0,
"tier_name": null
},
"attributes": {
"general": [],
"flavors": [],
"effects": [],
"ingredients": [],
"internal_tags": []
},
"product_barcodes": [],
"e_commerce": {
"all_images": [],
"primary_image": null,
"menu_title": null,
"product_description": null,
"minimum_visible_inventory_level": 1,
"hide_from_menu": false
},
"autoupdate_lab_results": true,
"lab_results": [],
"above_threshold": false,
"external_references": []
}
}
Updated 5 days ago
What’s Next
Check the Parameter Explained page for definitions of each field