Sample Responses

Product API

🚧

LAB RESULTS ARE BETA version

GET Endpoints for a List of Products

{
    "resultCode": "SUCCESS",
    "resultReason": null,
    "resultDetail": null,
    "data": {
        "product_id": "7b9406c0-0621-11e8-b4e9-02429027d658",
        "product_status": "ACTIVE",
        "last_updated_at": "2020-09-23T07:19:45.266-07:00",
        "sellable_quantity": 803.0,
        "sellable_quantity_detail": [
            {
                "inventory_type": "ADULT",
                "location": "FRONT OF HOUSE",
                "sellable_quantity": 21.0
            },
            {
                "inventory_type": "MEDICAL",
                "location": "FRONT OF HOUSE",
                "sellable_quantity": 778.0
            },
            {
                "inventory_type": "ADULT",
                "location": "VIP/GC",
                "sellable_quantity": 4.0
            }
        ],
        "category_type": "FLOWER",
        "product_configurable_fields": {
            "name": "CHEM FIRE SAMPLE",
            "uom": "GRAMS",
            "brand": "SAMPLE",
            "size": null,
            "amount": 1.0,
            "classification": "I/S",
            "total_mg_thc": 0.0,
            "total_mg_cbd": 0.0,
            "subtype": "PRE-PACK",
            "external_id": "1234134"
        },
        "pricing": {
            "price_type": "TIER",
            "price_sell": null,
            "tier_name": "testing tier",
            "tier_method": "UNIT",
            "tier_pricing_detail": [
                {
                    "start_value": 1.0,
                    "price_per_value": 10.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
                }
            ]
        },
        "attributes": {
            "general": [
                "BUDTENDER'S FAVORITE"
            ],
            "flavors": [
                "SWEET",
                "TROPICAL"
            ],
            "effects": [
                "RELAXING"
            ],
            "ingredients": [],
            "internal_tags": [
                "GREENBOX"
            ]
        },
        "product_barcodes": [
            {
                "created_date": "2018-01-30T16:55:51.000-08:00",
                "sku": "z3tM",
                "type": "GENERATED"
            }
        ],
        "e_commerce": {
            "all_images": [
                "https://treezpartnersandbox.s3.us-west-2.amazonaws.com/product/1e43a152-f84f-4022-a2c6-0c66c86e9e70_7b9406c0-0621-11e8-b4e9-02429027d658_null_20-09-19-14-01-25"
            ],
            "primary_image": "https://treezpartnersandbox.s3.us-west-2.amazonaws.com/product/1e43a152-f84f-4022-a2c6-0c66c86e9e70_7b9406c0-0621-11e8-b4e9-02429027d658_null_20-09-19-14-01-25",
            "menu_title": "PROD 2",
            "product_description": "This is a sample description.  ",
            "minimum_visible_inventory_level": 0,
            "hide_from_menu": false
        },
        "autoupdate_lab_results": true,
        "lab_results": [
            {
                "result_type": "THC",
                "amount": {
                    "minimum_value": 22.0,
                    "maximum_value": 24.2
                },
                "amount_type": "PERCENTAGE"
            }
        ],
        "above_threshold": true,
        "external_references": []
    }
}

GET Endpoint Based on Product Fields

