Endpoints and Coverage
Introduction
Insights is the suite of API endpoints used to access data on organizations (“orgs”), or locations, as well as the sales, product, and inventory data from each org’s integrated POS or invoice tracking system.
Visit our status page to view the data points covered for each of our integrations.
Service Provider
A distinct set of endpoints purpose built for the service provider providing access into its own configuration and access to a list of connected CRB's and their general configuration.
Endpoints:
- GET Service Provider: returns info related to your own org
- GET Service Provider CRBs: returns a list of CRBs connected to your service provider org. You can only query data related to CRBs connected to your own org.
CRB
A distinct set of API's catered towards a Cannabis Business being the direct consumer of the API's. While both CRB and SP share similar endpoints, data shape and size may vary.
Endpoints:
- GET CRB: returns info on a specific CRB org using the org_id
Documents
Documents are associated to a CRB and can range from anything related to properties, licenses, insurance etc. that are typically leveraged to validate and verify a business.
Endpoints:
- GET documents for service provider’s CRB: returns a list of documents that a CRB has shared with you such as MJ business license.
- GET CRB document by id: returns a specific document based on crb_id and document_id
Inventory
Inventory represents the quantity of specific products within a CRB’s inventory records.
Endpoints:
- GET CRB Inventory: returns a snapshot of a CRB’s inventory for a specific date
- GET CRB Inventory by ID: returns a single inventory record by inventroy_id
- GET Inventory by Location: returns inventory records for a CRB’s specific location on a specific date
- GET CRB Inventory Locations: returns a list of inventory locations for a CRB
- GET CRB Inventory Location by ID: returns information about a specific inventory location