M METRC / API · field guide
METRC WEB API · v2

METRC/API

Field guide for cannabis seed-to-sale tracking

A single-page reference for the entire Metrc Web API — every endpoint organized by license type, every method labeled, every required permission listed. Built for integrators who want to find the right call in under fifteen seconds.

BROWSE BY LICENSE → SEE ALL 453 →
453
Endpoints
6
License Types
25
Resources
v2
Recommended
SEED · SALE · SAFETY
SEED TO SALE.
BASIC AUTH integrator + user key
ISO 8601 dates & timestamps
JSON request & response
HTTPS only — period
01 · AUTH
Two Keys

Combine your integrator API key (username) and user API key (password) with a colon, base64-encode, then send via the Authorization header using HTTP Basic.

Basic base64(integrator:user)
02 · REST
Verbs

GET reads. POST creates. PUT performs idempotent updates. DELETE discontinues. Object body limit per request: 10. Larger payloads return 413.

GET POST PUT DELETE
03 · DATES
ISO 8601

All date and date/time fields use YYYY-MM-DD or full ISO 8601. URL-encode the plus sign in time-zone offsets as %2B or your filter is silently misread.

2026-05-04T08:00:00%2B02:00
04 · LIMITS
Rate & Pagination

Per-facility rate limits return 429 with Retry-After. v2 list endpoints support pageNumber and pageSize (max 20). Receive IDs in the order you POSTed objects.

?pageNumber=1&pageSize=20
II / SIX LICENSE TYPES

Pick your license.

Each block lists the resources that license is principally responsible for, and links to the relevant endpoint groups below.
LIC.001 / GROW

CULTIVATOR

Live plants, batches, harvests

Tracks the cannabis plant from seed or clone through vegetative growth, flowering, and harvest. Manages plant batches, individual plants, growth phases, harvests, waste, additives, and strains for the licensed cultivation facility.

Plants Plant Batches Harvests Strains Additives Templates
VIEW ENDPOINTS → JUMP TO PLANTS
LIC.001 / GROW
132 endpoints
Plant Move Manicure Phase Waste Harvest
LIC.002 / MFG

MANUFACTURER

Items, processing, infusion

Transforms harvested material into finished goods. Defines product items and brands, runs processing jobs, creates derived packages, and reports adjustments throughout production for an infused-products or manufacturing facility.

Processing Job Items
VIEW ENDPOINTS → JUMP TO PROCESSING JOB
LIC.002 / MFG
57 endpoints
Create Infuse Adjust Brand Finish Photo
LIC.003 / RTL

DISPENSARY

Sales, patients, retail ID

Sells finished product to consumers, patients, and caregivers. Records sales receipts, deliveries, patient check-ins, caregiver lookups, and retail ID staging for a licensed dispensary or retail facility.

Sales Patient Check Ins Patients Patients Status Caregivers Status Retail Id
VIEW ENDPOINTS → JUMP TO SALES
LIC.003 / RTL
102 endpoints
Receipt Deliver Check-In Lookup Return Refund
LIC.004 / LAB

TESTING LAB

Lab tests, results, batches

Submits lab test results for packages, manages testing types and batches, releases or discards results, and uploads test documents on behalf of the regulator for a licensed testing facility.

Lab Tests
VIEW ENDPOINTS → JUMP TO LAB TESTS
LIC.004 / LAB
15 endpoints
Record Release Upload Type Batch Result
LIC.005 / DSTR

DISTRIBUTOR

Transfers, transporters, hub

Moves packages between facilities. Manages outgoing, incoming, hub, and rejected transfers, deliveries, transporter wayfinding, drivers, vehicles, and templates for a licensed distribution or transport operator.

Transfers Transporters
VIEW ENDPOINTS → JUMP TO TRANSFERS
LIC.005 / DSTR
60 endpoints
Transfer Hub Reject Driver Vehicle Route
LIC.000 / ALL

UNIVERSAL

Every license touches these

Cross-cutting endpoints used by every license type. Facility records, employees, locations and sublocations, package-level inventory, tags, units of measure, waste methods, and the sandbox for safe experimentation.

Facilities Employees Locations Sublocations Packages Tags Units Of Measure Waste Methods Sandbox
VIEW ENDPOINTS → JUMP TO FACILITIES
LIC.000 / ALL
87 endpoints
Auth List Tag Unit Inventory Sandbox
III / EXPLORER

All 453 endpoints.

Search by path, filter by license, method, or version. v2 is the recommended generation; v1 endpoints are listed for reference.
— showing 453 · of 453
Additives Templates 5 Caregivers Status 2 Employees 3 Facilities 2 Harvests 27 Items 25 Lab Tests 15 Locations 13 Packages 52 Patient Check Ins 10 Patients 10 Patients Status 2 Plant Batches 35 Plants 54 Processing Job 32 Retail Id 7 Sales 71 Sandbox 4 Strains 11 Sublocations 6 Tags 3 Transfers 50 Transporters 10 Units Of Measure 3 Waste Methods 1

Additives Templates

Reusable recipes for fertilizers and other plant additives.

CULTIVATOR 5 ENDPOINTS
POST
v2 /additivestemplates/v2/
Creates new additive templates for a specified Facility.
Permissions
Manage Additives
PUT
v2 /additivestemplates/v2/
Updates existing additive templates for a specified Facility.
Permissions
Manage Additives
GET
v2 /additivestemplates/v2/active
Retrieves a list of active additive templates for a specified Facility.
Permissions
Manage Additives
GET
v2 /additivestemplates/v2/inactive
Retrieves a list of inactive additive templates for a specified Facility.
Permissions
Manage Additives
GET
v2 /additivestemplates/v2/{id}
Retrieves an Additive Template by its Id.
Permissions
Manage Additives

Caregivers Status

Lookup status of medical caregivers by license number.

DISPENSARY 2 ENDPOINTS
GET
v2 /caregivers/v2/status/{caregiverLicenseNumber}
Retrieves the status of a Caregiver by their License Number for a specified Facility. Data returned by this endpoint is cached for up to one minute.
Permissions
Lookup Caregivers
GET
v1 /caregivers/v1/status/{caregiverLicenseNumber}
Data returned by this endpoint is cached for up to one minute.
Permissions
Lookup Caregivers

Employees

Roster and per-facility permissions for employees.

UNIVERSAL 3 ENDPOINTS
GET
v2 /employees/v2/
Retrieves a list of employees for a specified Facility.
Permissions
Manage Employees View Employees
GET
v2 /employees/v2/permissions
Retrieves the permissions of a specified Employee, identified by their Employee License Number, for a given Facility.
Permissions
Manage Employees
GET
v1 /employees/v1/
Permissions
Manage Employees

Facilities

Facilities the authenticated user can access and their capabilities.

UNIVERSAL 2 ENDPOINTS
GET
v2 /facilities/v2/
This endpoint provides a list of facilities for which the authenticated user has access.
Permissions
None
GET
v1 /facilities/v1/
This endpoint provides a list of facilities for which the authenticated user has access.
Permissions
None

Harvests

Drying batches, waste, packaging from harvest, finish/unfinish.

CULTIVATOR 27 ENDPOINTS
GET
v2 /harvests/v2/active
Retrieves a list of active harvests for a specified Facility.
Permissions
View Harvests
PUT
v2 /harvests/v2/finish
Marks one or more harvests as finished for the specified Facility.
Permissions
View Harvests Finish/Discontinue Harvests
GET
v2 /harvests/v2/inactive
Retrieves a list of inactive harvests for a specified Facility.
Permissions
View Harvests
PUT
v2 /harvests/v2/location
Updates the Location of Harvest for a specified Facility.
Permissions
View Harvests Manage Harvests
GET
v2 /harvests/v2/onhold
Retrieves a list of harvests on hold for a specified Facility.
Permissions
View Harvests
POST
v2 /harvests/v2/packages
Creates packages from harvested products for a specified Facility.
Permissions
View Harvests Manage Harvests View Packages Create/Submit/Discontinue Packages
POST
v2 /harvests/v2/packages/testing
Creates packages for testing from harvested products for a specified Facility.
Permissions
View Harvests Manage Harvests View Packages Create/Submit/Discontinue Packages
PUT
v2 /harvests/v2/rename
Renames one or more harvests for the specified Facility.
Permissions
View Harvests Manage Harvests
PUT
v2 /harvests/v2/restore/harvestedplants
Restores previously harvested plants to their original state for the specified Facility.
Permissions
View Harvests Finish/Discontinue Harvests
PUT
v2 /harvests/v2/unfinish
Reopens one or more previously finished harvests for the specified Facility.
Permissions
View Harvests Finish/Discontinue Harvests
GET
v2 /harvests/v2/waste
Retrieves a list of Waste records for a specified Harvest, identified by its Harvest Id, within a Facility identified by its License Number.
Permissions
View Harvests
POST
v2 /harvests/v2/waste
Records Waste from harvests for a specified Facility. NOTE: The IDs passed in the request body are the harvest IDs for which you are documenting waste.
Permissions
View Harvests Manage Harvests
GET
v2 /harvests/v2/waste/types
Retrieves a list of Waste types for harvests.
Permissions
None
DELETE
v2 /harvests/v2/waste/{id}
Discontinues a specific harvest waste record by Id for the specified Facility.
Permissions
View Harvests Discontinue Harvest Waste
GET
v2 /harvests/v2/{id}
Retrieves a Harvest by its Id, optionally validated against a specified Facility License Number.
Permissions
View Harvests
GET
v1 /harvests/v1/active
Permissions
View Harvests
POST
v1 /harvests/v1/create/packages
Permissions
View Harvests Manage Harvests View Packages Create/Submit/Discontinue Packages
POST
v1 /harvests/v1/create/packages/testing
Permissions
View Harvests Manage Harvests View Packages Create/Submit/Discontinue Packages
POST
v1 /harvests/v1/finish
Permissions
View Harvests Finish/Discontinue Harvests
GET
v1 /harvests/v1/inactive
Permissions
View Harvests
PUT
v1 /harvests/v1/move
Permissions
View Harvests Manage Harvests
GET
v1 /harvests/v1/onhold
Permissions
View Harvests
POST
v1 /harvests/v1/removewaste
Permissions
View Harvests Manage Harvests
PUT
v1 /harvests/v1/rename
Permissions
View Harvests Manage Harvests
POST
v1 /harvests/v1/unfinish
Permissions
View Harvests Finish/Discontinue Harvests
GET
v1 /harvests/v1/waste/types
Permissions
None
GET
v1 /harvests/v1/{id}
Permissions
View Harvests