{
    "resultCode": "SUCCESS",
    "resultReason": null,
    "resultDetail": null,
    "data": {
        "total_count": 13,
        "product_fields": {
            "BEVERAGE": {
                "amount": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "doses": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "manufacturer_barcode": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "mg_per_dose": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "size": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "BEER",
                        "COFFEE",
                        "DISSOLVABLE",
                        "ELIXIR",
                        "JUICE",
                        "SHOT",
                        "SODA",
                        "TEA",
                        "TONIC",
                        "WATER",
                        "OTHER"
                    ]
                },
                "total_mg_cbd": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "total_mg_thc": {
                    "required": true,
                    "data_type": "DECIMAL"
                },
                "uom": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "GRAMS",
                        "LITERS",
                        "MILLIGRAMS",
                        "MILLILITERS"
                    ]
                }
            },
            "PLANT": {
                "amount": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "size": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": true,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "CLONE",
                        "SEEDS"
                    ]
                },
                "uom": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "GRAMS",
                        "LITERS",
                        "MILLIGRAMS",
                        "MILLILITERS"
                    ]
                }
            },
            "PREROLL": {
                "amount": {
                    "required": true,
                    "data_type": "DECIMAL"
                },
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "size": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": true,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "FLOWER",
                        "INFUSED",
                        "SHAKE"
                    ]
                },
                "total_mg_cbd": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "total_mg_thc": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "uom": {
                    "required": true,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "GRAMS",
                        "LITERS",
                        "MILLIGRAMS",
                        "MILLILITERS"
                    ]
                }
            },
            "MERCH": {
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "size": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "OTHER",
                        "BATTERY",
                        "BONG",
                        "BOOK",
                        "HAT",
                        "HOODIE",
                        "LIGHTER",
                        "OIL RIG",
                        "PIPE",
                        "ROLLING PAPERS",
                        "SWEATSHIRT",
                        "T SHIRT",
                        "VAPORIZER"
                    ]
                }
            },
            "NON-INV": {
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "FEE",
                        "MEMBERSHIP"
                    ]
                }
            },
            "TINCTURE": {
                "amount": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "doses": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "mg_per_dose": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "size": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "DROPPER",
                        "SYRUP",
                        "SPRAY"
                    ]
                },
                "total_mg_cbd": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "total_mg_thc": {
                    "required": true,
                    "data_type": "DECIMAL"
                },
                "uom": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "GRAMS",
                        "LITERS",
                        "MILLIGRAMS",
                        "MILLILITERS"
                    ]
                }
            },
            "MISC": {
                "amount": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "doses": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "mg_per_dose": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "size": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "SUPPOSITORY"
                    ]
                },
                "total_mg_cbd": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "total_mg_thc": {
                    "required": true,
                    "data_type": "DECIMAL"
                },
                "uom": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "GRAMS",
                        "LITERS",
                        "MILLIGRAMS",
                        "MILLILITERS"
                    ]
                }
            },
            "TOPICAL": {
                "amount": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "doses": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "mg_per_dose": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "size": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "BALM",
                        "CREAM",
                        "LOTION",
                        "OIL",
                        "PATCH",
                        "SALVE",
                        "SPRAY",
                        "OTHER",
                        "GEL"
                    ]
                },
                "total_mg_cbd": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "total_mg_thc": {
                    "required": true,
                    "data_type": "DECIMAL"
                },
                "uom": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "GRAMS",
                        "LITERS",
                        "MILLIGRAMS",
                        "MILLILITERS"
                    ]
                }
            },
            "CARTRIDGE": {
                "amount": {
                    "required": true,
                    "data_type": "DECIMAL"
                },
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "extraction_method": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "SOLVENT",
                        "SOLVENTLESS"
                    ]
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "DISPOSABLE",
                        "POD",
                        "SAUCE",
                        "510 THREAD"
                    ]
                },
                "total_mg_cbd": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "total_mg_thc": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "uom": {
                    "required": true,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "GRAMS",
                        "LITERS",
                        "MILLIGRAMS",
                        "MILLILITERS"
                    ]
                }
            },
            "FLOWER": {
                "amount": {
                    "required": true,
                    "data_type": "DECIMAL"
                },
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "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": [
                        "BULK FLOWER",
                        "KIEF",
                        "PRE-PACK",
                        "PRE-PACK SMALLS",
                        "SHAKE",
                        "STRAIN SPECIFIC SHAKE"
                    ]
                },
                "uom": {
                    "required": true,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "GRAMS",
                        "LITERS",
                        "MILLIGRAMS",
                        "MILLILITERS"
                    ]
                }
            },
            "PILL": {
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "doses": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "mg_per_dose": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "size": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "TABLET",
                        "CAPSULE",
                        "CHEWABLE"
                    ]
                },
                "total_mg_cbd": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "total_mg_thc": {
                    "required": true,
                    "data_type": "DECIMAL"
                }
            },
            "EXTRACT": {
                "amount": {
                    "required": true,
                    "data_type": "DECIMAL"
                },
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "extraction_method": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "SOLVENT",
                        "SOLVENTLESS"
                    ]
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "ISOLATE",
                        "BADDER",
                        "BUDDER",
                        "CRUMBLE",
                        "CRYSTALLINE",
                        "CURED RESIN",
                        "DISTILLATE",
                        "DRY SIFT",
                        "HASH",
                        "HASH ROSIN",
                        "ICE WATER HASH",
                        "ICE WAX",
                        "JELLY",
                        "LIVE RESIN",
                        "LIVE RESIN BADDER",
                        "LIVE RESIN BUDDER",
                        "LIVE RESIN SUGAR",
                        "LIVE ROSIN",
                        "OIL",
                        "OTHER",
                        "ROSIN BUDDER",
                        "SAUCE",
                        "SHATTER",
                        "SIFT ROSIN",
                        "SUGAR",
                        "THC-A",
                        "WAX",
                        "HASH ROSIN",
                        "RSO",
                        "DIAMONDS",
                        "CAVIAR"
                    ]
                },
                "total_mg_cbd": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "total_mg_thc": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "uom": {
                    "required": true,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "GRAMS",
                        "LITERS",
                        "MILLIGRAMS",
                        "MILLILITERS"
                    ]
                }
            },
            "EDIBLE": {
                "amount": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "brand": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "classification": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "I/S",
                        "KUSH",
                        "INDICA",
                        "CBD",
                        "HYBRID",
                        "NONE",
                        "S/I",
                        "SATIVA"
                    ]
                },
                "doses": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "external_id": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "menu_title": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "mg_per_dose": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "name": {
                    "required": true,
                    "data_type": "ALPHANUMERIC"
                },
                "size": {
                    "required": false,
                    "data_type": "ALPHANUMERIC"
                },
                "subtype": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "BAKED GOOD",
                        "BUTTER",
                        "CHEW",
                        "CHOCOLATE",
                        "COOKIE",
                        "GUMMY",
                        "HARD CANDY",
                        "LOZENGE",
                        "MINTS",
                        "OIL",
                        "SAVORY",
                        "SUBLINGUAL",
                        "OTHER"
                    ]
                },
                "total_mg_cbd": {
                    "required": false,
                    "data_type": "DECIMAL"
                },
                "total_mg_thc": {
                    "required": true,
                    "data_type": "DECIMAL"
                },
                "uom": {
                    "required": false,
                    "data_type": "ALPHABETS",
                    "accepted_values": [
                        "GRAMS",
                        "LITERS",
                        "MILLIGRAMS",
                        "MILLILITERS"
                    ]
                }
            }
        }
    }
}

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": []
    }
}

What’s Next

Check the Parameter Explained page for definitions of each field

Did this page help you?