The Transfers API from Canix — 2 operation(s) for transfers.
openapi: 3.2.0
info:
title: Canix Transfers 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: Transfers
paths:
/transfers:
get:
tags:
- Transfers
summary: GetTransfers
description: Return active Transfers
operationId: GetTransfers
parameters:
- $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/Transfer'
'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'
/transfers/{transfer_id}:
get:
tags:
- Transfers
summary: GetTransfer
description: Get Transfer by ID
operationId: GetTransferById
parameters:
- name: transfer_id
in: path
description: Transfer ID
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Transfer'
'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:
schemas:
SalesOrderPayment:
title: Sales Order Payment
required:
- amount
- date
type: object
properties:
id:
type: integer
sales_order_id:
type: integer
description: ID of the sales order this payment was applied to
amount:
type: number
date:
type: integer
reference_number:
type:
- string
- 'null'
description: Payment reference number
external_transaction_name:
type:
- string
- 'null'
description: Readable name of the linked external (e.g. accounting) transaction
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
example:
id: 9001
sales_order_id: 584857
amount: 10000
date: '2021-05-24T19:58:00.000Z'
reference_number: CHK-1042
external_transaction_name: 'QBO Payment #55'
updated_at: '2021-05-24T19:58:00.000Z'
Sales_order_item:
title: Item
type: object
properties:
id:
type: integer
name:
type: string
sku:
type: string
example:
id: 7036
name: Blue Dream - Trim
sku: '22657'
Discount:
title: Discount
type: object
properties:
type:
type: string
enum:
- fixed
- percentage
amount:
type: number
reason:
type: string
example:
type: fixed
amount: 10.0
reason: Black Friday Sale
LabTestInfo:
type: object
properties:
testing_facility_name:
type: string
description: Name of the facility where the testing was conducted.F
testing_facility_license:
type: string
description: License number of the testing facility.
required:
- testing_facility_name
- testing_facility_license
Address:
title: Address
type: object
properties:
street:
type: string
example: 123 Cumberland St
street2:
type: string
example: West
city:
type: string
example: Somerset
county:
type: string
example: KY
state:
type: string
example: CO
country:
type: string
example: USA
postal_code:
type: string
example: 42504
SalesOrderItem:
title: Sales Order Item
required:
- id
- sales_order_id
type: object
properties:
id:
type: integer
weight:
type: number
weight_unit:
oneOf:
- type: string
description: Unit name or abbreviation
- type: integer
description: Unit id
unit_price:
type: number
total_price:
type: number
description: Total price (unit * weight)
item:
$ref: '#/components/schemas/Sales_order_item'
brand:
allOf:
- $ref: '#/components/schemas/IdName'
description: Brand of the sold item, product, or non-cannabis product (null if none)
product_id:
type:
- integer
- 'null'
description: ID of the linked cannabis Product, if any
product_brand:
allOf:
- $ref: '#/components/schemas/IdName'
description: Brand of the linked cannabis Product, if any
is_sample:
type: boolean
description: Whether the line item is a trade sample
package_ids:
type: array
items:
type: integer
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
order:
type: integer
description: Position of the item in the order
discount:
$ref: '#/components/schemas/Discount'
example:
id: 100
weight: 20
weight_unit: Each
unit_price: 20
total_price: 400
item:
id: 7036
name: Blue Dream - Trim
sku: '22657'
brand:
id: 12
name: Sunshine Co
product_id: 4500
product_brand:
id: 12
name: Sunshine Co
is_sample: false
package_ids:
- 123
- 456
discount:
type: percentage
amount: 25.0
reason: 25% off
updated_at: '2021-05-24T19:58:00.000Z'
order: 1
Customer:
title: Customer
type: object
properties:
id:
type: integer
contact_name:
type: string
company_name:
type: string
facility_license_number:
type: string
license_type:
type: string
customer_number:
type: string
license_expiration_date:
type: string
phone:
type: string
email:
type: string
territory:
type: string
address:
$ref: '#/components/schemas/Address'
notes:
type: string
outstanding_balance:
type: number
credit:
type: number
description: Current credit balance available to this customer
dba:
type: string
example: Doing Business As
is_active:
type: boolean
created_at:
type: string
example: 2018-11-06 08:00:00+00:00
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
Location:
title: Location
required:
- id
- name
properties:
id:
type: integer
example: 123
name:
type: string
example: Pro System
sqft:
type: number
example: 14.4
num_lights:
type: integer
example: 42
parent_location:
$ref: '#/components/schemas/ParentLocation'
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
is_active:
type: boolean
example: true
User:
title: User
type: object
properties:
id:
type: integer
example: 123
name:
type: string
example: John Doe
email:
type: string
example: j@d.com
Transfer:
title: Transfer
required:
- id
properties:
id:
type: integer
example: 123
name:
type: string
example: Transfer
manifest_number:
type: string
example: 0000000028
is_active:
type: boolean
destinations:
type: array
items:
$ref: '#/components/schemas/TransferDestination'
sales_order:
$ref: '#/components/schemas/SalesOrder'
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
DestinationPackage:
title: Destination Package
required:
- id
type: object
properties:
id:
type: integer
tag:
type: string
weight:
type: number
weight_unit:
type: string
item:
$ref: '#/components/schemas/IdName'
SourcePackage:
title: Source Package
required:
- id
type: object
properties:
id:
type: integer
tag:
type: string
weight:
type: number
weight_unit:
type: string
item:
$ref: '#/components/schemas/IdName'
ItemStandardCost:
title: ItemStandardCost
required:
- id
- standard_cost_amount
- standard_cost_currency
- start_date
properties:
id:
type: integer
example: 123
standard_cost_amount:
type: number
example: 12.1111
standard_cost_currency:
type: string
example: USD
start_date:
type: string
example: '2023-04-19'
end_date:
type: string
example: '2023-05-19'
ItemType:
title: ItemType
required:
- id
- name
- facility_id
type: object
properties:
id:
type: integer
name:
type: string
quantity_type:
type: string
requires_strain:
type: boolean
requires_unit_volume:
type: boolean
requires_unit_weight:
type: boolean
requires_unit_thc_weight:
type: boolean
requires_unit_cbd_weight:
type: boolean
requires_unit_cbd_percent:
type: boolean
requires_unit_thc_percent:
type: boolean
requires_public_ingredients:
type: boolean
requires_administration_method:
type: boolean
requires_serving_size:
type: boolean
requires_supply_duration_days:
type: boolean
requires_number_of_doses:
type: boolean
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
TestResultValue:
title: TestResultValue
type: object
properties:
value:
type: number
format: double
example: 0.17501406232422
measure:
type: string
enum:
- mg
- mg/g
- mg/serving
- percent
example: mg/g
IdName:
title: IdName
type: object
properties:
id:
type: number
name:
type: string
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
Item:
title: Item
required:
- id
- name
- facility_id
type: object
properties:
id:
type: integer
name:
type: string
is_active:
type: boolean
item_type:
type: string
brand:
$ref: '#/components/schemas/IdName'
product_id:
type: integer
description: ID of the active Product this item belongs to, if any
product_brand:
$ref: '#/components/schemas/IdName'
quantity_type:
type: string
sku:
type: string
current_standard_cost:
$ref: '#/components/schemas/ItemStandardCost'
accounting_inventory_type:
type: string
notes:
type: string
facility_id:
type: integer
strain:
$ref: '#/components/schemas/Strain'
type:
$ref: '#/components/schemas/ItemType'
sub_type:
$ref: '#/components/schemas/ItemSubType'
weight_unit:
type: string
unit_weight:
type: number
unit_weight_unit:
type: string
case_quantity:
type: string
case_quantity_unit:
type: string
unit_cbd_weight:
type: number
unit_cbd_weight_unit:
type: string
unit_thc_weight:
type: number
unit_thc_weight_unit:
type: string
unit_cbd_percent:
type: number
unit_thc_percent:
type: number
description:
type: string
serving_size:
type: number
number_of_doses:
type: number
public_ingredients:
type: string
supply_duration_days:
type: number
administration_method:
type: string
allergens:
type: string
transfer_source_license:
type: string
description: Facility license number of the originating facility. Non-editable.
bills_of_materials:
type: array
items:
type: object
properties:
url:
type: string
name:
type: string
package_weight:
type: number
unit:
type: string
sage_item:
type: object
properties:
external_id:
type: string
name:
type: string
leaflink_item:
type: object
properties:
external_id:
type: string
name:
type: string
dutchie_product:
type: object
properties:
external_id:
type: string
name:
type: string
phenotype:
type: string
total_for_sale:
type: number
description: Total quantity marked as available to sell
ordered:
type: number
description: Total quantity ordered from in-progress sales orders
backordered:
type: number
description: Total quantity backordered from in-progress sales orders
unordered:
type: number
description: Quantity available to sell minus ordered quantity (minimum 0)
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
example:
id: 7036
name: Blue Dream - Trim
sku: '22657'
current_standard_costing:
id:
type: integer
example: 123
standard_cost_amount:
type: number
example: 12.1111
standard_cost_currency:
type: string
example: USD
start_date:
type: string
example: '2023-04-19'
end_date:
type: string
example: '2023-05-19'
is_active: true
facility_id: 14
type:
id: 884
name: Clone - Cutting
quantity_type: CountBased
product_category: Plants
sub_type: null
brand: null
product_id: 512
product_brand: null
quantity_type: CountBased
notes: ''
accounting_inventory_type: raw_materials
strain: null
weight_unit: Each
unit_weight: 10
unit_weight_unit: Grams
case_quantity: 100
case_unit: Each
description: Clone
allergens: Can s 2
transfer_source_license: '1234567890'
bills_of_materials:
- url: https://www.app.canix.com/inventory/non-cannabis/bill-of-materials/123
name: Bill of Materials
package_weight: 10
unit: g
sage_item:
external_id: '1234567890'
name: Sage Item
leaflink_item: null
dutchie_product: null
phenotype: Indica
total_for_sale: 100
ordered: 25
backordered: 10
unordered: 75
updated_at: '2021-03-16T23:49:03.175Z'
Brand:
title: Brand
required:
- id
- name
type: object
properties:
id:
type: integer
name:
type: string
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
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'
ItemSubType:
title: ItemSubType
required:
- id
- name
- weight_unit
- item_category
type: object
properties:
id:
type: integer
name:
type: string
weight_unit:
type: string
category:
$ref: '#/components/schemas/ItemType'
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
SalesOrder:
title: Sales Order
required:
- id
- facility_id
- name
- status
- delivery_date
- other_tax_rate
- local_tax_rate
- state_tax_rate
type: object
properties:
id:
type: integer
facility_id:
type: integer
description: Facility ID (fk)
name:
type: string
external_identifier:
type: string
description: External Sales Order ID (from partner system, not unique)
status:
type: string
description: status, can be one of 'created', 'approved', 'filled', 'shipped', 'rejected', 'accepted', 'archived', 'requested'
created_at:
type: string
description: Timestamp that the record was created in Canix
customer:
$ref: '#/components/schemas/Customer'
delivery_date:
type: string
delivery_fee:
type: number
payment_date:
type: string
description: Payment due date
payment_terms:
type: string
local_tax_rate:
type: number
state_tax_rate:
type: number
other_tax_rate:
type: number
subtotal:
type: number
description: Subtotal of all items
total_cultivation_tax:
type: number
total_price:
type: number
description: Total price (with taxes)
total_paid:
type: number
credits:
type: number
description: Customer credit applied to this order, as a positive number. Credits are applied after taxes, so they do not reduce the taxable subtotal. Writable on create/update via the `credits` request field.
discount:
type: number
description: Order-level discount amount (from `sales_order_credit`), as a positive number. Discounts are applied before taxes and reduce the taxable subtotal.
remaining_balance:
type: number
internal_notes:
type: string
payments:
description: Payments collected for this order
type: array
items:
$ref: '#/components/schemas/SalesOrderPayment'
sales_order_credit:
$ref: '#/components/schemas/Discount'
display_status:
type: string
description: The display status of the order. This is the custom status name if set, otherwise the standard status value.
contents:
description: Contents of the order (i.e. line items)
type: array
items:
allOf:
- $ref: '#/components/schemas/SalesOrderItem'
- type: object
properties:
weight_unit_id:
type: integer
weight_unit_name:
type: string
sales_representative:
schema: null
$ref: '#/components/schemas/User'
invoice_url:
type: string
description: URL to the latest invoice if it exists
example: https://www.app.canix.com/sales/invoice/view/123456
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
example:
id: 84
name: 1074
external_identifier: SAP-ORDER-12345
facility_id: 14
status: created
customer:
id: 345
contact_name: John Smith
company_name: Zen Ltd
facility_license_number: 2020124
license_type: 3
customer_number: 247123
updated_at: 2020-04-24 02:18:42.703000+00:00
license_expiration_date: 2020-04-24
phone: 1222312
email: john.doe@twww.com",
territory: abc
address:
street: 123 Cumberland St
street2: West
city: DL
county: LN
state: OK
postal_code: 111001
notes: great customer!
outstanding_balance: 0
delivery_date: '2021-05-24T19:58:00.000Z'
delivery_fee: 2000
payment_date: '2021-05-24T19:58:00.000Z'
payment_terms: NET-14
local_tax_rate: 0
state_tax_rate: 0.27
other_tax_rate: 0
subtotal: 2124.22
total_cultivation_tax: 0
total_price: 2697.76
total_paid: 100.0
credits: 0
discount: 0
internal_notes: ''
remaining_balance: 2597.76
contents:
- id: 100
weight: 20
weight_unit: Each
unit_price: 20
total_price: 400
item:
id: 7036
name: Blue Dream - Trim
sku: '22657'
package_ids:
- 123
- 456
discount:
type: fixed
amount: 10.0
reason: 10$ off
updated_at: '2021-05-24T19:58:00.000Z'
order: 1
payments:
- date: '2021-05-24T19:58:00.000Z'
amount: 100
sales_representative:
id: 123,
name: John Doe
email: j@d.com
sales_order_credit:
type: percentage
amount: 25.0
reason: 25% off
display_status: Pending Review
invoice_url: https://www.app.canix.com/sales/invoice/view/123456
updated_at: '2021-05-24T19:58:00.000Z'
ParentLocation:
title: Parent Location
required:
- id
- name
properties:
id:
type: integer
example: 123
name:
type: string
example: Pro System
sqft:
type: number
example: 14.4
num_lights:
type: integer
example: 42
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
is_active:
type: boolean
example: true
Package:
title: Package
required:
- id
type: object
properties:
id:
type: integer
tag:
type: string
is_active:
type: boolean
is_testing_package:
type: boolean
description: Whether the package is flagged as a testing (lab sample) package.
status:
type: string
item:
$ref: '#/components/schemas/Item'
weight:
type: number
original_weight:
type: number
weight_unit:
type: string
packaged_date:
type: string
production_batch_date:
type:
- string
- 'null'
format: date
description: The production batch date for the package.
expiration_date:
type: string
received_date:
type: string
location:
$ref: '#/components/schemas/Location'
production_batch:
type: string
lot_id:
type: string
cultivation_tax:
type: number
available_for_sale:
type: boolean
cannabis_cogs:
type: number
non_cannabis_inventory_cogs:
type: number
source_packages:
type: array
items:
$ref: '#/components/schemas/SourcePackage'
destination_packages:
type: array
items:
$ref: '#/components/schemas/DestinationPackage'
source_facility:
type: string
description: Originating facility license number
source_facility_name:
type: string
description: Originating facility name
source_harvests:
type: string
notes:
type: string
brand:
$ref: '#/components/schemas/Brand'
lab_test_url:
type: string
description: URL to the latest lab test if it exists
example: https://www.lab.com/lab-test/123456
coa_url:
type:
- string
- 'null'
description: URL to the Certificate of Analysis (COA) document. Returns either a direct URL or a presigned S3 URL (valid for 24 hours) if available.
example: https://s3.amazonaws.com/bucket/coa/abc123.pdf?X-Amz-Signature=...
test_results:
$ref: '#/components/schemas/TestResults'
cogs:
type: object
example:
labor: 10.0
non_cannabis: 120.0
cannabis: 30.0
total: 160.0
original_cogs:
type: object
description: COGS values at the time the package was created (before any later adjustments).
example:
labor: 10.0
non_cannabis: 120.0
cannabis: 30.0
total: 160.0
manufacturing_run:
type:
- object
- 'null'
description: Only returned by the show endpoint (GET /packages/{id}). Populated when the package is an output of a manufacturing run; null otherwise.
properties:
id:
type: integer
name:
type: string
status:
type: string
start_date:
type:
- string
- 'null'
format: date
end_date:
type:
- string
- 'null'
format: date
facility_id:
type: integer
updated_at:
type: string
example: 2018-11-06 08:00:00+00:00
tested_package_tag:
type: string
description: Tag identifying the package that has been tested
test_status:
type: string
description: Status of the test (e.g., passed, failed, pending)
test_date:
type: string
format: date
description: Date when the test was conducted
lab_test_info:
$ref: '#/components/schemas/LabTestInfo'
TestResults:
title: TestResults
type: object
properties:
thc:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
example:
- value: 12.345
measure: percent
- value: 0.12345
measure: mg/g
- value: 5.6789
measure: mg
cbd:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
example:
- value: 34.567
measure: percent
- value: 2.3456
measure: mg/g
- value: 9.1234
measure: mg
cbn:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
cbg:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
cbga:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
cbc:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
cbca:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
cbda:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
thca:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
delta_8_thc:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
delta_9_thc:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
delta_9_thca:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
delta_8_thca:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
thcv:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
thcva:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
total_cbd:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
total_cbg:
type: array
items:
$ref: '#/components/schemas/TestResultValue'
total_delta_9_thc:
ty
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canix/refs/heads/main/openapi/canix-transfers-api-openapi.yml