Items

Product items, categories, brands, photos, and files.

MANUFACTURER 25 ENDPOINTS
POST
v2 /items/v2/
Creates one or more new products for the specified Facility. NOTE: To include a photo with an item, first use POST /items/v2/photo to POST the photo, and then use the returned Id in the request body in this endpoint.
Permissions
Manage Items
PUT
v2 /items/v2/
Updates one or more existing products for the specified Facility.
Permissions
Manage Items
GET
v2 /items/v2/active
Returns a list of active items for the specified Facility.
Permissions
Manage Items
POST
v2 /items/v2/brand
Creates one or more new item brands for the specified Facility identified by the License Number.
Permissions
Manage Items
PUT
v2 /items/v2/brand
Updates one or more existing item brands for the specified Facility.
Permissions
Manage Items
DELETE
v2 /items/v2/brand/{id}
Archives the specified Item Brand by Id for the given Facility License Number.
Permissions
Manage Items
GET
v2 /items/v2/brands
Retrieves a list of active item brands for the specified Facility.
Permissions
Manage Items
GET
v2 /items/v2/categories
Retrieves a list of item categories.
Permissions
None
POST
v2 /items/v2/file
Uploads one or more image or PDF files for products, labels, packaging, or documents at the specified Facility.
Permissions
Manage Items
GET
v2 /items/v2/file/{id}
Retrieves a file by its Id for the specified Facility.
Permissions
Manage Items
GET
v2 /items/v2/inactive
Retrieves a list of inactive items for the specified Facility.
Permissions
Manage Items
POST
v2 /items/v2/photo
This endpoint allows only BMP, GIF, JPG, and PNG files and uploaded files can be no more than 5 MB in size.
Permissions
Manage Items
GET
v2 /items/v2/photo/{id}
Retrieves an image by its Id for the specified Facility.
Permissions
Manage Items
GET
v2 /items/v2/{id}
Retrieves detailed information about a specific Item by Id.
Permissions
Manage Items
DELETE
v2 /items/v2/{id}
Archives the specified Product by Id for the given Facility License Number.
Permissions
Manage Items
GET
v1 /items/v1/active
Permissions
Manage Items
GET
v1 /items/v1/brands
Permissions
Manage Items
GET
v1 /items/v1/categories
Permissions
None
POST
v1 /items/v1/create
NOTE: To include a photo with an item, first use POST /items/v1/photo to POST the photo, and then use the returned ID in the request body in this endpoint.
Permissions
Manage Items
GET
v1 /items/v1/inactive
Permissions
Manage Items
POST
v1 /items/v1/photo
This endpoint allows only BMP, GIF, JPG, and PNG files and uploaded files can be no more than 5 MB in size.
Permissions
Manage Items
GET
v1 /items/v1/photo/{id}
Permissions
Manage Items
POST
v1 /items/v1/update
Permissions
Manage Items
GET
v1 /items/v1/{id}
Permissions
Manage Items
DELETE
v1 /items/v1/{id}
Permissions
Manage Items

Lab Tests

Submit and release lab test results, manage types and batches.

LAB 15 ENDPOINTS
GET
v2 /labtests/v2/batches
Retrieves a list of Lab Test batches.
Permissions
None
PUT
v2 /labtests/v2/labtestdocument
Updates one or more documents for previously submitted lab tests.
Permissions
View Packages Manage Packages Inventory
GET
v2 /labtests/v2/labtestdocument/{id}
Retrieves a specific Lab Test result document by its Id for a given Facility.
Permissions
View Packages Manage Packages Inventory
POST
v2 /labtests/v2/record
Submits Lab Test results for one or more packages. NOTE: This endpoint allows only PDF files, and uploaded files can be no more than 5 MB in size. The Label element in the request is a Package Label.
Permissions
View Packages Manage Packages Inventory
GET
v2 /labtests/v2/results
Retrieves Lab Test results for a specified Package.
Permissions
View Packages Manage Packages Inventory
PUT
v2 /labtests/v2/results/release
Releases Lab Test results for one or more packages.
Permissions
View Packages Manage Packages Inventory
GET
v2 /labtests/v2/states
Returns a list of all lab testing states.
Permissions
None
GET
v2 /labtests/v2/types
Returns a list of Lab Test types.
Permissions
None
PUT
v1 /labtests/v1/labtestdocument
Permissions
View Packages Manage Packages Inventory
GET
v1 /labtests/v1/labtestdocument/{id}
Permissions
View Packages Manage Packages Inventory
POST
v1 /labtests/v1/record
Permissions
View Packages Manage Packages Inventory
GET
v1 /labtests/v1/results
Permissions
View Packages
PUT
v1 /labtests/v1/results/release
Permissions
View Packages Manage Packages Inventory
GET
v1 /labtests/v1/states
Permissions
None
GET
v1 /labtests/v1/types
Permissions
None

Locations

Top-level locations within a facility, by type.

UNIVERSAL 13 ENDPOINTS
POST
v2 /locations/v2/
Creates new locations for a specified Facility.
Permissions
Manage Locations
PUT
v2 /locations/v2/
Updates existing locations for a specified Facility.
Permissions
Manage Locations
GET
v2 /locations/v2/active
Retrieves a list of active locations for a specified Facility.
Permissions
Manage Locations
GET
v2 /locations/v2/inactive
Retrieves a list of inactive locations for a specified Facility.
Permissions
Manage Locations
GET
v2 /locations/v2/types
Retrieves a list of active location types for a specified Facility.
Permissions
Manage Locations
GET
v2 /locations/v2/{id}
Retrieves a Location by its Id.
Permissions
Manage Locations
DELETE
v2 /locations/v2/{id}
Archives a specified Location, identified by its Id, for a Facility.
Permissions
Manage Locations
GET
v1 /locations/v1/active
Permissions
Manage Locations
POST
v1 /locations/v1/create
Permissions
Manage Locations
GET
v1 /locations/v1/types
Permissions
Manage Locations
POST
v1 /locations/v1/update
Permissions
Manage Locations
GET
v1 /locations/v1/{id}
Permissions
Manage Locations
DELETE
v1 /locations/v1/{id}
Permissions
Manage Locations

Packages

The core inventory unit. Create, adjust, finish, transfer, flag, remediate.

UNIVERSAL 52 ENDPOINTS
POST
v2 /packages/v2/
Creates new packages for a specified Facility.
Permissions
View Packages Create/Submit/Discontinue Packages
GET
v2 /packages/v2/active
Retrieves a list of active packages for a specified Facility.
Permissions
View Packages
POST
v2 /packages/v2/adjust
Records a list of adjustments for packages at a specific Facility.
Permissions
View Packages Manage Packages Inventory
PUT
v2 /packages/v2/adjust
Set the final quantity for a Package.
Permissions
View Packages Manage Packages Inventory
GET
v2 /packages/v2/adjust/reasons
Retrieves a list of adjustment reasons for packages at a specified Facility.
Permissions
None
GET
v2 /packages/v2/adjustments
Retrieves the Package Adjustments for a Facility
Permissions
View Packages
PUT
v2 /packages/v2/decontaminate
Updates the Product decontaminate information for a list of packages at a specific Facility.
Permissions
View Packages Manage Packages Inventory
PUT
v2 /packages/v2/donation/flag
Flags one or more packages for donation at the specified Facility.
Permissions
View Packages Manage Packages Inventory
PUT
v2 /packages/v2/donation/unflag
Removes the donation flag from one or more packages at the specified Facility.
Permissions
View Packages Manage Packages Inventory
PUT
v2 /packages/v2/externalid
Updates the external identifiers for one or more packages at the specified Facility.
Permissions
View Packages Manage Package Inventory External Id Enabled
PUT
v2 /packages/v2/finish
Updates a list of packages as finished for a specific Facility.
Permissions
View Packages Manage Packages Inventory
PUT
v2 /packages/v2/finishedgood/flag
Flags one or more Packages at the specified Facility as Finished Goods.
Permissions
View Packages Manage Packages Inventory
PUT
v2 /packages/v2/finishedgood/unflag
Removes the Finished Good flag one or more Packages at the specified Facility.
Permissions
View Packages Manage Packages Inventory
GET
v2 /packages/v2/inactive
Retrieves a list of inactive packages for a specified Facility.
Permissions
View Packages
GET
v2 /packages/v2/intransit
Retrieves a list of packages in transit for a specified Facility.
Permissions
View Packages
PUT
v2 /packages/v2/item
Updates the associated Item for one or more packages at the specified Facility.
Permissions
View Packages Create/Submit/Discontinue Packages
GET
v2 /packages/v2/labsamples
Retrieves a list of lab sample packages created or sent for testing for a specified Facility.
Permissions
View Packages
PUT
v2 /packages/v2/labtests/required
Updates the list of required lab test batches for one or more packages at the specified Facility.
Permissions
View Packages Create/Submit/Discontinue Packages
PUT
v2 /packages/v2/location
Updates the Location and Sublocation for one or more packages at the specified Facility.
Permissions
View Packages Create/Submit/Discontinue Packages
PUT
v2 /packages/v2/note
Updates notes associated with one or more packages for the specified Facility.
Permissions
View Packages Manage Packages Inventory Manage Package Notes
GET
v2 /packages/v2/onhold
Retrieves a list of packages on hold for a specified Facility.
Permissions
View Packages
POST
v2 /packages/v2/plantings
Creates new plantings from packages for a specified Facility.
Permissions
View Immature Plants Manage Immature Plants View Packages Manage Packages Inventory
PUT
v2 /packages/v2/pretreat
Updates a list of Product pre-treatments for packages at a specific Facility.
Permissions
View Packages Manage Packages Inventory
PUT
v2 /packages/v2/remediate
Updates a list of Product remediations for packages at a specific Facility.
Permissions
View Packages Manage Packages Inventory
POST
v2 /packages/v2/testing
Creates new packages for testing for a specified Facility.
Permissions
View Packages Create/Submit/Discontinue Packages
PUT
v2 /packages/v2/tradesample/flag
Flags or unflags one or more packages at the specified Facility as trade samples.
Permissions
View Packages Manage Packages Inventory
PUT
v2 /packages/v2/tradesample/unflag
Removes the trade sample flag from one or more packages at the specified Facility.
Permissions
View Packages Manage Packages Inventory
GET
v2 /packages/v2/transferred
Retrieves a list of transferred packages for a specific Facility.
Permissions
View Packages
GET
v2 /packages/v2/types
Retrieves a list of available Package types.
Permissions
None
PUT
v2 /packages/v2/unfinish
Updates a list of packages as unfinished for a specific Facility.
Permissions
View Packages Manage Packages Inventory
PUT
v2 /packages/v2/usebydate
Updates the use-by date for one or more packages at the specified Facility.
Permissions
View Packages Create/Submit/Discontinue Packages
GET
v2 /packages/v2/{id}
Retrieves a Package by its Id.
Permissions
View Packages
DELETE
v2 /packages/v2/{id}
Discontinues a Package at a specific Facility.
Permissions
View Packages Create/Submit/Discontinue Packages
GET
v2 /packages/v2/{id}/source/harvests
Retrieves the source harvests for a Package by its Id.
Permissions
View Package Source Harvests
GET
v2 /packages/v2/{label}
Retrieves a Package by its label.
Permissions
View Packages
GET
v1 /packages/v1/active
Permissions
View Packages
POST
v1 /packages/v1/adjust
Permissions
View Packages Manage Packages Inventory
GET
v1 /packages/v1/adjust/reasons
Permissions
None
POST
v1 /packages/v1/change/item
Permissions
View Packages Create/Submit/Discontinue Packages
POST
v1 /packages/v1/change/locations
Permissions
View Packages Create/Submit/Discontinue Packages
PUT
v1 /packages/v1/change/note
Permissions
View Packages Manage Packages Inventory Manage Package Notes
POST
v1 /packages/v1/create
Permissions
View Packages Create/Submit/Discontinue Packages
POST
v1 /packages/v1/create/plantings
Permissions
View Immature Plants Manage Immature Plants View Packages Manage Packages Inventory
POST
v1 /packages/v1/create/testing
Permissions
View Packages Create/Submit/Discontinue Packages
POST
v1 /packages/v1/finish
Permissions
View Packages Manage Packages Inventory
GET
v1 /packages/v1/inactive
Permissions
View Packages
GET
v1 /packages/v1/onhold
Permissions
View Packages
POST
v1 /packages/v1/remediate
Permissions
View Packages Manage Packages Inventory
GET
v1 /packages/v1/types
Permissions
None
POST
v1 /packages/v1/unfinish
Permissions
View Packages Manage Packages Inventory
GET
v1 /packages/v1/{id}
Permissions
View Packages
GET
v1 /packages/v1/{label}
Permissions
View Packages

Patient Check Ins

Daily patient check-ins for medical retail.

DISPENSARY 10 ENDPOINTS
GET
v2 /patient-checkins/v2/
Retrieves a list of patient check-ins for a specified Facility.
Permissions
ManagePatientsCheckIns
POST
v2 /patient-checkins/v2/
Records patient check-ins for a specified Facility.
Permissions
ManagePatientsCheckIns
PUT
v2 /patient-checkins/v2/
Updates patient check-ins for a specified Facility.
Permissions
ManagePatientsCheckIns
GET
v2 /patient-checkins/v2/locations
Retrieves a list of Patient Check-In locations.
Permissions
None
DELETE
v2 /patient-checkins/v2/{id}
Archives a Patient Check-In, identified by its Id, for a specified Facility.
Permissions
ManagePatientsCheckIns
GET
v1 /patient-checkins/v1/
Permissions
ManagePatientsCheckIns
POST
v1 /patient-checkins/v1/
Permissions
ManagePatientsCheckIns
PUT
v1 /patient-checkins/v1/
Permissions
ManagePatientsCheckIns
GET
v1 /patient-checkins/v1/locations
Permissions
None
DELETE
v1 /patient-checkins/v1/{id}
Permissions
ManagePatientsCheckIns

Patients

Active patient roster and CRUD for medical facilities.

DISPENSARY 10 ENDPOINTS
POST
v2 /patients/v2/
Adds new patients to a specified Facility.
Permissions
Manage Patients
PUT
v2 /patients/v2/
Updates Patient information for a specified Facility.
Permissions
Manage Patients
GET
v2 /patients/v2/active
Retrieves a list of active patients for a specified Facility.
Permissions
Manage Patients
GET
v2 /patients/v2/{id}
Retrieves a Patient by Id.
Permissions
Manage Patients
DELETE
v2 /patients/v2/{id}
Removes a Patient, identified by an Id, from a specified Facility.
Permissions
Manage Patients
GET
v1 /patients/v1/active
Permissions
Manage Patients
POST
v1 /patients/v1/add
Permissions
Manage Patients
POST
v1 /patients/v1/update
Permissions
Manage Patients
GET
v1 /patients/v1/{id}
Permissions
Manage Patients
DELETE
v1 /patients/v1/{id}
Permissions
Manage Patients

Patients Status

Look up a patient by license number.

DISPENSARY 2 ENDPOINTS
GET
v2 /patients/v2/statuses/{patientLicenseNumber}
Retrieves a list of statuses for a Patient License Number for a specified Facility. Data returned by this endpoint is cached for up to one minute.
Permissions
Lookup Patients
GET
v1 /patients/v1/statuses/{patientLicenseNumber}
Data returned by this endpoint is cached for up to one minute.
Permissions
Lookup Patients

Plant Batches

Batches of immature plants — clones, seeds, opening balances.

