Jane Docs
Search…
Jane APIs
This document is an overview Jane's partner-facing APIs. A sandbox environment can be found here: https://www.iheartjane.com/api/jane-api-docs/index.html.

Brand Partner

The Brand Partner API targets brands on the Jane platform. The available endpoints expose the data necessary to accomplish a variety of tasks including but not limited to:
  • Automating marketing campaigns based on cart data.
  • Facilitating a brand-scoped product-first search experience in order to link the user to menus of stores within the Jane store network.
  • Building out a custom frontend that replicates Jane's brand eComm app (e.g. https://www.canndescent.com/buy-canndescent-products).
Below are the endpoints exposed to brand partners:
  • GET /carts
    • Retrieves all carts that originated from the brand partner's embedded or headless eCommerce site.
  • GET /stores/{store_id}/menu_products
    • Retrieves all menu products scoped to the brand partner's brands for a given store ID.
  • GET /products
    • Retrieves all of the brand partner's products within a specified radius of a given zipcode. Each product record contains an array of store ids, which represent the set of stores that carry that particular product.
  • GET /stores
    • Retrieves all of the stores that carry at least one of the brand partner's products.
  • GET /reviews
    • Retrieves all of the user-generated verified product reviews for each of the brand partner's products.
  • GET /specials
    • Retrieves all of the deals and specials across Jane's ecosystem that implicate at least one of the brand partner's products.

Brand Feed Partner

The Brand Feed Partner API targets entities that support the cannabis brand ecosystem but are not cannabis brands themselves. These entities might include wholesale marketplaces, like Nabis (https://www.nabis.com/), seeking to enrich their product catalog with Jane's product data.
Below are the endpoints exposed to brand feed partners:
  • GET /reviews
    • Retrieves all user-generated verified product reviews for all of the brands within the brand feed partner's API policy.
  • GET products/{product_id}/reviews
    • Retrieves all user-generated verified product reviews for a particular Jane product SKU.

Store Operator Partner

The Store Operator Partner API targets Jane's store partners who use Jane as their eComm solution. These endpoints expose a wide range of data and actions that support the following example use cases:
  • Building out a soup-to-nuts eComm frontend that supports product browsing, discovery, cart creation, and checkouts.
  • Retrieving all abandoned carts within a specified time period in order to send abandoned cart campaigns.
  • Populating marketing campaigns with user data.
  • Displaying a merchandising section above or below the Jane embedded menu.
Below are the endpoints exposed to store operator partners:
  • GET carts
    • Retrieves all cart data for all purchases originating from the store operator's embedded or headless eComm site.
  • GET /menu_products
    • Retrieves all of the given store's menu products
  • GET /menu_products/{menu_product_id}
    • Retrieves the product information for the given menu product.
  • GET /products/{product_id}/recommendations
    • Retrieves a set of product recommendations based on the characteristics of a given product.
  • GET /products/{product_id}/reviews
    • Retrieves all of the user-generated verified product reviews for a given product.
  • GET /specials
    • Retrieves all of the deals and specials offered at the given store.
  • GET /curbside_pickup_setting
    • Retrieves the store's curbside pickup setting data, used for displaying a 'customer arrival' form.
  • POST reservations/{uuid}/curbside_arrival
    • Posts the customer's arrival at the curbside pickup location in order to notify the store of the user's arrival.
The Store Operator API is part of the overall Jane Roots product that allows store partners to build out custom eComm solutions using Jane's data. To learn more about Jane Roots, feel free to read the overview here: https://docs.iheartjane.com/docs/jane-roots.

Store Menu Feed Partner

The Store Menu Feed Partner API targets entities that are implicated in the store's operations (or are generally in the store's orbit) but are not the store itself. These entities might include (but are not limited to):
  • Third-party digital marketing agencies tasked with targeting new customers.
  • Third-party marketplaces (e.g. Leafly) consuming menu product data to stand up their own menus using Jane's canonical product data.
Below are the endpoints exposed to store menu feed partners:
  • GET /menu_products
    • Retrieves all of the given store's menu products
  • GET /menu_products/{menu_product_id}
    • Retrieves the product information for the given menu product.
  • GET /products/{product_id}/recommendations
    • Retrieves a set of product recommendations based on the characteristics of a given product.
  • GET /products/{product_id}/reviews
    • Retrieves all of the user-generated verified product reviews for a given product.
  • GET /specials
    • Retrieves all of the deals and specials offered at the given store.
  • GET /curbside_pickup_setting
    • Retrieves the store's curbside pickup setting data, used for displaying a 'customer arrival' form.
  • POST reservations/{uuid}/curbside_arrival
    • Posts the customer's arrival at the curbside pickup location in order to notify the store of the user's arrival.
Last modified 7mo ago