The Submissions API from Canix — 1 operation(s) for submissions.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/canix:canix-submissions-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Canix Submissions 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, 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 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.11
servers:
- url: https://api.canix.com/api/v1
variables: {}
security:
- ApiKeyAuth: []
tags:
- name: Submissions
paths:
/submissions:
get:
tags:
- Submissions
summary: GetSubmissions
description: 'Return submissions across the company''s facilities, newest first. A submission represents an asynchronous
action (such as creating a package, adjusting inventory, submitting a transfer, etc.) that may be pending,
successful, failed, or require approval.
This list omits the `description` and `result` fields, which are only available from
`GET /submissions/{submission_id}`. Use the `uuid` of a listed submission to fetch those details.
Filter with the `where` parameter, e.g. `where=status=''FAILED'' AND created_at >= ''2026-01-01''`.'
operationId: GetSubmissions
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/SubmissionSummary'
'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'
/submissions/{submission_id}:
get:
tags:
- Submissions
summary: GetSubmission
description: 'Get Submission by ID. A submission represents an asynchronous action (such as creating a package,
adjusting inventory, submitting a transfer, etc.) that may be pending, successful, failed, or
require approval. Use this endpoint to poll the status of a submission after initiating an action.'
operationId: GetSubmissionById
parameters:
- name: submission_id
in: path
description: Submission UUID
required: true
schema:
type: string
example: U3VibWlzc2lvbjo0NTY3ODk=
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Submission'
examples:
success:
summary: Successful submission
value:
uuid: U3VibWlzc2lvbjo0NTY3ODk=
status: SUCCESS
readable_name: Create Package
description: 'Package created from harvest
Tag: 1A40000000000000001'
error_message: ''
result:
package_id: 12345
tag: 1A40000000000000001
created_at: '2024-01-15T10:30:00.000Z'
last_run_at: '2024-01-15T10:30:05.000Z'
pending:
summary: Pending submission
value:
uuid: U3VibWlzc2lvbjo0NTY3OTA=
status: PENDING
readable_name: Adjust Package
description: Adjusting package weight
error_message: ''
result: null
created_at: '2024-01-15T10:30:00.000Z'
last_run_at: null
failed:
summary: Failed submission
value:
uuid: U3VibWlzc2lvbjo0NTY3OTE=
status: FAILED
readable_name: Create Transfer
description: Transfer to ABC Dispensary
error_message: Invalid destination license number
result: null
created_at: '2024-01-15T10:30:00.000Z'
last_run_at: '2024-01-15T10:30:10.000Z'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401NotAuthenticated'
'403':
$ref: '#/components/responses/403AccessDenied'
'404':
$ref: '#/components/responses/404NotFound'
'422':
description: Unable to fetch submission data
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Unable to fetch submission data
'500':
$ref: '#/components/responses/500ServerError'
components:
parameters:
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'
orderByParam:
name: order_by
in: query
description: Order-by clause, in SQL format (optional)
schema:
type: string
example: id desc
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
offsetParam:
name: offset
in: query
description: Offset for the returned records (optional)
schema:
type: integer
default: 0
example: 20
schemas:
SubmissionStatus:
title: Submission Status
type: string
description: 'The current status of the submission:
- **CREATED**: Transaction queued for processing
- **PENDING_APPROVAL**: Transaction awaiting admin approval
- **PENDING**: Transaction pending response from compliance system
- **RETRYING**: Transaction failed but will be automatically retried
- **FAILED**: Transaction failed permanently
- **SUCCESS**: Transaction completed successfully
- **DENIED**: Transaction was reviewed by an admin and denied
- **ABORTED**: Transaction has been aborted
- **PARTIAL_FAILURE**: Some steps succeeded but others failed
'
enum:
- CREATED
- PENDING_APPROVAL
- PENDING
- RETRYING
- FAILED
- SUCCESS
- DENIED
- ABORTED
- PARTIAL_FAILURE
example: SUCCESS
SubmissionIntegration:
title: Submission Integration
type: string
description: 'The system the submission is sent to:
- **METRC**: Submitted to Metrc
- **BIO_TRACK**: Submitted to BioTrack
- **STANDALONE**: Handled entirely within Canix, with no compliance system involved
'
enum:
- METRC
- BIO_TRACK
- STANDALONE
example: METRC
SubmissionSummary:
title: Submission Summary
description: 'A submission as returned by the list endpoint. Carries the same identifier as `Submission` but omits
`description` and `result`, which are only available from `GET /submissions/{submission_id}`.
'
type: object
required:
- uuid
- status
- created_at
properties:
uuid:
type: string
description: The unique identifier for the submission, accepted by `GET /submissions/{submission_id}`
example: U3VibWlzc2lvbjo0NTY3ODk=
status:
$ref: '#/components/schemas/SubmissionStatus'
readable_name:
type:
- string
- 'null'
description: Human-readable name describing the submission action
example: Create Package
integration:
$ref: '#/components/schemas/SubmissionIntegration'
transaction_type:
type:
- string
- 'null'
description: The compliance action the submission performs. Null for standalone submissions, which are not sent to a compliance system.
example: create_package_from_harvests
error_message:
type:
- string
- 'null'
description: Error message if the submission failed, empty string otherwise
example: ''
facility_id:
type: integer
description: The facility the submission belongs to
example: 123
is_archived:
type: boolean
description: Whether the submission has been archived
example: false
created_at:
type: string
format: date-time
description: When the submission was created
example: '2024-01-15T10:30:00.000Z'
updated_at:
type: string
format: date-time
description: When the submission was last modified
example: '2024-01-15T10:30:05.000Z'
last_run_at:
type:
- string
- 'null'
format: date-time
description: When the submission was last executed (null if not yet run)
example: '2024-01-15T10:30:05.000Z'
example:
uuid: U3VibWlzc2lvbjo0NTY3ODk=
status: SUCCESS
readable_name: Create Package
integration: METRC
transaction_type: create_package_from_harvests
error_message: ''
facility_id: 123
is_archived: false
created_at: '2024-01-15T10:30:00.000Z'
updated_at: '2024-01-15T10:30:05.000Z'
last_run_at: '2024-01-15T10:30:05.000Z'
Submission:
title: Submission
description: 'A submission represents an asynchronous action (such as creating a package, adjusting inventory,
submitting a transfer, etc.) that may be pending, successful, failed, or require approval.
'
type: object
required:
- uuid
- status
- created_at
properties:
uuid:
type: string
description: The unique identifier for the submission
example: U3VibWlzc2lvbjo0NTY3ODk=
status:
$ref: '#/components/schemas/SubmissionStatus'
readable_name:
type:
- string
- 'null'
description: Human-readable name describing the submission action
example: Create Package
description:
type: string
description: Detailed description of the submission, may include multiple lines
example: 'Package created from harvest
Tag: 1A40000000000000001'
error_message:
type: string
description: Error message if the submission failed, empty string otherwise
example: ''
result:
type:
- object
- 'null'
description: Result data from a successful submission (e.g., created record IDs)
additionalProperties: true
example:
package_id: 12345
tag: 1A40000000000000001
created_at:
type: string
format: date-time
description: When the submission was created
example: '2024-01-15T10:30:00.000Z'
last_run_at:
type:
- string
- 'null'
format: date-time
description: When the submission was last executed (null if not yet run)
example: '2024-01-15T10:30:05.000Z'
example:
uuid: U3VibWlzc2lvbjo0NTY3ODk=
status: SUCCESS
readable_name: Create Package
description: 'Package created from harvest
Tag: 1A40000000000000001'
error_message: ''
result:
package_id: 12345
tag: 1A40000000000000001
created_at: '2024-01-15T10:30:00.000Z'
last_run_at: '2024-01-15T10:30:05.000Z'
responses:
500ServerError:
description: Server error
403AccessDenied:
description: Access denied
400BadRequest:
description: Bad request
401NotAuthenticated:
description: Not authenticated
404NotFound:
description: The specified resource was not found
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
x-provenance:
method: harvested
publisher: Canix
source: https://api.canix.com/api.yaml?ver=1.3.12
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)