CULTIVATOR 35 ENDPOINTS
DELETE
v2 /plantbatches/v2/
Completes the destruction of plant batches based on the provided input data.
Permissions
View Immature Plants Destroy Immature Plants
GET
v2 /plantbatches/v2/active
Retrieves a list of active plant batches for the specified Facility, optionally filtered by last modified date.
Permissions
View Immature Plants
POST
v2 /plantbatches/v2/additives
Records Additive usage details for plant batches at a specific Facility.
Permissions
Manage Plants Additives
POST
v2 /plantbatches/v2/additives/usingtemplate
Records Additive usage for plant batches at a Facility using predefined additive templates.
Permissions
Manage Plants Additives
POST
v2 /plantbatches/v2/adjust
Applies Facility specific adjustments to plant batches based on submitted reasons and input data.
Permissions
View Immature Plants Manage Immature Plants Inventory
POST
v2 /plantbatches/v2/growthphase
Updates the growth phase of plants at a specified Facility based on tracking information.
Permissions
View Immature Plants Manage Immature Plants Inventory View Veg/Flower Plants Manage Veg/Flower Plants Inventory
GET
v2 /plantbatches/v2/inactive
Retrieves a list of inactive plant batches for the specified Facility, optionally filtered by last modified date.
Permissions
View Immature Plants
PUT
v2 /plantbatches/v2/location
Moves one or more plant batches to new locations with in a specified Facility.
Permissions
View Immature Plants Manage Immature Plants
PUT
v2 /plantbatches/v2/name
Renames plant batches at a specified Facility.
Permissions
View Veg/Flower Plants Manage Veg/Flower Plants Inventory
POST
v2 /plantbatches/v2/packages
Creates packages from plant batches at a Facility, with optional support for packaging from mother plants.
Permissions
View Immature Plants Manage Immature Plants Inventory View Packages Create/Submit/Discontinue Packages
POST
v2 /plantbatches/v2/packages/frommotherplant
Creates packages from mother plants at the specified Facility.
Permissions
View Immature Plants Manage Immature Plants Inventory View Packages Create/Submit/Discontinue Packages
POST
v2 /plantbatches/v2/plantings
Creates new plantings for a Facility by generating plant batches based on provided planting details.
Permissions
View Immature Plants Manage Immature Plants Inventory
POST
v2 /plantbatches/v2/split
Splits an existing Plant Batch into multiple groups at the specified Facility.
Permissions
View Immature Plants Manage Immature Plants Inventory
PUT
v2 /plantbatches/v2/strain
Changes the strain of plant batches at a specified Facility.
Permissions
View Veg/Flower Plants Manage Veg/Flower Plants Inventory
PUT
v2 /plantbatches/v2/tag
Replaces tags for plant batches at a specified Facility.
Permissions
View Veg/Flower Plants Manage Veg/Flower Plants Inventory
GET
v2 /plantbatches/v2/types
Retrieves a list of plant batch types.
Permissions
None
GET
v2 /plantbatches/v2/waste
Retrieves waste details associated with plant batches at a specified Facility.
Permissions
View Plants Waste
POST
v2 /plantbatches/v2/waste
Records waste information for plant batches based on the submitted data for the specified Facility.
Permissions
Manage Plants Waste
GET
v2 /plantbatches/v2/waste/reasons
Retrieves a list of valid waste reasons associated with immature plant batches for the specified Facility.
Permissions
None
GET
v2 /plantbatches/v2/{id}
Retrieves a Plant Batch by Id.
Permissions
View Immature Plants
DELETE
v1 /plantbatches/v1/
Permissions
View Immature Plants Destroy Immature Plants
GET
v1 /plantbatches/v1/active
Permissions
View Immature Plants
POST
v1 /plantbatches/v1/additives
Permissions
Manage Plants Additives
POST
v1 /plantbatches/v1/adjust
Permissions
View Immature Plants Manage Immature Plants Inventory
POST
v1 /plantbatches/v1/changegrowthphase
Permissions
View Immature Plants Manage Immature Plants Inventory View Veg/Flower Plants Manage Veg/Flower Plants Inventory
POST
v1 /plantbatches/v1/create/packages/frommotherplant
Permissions
View Immature Plants Manage Immature Plants Inventory View Packages Create/Submit/Discontinue Packages
POST
v1 /plantbatches/v1/createpackages
Permissions
View Immature Plants Manage Immature Plants Inventory View Packages Create/Submit/Discontinue Packages
POST
v1 /plantbatches/v1/createplantings
Permissions
View Immature Plants Manage Immature Plants Inventory
GET
v1 /plantbatches/v1/inactive
Permissions
View Immature Plants
PUT
v1 /plantbatches/v1/moveplantbatches
Permissions
View Immature Plants
POST
v1 /plantbatches/v1/split
Permissions
View Immature Plants Manage Immature Plants Inventory
GET
v1 /plantbatches/v1/types
Permissions
None
POST
v1 /plantbatches/v1/waste
Permissions
Manage Plants Waste
GET
v1 /plantbatches/v1/waste/reasons
Permissions
None
GET
v1 /plantbatches/v1/{id}
Permissions
View Immature Plants

Plants

Veg/flower/mother plants, growth phases, additives, harvest.

CULTIVATOR 54 ENDPOINTS
DELETE
v2 /plants/v2/
Removes plants from a Facility’s inventory while recording the reason for their disposal.
Permissions
View Veg/Flower Plants Destroy Veg/Flower Plants
GET
v2 /plants/v2/additives
Retrieves additive records applied to plants at a specified Facility.
Permissions
View/Manage Plants Additives
POST
v2 /plants/v2/additives
Records additive usage details applied to specific plants at a Facility.
Permissions
Manage Plants Additives
POST
v2 /plants/v2/additives/bylocation
Records additive usage for plants based on their location within a specified Facility.
Permissions
Manage Plants Manage Plants Additives
POST
v2 /plants/v2/additives/bylocation/usingtemplate
Records additive usage for plants by location using a predefined additive template at a specified Facility.
Permissions
Manage Plants Additives
GET
v2 /plants/v2/additives/types
Retrieves a list of all plant additive types defined within a Facility.
Permissions
None
POST
v2 /plants/v2/additives/usingtemplate
Records additive usage for plants using predefined additive templates at a specified Facility.
Permissions
Manage Plants Additives
GET
v2 /plants/v2/flowering
Retrieves flowering-phase plants at a specified Facility, optionally filtered by last modified date.
Permissions
View Veg/Flower Plants
PUT
v2 /plants/v2/growthphase
Changes the growth phases of plants within a specified Facility.
Permissions
View Veg/Flower Plants Manage Veg/Flower Plants Inventory
GET
v2 /plants/v2/growthphases
Retrieves the list of growth phases supported by a specified Facility.
Permissions
None
PUT
v2 /plants/v2/harvest
Processes whole plant Harvest data for a specific Facility. NOTE: If HarvestName is excluded from the request body, or if it is passed in as null, the harvest name is auto-generated.
Permissions
View Veg/Flower Plants Manicure/Harvest Veg/Flower Plants
GET
v2 /plants/v2/inactive
Retrieves inactive plants at a specified Facility.
Permissions
View Veg/Flower Plants
PUT
v2 /plants/v2/location
Moves plant batches to new locations within a specified Facility.
Permissions
View Veg/Flower Plants Manage Veg/Flower Plants Inventory
POST
v2 /plants/v2/manicure
Creates harvest product records from plant batches at a specified Facility.
Permissions
View Veg/Flower Plants Manicure/Harvest Veg/Flower Plants
PUT
v2 /plants/v2/merge
Merges multiple plant groups into a single group within a Facility.
Permissions
View Veg/Flower Plants Manicure/Harvest Veg/Flower Plants
GET
v2 /plants/v2/mother
Retrieves mother-phase plants at a specified Facility.
Permissions
View Mother Plants
GET
v2 /plants/v2/mother/inactive
Retrieves inactive mother-phase plants at a specified Facility.
Permissions
View Mother Plants
GET
v2 /plants/v2/mother/onhold
Retrieves mother-phase plants currently marked as on hold at a specified Facility.
Permissions
View Mother Plants
GET
v2 /plants/v2/onhold
Retrieves plants that are currently on hold at a specified Facility.
Permissions
View Veg/Flower Plants
POST
v2 /plants/v2/plantbatch/packages
Creates packages from plant batches at a specified Facility.
Permissions
View Immature Plants Manage Immature Plants Inventory View Veg/Flower Plants Manage Veg/Flower Plants Inventory View Packages Create/Submit/Discontinue Packages
POST
v2 /plants/v2/plantings
Creates new plant batches at a specified Facility from existing plant data.
Permissions
View Immature Plants Manage Immature Plants Inventory View Veg/Flower Plants Manage Veg/Flower Plants Inventory
PUT
v2 /plants/v2/split
Splits an existing plant group into multiple groups within a Facility.
Permissions
View Plant
PUT
v2 /plants/v2/strain
Updates the strain information for plants within a Facility.
Permissions
View Veg/Flower Plants Manage Veg/Flower Plants Inventory
PUT
v2 /plants/v2/tag
Replaces existing plant tags with new tags for plants within a Facility.
Permissions
View Veg/Flower Plants Manage Veg/Flower Plants Inventory
GET
v2 /plants/v2/vegetative
Retrieves vegetative-phase plants at a specified Facility, optionally filtered by last modified date.
Permissions
View Veg/Flower Plants
GET
v2 /plants/v2/waste
Retrieves a list of recorded plant waste events for a specific Facility.
Permissions
View Plants Waste
POST
v2 /plants/v2/waste
Records waste events for plants at a Facility, including method, reason, and location details.
Permissions
Manage Plants Waste
GET
v2 /plants/v2/waste/methods/all
Retrieves a list of all available plant waste methods for use within a Facility.
Permissions
None
GET
v2 /plants/v2/waste/reasons
Retriveves available reasons for recording mature plant waste at a specified Facility.
Permissions
None
GET
v2 /plants/v2/waste/{id}/package
Retrieves a list of package records linked to the specified plantWasteId for a given facility.
Permissions
View Plants Waste
GET
v2 /plants/v2/waste/{id}/plant
Retrieves a list of plants records linked to the specified plantWasteId for a given facility.
Permissions
View Plants Waste
GET
v2 /plants/v2/{id}
Retrieves a Plant by Id.
Permissions
View Veg/Flower Plants
GET
v2 /plants/v2/{label}
Retrieves a Plant by label.
Permissions
View Veg/Flower Plants
DELETE
v1 /plants/v1/
Permissions
View Veg/Flower Plants Destroy Veg/Flower Plants
GET
v1 /plants/v1/additives
Permissions
View/Manage Plants Additives
POST
v1 /plants/v1/additives
Permissions
Manage Plants Additives
POST
v1 /plants/v1/additives/bylocation
Permissions
Manage Plants Manage Plants Additives
GET
v1 /plants/v1/additives/types
Permissions
Permissions vary
POST
v1 /plants/v1/changegrowthphases
Permissions
View Veg/Flower Plants Manage Veg/Flower Plants Inventory
POST
v1 /plants/v1/create/plantbatch/packages
Permissions
View Immature Plants Manage Immature Plants Inventory View Veg/Flower Plants Manage Veg/Flower Plants Inventory View Packages Create/Submit/Discontinue Packages
POST
v1 /plants/v1/create/plantings
Permissions
View Immature Plants Manage Immature Plants Inventory View Veg/Flower Plants Manage Veg/Flower Plants Inventory
GET
v1 /plants/v1/flowering
Permissions
View Veg/Flower Plants
GET
v1 /plants/v1/growthphases
Permissions
None
POST
v1 /plants/v1/harvestplants
NOTE: If HarvestName is excluded from the request body, or if it is passed in as null, the harvest name is auto-generated.
Permissions
View Veg/Flower Plants Manicure/Harvest Veg/Flower Plants
GET
v1 /plants/v1/inactive
Permissions
View Veg/Flower Plants
POST
v1 /plants/v1/manicureplants
Permissions
View Veg/Flower Plants Manicure/Harvest Veg/Flower Plants
POST
v1 /plants/v1/moveplants
Permissions
View Veg/Flower Plants Manage Veg/Flower Plants Inventory
GET
v1 /plants/v1/onhold
Permissions
View Veg/Flower Plants
GET
v1 /plants/v1/vegetative
Permissions
View Veg/Flower Plants
POST
v1 /plants/v1/waste
Permissions
Manage Plants Waste
GET
v1 /plants/v1/waste/methods/all
Permissions
None
GET
v1 /plants/v1/waste/reasons
Permissions
None
GET
v1 /plants/v1/{id}
Permissions
View Veg/Flower Plants
GET
v1 /plants/v1/{label}
Permissions
View Veg/Flower Plants

