The Strains API from Canix — 2 operation(s) for strains.
openapi: 3.2.0
info:
title: Canix Strains API
x-logo:
url: https://assets.website-files.com/5ee52a0f4be6ffc2aaeb52cd/5ee52a0f4be6ff20e7eb534f_canix-logo.svg
backgroundColor: '#FFFFFF'
altText: Canix logo
description: '# Introduction
This API documentation describes the endpoints used by third-party developers to get Canix data for their account.
# Authentication
Canix API uses API Keys for authentication. You can generate an API key on our [API page](https://app.canix.com/company/api), and on your API requests use the `X-API-KEY` header with the API key value you generated.
We strongly recommend using a secrets manager. Plain text files like dotenv lead to accidental costly leaks. Use [Doppler](https://doppler.com/) or similar options for a developer friendly experience. AWS and Google Cloud have native solutions as well.'
contact:
name: Canix Support
url: https://help.canix.com/
email: help@canix.com
version: 1.3.10
servers:
- url: https://api.canix.com/api/v1
variables: {}
security:
- ApiKeyAuth: []
tags:
- name: Strains
paths:
/strains:
get:
tags:
- Strains
summary: GetStrains
description: Return active Strains
operationId: GetStrains
parameters:
- name: facility_id
in: query
description: Facility ID (optional)
example: 123
required: false
schema:
type: integer
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/orderByParam'
- $ref: '#/components/parameters/whereParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Strain'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401NotAuthenticated'
'403':
$ref: '#/components/responses/403AccessDenied'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500ServerError'
post:
tags:
- Strains
summary: CreateStrain
description: __CALLING THIS ENDPOINT WILL MODIFY YOUR DATA IRREVERSIBLY. ONLY CALL THIS ON SANDBOX DATA DURING DEVELOPMENT/CODING/TESTING.__
operationId: CreateStrain
requestBody:
required: true
description: Create a new Strain
content:
application/json:
schema:
$ref: '#/components/schemas/CreateStrainRequestBody'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Strain'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401NotAuthenticated'
'403':
$ref: '#/components/responses/403AccessDenied'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500ServerError'
/strains/{strain_id}:
get:
tags:
- Strains
summary: GetStrain
description: Get Strain by ID
operationId: GetStrainById
parameters:
- name: strain_id
in: path
description: Strain ID
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Strain'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401NotAuthenticated'
'403':
$ref: '#/components/responses/403AccessDenied'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500ServerError'
put:
tags:
- Strains
summary: UpdateStrain
description: __CALLING THIS ENDPOINT WILL MODIFY YOUR DATA IRREVERSIBLY. ONLY CALL THIS ON SANDBOX DATA DURING DEVELOPMENT/CODING/TESTING.__
operationId: UpdateStrain
parameters:
- name: strain_id
in: path
description: ID of Strain to update
required: true
schema:
type: integer
requestBody:
required: true
description: Update an existing Strain
content:
application/json:
schema:
$ref: '#/components/schemas/StrainRequestBody'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Strain'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401NotAuthenticated'
'403':
$ref: '#/components/responses/403AccessDenied'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500ServerError'
components:
responses:
400BadRequest:
description: Bad request
500ServerError:
description: Server error
401NotAuthenticated:
description: Not authenticated
403AccessDenied:
description: Access denied
404NotFound:
description: The specified resource was not found
parameters:
offsetParam:
name: offset
in: query
description: Offset for the returned records (optional)
schema:
type: integer
default: 0
example: 20
limitParam:
name: limit
in: query
description: Max number of records to return (optional). Cannot exceed 2000
required: false
style: form
schema:
type: integer
default: 2000
example: 100
orderByParam:
name: order_by
in: query
description: Order-by clause, in SQL format (optional)
schema:
type: string
example: id desc
whereParam:
name: where
in: query
description: 'Filter results using SQL-like WHERE clause syntax (optional).
**Supported operators**: =, >, <, >=, <=, BETWEEN, IN, LIKE, AND, OR
**Supported patterns**:
- Equality: `status=''Active''`
- Comparison: `updated_at >= ''2024-01-01''`
- Range: `id BETWEEN 1 AND 10000`
- List: `status IN (''Active'', ''Pending'')`
- Pattern: `sku LIKE ''ABC%''`
- Compound: `facility_id=123 AND is_active=true`
'
schema:
type: string
example: status='Active' AND updated_at >= '2024-01-01'
schemas:
Strain:
title: Strain
required:
- id
- name
properties:
id:
type: integer
name:
type: string
example: Lemon Skunk
description: Strain name
notes:
type: string
example: Terpenes .63%
description: Notes
sku:
type: string
example: BIOJJ
description: SKU
testing_status:
type: string
example: InHouse
description: 'Testing status: InHouse, ThirdParty, None, NA'
indica_percent:
type: number
example: 45.0
description: Indica Percentage
sativa_percent:
type: number
example: 55.0
description: Sativa Percentage
cross_strains:
type: array
description: Cross strains
items:
$ref: '#/components/schemas/CrossStrain'
CreateStrainRequestBody:
title: Strain Request Body
type: object
required:
- name
properties:
facility_id:
type: integer
description: ID of the facility where the strain will be created. Must be a facility with standalone, CA METRC standalone, or METRC standalone integration
example: 123
name:
type: string
example: Blue Dream
description:
type: string
example: A sativa-dominant hybrid
genetics:
type: string
example: Blueberry x Haze
active:
type: boolean
example: true
cross_strain_ids:
type: array
description: Array of strain IDs that are crossed with this strain. All cross strains must belong to the same facility.
items:
type: integer
example:
- 456
- 789
sku:
type: string
example: BD-001
notes:
type: string
example: High-yield strain with excellent terpene profile
cbd_level:
type: number
format: float
description: CBD percentage level
example: 0.5
thc_level:
type: number
format: float
description: THC percentage level
example: 18.5
indica_percent:
type: number
format: float
description: Percentage of indica genetics
example: 40.0
sativa_percent:
type: number
format: float
description: Percentage of sativa genetics
example: 60.0
testing_status:
type: string
description: Current testing status of the strain
example: Tested
StrainRequestBody:
title: Strain Request Body
type: object
required:
- name
properties:
name:
type: string
example: Blue Dream
description:
type: string
example: A sativa-dominant hybrid
genetics:
type: string
example: Blueberry x Haze
active:
type: boolean
example: true
CrossStrain:
title: Cross Strain
required:
- id
- name
properties:
id:
type: integer
name:
type: string
example: Lemon Skunk
description: Strain name
notes:
type: string
example: Terpenes .63%
description: Notes
sku:
type: string
example: BIOJJ
description: SKU
testing_status:
type: string
example: InHouse
description: 'Testing status: InHouse, ThirdParty, None, NA'
indica_percent:
type: number
example: 45.0
description: Indica Percentage
sativa_percent:
type: number
example: 55.0
description: Sativa Percentage
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY