NAV Navbar
cURL
  • Intro
  • Authentication
  • /Menu

    • Intro

    Welcome to the CannaCtrl API! You can use our API to access Dispensary API endpoints, which can get information on various menu items, store information, and real time inventory in our database.

    All requests are made using HTTP requests. You can view code examples in the dark area to the right.

    Authentication

    username and password must be included in every request

    curl "https://api.cannactrl.com/"
  -H {"username": 'myUserName', "password": 'myPassword', "store": "dispensary_token"}

    Make sure to replace myUserName and myPassword with the credentials we provide and obtain the store token from the dispensary.

    CannCtrl uses username and password to allow access to the API. You can register a new CannaCtrl API credentials by emailing info@CannaCtrl.com

    CannCtrl expects for the username and password to be included in all API requests in the header that looks like the following:

    username: myUserName, password: myPassword, store: 12345678

    You must obtain an API token from the collectives you choose to request information from

    /Menu

    Get All Menu Items

    curl "https://api.cannactrl.com/menu"
  -X 'GET'
  -H { "store": 'dispensary_token', "username": 'myUserName', "password": 'myPassword'}

    The above command returns JSON structured like this:

    [
  {
    "id": 1,
    "name": "Brownie Bites",
    "brand_name": "Milf 'n Cookies",
    "type": "Edible",
    "subtype": "Brownies",
    "image": "https://image.cannactrl.com/brownie-bites-milf-n-cookies.jpg",
    "description": "Spoil yourself with this sinful blend of silky, rich chocolate.",
    "prices" : [{"unit": "unit", "amount": 1, "price": 10.00}]
  },
  {
    "id": 2,
    "name": "Purple Punch",
    "brand_name": "Jungle Boys",
    "type": "Flower",
    "subtype": "Indica",
    "image": "https://image.cannactrl.com/purple-punch-jungle-boys-flower.jpg"
    "description": "Hits you right in the face. Great night time medicine",
    "prices" : [
        {"unit": "gram", "amount": 1, "price": 10.00},
        {"unit": "ounce", "amount": 0.125, "price": 50.00},
        {"unit": "ounce", "amount": 0.5, "price": 100.00},
        {"unit": "ounce", "amount": 1, "price": 180.00}
        ]
  }
]

    This endpoint retrieves all Menu Items.

    HTTP Request

    GET https://api.cannactrl.com/menu

    Headers

    Parameter Type Description
    store String A unique token for each dispensary.
    username String
    password String

    Response

    Parameter Type Description
    name String Name of the product
    description String Description of the Product
    image String A Url of the image
    type String Flower, Edible, Concentrate, Tincture, Vape, Drink, Wax, Preroll, Gear, Topical, Other
    subtype String i.e. Indica, Sativa, Hybrid, Brownies, Indica Hybrid (Indica dominant hybrid)
    brand String The name of the product brand (if applicable)
    cbd Number Percent cbd
    cbn Number Percent cbn
    thc Number Percent thc
    total_thc Number Amount of thc in milligrams
    total_cbd Number Amount of cbd in milligrams
    flavors [String] List of words describing the taste/smell of product
    effects [String] List of words describing how the product makes consumers feel
    conditions [String] List of treated conditions
    variants [Variants] An array of Prices. See Product Prices Schema below

    Prices

    Parameter Type Description
    unit String gram, ounce, or unit(each)
    amount Number quantity of the units (i.e. 0.125 ounce = 1/8)
    price Number price of product
    stock Number quantity in stock for this variant
    cURL