Processing Job

Convert source packages into finished goods via job types.

MANUFACTURER 32 ENDPOINTS
GET
v2 /processing/v2/active
Retrieves active processing jobs at a specified Facility.
Permissions
Manage Processing Job
POST
v2 /processing/v2/adjust
Adjusts the details of existing processing jobs at a Facility, including units of measure and associated packages.
Permissions
Manage Processing Job
POST
v2 /processing/v2/createpackages
Creates packages from processing jobs at a Facility, including optional location and note assignments.
Permissions
Manage Processing Job
PUT
v2 /processing/v2/finish
Completes processing jobs at a Facility by recording final notes and waste measurements.
Permissions
Manage Processing Job
GET
v2 /processing/v2/inactive
Retrieves inactive processing jobs at a specified Facility.
Permissions
Manage Processing Job
POST
v2 /processing/v2/jobtypes
Creates new processing job types for a Facility, including name, category, description, steps, and attributes.
Permissions
Manage Processing Job
PUT
v2 /processing/v2/jobtypes
Updates existing processing job types at a Facility, including their name, category, description, steps, and attributes.
Permissions
Manage Processing Job
GET
v2 /processing/v2/jobtypes/active
Retrieves a list of all active processing job types defined within a Facility.
Permissions
Manage Processing Job
GET
v2 /processing/v2/jobtypes/attributes
Retrieves all processing job attributes available for a Facility.
Permissions
Manage Processing Job
GET
v2 /processing/v2/jobtypes/categories
Retrieves all processing job categories available for a specified Facility.
Permissions
Manage Processing Job
GET
v2 /processing/v2/jobtypes/inactive
Retrieves a list of all inactive processing job types defined within a Facility.
Permissions
Manage Processing Job
DELETE
v2 /processing/v2/jobtypes/{id}
Archives a Processing Job Type at a Facility, making it inactive for future use.
Permissions
Manage Processing Job
POST
v2 /processing/v2/start
Initiates new processing jobs at a Facility, including job details and associated packages.
Permissions
Manage Processing Job
PUT
v2 /processing/v2/unfinish
Reopens previously completed processing jobs at a Facility to allow further updates or corrections.
Permissions
Manage Processing Job
GET
v2 /processing/v2/{id}
Retrieves a ProcessingJob by Id.
Permissions
Manage Processing Job
DELETE
v2 /processing/v2/{id}
Archives a Processing Job at a Facility by marking it as inactive and removing it from active use.
Permissions
Manage Processing Job
GET
v1 /processing/v1/active
Permissions
Manage Processing Job
POST
v1 /processing/v1/adjust
Permissions
ManageProcessingJobs
POST
v1 /processing/v1/createpackages
Permissions
ManageProcessingJobs
PUT
v1 /processing/v1/finish
Permissions
Manage Processing Job
GET
v1 /processing/v1/inactive
Permissions
Manage Processing Job
POST
v1 /processing/v1/jobtypes
Permissions
Manage Processing Job
PUT
v1 /processing/v1/jobtypes
Permissions
Manage Processing Job
GET
v1 /processing/v1/jobtypes/active
Permissions
Manage Processing Job
GET
v1 /processing/v1/jobtypes/attributes
Permissions
Manage Processing Job
GET
v1 /processing/v1/jobtypes/categories
Permissions
Manage Processing Job
GET
v1 /processing/v1/jobtypes/inactive
Permissions
Manage Processing Job
DELETE
v1 /processing/v1/jobtypes/{id}
Permissions
Manage Processing Job
POST
v1 /processing/v1/start
Permissions
ManageProcessingJobs
PUT
v1 /processing/v1/unfinish
Permissions
Manage Processing Job
GET
v1 /processing/v1/{id}
Permissions
Manage Processing Job
DELETE
v1 /processing/v1/{id}
Permissions
Manage Processing Job

Retail Id

Stage packages and orders for retail-ID third-party vendors.

DISPENSARY 7 ENDPOINTS
GET
v2 /retailid/v2/allotment
Retrieves the available Retail Item ID quota for a facility.
Permissions
Download Product Labels Manage Product Labels Manage Tag Orders
POST
v2 /retailid/v2/associate
Facilitate association of QR codes and Package labels. This will return the count of packages and QR codes associated that were added or replaced.
Permissions
External Sources(ThirdPartyVendorV2)/Retail ID(Write) WebApi Retail ID Read Write State (All or WriteOnly) Industry/View Packages
POST
v2 /retailid/v2/generate
Allows you to generate a specific quantity of QR codes. Id value returned (issuance ID) could be used for printing.
Permissions
External Sources(ThirdPartyVendorV2)/Retail ID(Write) WebApi Retail ID Read Write State (All or WriteOnly) Industry/View Packages
POST
v2 /retailid/v2/merge
Merge and adjust one source to one target Package. First Package detected will be processed as target Package. This requires an action reason with name containing the 'Merge' word and setup with 'Package adjustment' area.
Permissions
External Sources(ThirdPartyVendorV2)/Retail ID(Write) WebApi Retail ID Read Write State (All or WriteOnly) Key Value Settings/Retail ID Merge Packages Enabled
POST
v2 /retailid/v2/packages/info
Retrieves Package information for given list of Package labels.
Permissions
External Sources(ThirdPartyVendorV2)/Retail ID(Write) WebApi Retail ID Read Write State (All or WriteOnly) Industry/View Packages Admin/Employees/Packages Page/Product Labels(Manage)
GET
v2 /retailid/v2/receive/qr/{shortCode}
Get a list of eaches (Retail ID QR code URL) and sibling tags based on given short code value (first segment in Retail ID QR code URL).
Permissions
External Sources(ThirdPartyVendorV2)/Manage RetailId WebApi Retail ID Read Write State (All or ReadOnly) Industry/View Packages
GET
v2 /retailid/v2/receive/{label}
Get a list of eaches (Retail ID QR code URL) and sibling tags based on given Package label.
Permissions
External Sources(ThirdPartyVendorV2)/Manage RetailId WebApi Retail ID Read Write State (All or ReadOnly) Industry/View Packages

Sales

Sales receipts, deliveries, retailer delivery, returns.

DISPENSARY 71 ENDPOINTS
GET
v2 /sales/v2/counties
Returns a list of counties available for sales deliveries.
Permissions
None
GET
v2 /sales/v2/customertypes
Returns a list of customer types.
Permissions
None
POST
v2 /sales/v2/deliveries
Records new sales delivery entries for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write)
PUT
v2 /sales/v2/deliveries
Updates sales delivery records for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Manage Sales Delivery
GET
v2 /sales/v2/deliveries/active
Returns a list of active sales deliveries for a Facility, filtered by optional sales or last modified date ranges.
Permissions
View Sales Delivery Manage Sales Delivery
PUT
v2 /sales/v2/deliveries/complete
Completes a list of sales deliveries for a Facility using the provided License Number and delivery data.
Permissions
Manage Sales Delivery
PUT
v2 /sales/v2/deliveries/hub
Updates hub transporter details for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Manage Sales Delivery, Manage Sales Delivery Hub
PUT
v2 /sales/v2/deliveries/hub/accept
Accepts a list of hub sales deliveries for a Facility based on the provided License Number and delivery data.
Permissions
Manage Sales Delivery Hub
PUT
v2 /sales/v2/deliveries/hub/depart
Processes the departure of hub sales deliveries for a Facility using the provided License Number and delivery data.
Permissions
Manage Sales Delivery Hub
PUT
v2 /sales/v2/deliveries/hub/verifyID
Verifies identification for a list of hub sales deliveries using the provided License Number and delivery data.
Permissions
Manage Sales Delivery Hub
GET
v2 /sales/v2/deliveries/inactive
Returns a list of inactive sales deliveries for a Facility, filtered by optional sales or last modified date ranges.
Permissions
View Sales Delivery Manage Sales Delivery
POST
v2 /sales/v2/deliveries/retailer
Records retailer delivery data for a given License Number, including delivery destinations. Please note: The DateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write) Industry/Facility Type/Retailer Delivery
PUT
v2 /sales/v2/deliveries/retailer
Updates retailer delivery records for a given License Number. Please note: The DateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write) Industry/Facility Type/Retailer Delivery
GET
v2 /sales/v2/deliveries/retailer/active
Returns a list of active retailer deliveries for a Facility, optionally filtered by last modified date range
Permissions
View Retailer Delivery Manage Retailer Delivery
POST
v2 /sales/v2/deliveries/retailer/depart
Processes the departure of retailer deliveries for a Facility using the provided License Number and delivery data.
Permissions
External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write) Industry/Facility Type/Retailer Delivery
POST
v2 /sales/v2/deliveries/retailer/end
Ends retailer delivery records for a given License Number. Please note: The ActualArrivalDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write) Industry/Facility Type/Retailer Delivery
GET
v2 /sales/v2/deliveries/retailer/inactive
Returns a list of inactive retailer deliveries for a Facility, optionally filtered by last modified date range
Permissions
View Retailer Delivery Manage Retailer Delivery
POST
v2 /sales/v2/deliveries/retailer/restock
Records restock deliveries for retailer facilities using the provided License Number. Please note: The DateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write) Industry/Facility Type/Retailer Delivery
POST
v2 /sales/v2/deliveries/retailer/sale
Records sales deliveries originating from a retailer delivery for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write) Industry/Facility Type/Retailer Delivery
GET
v2 /sales/v2/deliveries/retailer/{id}
Retrieves a retailer delivery record by its ID, with an optional License Number.
Permissions
View Retailer Delivery Manage Retailer Delivery
DELETE
v2 /sales/v2/deliveries/retailer/{id}
Voids a retailer delivery for a Facility using the provided License Number and delivery Id.
Permissions
External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write) Industry/Facility Type/Retailer Delivery
GET
v2 /sales/v2/deliveries/returnreasons
Returns a list of return reasons for sales deliveries based on the provided License Number.
Permissions
Sales Delivery
GET
v2 /sales/v2/deliveries/{id}
Retrieves a sales delivery record by its Id, with an optional License Number.
Permissions
View Sales Delivery Manage Sales Delivery
DELETE
v2 /sales/v2/deliveries/{id}
Voids a sales delivery for a Facility using the provided License Number and delivery Id.
Permissions
Manage Sales Delivery
GET
v2 /sales/v2/patientregistration/locations
Returns a list of valid Patient registration locations for sales.
Permissions
Permissions vary
GET
v2 /sales/v2/paymenttypes
Returns a list of available payment types for the specified License Number.
Permissions
View Sales Delivery Manage Sales Delivery
POST
v2 /sales/v2/receipts
Records a list of sales deliveries for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
External Sources(ThirdPartyVendorV2)/Sales (Write)
PUT
v2 /sales/v2/receipts
Updates sales receipt records for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Manage Sales
GET
v2 /sales/v2/receipts/active
Returns a list of active sales receipts for a Facility, filtered by optional sales or last modified date ranges.
Permissions
View Sales Manage Sales
GET
v2 /sales/v2/receipts/external/{externalNumber}
Retrieves a Sales Receipt by its external number, with an optional License Number.
Permissions
View Sales Manage Sales
PUT
v2 /sales/v2/receipts/finalize
Finalizes a list of sales receipts for a Facility using the provided License Number and receipt data.
Permissions
Manage Sales
GET
v2 /sales/v2/receipts/inactive
Returns a list of inactive sales receipts for a Facility, filtered by optional sales or last modified date ranges.
Permissions
View Sales Manage Sales
PUT
v2 /sales/v2/receipts/unfinalize
Unfinalizes a list of sales receipts for a Facility using the provided License Number and receipt data.
Permissions
Manage Sales
GET
v2 /sales/v2/receipts/{id}
Retrieves a sales receipt by its Id, with an optional License Number.
Permissions
View Sales Manage Sales
DELETE
v2 /sales/v2/receipts/{id}
Archives a sales receipt for a Facility using the provided License Number and receipt Id.
Permissions
Manage Sales
GET
v1 /sales/v1/counties
Permissions
None
GET
v1 /sales/v1/customertypes
Permissions
None
POST
v1 /sales/v1/deliveries
Please note: The SalesDateTime field must be the actual date and time of the transaction without time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Sales Delivery
PUT
v1 /sales/v1/deliveries
Please note: The SalesDateTime field must be the actual date and time of the transaction without time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Sales Delivery
GET
v1 /sales/v1/deliveries/active
Permissions
Sales Delivery
PUT
v1 /sales/v1/deliveries/complete
Permissions
Sales Delivery
PUT
v1 /sales/v1/deliveries/hub
Please note: The SalesDateTime field must be the actual date and time of the transaction without time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Sales Delivery
PUT
v1 /sales/v1/deliveries/hub/accept
Permissions
Permissions vary
PUT
v1 /sales/v1/deliveries/hub/depart
Permissions
Permissions vary
PUT
v1 /sales/v1/deliveries/hub/verifyID
Permissions
Permissions vary
GET
v1 /sales/v1/deliveries/inactive
Permissions
Sales Delivery
POST
v1 /sales/v1/deliveries/retailer
Please note: The DateTime field must be the actual date and time of the transaction without time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Retailer Delivery
PUT
v1 /sales/v1/deliveries/retailer
Please note: The DateTime field must be the actual date and time of the transaction without time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Retailer Delivery
GET
v1 /sales/v1/deliveries/retailer/active
Permissions
Retailer Delivery
POST
v1 /sales/v1/deliveries/retailer/depart
Permissions
Retailer Delivery
POST
v1 /sales/v1/deliveries/retailer/end
Please note: The ActualArrivalDateTime field must be the actual date and time of the transaction without time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Retailer Delivery
GET
v1 /sales/v1/deliveries/retailer/inactive
Permissions
Retailer Delivery
POST
v1 /sales/v1/deliveries/retailer/restock
Please note: The DateTime field must be the actual date and time of the transaction without time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Retailer Delivery
POST
v1 /sales/v1/deliveries/retailer/sale
Please note: The SalesDateTime field must be the actual date and time of the transaction without time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Retailer Delivery
GET
v1 /sales/v1/deliveries/retailer/{id}
Permissions
Retailer Delivery
DELETE
v1 /sales/v1/deliveries/retailer/{id}
Permissions
Retailer Delivery
GET
v1 /sales/v1/deliveries/returnreasons
Permissions
Permissions vary
GET
v1 /sales/v1/deliveries/{id}
Permissions
Sales Delivery
DELETE
v1 /sales/v1/deliveries/{id}
Permissions
Sales Delivery
GET
v1 /sales/v1/patientregistration/locations
Permissions
Permissions vary
GET
v1 /sales/v1/paymenttypes
Permissions
Sales Delivery
POST
v1 /sales/v1/receipts
Please note: The SalesDateTime field must be the actual date and time of the transaction without time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Permissions vary
PUT
v1 /sales/v1/receipts
Please note: The SalesDateTime field must be the actual date and time of the transaction without time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be Pacific Standard (or Daylight Savings) Time and not in UTC.
Permissions
Permissions vary
GET
v1 /sales/v1/receipts/active
Permissions
Permissions vary
GET
v1 /sales/v1/receipts/inactive
Permissions
Permissions vary
GET
v1 /sales/v1/receipts/{id}
Permissions
Permissions vary
DELETE
v1 /sales/v1/receipts/{id}
Permissions
Permissions vary
GET
v1 /sales/v1/transactions
Permissions
Permissions vary
POST
v1 /sales/v1/transactions/{date}
Permissions
Permissions vary
PUT
v1 /sales/v1/transactions/{date}
Permissions
Permissions vary
GET
v1 /sales/v1/transactions/{salesDateStart}/{salesDateEnd}
Permissions
Permissions vary

Sandbox

Tools to seed and clear sandbox data while developing.

UNIVERSAL 4 ENDPOINTS
POST
v2 /sandbox/v2/facility/tags
Generates tags of a specified type for a sandbox facility. Tags are created, shipped, and received in a single synchronous operation, making them immediately available for use in packages and plant batches. The maximum allowed count per request is 1,000. Request body example: { "TagType": "Marijuana Package", "Count": 100 } Response codes: HTTP 200: Returns a SandboxTagTypeResult with the generated tag labels (see example below). HTTP 400: Validation failure — see response body for details (e.g., invalid tag type, count out of range, on-hand cap exceeded). HTTP 401: Invalid or unauthorized API key. or Request origin is not permitted. HTTP 403: This endpoint is only available in sandbox environments.
Permissions
None
POST
v2 /sandbox/v2/integrator/setup
Handles sandbox integrator setup. Call without userKey to create a new sandbox user; the resulting key will be sent to the contact email on file. Call with userKey to look up an existing setup by that key; if creation is complete the key is returned directly in the response body.
Permissions
None
POST
v2 /sandbox/v2/packages/create
Creates opening balance packages for the sandbox integrator's facility. Automatically selects available package tags and assigns them to items. By default, items are selected randomly from weight-based items only. Use the optional FilterBy and FilterValue body fields to target items by a specific dimension across all item types: Name — exact item name match Category — items in the specified product category UnitOfMeasure — items using the specified unit of measure When FilterBy is provided, FilterValue is required. If Count is omitted, it defaults to 10. The maximum allowed value is 100. Request body examples: Default — no filter (weight-based items only): { "Count": 5 } Filter by item name (exact match): { "Count": 5, "FilterBy": "Name", "FilterValue": "Blue Dream" } Filter by product category: { "Count": 10, "FilterBy": "Category", "FilterValue": "Buds" } Filter by unit of measure: { "Count": 3, "FilterBy": "UnitOfMeasure", "FilterValue": "Grams" } Response codes: HTTP 200: Returns a SuccessResponseDocument containing the IDs of the created packages (see example below). HTTP 400: Validation failure — see response body for details (e.g., no available tags, no matching items, invalid filter). HTTP 401: Invalid or unauthorized API key. or Request origin is not permitted. HTTP 403: This endpoint is only available in sandbox environments.
Permissions
None
GET
v2 /sandbox/v2/tagtypes
Returns the list of tag types available for a specified facility. Use this endpoint to discover valid TagType values before calling POST /sandbox/v2/facility/tags. Response codes: HTTP 200: Returns an array of SandboxTagTypeModel objects (see example below). HTTP 400: Validation failure — see response body for details. HTTP 401: Invalid or unauthorized API key. or Request origin is not permitted. HTTP 403: This endpoint is only available in sandbox environments.
Permissions
None

Strains

Cultivar definitions: indica/sativa/hybrid, THC/CBD ranges.

CULTIVATOR 11 ENDPOINTS
POST
v2 /strains/v2/
Creates new strain records for a specified Facility.
Permissions
Manage Strains
PUT
v2 /strains/v2/
Updates existing strain records for a specified Facility.
Permissions
Manage Strains
GET
v2 /strains/v2/active
Retrieves a list of active strains for the current Facility, optionally filtered by last modified date range.
Permissions
Manage Strains
GET
v2 /strains/v2/inactive
Retrieves a list of inactive strains for the current Facility, optionally filtered by last modified date range.
Permissions
Manage Strains
GET
v2 /strains/v2/{id}
Retrieves a Strain record by its Id, with an optional license number.
Permissions
Manage Strains
DELETE
v2 /strains/v2/{id}
Archives an existing strain record for a Facility
Permissions
Manage Strains
GET
v1 /strains/v1/active
Permissions
Manage Strains
POST
v1 /strains/v1/create
Permissions
Manage Strains
POST
v1 /strains/v1/update
Permissions
Manage Strains
GET
v1 /strains/v1/{id}
Permissions
Manage Strains
DELETE
v1 /strains/v1/{id}
Permissions
Manage Strains

Sublocations

Finer-grained locations nested under top-level locations.

UNIVERSAL 6 ENDPOINTS
POST
v2 /sublocations/v2/
Creates new sublocation records for a Facility.
Permissions
Manage Locations
PUT
v2 /sublocations/v2/
Updates existing sublocation records for a specified Facility.
Permissions
Manage Locations
GET
v2 /sublocations/v2/active
Retrieves a list of active sublocations for the current Facility, optionally filtered by last modified date range.
Permissions
Manage Locations
GET
v2 /sublocations/v2/inactive
Retrieves a list of inactive sublocations for the specified Facility.
Permissions
Manage Locations
GET
v2 /sublocations/v2/{id}
Retrieves a Sublocation by its Id, with an optional license number.
Permissions
Manage Locations
DELETE
v2 /sublocations/v2/{id}
Archives an existing Sublocation record for a Facility.
Permissions
Manage Locations

Tags

RFID-style identifiers ordered for plants and packages.

UNIVERSAL 3 ENDPOINTS
GET
v2 /tags/v2/package/available
Returns a list of available package tags. NOTE: This is a premium endpoint.
Permissions
WebApi Tags Read Write State (All or WriteOnly)
GET
v2 /tags/v2/plant/available
Returns a list of available plant tags. NOTE: This is a premium endpoint.
Permissions
WebApi Tags Read Write State (All or WriteOnly)
GET
v2 /tags/v2/staged
Returns a list of staged tags. NOTE: This is a premium endpoint.
Permissions
WebApi Tags Read Write State (All or WriteOnly) RetailId.AllowPackageStaging Key Value enabled

Transfers

Outgoing, incoming, hub, rejected transfers and deliveries.

DISTRIBUTOR 50 ENDPOINTS
GET
v2 /transfers/v2/deliveries/package/{id}/requiredlabtestbatches
Retrieves a list of required lab test batches for a given Transfer Delivery Package Id. Please note: The {id} parameter above represents a Transfer Delivery Package Id, not a Manifest Number.
Permissions
Manage Transfers View Transfers
GET
v2 /transfers/v2/deliveries/packages/states
Returns a list of available shipment Package states.
Permissions
None
GET
v2 /transfers/v2/deliveries/{id}/packages
Retrieves a list of packages associated with a given Transfer Delivery Id. Please note: The {id} parameter above represents a Transfer Delivery Id, not a Manifest Number.
Permissions
Manage Transfers View Transfers
GET
v2 /transfers/v2/deliveries/{id}/packages/wholesale
Retrieves a list of wholesale shipment packages for a given Transfer Delivery Id. Please note: The {id} parameter above represents a Transfer Delivery Id, not a Manifest Number.
Permissions
Manage Transfers View Transfers
GET
v2 /transfers/v2/deliveries/{id}/transporters
Retrieves a list of transporters for a given Transfer Delivery Id. Please note: The {id} parameter above represents a Transfer Delivery Id, not a Manifest Number.
Permissions
Manage Transfers View Transfers
GET
v2 /transfers/v2/deliveries/{id}/transporters/details
Retrieves a list of transporter details for a given Transfer Delivery Id. Please note: The {id} parameter above represents a Transfer Delivery Id, not a Manifest Number.
Permissions
Manage Transfers View Transfers
POST
v2 /transfers/v2/external/incoming
Creates external incoming shipment plans for a Facility.
Permissions
Manage Transfers
PUT
v2 /transfers/v2/external/incoming
Updates external incoming shipment plans for a Facility.
Permissions
Manage Transfers
DELETE
v2 /transfers/v2/external/incoming/{id}
Voids an external incoming shipment plan for a Facility.
Permissions
Manage Transfers
GET
v2 /transfers/v2/hub
Retrieves a list of transfer hub shipments for a Facility, filtered by either last modified or estimated arrival date range.
Permissions
Manage Transfers View Transfers
POST
v2 /transfers/v2/hub/arrive
Arrive a transfer for a Facility.
Permissions
Manage Transfer Hub
POST
v2 /transfers/v2/hub/checkin
CheckIn a transfer for a Facility.
Permissions
Manage Transfer Hub
POST
v2 /transfers/v2/hub/checkout
CheckOut a transfer for a Facility.
Permissions
Manage Transfer Hub
POST
v2 /transfers/v2/hub/depart
Depart a transfer for a Facility.
Permissions
Manage Transfer Hub
GET
v2 /transfers/v2/incoming
Retrieves a list of incoming shipments for a Facility, optionally filtered by last modified date range.
Permissions
Manage Transfers View Transfers
GET
v2 /transfers/v2/manifest/{id}/pdf
Get Transfer Manifest PDF for a given Transfer Id
Permissions
Manage Transfer Templates View Transfer Templates
GET
v2 /transfers/v2/outgoing
Retrieves a list of outgoing shipments for a Facility, optionally filtered by last modified date range.
Permissions
Manage Transfers View Transfers
GET
v2 /transfers/v2/rejected
Retrieves a list of shipments with rejected packages for a Facility.
Permissions
Manage Transfers View Transfers
GET
v2 /transfers/v2/templates/outgoing
Retrieves a list of transfer templates for a Facility, optionally filtered by last modified date range.
Permissions
Manage Transfer Templates View Transfer Templates
POST
v2 /transfers/v2/templates/outgoing
Creates new transfer templates for a Facility.
Permissions
Manage Transfer Templates
PUT
v2 /transfers/v2/templates/outgoing
Updates existing transfer templates for a Facility.
Permissions
Manage Transfer Templates
GET
v2 /transfers/v2/templates/outgoing/deliveries/{id}/packages
Retrieves a list of delivery package templates for a given Transfer Template Delivery Id. Please note: The {id} parameter above represents a Transfer Template Delivery Id, not a Manifest Number.
Permissions
Manage Transfer Templates View Transfer Templates
GET
v2 /transfers/v2/templates/outgoing/deliveries/{id}/transporters
Retrieves a list of transporter templates for a given Transfer Template Delivery Id. Please note: The {id} parameter above represents a Transfer Template Delivery Id, not a Manifest Number.
Permissions
Manage Transfer Templates View Transfer Templates
GET
v2 /transfers/v2/templates/outgoing/deliveries/{id}/transporters/details
Retrieves detailed transporter templates for a given Transfer Template Delivery Id. Please note: The {id} parameter above represents a Transfer Template Delivery Id, not a Manifest Number.
Permissions
Manage Transfer Templates View Transfer Templates
DELETE
v2 /transfers/v2/templates/outgoing/{id}
Archives a transfer template for a Facility.
Permissions
Manage Transfer Templates
GET
v2 /transfers/v2/templates/outgoing/{id}/deliveries
Retrieves a list of deliveries associated with a specific transfer template.
Permissions
Manage Transfer Templates View Transfer Templates
GET
v2 /transfers/v2/types
Retrieves a list of available transfer types for a Facility based on its license number.
Permissions
None
GET
v2 /transfers/v2/{id}/deliveries
Retrieves a list of shipment deliveries for a given Transfer Id. Please note: The {id} parameter above represents a Transfer Id.
Permissions
Manage Transfers View Transfers
GET
v1 /transfers/v1/deliveries/package/{id}/requiredlabtestbatches
Please note: The {id} parameter above represents a Transfer Delivery Package ID, not a Manifest Number.
Permissions
Permissions vary
GET
v1 /transfers/v1/deliveries/packages/states
Permissions
None
GET
v1 /transfers/v1/deliveries/{id}/packages
Please note: The {id} parameter above represents a Transfer Delivery ID, not a Manifest Number.
Permissions
Permissions vary
GET
v1 /transfers/v1/deliveries/{id}/packages/wholesale
Please note: The {id} parameter above represents a Transfer Delivery ID, not a Manifest Number.
Permissions
Permissions vary
GET
v1 /transfers/v1/deliveries/{id}/transporters
Please note: that the {id} parameter above represents a Shipment Delivery ID.
Permissions
Permissions vary
GET
v1 /transfers/v1/deliveries/{id}/transporters/details
Please note: The {id} parameter above represents a Shipment Delivery ID.
Permissions
Permissions vary
POST
v1 /transfers/v1/external/incoming
Permissions
Permissions vary
PUT
v1 /transfers/v1/external/incoming
Permissions
Permissions vary
DELETE
v1 /transfers/v1/external/incoming/{id}
Permissions
Permissions vary
GET
v1 /transfers/v1/incoming
Permissions
Permissions vary
GET
v1 /transfers/v1/outgoing
Permissions
Permissions vary
GET
v1 /transfers/v1/rejected
Permissions
Permissions vary
GET
v1 /transfers/v1/templates
Permissions
Transfer Templates
POST
v1 /transfers/v1/templates
Permissions
Transfer Templates
PUT
v1 /transfers/v1/templates
Permissions
Transfer Templates
GET
v1 /transfers/v1/templates/deliveries/{id}/packages
Please note: The {id} parameter above represents a Transfer Template Delivery ID, not a Manifest Number.
Permissions
Permissions vary
GET
v1 /transfers/v1/templates/deliveries/{id}/transporters
Please note: The {id} parameter above represents a Transfer Template Delivery ID, not a Manifest Number.
Permissions
Transfer Templates
GET
v1 /transfers/v1/templates/deliveries/{id}/transporters/details
Please note: The {id} parameter above represents a Transfer Template Delivery ID, not a Manifest Number.
Permissions
Transfer Templates
DELETE
v1 /transfers/v1/templates/{id}
Permissions
Transfer Templates
GET
v1 /transfers/v1/templates/{id}/deliveries
Permissions
Transfer Templates
GET
v1 /transfers/v1/types
Permissions
None
GET
v1 /transfers/v1/{id}/deliveries
Please note: that the {id} parameter above represents a Shipment Plan ID.
Permissions
Permissions vary

Transporters

Drivers and vehicles registered to transport product.

DISTRIBUTOR 10 ENDPOINTS
GET
v2 /transporters/v2/drivers
Retrieves a list of drivers for a Facility.
Permissions
Permissions vary
POST
v2 /transporters/v2/drivers
Creates new driver records for a Facility.
Permissions
Manage Transporters
PUT
v2 /transporters/v2/drivers
Updates existing driver records for a Facility.
Permissions
Manage Transporters
GET
v2 /transporters/v2/drivers/{id}
Retrieves a Driver by its Id, with an optional license number. Please note: The {id} parameter above represents a Driver Id.
Permissions
Permissions vary
DELETE
v2 /transporters/v2/drivers/{id}
Archives a Driver record for a Facility. Please note: The {id} parameter above represents a Driver Id.
Permissions
Manage Transporters
GET
v2 /transporters/v2/vehicles
Retrieves a list of vehicles for a Facility.
Permissions
Permissions vary
POST
v2 /transporters/v2/vehicles
Creates new vehicle records for a Facility.
Permissions
Manage Transporters
PUT
v2 /transporters/v2/vehicles
Updates existing vehicle records for a facility.
Permissions
Manage Transporters
GET
v2 /transporters/v2/vehicles/{id}
Retrieves a Vehicle by its Id, with an optional license number. Please note: The {id} parameter above represents a Vehicle Id.
Permissions
Permissions vary
DELETE
v2 /transporters/v2/vehicles/{id}
Archives a Vehicle for a facility. Please note: The {id} parameter above represents a Vehicle Id.
Permissions
Manage Transporters

Units Of Measure

Allowed units (Grams, Ounces, Each, etc).

UNIVERSAL 3 ENDPOINTS
GET
v2 /unitsofmeasure/v2/active
Retrieves all active units of measure.
Permissions
None
GET
v2 /unitsofmeasure/v2/inactive
Retrieves all inactive units of measure.
Permissions
None
GET
v1 /unitsofmeasure/v1/active
Permissions
None

Waste Methods

Approved methods for destroying or rendering waste.

UNIVERSAL 1 ENDPOINTS
GET
v2 /wastemethods/v2/
Retrieves all available waste methods.
Permissions
None