Distru API

Stay Up To Date

To stay up to date with the latest breaking changes to the Distru public API, please sign up for our email list.

Overview

Distru's public API allows you to easily access and manipulate your data in our system automatically.

Integrate your supply chain with the rest of your business Build your own custom connectors that support your most important workflows.
Extend your reports Take data from Distru and pipe it into other systems for a unified view of your business.
Maximize your efficiency Automate tasks based on changes in your distribution, manufacturing, and sales.

Base URL

All API requests should be made to the base URL: https://app.distru.com

Getting Started

To integrate with Distru, you'll need to contact a representative that will can enable your account's API access. From there, have a look at the following information on how to authenticate with Distru.

Authentication

An admin user can generate API keys in the Distru app by following these steps.

Steps:

Log in to Distru with your admin account.
Navigate to the Settings page from the left menu.
Click on Distru API under the Integrations section.
Use the Create API Key option to generate your API token.

Models

Strain

A strain as shown in Distru

{
  "id": "12345",
  "name": "Strain 123"
}

Property	Description	Type	Required
id	Unique ID for this strain	string	false
name	Name of the strain	string	false

StockAdjustments

A collection of Stock Adjustments

Property	Description	Type	Required

Product

A product as shown in Distru

{
  "brand": {
    "name": "Brand 123"
  },
  "category": {
    "id": "89c8323f-aaaa-45v3-88f9-64009d68h3n8",
    "name": "Super Dank Buds"
  },
  "id": "02c88a3f-d759-4973-88f9-60049d682524",
  "images": [
    {
      "id": "12345",
      "name": "image.jpg",
      "url": "https://example.com/image.jpg"
    }
  ],
  "is_active": true,
  "msrp": 100.1,
  "name": "Blue Dream Preroll 1G",
  "sku": "BDP-1G",
  "unit_price": 1.5,
  "unit_type": {
    "name": "Gram"
  },
  "units_per_case": 6
}

Property	Description	Type	Required
brand	A brand as shown in Distru	Brand	false
category	A product category as shown in Distru	ProductCategory	false
company	A company as shown in Distru	Company	false
custom_data	The custom data for this product	array(CustomField)	false
description	The description of this product	string	false
id	Unique ID for this product	string	false
images	The images associated with the product	array(Image)	false
is_active	Is this product active?	boolean	false
msrp	The MSRP of the product	number	false
name	Human readable name for this product	string	false
sku	The SKU configured for the product	string	false
strain	A strain as shown in Distru	Strain	false
subcategory	A product subcategory as shown in Distru	ProductSubcategory	false
unit_price	The price of one unit of this product	number	false
unit_type	A unit type as shown in Distru	UnitType	false
units_per_case	The number of units of this product that come in one case, if any	number	false
updated_datetime	The datetime this product was last updated at	string	false

AdditionalCost

An additional cost for an assembly as shown in Distru

Property	Description	Type	Required
cost_per_unit	The cost per unit of the additional cost	number	false
description	The description of the additional cost	string	false
name	The name of the additional cost	string	false
quantity	The quantity of the additional cost	number	false
unit_type	A unit type as shown in Distru	UnitType	false

Products

A collection of Products

Property	Description	Type	Required

Assembly

An assembly as shown in Distru

Property	Description	Type	Required
completion_datetime	The datetime this assembly was completed at	string	false
compliance_type	The compliance type for this assembly. Options include METRC, BIOTRACK or NONE	string	false
creation_source	The creation source for this assembly	string	false
custom_data	The custom data for this assembly	array(CustomField)	false
description	The description for this assembly	string	false
estimated_work_hours	The estimated work hours for this assembly	integer	false
estimated_work_minutes	The estimated work minutes for this assembly	integer	false
fulfilled	True if all assembly inputs have been fulfilled with batches or packages, false otherwise.	boolean	false
id	Unique ID for this assembly	string	false
is_metrc_processing_job	True if this assembly is associated with a Metrc processing job, false otherwise	boolean	false
license	The license number for this assembly	string	false
outputs	The outputs for this assembly	array(AssemblyOutput)	false
owner_id	The ID of the user that owns this assembly	string	false
status	The status of this assembly	string	false

OrderItemsRequest

A collection of Order item params

Property	Description	Type	Required

Locations

A collection of Locations

Property	Description	Type	Required

Charge

A line representing a Tax, Discount, or Charge added to an order

Property	Description	Type	Required
id	Unique ID for this charge	string	false
name	The name for this charge	string	false
percent	The percent to charge for this line if it is a percentage	number	false
price	The price of this line if it is a flat charge	number	false
type	What type of additional line is this	array(any)	false
unit_type	Determines if this line is tracked as a percentage or a flat charge	array(any)	false
tax.id	Unique ID for this Tax	string	false
tax.name	The name of this tax	string	false
tax.percent	The amount of tax levied	string	false

Strains

A collection of Strains. Note: This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Property	Description	Type	Required

Role

A user role as shown in Distru

{
  "id": "12345",
  "name": "Admin"
}

Property	Description	Type	Required
id	Unique ID for this role	string	false
name	Name of the role	string	false

OrderTransferTemplateTransporterInfoRequest

A Metrc-specific Order transfer template transporter info

Property	Description	Type	Required
driver_license_number	The driver's license number	string	false
driver_name	The driver's name	string	false
driver_occupational_license_number	The driver's occupational license number	string	false
driver_phone_number	The driver's phone number	string	false
transporter_license_number	The transporter's license number	string	false
vehicle_license_plate_number	The vehicle's license plate number	string	false
vehicle_make	The vehicle's make	string	false
vehicle_model	The vehicle's model	string	false

InvoiceItemsRequest

A collection of invoice item params

Property	Description	Type	Required

InvoiceItem

A invoice line item as shown in Distru

Property	Description	Type	Required
batch	A batch for a product as shown in Distru	Batch	false
id	Unique ID for this invoice item	string	false
package	A package as shown in Distru	Package	false
price	Price per unit of this invoice item	number	false
product	A product as shown in Distru	Product	false
quantity	Quantity used on this invoice item	number	false
returned_quantity	Quantity returned on this invoice item. This is the sum of all return items associated with this invoice item allocated proportionally based on the quantity

of the invoice item relative to its associated order item. For example, if an invoice item with a quantity of 1 has an order item with a quantity of 2, and a return item with a quantity of 2, the returned_quantity would be 1, calculated as (1 ÷ 2) × 2. |number|false| |total_cost_actual|Total cost of the non-returned quantity in this order item, in other words, this is the total cost of order_item.quantity minus order_item.returned quantity. The cost is allocated proportionally based on the quantity of the invoice item relative to its associated order item. For example, if an invoice item with a quantity of 1 has an order item with a quantity of 2 and a total cost of $10, the total_cost_actual would be $5, calculated as (1 ÷ 2) × $10. |number|false| |total_cost_default|Default cost of the non-returned quantity in this order item, in other words, this is the default cost of order_item.quantity minus order_item.returned quantity. The cost is allocated proportionally based on the quantity of the invoice item relative to its associated order item. For example, if an invoice item with a quantity of 1 has an order item with a quantity of 2 and a total cost of $10, the total_cost_default would be $5, calculated as (1 ÷ 2) × $10. |number|false|

RelationshipType

A relationship type as shown in Distru

{
  "id": "12345",
  "name": "Supplier"
}

Property	Description	Type	Required
id	Unique ID for this relationship type	string	false
name	Name of the relationship type	string	false

OrderItemRequest

Order item params

Property	Description	Type	Required
batch_id	The ID of the batch (if the product is batch-tracked)	string	false
id	Unique ID for this order item. If it exists, an update will be performed; otherwise, it will be used as the ID of a new order item record	string	false
package_id	The ID of the package (if the product is package-tracked)	string	false
price_base	Price per unit of this order item (prior to price tier items being applied)	number	true
product_id	The ID of the product (if the product is product-tracked)	string	false
quantity	Quantity used on this order item	number	true

Batch

A batch for a product as shown in Distru

Property	Description	Type	Required
id	Unique ID for this batch	string	false
name	Human readable name for this batch	string	false

TestResults

A collection of Test Results

Property	Description	Type	Required

PurchaseChargesRequest

A collection of Invoice charge params

Property	Description	Type	Required

PurchaseItemRequest

Purchase item params

Property	Description	Type	Required
batch_id	The ID of the batch (if the product is batch-tracked)	string	false
id	Unique ID for this order item. If it exists, an update will be performed; otherwise, it will be used as the ID of a new invoice item record	string	false
price	Price per unit of the inventory being received on this line item	number	true
product_id	The ID of the product (if the product is product-tracked)	string	false
quantity	Quantity received in this order item	number	true

OrderTransferTemplateTransporterInfosRequest

A collection of Metrc-specific Order transfer template transporter info params

Property	Description	Type	Required

InvoiceChargesRequest

A collection of Invoice charge params

Property	Description	Type	Required

PurchaseOrderItem

An order line item as shown in Distru

Property	Description	Type	Required
batch	A batch for a product as shown in Distru	Batch	false
id	Unique ID for this order item	string	false
package	A package as shown in Distru	Package	false
price	Price per unit of this order item (with discounts applied)	number	false
price_base	Price per unit of this order item	number	false
product	A product as shown in Distru	Product	false
quantity	Quantity used on this order item	number	false
received_quantity	Quantity received on this order item. Less than or equal to the quantity field	number	false

PageWithSize

Pagination information for a request

{
  "number": 1,
  "size": 100
}

Property	Description	Type	Required
number	Page number	integer	true
size	Amount of records per page	integer	true

InvoicePayment

An invoice payment as shown in Distru

{
  "amount": 100.0,
  "description": "Payment for invoice 12345",
  "id": "12345",
  "method_id": "12345",
  "payment_datetime": "2024-12-12 20:26:19.297537",
  "payment_number": "12345",
  "quickbooks_deposit_account_id": "12345"
}

Property	Description	Type	Required
amount	The amount of the payment	number	false
descriptiontime	The description of this payment	string	false
id	Unique ID for this invoice payment	string	false
invoice_id	The ID of the invoice this payment is for	string	false
method_id	The ID of the payment method used for this payment	string	false
payment_date	The date of this payment	string	false
payment_number	The payment number for this payment	string	false
quickbooks_deposit_account_id	The id of the Quickbooks deposit account used for this payment	string	false

InvoiceItemRequest

Invoice item params

Property	Description	Type	Required
id	Unique ID for this order item. If it exists, an update will be performed; otherwise, it will be used as the ID of a new invoice item record	string	false
order_item_id	The ID of order item with which this invoice item is associated	string	false
quantity	Quantity used on this order item	number	true

CustomField

A custom field as shown in Distru

{
  "id": "12345",
  "name": "Custom Field 1",
  "value": "Custom Field Value 1"
}

Property	Description	Type	Required
id	Unique ID for this custom field	string	false
name	The name of this custom field	string	false
value	The value of the custom field in the context of the object it's associated with	string	false

Image

An image as shown in Distru

{
  "id": "12345",
  "name": "image.jpg",
  "rank": 0,
  "url": "https://example.com/image.jpg"
}

Property	Description	Type	Required
id	Unique ID for this image	string	false
name	Name of the file for this image	string	false
rank	The rank of this image in the list of images for the product	integer	false
url	URL to the image file	string	false

User

Information about a user in Distru

{
  "banned": false,
  "email": "jeanb@zorgindustries.com",
  "full_name": "Jean-Baptiste Emanuel Zorg",
  "id": "12345",
  "role": "Admin"
}

Property	Description	Type	Required
banned	Is this user banned by Distru?	boolean	false
email	The email address of this user	string	false
full_name	The full name of this user	string	false
id	Unique ID for this user	string	false
role	A user role as shown in Distru	Role	false

AdditionalTestResult

An additional test result object for a test result as shown in Distru

Property	Description	Type	Required
chlorfenapyr_ug_per_g	Pesticide	string	false
dimethoxyethane_ug_per_g	Solvent	string	false
etofenprox_ug_per_g	Pesticide	string	false
formic_acid_ug_per_g	Other	string	false
cbda_percentage	Cannabinoid	string	false
methylcyclohexane_ug_per_g	Solvent	string	false
cadmium_ug_per_g	Heavy Metal	string	false
cbl_percentage	Cannabinoid	string	false
daminozide_ug_per_g	Pesticide	string	false
other_pesticides_ug_per_g	Pesticide	string	false
diazinon_ug_per_g	Pesticide	string	false
cannabinoids_mg_per_unit_total	Cannabinoid	string	false
methiocarb_ug_per_g	Pesticide	string	false
water_activity_aw	Water Activity	string	false
cbt_percentage	Cannabinoid	string	false
camphor_mg_per_unit	Terpene	string	false
hexythiazox_ug_per_g	Pesticide	string	false
linalool_mg_per_unit	Terpene	string	false
ethoprophos_ug_per_g	Pesticide	string	false
other_microbials_cfu_per_g	Microbial	string	false
cbt_mg_per_unit	Cannabinoid	string	false
ethylene_oxide_ug_per_g	Solvent	string	false
thcva_percentage	Cannabinoid	string	false
carbaryl_ug_per_g	Pesticide	string	false
acetone_ug_per_g	Solvent	string	false
ocimene_percentage	Terpene	string	false
nickel_ug_per_g	Heavy Metal	string	false
imidacloprid_ug_per_g	Pesticide	string	false
acetic_acid_ug_per_g	Other	string	false
beta_humulene_mg_per_unit	Terpene	string	false
cypermethrin_ug_per_g	Pesticide	string	false
pyrethrins_pyrethrin_ii_ug_per_g	Pesticide	string	false
camphene_percentage	Terpene	string	false
methoxybenzene_ug_per_g	Solvent	string	false
limonene_percentage	Terpene	string	false
nerolidol_percentage	Terpene	string	false
fenchol_percentage	Terpene	string	false
flonicamid_ug_per_g	Pesticide	string	false
alpha_cyfluthrin_ug_per_g	Pesticide	string	false
spinetoram_l_ug_per_g	Pesticide	string	false
clothianidin_ug_per_g	Pesticide	string	false
sabinene_percentage	Terpene	string	false
chlormequat_chloride_ug_per_g	Other	string	false
aflatoxins_ug_per_kg	Mycotoxin	string	false
ethanol_ug_per_g	Solvent	string	false
permethrin_trans_ug_per_g	Pesticide	string	false
ethyl_acetate_ug_per_g	Solvent	string	false
salmonella_cfu_per_g	Microbial	string	false
valencene_percentage	Terpene	string	false
beta_pinene_percentage	Terpene	string	false
caryophyllene_oxide_mg_per_unit	Terpene	string	false
pyridaben_ug_per_g	Pesticide	string	false
beta_caryophyllene_percentage	Terpene	string	false
oxamyl_ug_per_g	Pesticide	string	false
methyl_butanol_ug_per_g	Solvent	string	false
fenpyroximate_ug_per_g	Pesticide	string	false
delta_8_thc_mg_per_unit	Cannabinoid	string	false
cymene_percentage	Terpene	string	false
caryophyllene_oxide_percentage	Terpene	string	false
bifenthrin_ug_per_g	Pesticide	string	false
methomyl_ug_per_g	Pesticide	string	false
isopropyl_acetate_ug_per_g	Solvent	string	false
alpha_myrcene_mg_per_unit	Terpene	string	false
beta_cypermethrin_ug_per_g	Pesticide	string	false
terpinolene_percentage	Terpene	string	false
tert_butyl_methyl_ether_ug_per_g	Solvent	string	false
acetic_acid_percentage	Other	string	false
borneol_mg_per_unit	Terpene	string	false
mercury_ug_per_g	Heavy Metal	string	false
aflatoxin_g1_ug_per_kg	Mycotoxin	string	false
linalool_percentage	Terpene	string	false
pyrethrins_ug_per_g	Pesticide	string	false
beta_myrcene_mg_per_unit	Terpene	string	false
terpenes_percentage_total	Terpene	string	false
aflatoxin_b1_ug_per_kg	Mycotoxin	string	false
dimethyl_sulfoxide_ug_per_g	Solvent	string	false
naled_ug_per_g	Pesticide	string	false
spirotetramat_ug_per_g	Pesticide	string	false
boscalid_ug_per_g	Pesticide	string	false
geraniol_percentage	Terpene	string	false
cbc_mg_per_unit	Cannabinoid	string	false
butane_ug_per_g	Solvent	string	false
cumene_ug_per_g	Solvent	string	false
dimethomorph_ug_per_g	Pesticide	string	false
piperonylbutoxide_ug_per_g	Pesticide	string	false
moisture_percentage	Moisture	string	false
cbn_percentage	Cannabinoid	string	false
prallethrin_trans_ug_per_g	Pesticide	string	false
aspergillus_cfu_per_g	Microbial	string	false
lead_ug_per_g	Heavy Metal	string	false
ancymidol_ug_per_g	Pesticide	string	false
acephate_ug_per_g	Pesticide	string	false
dimethylformamide_ug_per_g	Solvent	string	false
candida_albicans_cfu_per_g	Microbial	string	false
nitromethane_ug_per_g	Solvent	string	false
pyrethrins_cinerin_i_ug_per_g	Pesticide	string	false
mevinphos_ii_ug_per_g	Pesticide	string	false
kresoxim_methyl_ug_per_g	Pesticide	string	false
spinetoram_j_ug_per_g	Pesticide	string	false
cyclohexane_ug_per_g	Solvent	string	false
alpha_phellandrene_percentage	Terpene	string	false
chloroform_ug_per_g	Solvent	string	false
beta_cyfluthrin_ug_per_g	Pesticide	string	false
borneol_percentage	Terpene	string	false
propyl_acetate_ug_per_g	Solvent	string	false
cyfluthrin_ug_per_g	Pesticide	string	false
fenhexamid_ug_per_g	Pesticide	string	false
cbdv_mg_per_unit	Cannabinoid	string	false
alpha_humulene_percentage	Terpene	string	false
pentachloronitrobenzene_ug_per_g	Pesticide	string	false
xylene_ug_per_g_total	Solvent	string	false
tebuconazole_ug_per_g	Pesticide	string	false
propiconazole_cis_ug_per_g	Pesticide	string	false
butanol_ug_per_g	Solvent	string	false
fenoxycarb_ug_per_g	Pesticide	string	false
antimony_ug_per_g	Heavy Metal	string	false
alpha_cypermethrin_ug_per_g	Pesticide	string	false
chromium_ug_per_g	Heavy Metal	string	false
zinc_ug_per_g	Heavy Metal	string	false
heptane_ug_per_g	Solvent	string	false
spiromesifen_ug_per_g	Pesticide	string	false
thca_percentage	Cannabinoid	string	false
spiroxamine_ug_per_g	Pesticide	string	false
nerolidol_mg_per_unit	Terpene	string	false
tetrahydrofuran_ug_per_g	Solvent	string	false
chlordane_cis_ug_per_g	Pesticide	string	false
propanol_ug_per_g	Solvent	string	false
yeast_cfu_per_g	Microbial	string	false
beta_caryophyllene_mg_per_unit	Terpene	string	false
enterobacteriacaea_cfu_per_g	Microbial	string	false
dimethoate_ug_per_g	Pesticide	string	false
pulegone_percentage	Terpene	string	false
vitamin_e_acetate_percentage	Other	string	false
pentanol_ug_per_g	Solvent	string	false
formic_acid_percentage	Other	string	false
isopulegol_percentage	Terpene	string	false
other_terpenes_mg_per_unit	Terpene	string	false
gamma_terpinene_percentage	Terpene	string	false
spinosad_d_ug_per_g	Pesticide	string	false
l_monocytogenes_cfu_per_g	Microbial	string	false
thiabendazole_ug_per_g	Pesticide	string	false
formamide_ug_per_g	Pesticide	string	false
ethyl_formate_percentage	Other	string	false
ethylene_glycol_ug_per_g	Other	string	false
methyl_propanol_ug_per_g	Solvent	string	false
eucalyptol_percentage	Terpene	string	false
alpha_myrcene_percentage	Terpene	string	false
thca_mg_per_unit	Cannabinoid	string	false
cbg_percentage	Cannabinoid	string	false
ethylene_glycol_percentage	Other	string	false
copper_ug_per_g	Heavy Metal	string	false
mold_cfu_per_g	Microbial	string	false
phytol_mg_per_unit	Terpene	string	false
thcv_percentage	Cannabinoid	string	false
phosmet_ug_per_g	Pesticide	string	false
trifloxystrobin_ug_per_g	Pesticide	string	false
dichloromethane_ug_per_g	Solvent	string	false
thcv_mg_per_unit	Cannabinoid	string	false
delta_8_thc_percentage	Cannabinoid	string	false
fenchol_mg_per_unit	Terpene	string	false
bifenazate_ug_per_g	Pesticide	string	false
cannabinoids_percentage_total	Cannabinoid	string	false
eucalyptol_mg_per_unit	Terpene	string	false
cbdv_percentage	Cannabinoid	string	false
dichloroethane_ug_per_g	Solvent	string	false
propiconazole_ug_per_g	Pesticide	string	false
paclobutrazol_ug_per_g	Pesticide	string	false
cbl_mg_per_unit	Cannabinoid	string	false
delta_3_carene_percentage	Terpene	string	false
myclobutanil_ug_per_g	Pesticide	string	false
dichlorvos_ug_per_g	Pesticide	string	false
pulegone_mg_per_unit	Terpene	string	false
butyl_acetate_ug_per_g	Solvent	string	false
aflatoxin_b2_ug_per_kg	Mycotoxin	string	false
isopulegol_mg_per_unit	Terpene	string	false
trichloroethylene_ug_per_g	Solvent	string	false
sulfolane_ug_per_g	Solvent	string	false
benzene_ug_per_g	Solvent	string	false
terpineol_mg_per_unit	Terpene	string	false
guaiol_percentage	Terpene	string	false
acetonitrile_ug_per_g	Solvent	string	false
chlordane_trans_ug_per_g	Pesticide	string	false
camphene_mg_per_unit	Terpene	string	false
alpha_humulene_mg_per_unit	Terpene	string	false
isopropanol_ug_per_g	Solvent	string	false
spinetoram_ug_per_g	Pesticide	string	false
chlorpyrifos_ug_per_g	Pesticide	string	false
permethrin_cis_ug_per_g	Pesticide	string	false
methyl_butyl_ketone_ug_per_g	Solvent	string	false
aspergillus_terreus_cfu_per_g	Microbial	string	false
aflatoxin_g2_ug_per_kg	Mycotoxin	string	false
metalaxyl_ug_per_g	Pesticide	string	false
alpha_terpinene_mg_per_unit	Terpene	string	false
spiroxamine_b_ug_per_g	Pesticide	string	false
dimethomorph_e_ug_per_g	Pesticide	string	false
tetralin_ug_per_g	Solvent	string	false
n_methylpyrrolidone_ug_per_g	Solvent	string	false
ethyl_formate_ug_per_g	Other	string	false
dinotefuran_ug_per_g	Pesticide	string	false
methanol_ug_per_g	Solvent	string	false
dimethylacetamide_ug_per_g	Solvent	string	false
fipronil_ug_per_g	Pesticide	string	false
flurprimidol_ug_per_g	Pesticide	string	false
dimethomorph_z_ug_per_g	Pesticide	string	false
m_and_p_xylene_ug_per_g	Solvent	string	false
sand_and_soil_and_cinders_and_dirt_percentage	Other	string	false
terpineol_percentage	Terpene	string	false
imazalil_ug_per_g	Pesticide	string	false
filth_and_foreign_material_percentage	Other	string	false
ethyl_ether_ug_per_g	Solvent	string	false
alpha_bisabolol_percentage	Terpene	string	false
acequinocyl_ug_per_g	Pesticide	string	false
cbda_mg_per_unit	Cannabinoid	string	false
permethrin_ug_per_g	Pesticide	string	false
cymene_mg_per_unit	Terpene	string	false
azoxystrobin_ug_per_g	Pesticide	string	false
malathion_ug_per_g	Pesticide	string	false
gamma_terpinene_mg_per_unit	Terpene	string	false
methyl_parathion_ug_per_g	Pesticide	string	false
clofentezine_ug_per_g	Pesticide	string	false
alpha_pinene_percentage	Terpene	string	false
terpenes_mg_per_unit_total	Terpene	string	false
alpha_terpinene_percentage	Terpene	string	false
coumaphos_ug_per_g	Pesticide	string	false
acetamiprid_ug_per_g	Pesticide	string	false
ocimene_mg_per_unit	Terpene	string	false
ethephon_ug_per_g	Pesticide	string	false
geraniol_mg_per_unit	Terpene	string	false
cbc_percentage	Cannabinoid	string	false
pyriproxyfen_ug_per_g	Pesticide	string	false
cbga_mg_per_unit	Cannabinoid	string	false
cbga_percentage	Cannabinoid	string	false
phytol_percentage	Terpene	string	false
chlordane_ug_per_g	Pesticide	string	false
beta_humulene_percentage	Terpene	string	false
terpinolene_mg_per_unit	Terpene	string	false
thcva_mg_per_unit	Cannabinoid	string	false
farnesene_mg_per_unit	Terpene	string	false
camphor_percentage	Terpene	string	false
lambda_cyhalothrin_ug_per_g	Pesticide	string	false
e_coli_cfu_per_g	Microbial	string	false
alpha_bisabolol_mg_per_unit	Terpene	string	false
valencene_mg_per_unit	Terpene	string	false
methoxyethanol_ug_per_g	Solvent	string	false
isobutyl_acetate_ug_per_g	Solvent	string	false
farnesene_percentage	Terpene	string	false
propiconazole_trans_ug_per_g	Pesticide	string	false
dioxane_ug_per_g	Solvent	string	false
chlorobenzene_ug_per_g	Solvent	string	false
alpha_phellandrene_mg_per_unit	Terpene	string	false
cbg_mg_per_unit	Cannabinoid	string	false
other_heavy_metals_ug_per_g	Heavy Metal	string	false
diuron_ug_per_g	Pesticide	string	false
delta_3_carene_mg_per_unit	Terpene	string	false
ethoxyethanol_ug_per_g	Solvent	string	false
aldicarb_ug_per_g	Pesticide	string	false
aspergillus_fumigatus_cfu_per_g	Microbial	string	false
captan_ug_per_g	Pesticide	string	false
chlorantraniliprole_ug_per_g	Pesticide	string	false
propane_ug_per_g	Solvent	string	false
hexane_ug_per_g	Solvent	string	false
other_terpenes_percentage	Terpene	string	false
pyrethrins_pyrethrin_i_ug_per_g	Pesticide	string	false
prallethrin_cis_ug_per_g	Pesticide	string	false
chlormequat_chloride_percentage	Other	string	false
spinosad_a_ug_per_g	Pesticide	string	false
pyrethrins_jasmolin_ii_ug_per_g	Pesticide	string	false
spiroxamine_a_ug_per_g	Pesticide	string	false
guaiol_mg_per_unit	Terpene	string	false
methyl_acetate_ug_per_g	Solvent	string	false
aspergillus_flavus_cfu_per_g	Microbial	string	false
etoxazole_ug_per_g	Pesticide	string	false
methylisobutyl_ketone_ug_per_g	Solvent	string	false
vitamin_e_acetate_ug_per_g	Other	string	false
pyrethrins_cinerin_ii_ug_per_g	Pesticide	string	false
cbn_mg_per_unit	Cannabinoid	string	false
prallethrin_ug_per_g	Pesticide	string	false
mgk_264_ug_per_g	Pesticide	string	false
arsenic_ug_per_g	Heavy Metal	string	false
limonene_mg_per_unit	Terpene	string	false
alpha_pinene_mg_per_unit	Terpene	string	false
mevinphos_ug_per_g	Pesticide	string	false
pyridine_ug_per_g	Solvent	string	false
thiamethoxam_ug_per_g	Pesticide	string	false
toluene_ug_per_g	Solvent	string	false
spinosad_ug_per_g	Pesticide	string	false
pentane_ug_per_g	Solvent	string	false
propoxur_ug_per_g	Pesticide	string	false
ochratoxin_a_ug_per_kg	Mycotoxin	string	false
fludioxonil_ug_per_g	Pesticide	string	false
beta_myrcene_percentage	Terpene	string	false
thiacloprid_ug_per_g	Pesticide	string	false
aspergillus_niger_cfu_per_g	Microbial	string	false
mevinphos_i_ug_per_g	Pesticide	string	false
sabinene_mg_per_unit	Terpene	string	false
other_solvents_ug_per_g	Solvent	string	false
carbofuran_ug_per_g	Pesticide	string	false
beta_pinene_mg_per_unit	Terpene	string	false
other_mycotoxins_ug_per_kg	Mycotoxin	string	false
pyrethrins_jasmolin_i_ug_per_g	Pesticide	string	false
methyl_ethyl_ketone_ug_per_g	Solvent	string	false

OrderChargeRequest

Order charge params

Property	Description	Type	Required
id	Unique ID for this order charge. If it exists, an update will be performed; otherwise, it will be used as the ID of a new order charge record	string	false
name	The ID of the batch (if the product is batch-tracked)	string	false
percent	The ID of the package (if the product is package-tracked)	number	false
price	The ID of the product (if the product is product-tracked)	number	false
type	What type of additional line is this	string	true
unit_type	Determines if this line is tracked as a percentage or a flat charge	string	true

PurchasePayment

A purchase payment as shown in Distru

{
  "amount": 100.0,
  "description": "Payment for invoice 12345",
  "id": "12345",
  "method_id": "12345",
  "payment_datetime": "2024-12-12 20:26:19.297537",
  "payment_number": "12345",
  "quickbooks_deposit_account_id": "12345"
}

Property	Description	Type	Required
amount	The amount of the payment	number	false
descriptiontime	The description of this payment	string	false
id	Unique ID for this purchase payment	string	false
method_id	The ID of the payment method used for this payment	string	false
payment_date	The date of this payment	string	false
payment_number	The payment number for this payment	string	false
purchase_id	The ID of the purchase this payment is for	string	false
quickbooks_deposit_account_id	The id of the Quickbooks deposit account used for this payment	string	false

Packages

A collection of Packages

Property	Description	Type	Required

StockAdjustment

A stock adjustment as shown in Distru

{
  "batch_id": "12345",
  "completion_datetime": "2024-12-12 20:26:19.297537",
  "compliance_quantity": 10,
  "description": "The description for this adjustment",
  "id": "12345",
  "license_id": "12345",
  "location_id": "12345",
  "owner_id": "12345",
  "package_id": "12345",
  "product_id": "12345",
  "quantity": 10,
  "reason": "Waste",
  "total_cost": 100
}

Property	Description	Type	Required
batch_id	The ID of this adjustment's batch. Null if this adjustment is not associated with a batch-tracked product	string	false
completion_datetime	The datetime this adjustment was completed at	datetime	false
compliance_quantity	The quantity of this adjustment expressed in it's package's unit type. Null if this adjustment is not associated with a package-tracked product.	number	false
description	The description for this adjustment	string	false
id	Unique ID for this stock adjustment	string	false
license_id	ID of the license that this adjustment is associated with	string	false
location_id	ID of the location that this adjustment is associated with	string	false
owner_id	The ID of the user that owns this adjustment	string	false
package_id	The ID of this adjustment's package. Null if this adjustment is not associated with a package-tracked product	string	false
product_id	The ID of this adjustment's product. Populated regardless of the product's inventory tracking method.	string	false
quantity	The quantity of the adjustment	number	false
reason	The reason for this adjustment	string	false
total_cost	The total cost of this adjustment	number	false

Batches

A collection of Batches

Property	Description	Type	Required

Inventory

{
  "active": "500.000000000",
  "available": "400.000000000",
  "batch_number": "1234",
  "location_id": "1764da45-c1be-425c-9b31-b860cdb93e98",
  "product_id": "67ae9080-8dc2-4ab7-9704-19673f4d9f21"
}

Property	Description	Type	Required
active	Active quantity	number	true
available	Available quantity (active - reserved)	number	true
batch_number	The batch number of the batch or the package	string	false
location_id	ID of the location	string	false
product_id	ID of the product	string	true

Order

A sales order as shown in Distru. Ordered by order date

{
  "billing_location": {
    "address": "123 Compton Street, CA, USA, 12345",
    "id": "d06a5135-dccf-4d62-a922-804190213c10",
    "name": "Warehouse 1"
  },
  "charges": [
    {
      "id": "8h7512d2-g4h6-jj89-92h7-12f9ed9ls8f5",
      "name": "Friends and Family",
      "percent": -10,
      "type": "DISCOUNT",
      "unit_type": "PERCENT"
    },
    {
      "id": "duy67x9r-0d4k-mmk5-8u9u-l3k8ed9lj900",
      "name": "Excise Tax",
      "percent": 27,
      "tax": {
        "id": "9876",
        "name": "Excise Tax - CA 27%",
        "percent": 27.0
      },
      "type": "TAX",
      "unit_type": "PERCENT"
    },
    {
      "id": "ko38h9ju-ndn7-76h8-jio9-j98yhd93h6fh",
      "name": "Membership Fee",
      "price": 25.0,
      "type": "CHARGE",
      "unit_type": "PRICE"
    }
  ],
  "creator": {
    "banned": false,
    "email": "jeanb@zorgindustries.com",
    "full_name": "Jean-Baptiste Emanuel Zorg",
    "id": "3e98e590-85b6-4247-b2e9-96fc2f45802e"
  },
  "delivery_datetime": "2022‐07‐02T00:00:00Z",
  "due_datetime": "2022‐07‐02T00:00:00Z",
  "id": "193c12d2-bc68-46fa-a221-12f9ed958ef4",
  "inserted_datetime": "2022‐07‐02T00:00:00Z",
  "internal_notes": "Internal note example",
  "items": [
    {
      "id": "3e98e590-85b6-4247-b2e9-96fc2f45802e",
      "price": 0.006,
      "price_base": 0.006,
      "product": {
        "id": "4ec0ac89-a382-409c-ae67-4478e7e681ac",
        "name": "Crawdad Crippler - 1g - PreRoll",
        "sku": "WHODAT"
      },
      "quantity": 786
    }
  ],
  "order_datetime": "2022‐07‐02T00:00:00Z",
  "order_number": "SO-00012345",
  "shipping_location": {
    "address": "123 Compton Street, CA, USA, 12345",
    "id": "d06a5135-dccf-4d62-a922-804190213c10",
    "name": "Warehouse 1"
  },
  "status": "PENDING",
  "total": 150.23,
  "updated_datetime": "2022‐07‐02T00:00:00Z"
}

Property	Description	Type	Required
billing_location	A location as shown in Distru	Location	false
charges	A collection of Charges	array(Charge)	false
company	A company as shown in Distru	Company	false
creator	Information about a user in Distru	User	false
custom_data	A collection of CustomData	array(CustomData)	false
delivery_datetime	The datetime on which the order was / will be delivered	string	false
due_datetime	The datetime by which the order should be completed for the customer	string	false
id	Unique ID for this order	string	false
inserted_datetime	The datetime at which the order was created in Distru	string	false
internal_notes	Internal notes for this order	string	false
items	A collection of SalesOrderItems	array(SalesOrderItem)	false
order_datetime	The datetime on which the order was placed	string	false
order_number	The order number as shown in the Distru UI	string	false
owner	Information about a user in Distru	User	false
shipping_location	A location as shown in Distru	Location	false
status	The status of this sales order	string	false
total	The total for this order including taxes, discounts, and all line items	number	false
updated_datetime	The datetime at which the order was last updated in Distru	string	false

Contacts

A collection of Contacts

Property	Description	Type	Required

Page

Pagination information for a request

{
  "number": 1
}

Property	Description	Type	Required
number	Page number	integer	true

Purchase

A purchase order as shown in Distru. Ordered by order date

{
  "charges": [
    {
      "id": "8h7512d2-g4h6-jj89-92h7-12f9ed9ls8f5",
      "name": "Friends and Family",
      "percent": -10,
      "type": "Discount",
      "unit_type": "Percent"
    },
    {
      "id": "duy67x9r-0d4k-mmk5-8u9u-l3k8ed9lj900",
      "name": "Excise Tax",
      "percent": 27,
      "tax": {
        "id": "9876",
        "name": "Excise Tax - CA 27%",
        "percent": 27.0
      },
      "type": "Tax",
      "unit_type": "Percent"
    },
    {
      "id": "ko38h9ju-ndn7-76h8-jio9-j98yhd93h6fh",
      "name": "Membership Fee",
      "price": 25.0,
      "type": "Charge",
      "unit_type": "Price"
    }
  ],
  "due_datetime": "2022‐07‐02T00:00:00Z",
  "id": "193c12d2-bc68-46fa-a221-12f9ed958ef4",
  "inserted_datetime": "2022‐07‐02T00:00:00Z",
  "items": [
    {
      "id": "3e98e590-85b6-4247-b2e9-96fc2f45802e",
      "price": 0.006,
      "product": {
        "id": "4ec0ac89-a382-409c-ae67-4478e7e681ac",
        "name": "Crawdad Crippler - 1g - PreRoll",
        "sku": "WHODAT"
      },
      "quantity": 786,
      "received_quantity": 786
    }
  ],
  "order_datetime": "2022‐07‐02T00:00:00Z",
  "purchase_number": "PO-00012345",
  "status": "Pending",
  "total": 150.23,
  "updated_datetime": "2022‐07‐02T00:00:00Z"
}

Property	Description	Type	Required
charges	A collection of Charges	array(Charge)	false
company	A company as shown in Distru	Company	false
creator	Information about a user in Distru	User	false
custom_data	The custom data for this purchase order	array(CustomField)	false
due_datetime	The datetime by which the order should be completed for the customer	string	false
id	Unique ID for this order	string	false
inserted_datetime	The datetime at which the order was created in Distru	string	false
items	A collection of PurchaseOrderItems	array(PurchaseOrderItem)	false
order_datetime	The datetime on which the order was placed	string	false
order_number	The order number as shown in the Distru UI	string	false
owner	Information about a user in Distru	User	false
status	The status of this purchase order	string	false
total	The total for this order including taxes, discounts, and all line items	number	false
updated_datetime	The datetime at which the order was last updated in Distru	string	false

PaymentMethod

A payment method as shown in Distru

{
  "id": "12345",
  "name": "Credit Card"
}

Property	Description	Type	Required
id	Unique ID for this payment method	string	false
name	Name of the payment method	string	false

Package

A package as shown in Distru

Property	Description	Type	Required
batch_number	The non-compliance batch number for this package	string	false
compliance_label	The compliance (e.g. Metrc) label for this package	string	false
id	Unique ID for this package in Distru	string	false
status	The status of this package	array(any)	false

BatchFull

Extended details about a batch for a product as shown in Distru

Property	Description	Type	Required
batch_number	The batch number for this batch	string	false
custom_data	The custom data for this batch	array(CustomField)	false
description	The description for this batch	string	false
expiration_date	The expiration date for this batch	string	false
id	Unique ID for this batch	string	false
name	Human readable name for this batch	string	false
owner_id	The ID of the user that owns this batch	string	false
product_id	The ID of the batch's product	string	false

Invoices

A collection of Invoices

Property	Description	Type	Required

ProductSubcategory

A product subcategory as shown in Distru

{
  "id": "88c02a3f-57d9-9473-f8f9-40609d68bbh4",
  "name": "High Grade Flower"
}

Property	Description	Type	Required
id	Unique ID for this subcategory	string	false
name	Human readable name for this subcategory	string	false

Orders

A collection of Orders

Property	Description	Type	Required

SalesOrderItem

An order line item as shown in Distru

Property	Description	Type	Required
batch	A batch for a product as shown in Distru	Batch	false
id	Unique ID for this order item	string	false
package	A package as shown in Distru	Package	false
price	Price per unit of this order item	number	false
product	A product as shown in Distru	Product	false
quantity	Quantity sold on this order item	number	false
returned_quantity	Quantity returned on this order item	number	false
total_cost_actual	Total cost of the non-returned quantity in this order item, in other words, this is the total cost of order_item.quantity minus order_item.returned quantity.	number	false
total_cost_default	Default cost of the non-returned quantity in this order item, in other words, this is the default cost of order_item.quantity minus order_item.returned quantity.	number	false

Assemblies

A collection of Assemblies

Property	Description	Type	Required

Invoice

An invoice as shown in Distru. Ordered by invoice date

{
  "creator": {
    "banned": false,
    "email": "jeanb@zorgindustries.com",
    "full_name": "Jean-Baptiste Emanuel Zorg",
    "id": "12345"
  },
  "due_datetime": "2022‐07‐02T00:00:00Z",
  "id": "193c12d2-bc68-46fa-a221-12f9ed958ef4",
  "inserted_datetime": "2022‐07‐02T00:00:00Z",
  "invoice_datetime": "2022‐07‐02T00:00:00Z",
  "invoice_number": "INV-00012345",
  "items": [
    {
      "id": "1",
      "price": 3.0,
      "product": {
        "id": "543",
        "name": "Crawdad Crippler - 1g - PreRoll",
        "sku": "WHODAT"
      },
      "quantity": 5
    }
  ],
  "order": {
    "id": "931c12d2-68bc-fa46-a221-12f9edcg5hd7",
    "order_number": "SO-0000657",
    "status": "Delivering",
    "total": 999.99
  },
  "status": "Pending",
  "total": 543.23,
  "updated_datetime": "2022‐07‐02T00:00:00Z"
}

Property	Description	Type	Required
charges	A collection of Charges	array(Charge)	false
company	A company as shown in Distru	Company	false
creator	Information about a user in Distru	User	false
custom_data	A collection of CustomData	array(CustomField)	false
due_datetime	The datetime by which the invoice should be paid by the customer	string	false
id	Unique ID for this invoice	string	false
inserted_datetime	The datetime at which the invoice was created in Distru	string	false
invoice_datetime	The datetime on which the invoice was placed	string	false
invoice_number	The invoice number as shown in the Distru UI	string	false
items	A collection of InvoiceItems	array(InvoiceItem)	false
owner	Information about a user in Distru	User	false
paid_amount	The payment amount recorded against this invoice so far.	number	false
status	The status of this invoice	string	false
total	The total for this invoice including taxes, discounts, and all line items	number	false
updated_datetime	The datetime at which the invoice was last updated in Distru	string	false
order.id	Unique ID for this order	string	false
order.order_number	The order number for this sale as seen in the Distru UI	string	false
order.status	Status of the associated order	string	false
order.total	The total on the order	number	false

PurchaseChargeRequest

Purchase charge params

Property	Description	Type	Required
id	Unique ID for this purchase charge. If it exists, an update will be performed; otherwise, it will be used as the ID of a new purchase charge record	string	false
name	The name of this charge	string	false
percent	The percent (if it is percent-based) of this charge	number	false
price	The flat price (if it is price-based) of this charge	number	false
type	Determines if this is a charge or discount	string	true
unit_type	Determines if this line is tracked as a percentage or a flat charge	string	true

PackageFull

A package with extended details as shown in Distru

Property	Description	Type	Required
batch_number	The non-compliance batch number for this package	string	false
compliance_label	The compliance (e.g. Metrc) label for this package	string	false
custom_data	The custom data for this package	array(CustomField)	false
expiration_date	The date that this package expires	string	false
id	Unique ID for this package in Distru	string	false
is_trade_sample	True if this package is a Metrc trade sample	boolean	false
license	A license as shown in Distru	License	false
product_unit_quantity	The quantity of this package expressed in it's product's unit type	string	false
product_unit_type	A unit type as shown in Distru	UnitType	false
quantity	The last known accurate quantity of this package	string	false
quantity_assembling	This quantity of this package currently allocated towards a pending assembly	string	false
quantity_available	The quantity available for use of this package (i.e. inventory that is not held up on a sales order or assembly.)	string	false
status	The status of this package	array(any)	false
unit_type	A unit type as shown in Distru	UnitType	false
location.id	Unique ID for this Location	string	false
location.name	The name of this Location	string	false

License

A license as shown in Distru

Property	Description	Type	Required
id	Unique ID for this license	string	false
license_number	License number	string	false

Purchases

A collection of Purchases

Property	Description	Type	Required

AssemblyOutput

An output for an assembly as shown in Distru

Property	Description	Type	Required
additional_costs	The additional costs for this assembly output	array(AdditionalCost)	false
batch	A batch for a product as shown in Distru	Batch	false
compliance_label	The compliance label for this assembly output	string	false
compliance_quantity	The quantity of this output expressed in the package's unit type. Null if this input is not package-tracked.	number	false
expiration_date	The expiration date for this assembly output	string	false
ingredients	The ingredients for this assembly output	array(AssemblyInput)	false
is_production_batch	Is this output a production batch?	boolean	false
location	A location as shown in Distru	Location	false
package	A package as shown in Distru	Package	false
package_date	The date that this package was created at	string	false
package_unit_type	A unit type as shown in Distru	UnitType	false
product	A product as shown in Distru	Product	false
quantity	The quantity of this output in its product's unit	number	false

PurchaseItemsRequest

A collection of purchase item params

Property	Description	Type	Required

Location

A location as shown in Distru

Property	Description	Type	Required
address	Human readable address for this location	string	false
company_id	ID of the company that owns this location	string	false
id	Unique ID for this location	string	false
license	A license as shown in Distru	License	false
license_id	ID of the license that this location is associated with, if null, then this location is not associated to a license	string	false
name	Human readable name for this location	string	false

TestResult

A test result as shown in Distru

Property	Description	Type	Required
additional_test_results	An additional test result object for a test result as shown in Distru	AdditionalTestResult	false
cbd_mg_per_unit	The CBD mg per unit for this test result	string	false
cbd_percentage	The CBD percentage for this test result	string	false
id	Unique ID for this test result	string	false
is_primary	True if this is the primary test result for the product	boolean	false
lab_license_number	The license number for the lab that performed this test	string	false
lab_name	The name of the lab that performed this test	string	false
mg_per_unit_type	The unit type for the mg per unit fields	string	false
name	The name of the test result	string	false
release_date	The release date for this test result	string	false
thc_mg_per_unit	The THC mg per unit for this test result	string	false
thc_percentage	The THC percentage for this test result	string	false
total_cbd_mg_per_unit	The total CBD mg per unit for this test result	string	false
total_cbd_percentage	The total CBD percentage for this test result	string	false
total_thc_mg_per_unit	The total THC mg per unit for this test result	string	false
total_thc_percentage	The total THC percentage for this test result	string	false
updated_datetime	The datetime this test result was updated at	string	false

ProductCategory

A product category as shown in Distru

{
  "id": "88c02a3f-57d9-9473-f8f9-40609d68bbh4",
  "name": "Flower",
  "type": "FLOWER"
}

Property	Description	Type	Required
id	Unique ID for this category	string	false
name	Human readable name for this category	string	false
type	The type of this category	string	false

OrderChargesRequest

A collection of Order charge params

Property	Description	Type	Required

Contact

Information about a contact in Distru's CRM

{
  "company": {
    "id": "3f128a34-cc59-4b49-8883-23bf10e59c6c"
  },
  "email": "contact@example.com",
  "full_name": "John Doe",
  "id": "12345",
  "owner": {
    "id": "02c88a3f-d759-4973-88f9-60049d682524"
  }
}

Property	Description	Type	Required
company	A company as shown in Distru	Company	false
custom_data	The custom data for this contact	array(CustomField)	false
email	The email address of this contact	string	false
full_name	The full name of this contact	string	false
id	Unique ID for this contact	string	false
owner	Information about a user in Distru	User	false
phone_number	The phone number of this contact	string	false
title	The title of this contact	string	false

PaymentMethods

A collection of Payment Methods

Property	Description	Type	Required

InvoiceChargeRequest

Invoice charge params

Property	Description	Type	Required
id	Unique ID for this invoice charge. If it exists, an update will be performed; otherwise, it will be used as the ID of a new invoice charge record	string	false
name	The name of this charge	string	false
percent	The percent (if it is percent-based) of this charge	number	false
price	The flat price (if it is price-based) of this charge	number	false
type	Determines if this is a charge or discount	string	true
unit_type	Determines if this line is tracked as a percentage or a flat charge	string	true

Companies

A collection of companies

Property	Description	Type	Required

UnitType

A unit type as shown in Distru

{
  "name": "Gram"
}

Property	Description	Type	Required
id	Unique ID for this unit type	string	false
name	Human readable name for this unit type	string	false

Company

A company as shown in Distru

Property	Description	Type	Required
category	The category of this company	string	false
custom_data	The custom data for this company	array(CustomField)	false
default_email	The default email for this company	string	false
default_purchase_order_notes	The default notes that will be automatically added to purchase orders when this company is the supplier	string	false
default_sales_order_notes	The default external notes that will be automatically added to sales orders when this company is the customer	string	false
id	Unique ID for this company	string	false
invoice_email	The email address where sales order invoices are delivered	string	false
legal_business_name	The legal business name for this company	string	false
licenses	The license for the company	array(License)	false
locations	The location for the company	array(Location)	false
name	Human readable name for this company	string	false
order_shipment_email	The email address where sales order shipment packing slips are delivered	string	false
outstanding_balance_threshold	Threshold that determines when a company is considered to have a too high an outstanding balance. When exceeded, Distru will show a warning banner in the company's page and when selling to this company.	integer	false
owner_id	The ID of the user that owns this company	string	false
phone_number	The phone number for this company	string	false
purchase_order_email	The email address where purchase order slips are delivered	string	false
relationship_type	A relationship type as shown in Distru	RelationshipType	false
sales_order_email	The email address where sales order slips are delivered	string	false
updated_datetime	The datetime this company was last updated at	string	false
website	The website for this company	string	false

AssemblyInput

An input for an assembly as shown in Distru

Property	Description	Type	Required
batch	A batch for a product as shown in Distru	Batch	false
compliance_quantity	The quantity of this input expressed in the package's unit type. Null if this input is not package-tracked.	number	false
cost	The cost of this input	number	false
location	A location as shown in Distru	Location	false
package	A package as shown in Distru	Package	false
product	A product as shown in Distru	Product	false
quantity	The quantity of this input in its product's unit	number	false

Inventories

A list of active and available quantity for each group

Property	Description	Type	Required

Brand

A brand as shown in Distru

{
  "name": "Brand 123"
}

Property	Description	Type	Required
name	Name of the brand	string	false

Users

A collection of Users

Property	Description	Type	Required

Assembly

Get assemblies

GET /public/v1/assemblies returns proper data for non-compliance assembly

GET /public/v1/assemblies?creation_source=MANUALLY_CREATED&page[number]=1
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI1NzcsImlhdCI6MTc0NzE0Mjk3NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiY2M2Yjg0NjctMDUxYi00ZGMyLTlhNzQtNDU4NDEwZTljY2YyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyOTc2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNDg5NjEiLCJ0eXAiOiJhY2Nlc3MifQ._LLUg-2R8ZB8SZnOdYNJtpGuB76EnfvqCKranA72mUM

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: c5b21a820975c0000000000000000001-666df45ef1c52491-0

{
  "data": [
    {
      "completion_datetime": null,
      "compliance_type": "NONE",
      "creation_source": "MANUALLY_CREATED",
      "custom_data": [
        {
          "id": 68796,
          "name": "Custom Field 123",
          "value": "Custom Field Value"
        }
      ],
      "description": null,
      "estimated_work_hours": 1,
      "estimated_work_minutes": 5,
      "fulfilled": true,
      "id": "c42702b5-4040-4b33-8806-cc6f8acf0c07",
      "is_metrc_processing_job": false,
      "license": null,
      "outputs": [
        {
          "additional_costs": [
            {
              "cost_per_unit": "-1",
              "description": null,
              "name": "CostType 106",
              "quantity": "1",
              "unit_type": {
                "id": "00000000-0000-0000-0000-00000c3a45d1",
                "name": "Unit Type 417"
              }
            }
          ],
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fee09",
            "name": "B21117"
          },
          "compliance_label": null,
          "compliance_quantity": null,
          "expiration_datetime": null,
          "ingredients": [
            {
              "batch": {
                "batch_number": null,
                "id": "00000000-0000-0000-0000-0000004fee09",
                "name": "B21117"
              },
              "compliance_quantity": null,
              "cost": 0,
              "location": {
                "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
                "company_id": "00000000-0000-0000-0000-000000ddb89c",
                "id": "00000000-0000-0000-0000-00000059d45f",
                "license_id": null,
                "name": "Place 7462"
              },
              "package": null,
              "product": {
                "id": "ef671826-55f0-4893-92dd-e0b43d71c0d4",
                "name": "Product 21115",
                "sku": "sku 21116",
                "updated_datetime": "2025-05-13T13:29:37.729482Z"
              },
              "quantity": "1"
            }
          ],
          "is_production_batch": false,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000ddb89c",
            "id": "00000000-0000-0000-0000-00000059d45f",
            "license_id": null,
            "name": "Place 7462"
          },
          "package": null,
          "package_datetime": null,
          "package_unit_type": null,
          "product": {
            "id": "ef671826-55f0-4893-92dd-e0b43d71c0d4",
            "name": "Product 21115",
            "sku": "sku 21116",
            "updated_datetime": "2025-05-13T13:29:37.729482Z"
          },
          "quantity": "1"
        }
      ],
      "owner_id": "00000000-0000-0000-0000-000001273de1",
      "status": "PENDING"
    }
  ]
}

GET /public/v1/assemblies returns proper data for pending metrc assembly

GET /public/v1/assemblies?creation_source=MANUALLY_CREATED&license_number=CDPH-00005993&page[number]=1
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI1ODAsImlhdCI6MTc0NzE0Mjk4MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGU2Y2YxMzktYjU0Yy00N2M4LWFlMDQtM2Q2ZGEzOTk0YTVmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyOTc5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNDkzNjYiLCJ0eXAiOiJhY2Nlc3MifQ.22BnJ6_ArjMToG1uJ_Pysjx6W8_FWQvwJF3y9X8QVxQ

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: c9af9d4f9d3fc8000000000000000001-2c29a2bb7f416e2c-0

{
  "data": [
    {
      "completion_datetime": null,
      "compliance_type": "METRC",
      "creation_source": "MANUALLY_CREATED",
      "custom_data": [
        {
          "id": 68797,
          "name": "Custom Field 124",
          "value": null
        }
      ],
      "description": null,
      "estimated_work_hours": null,
      "estimated_work_minutes": null,
      "fulfilled": true,
      "id": "d0261409-6ecd-48b6-a110-e78544f37c30",
      "is_metrc_processing_job": false,
      "license": {
        "id": "00000000-0000-0000-0000-000000395159",
        "license_number": "CDPH-00005993"
      },
      "outputs": [
        {
          "additional_costs": [],
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fee8b",
            "name": "B21523"
          },
          "compliance_label": "1A4010200001234000000561",
          "compliance_quantity": "2",
          "expiration_datetime": null,
          "ingredients": [
            {
              "batch": {
                "batch_number": null,
                "id": "00000000-0000-0000-0000-0000004fee8b",
                "name": "B21523"
              },
              "compliance_quantity": "0.0353",
              "cost": 0,
              "location": {
                "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
                "company_id": "00000000-0000-0000-0000-000000ddba00",
                "id": "00000000-0000-0000-0000-00000059d4e1",
                "license_id": "00000000-0000-0000-0000-000000395159",
                "name": "Place 7585"
              },
              "package": {
                "batch_number": "1234567890",
                "compliance_label": "ABCDEF012345670000073130",
                "id": "00000000-0000-0000-0000-0000001cded7",
                "metrc_label": "ABCDEF012345670000073130",
                "status": "active"
              },
              "product": {
                "id": "8ac582b2-d84a-4cfb-b3be-792360ee5e96",
                "name": "Product 21519",
                "sku": "sku 21520",
                "updated_datetime": "2025-05-13T13:29:40.356546Z"
              },
              "quantity": "1"
            }
          ],
          "is_production_batch": false,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000ddba00",
            "id": "00000000-0000-0000-0000-00000059d4e1",
            "license_id": "00000000-0000-0000-0000-000000395159",
            "name": "Place 7585"
          },
          "package": null,
          "package_datetime": "2025-05-13",
          "package_unit_type": {
            "id": "00000000-0000-0000-0000-00000c3a57d5",
            "name": "Gram"
          },
          "product": {
            "id": "8ac582b2-d84a-4cfb-b3be-792360ee5e96",
            "name": "Product 21519",
            "sku": "sku 21520",
            "updated_datetime": "2025-05-13T13:29:40.356546Z"
          },
          "quantity": "2"
        }
      ],
      "owner_id": "00000000-0000-0000-0000-000001273f76",
      "status": "PENDING"
    }
  ]
}

GET /public/v1/assemblies returns proper data for completed metrc assembly

GET /public/v1/assemblies?completion_datetime=2025-05-13+12%3A29%3A38.703321Z%2C2025-05-13+14%3A29%3A38.703321Z&creation_source=MANUALLY_CREATED&license_number=CDPH-00005944&page[number]=1
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI1NzgsImlhdCI6MTc0NzE0Mjk3OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYWEzNjViNTYtZDJiMi00OWFkLTgwYWQtYjAyNTBlZmUyYjM3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyOTc3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNDkwOTQiLCJ0eXAiOiJhY2Nlc3MifQ.OhoA0YlKfKiqHIhaWHFa5pfcInajq7zOExxKNY6HEyc

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 8287ecaafb1b08000000000000000001-1dc99f63de0722ac-0

{
  "data": [
    {
      "completion_datetime": "2025-05-13T13:29:38.703321Z",
      "compliance_type": "METRC",
      "creation_source": "MANUALLY_CREATED",
      "custom_data": [],
      "description": null,
      "estimated_work_hours": null,
      "estimated_work_minutes": null,
      "fulfilled": true,
      "id": "0f870dc3-ccb5-4231-8acc-049ddea830c5",
      "is_metrc_processing_job": false,
      "license": {
        "id": "00000000-0000-0000-0000-000000395130",
        "license_number": "CDPH-00005944"
      },
      "outputs": [
        {
          "additional_costs": [],
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fee39",
            "name": "B21253"
          },
          "compliance_label": "1A4010200001234000000554",
          "compliance_quantity": "2",
          "expiration_datetime": null,
          "ingredients": [
            {
              "batch": {
                "batch_number": null,
                "id": "00000000-0000-0000-0000-0000004fee39",
                "name": "B21253"
              },
              "compliance_quantity": "0.0353",
              "cost": 0,
              "location": {
                "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
                "company_id": "00000000-0000-0000-0000-000000ddb908",
                "id": "00000000-0000-0000-0000-00000059d48b",
                "license_id": "00000000-0000-0000-0000-000000395130",
                "name": "Place 7501"
              },
              "package": {
                "batch_number": "1234567890",
                "compliance_label": "ABCDEF012345670000073022",
                "id": "00000000-0000-0000-0000-0000001cdeaf",
                "metrc_label": "ABCDEF012345670000073022",
                "status": "active"
              },
              "product": {
                "id": "335471eb-cb37-4981-8135-b911a517abdf",
                "name": "Product 21242",
                "sku": "sku 21243",
                "updated_datetime": "2025-05-13T13:29:38.457424Z"
              },
              "quantity": "1"
            }
          ],
          "is_production_batch": false,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000ddb908",
            "id": "00000000-0000-0000-0000-00000059d48b",
            "license_id": "00000000-0000-0000-0000-000000395130",
            "name": "Place 7501"
          },
          "package": {
            "batch_number": null,
            "compliance_label": "1A4010200001234000000554",
            "id": "00000000-0000-0000-0000-0000001cdeb1",
            "metrc_label": "1A4010200001234000000554",
            "status": "active"
          },
          "package_datetime": "2025-05-13",
          "package_unit_type": {
            "id": "00000000-0000-0000-0000-00000c3a4a9c",
            "name": "Gram"
          },
          "product": {
            "id": "335471eb-cb37-4981-8135-b911a517abdf",
            "name": "Product 21242",
            "sku": "sku 21243",
            "updated_datetime": "2025-05-13T13:29:38.457424Z"
          },
          "quantity": "2"
        }
      ],
      "owner_id": "00000000-0000-0000-0000-000001273e66",
      "status": "COMPLETED"
    }
  ]
}

GET /public/v1/assemblies returns proper data for biotrack assembly

GET /public/v1/assemblies?completion_datetime=2025-05-13+12%3A29%3A41.396941Z%2C2025-05-13+14%3A29%3A41.396941Z&creation_source=MANUALLY_CREATED&license_number=CDPH-00006017&page[number]=1
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI1ODEsImlhdCI6MTc0NzE0Mjk4MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODNiZGI3ZDYtNWMyYi00MTJmLThjYWItYzg3MjQwOTY3MDg3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyOTgwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNDk0NzkiLCJ0eXAiOiJhY2Nlc3MifQ.t1K9q-fb6vZoqWSxgRkdkLXs5g5Rdz4x3RV303W8QII

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: a27219c34bf600000000000000000001-ee1f42ceb9f174f4-0

{
  "data": [
    {
      "completion_datetime": "2025-05-13T13:29:41.396941Z",
      "compliance_type": "BIOTRACK",
      "creation_source": "MANUALLY_CREATED",
      "custom_data": [],
      "description": null,
      "estimated_work_hours": null,
      "estimated_work_minutes": null,
      "fulfilled": true,
      "id": "ce6e45d3-adc5-4ab7-ac67-e579f43f67de",
      "is_metrc_processing_job": false,
      "license": {
        "id": "00000000-0000-0000-0000-00000039516e",
        "license_number": "CDPH-00006017"
      },
      "outputs": [
        {
          "additional_costs": [],
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004feeaa",
            "name": "B21622"
          },
          "compliance_label": null,
          "compliance_quantity": "1",
          "expiration_datetime": null,
          "ingredients": [
            {
              "batch": {
                "batch_number": null,
                "id": "00000000-0000-0000-0000-0000004feeaa",
                "name": "B21622"
              },
              "compliance_quantity": "1",
              "cost": 0,
              "location": {
                "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
                "company_id": "00000000-0000-0000-0000-000000ddba51",
                "id": "00000000-0000-0000-0000-00000059d4f9",
                "license_id": "00000000-0000-0000-0000-00000039516e",
                "name": "Place 7609"
              },
              "package": {
                "batch_number": null,
                "compliance_label": "1897",
                "id": "00000000-0000-0000-0000-0000001cdee3",
                "metrc_label": "1897",
                "status": "active"
              },
              "product": {
                "id": "f5ded1cb-1815-4f72-91ce-b244d64baedd",
                "name": "Product 21615",
                "sku": "sku 21616",
                "updated_datetime": "2025-05-13T13:29:41.092807Z"
              },
              "quantity": "1"
            }
          ],
          "is_production_batch": false,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000ddba51",
            "id": "00000000-0000-0000-0000-00000059d4f9",
            "license_id": "00000000-0000-0000-0000-00000039516e",
            "name": "Place 7609"
          },
          "package": {
            "batch_number": null,
            "compliance_label": null,
            "id": "00000000-0000-0000-0000-0000001cdee9",
            "metrc_label": null,
            "status": "active"
          },
          "package_datetime": null,
          "package_unit_type": {
            "id": "00000000-0000-0000-0000-00000c3a5c62",
            "name": "Gram"
          },
          "product": {
            "id": "f5ded1cb-1815-4f72-91ce-b244d64baedd",
            "name": "Product 21615",
            "sku": "sku 21616",
            "updated_datetime": "2025-05-13T13:29:41.092807Z"
          },
          "quantity": "1"
        }
      ],
      "owner_id": "00000000-0000-0000-0000-000001273fe7",
      "status": "COMPLETED"
    }
  ]
}

Get assemblies ordered from oldest to newest by their last modified date.

Note: The page size for this endpoint is 500 assemblies per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/assemblies

Parameters

Parameter	Description	In	Type	Required	Example
completion_datetime	Filter assemblies by their completion datetime	query	string	false	2022-07-10T00:00:00Z,
page	Pagination information	body	Page	false
creation_source	Filter assemblies by their creation source. Options include MANUALLY_CREATED, SPLIT_PACKAGE, SALES_ORDER and LAB_TESTING	query	string	false
license_number	Filter assemblies by their license number	query	string	false

Responses

Status	Description	Schema
200	A list of assemblies	Assemblies

Batch

Get batches

GET /public/v1/batches returns batches related to the company

GET /public/v1/batches
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NDksImlhdCI6MTc0NzE0Mjg0OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMWVlYzA0OTYtOWMyYS00Y2I3LWFmZWQtYjI3MzRkN2Y1YmMzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjYzMjkiLCJ0eXAiOiJhY2Nlc3MifQ.glDhPiAhhqWUEObQV5yv6s68mdli2gNw0xxneiZy5B4

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 05f2e25444deb6000000000000000001-fccf51bad9e74dbe-0

{
  "data": [
    {
      "batch_number": null,
      "custom_data": [
        {
          "id": 68720,
          "name": "Custom Field 16",
          "value": "Custom Data 1"
        }
      ],
      "description": null,
      "expiration_date": "2024-01-01T00:00:00.000000Z",
      "id": "00000000-0000-0000-0000-0000004fd665",
      "name": "B1801",
      "owner_id": "00000000-0000-0000-0000-00000126e57e",
      "primary_test_result": null,
      "product_id": "04f25333-78e8-43e3-aca2-8c16c7103ee0"
    },
    {
      "batch_number": null,
      "custom_data": [
        {
          "id": 68720,
          "name": "Custom Field 16",
          "value": null
        }
      ],
      "description": null,
      "expiration_date": null,
      "id": "00000000-0000-0000-0000-0000004fd666",
      "name": "B1806",
      "owner_id": "00000000-0000-0000-0000-00000126e584",
      "primary_test_result": {
        "cbd_mg_per_unit": "1",
        "cbd_mg_per_unit_total": "2",
        "cbd_percentage": "3",
        "cbd_percentage_total": "4",
        "mg_per_unit_type": "mg/mL",
        "name": "File.pdf",
        "thc_mg_per_unit": "5",
        "thc_mg_per_unit_total": "6",
        "thc_percentage": "7",
        "thc_percentage_total": "8"
      },
      "product_id": "89aa8ebb-5b68-4392-a2b8-9e41b0cfa865"
    }
  ]
}

Get batches sorted by their creation date and filtered by various attributes.

Note: The page size for this endpoint is 5000 batches per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/batches

Parameters

Parameter	Description	In	Type	Required	Example
inserted_datetime	Filter batches by their creation datetime	query	string	false	2022-07-10T00:00:00Z,
page	Pagination information	body	Page	false
updated_datetime	Filter batches by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of batches	Batches

Create a batch

POST /public/v1/batches Errors from service messages are properly reflected in the response

POST /public/v1/batches
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTEsImlhdCI6MTc0NzE0Mjg1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMDgyMWEwYzgtYjAwZS00ZDViLTk5ZmUtNjk1MmQ1Mzk0MzVkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjY3NjkiLCJ0eXAiOiJhY2Nlc3MifQ.5ZBqM5IvzNze0iQejsFTbSmMNYlJlvoyQ11Pg_AwvLw

{
  "owner_id": "56d60483-9f9b-4adb-8f38-d3cd2e3454b9",
  "product_id": "30eb1b77-5eb3-4a53-a0c2-70401d9b1a3c"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: b3c1f08b5be258000000000000000001-b3de6fc2a732cae3-0

{
  "errors": [
    {
      "context": {},
      "message": "Owner not found",
      "pointer": ["owner_id"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Product not found",
      "pointer": ["product_id"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Unable to verify inventory tracking method",
      "pointer": ["product_id"],
      "section": "body"
    }
  ]
}

POST /public/v1/batches Can create batch with all optional fields missing

POST /public/v1/batches
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTIsImlhdCI6MTc0NzE0Mjg1MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOTdmYTA2OGEtMTY0My00ZjhkLWI4ZGUtNjU1OGJhYzIzNmFlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODUxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjY4MzAiLCJ0eXAiOiJhY2Nlc3MifQ.1b0B6p3pyPaHC64ED2TIi5O02fl-fs1QSi9YBvDjVjU

{
  "product_id": "8f09bada-e6a9-4028-a1a4-b107a92dedba"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 593eb240adb764000000000000000001-5cea23c62faf7e36-0

{
  "data": {
    "batch_number": null,
    "custom_data": [],
    "description": null,
    "expiration_date": null,
    "id": "00000000-0000-0000-0000-0000004fd6ca",
    "name": "B1",
    "owner_id": null,
    "product_id": "8f09bada-e6a9-4028-a1a4-b107a92dedba"
  }
}

POST /public/v1/batches Can create batch with all optional fields provided

POST /public/v1/batches
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTAsImlhdCI6MTc0NzE0Mjg1MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNjEwYmQyNDEtY2Q4Yi00YjY0LThkMTMtZDNmMWZkZGExNGI4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjY0MjYiLCJ0eXAiOiJhY2Nlc3MifQ.0M3I6pQe71uysJq-B4tsB59T7o4Rl0qkti2JPuXSUxQ

{
  "batch_number": "B1",
  "description": "Test batch",
  "expiration_date": "2025-01-01T00:00:00.000000Z",
  "owner_id": "00000000-0000-0000-0000-00000126e5e3",
  "product_id": "513b6d9c-326f-4f6f-99ac-36a968e4695a"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 3c7802802dec86000000000000000001-e81d53c6b585dc87-0

{
  "data": {
    "batch_number": "B1",
    "custom_data": [],
    "description": "Test batch",
    "expiration_date": "2025-01-01T00:00:00.000000Z",
    "id": "00000000-0000-0000-0000-0000004fd68e",
    "name": "B1",
    "owner_id": "00000000-0000-0000-0000-00000126e5e3",
    "product_id": "513b6d9c-326f-4f6f-99ac-36a968e4695a"
  }
}

Create a single batch.

Request

POST /public/v1/batches

Parameters

Parameter	Description	In	Type	Required
product_id	The ID of the product that this batch belongs to.	query	string	false
batch_number	The batch number of the batch.	query	string	false
expiration_date	The expiration date of the batch.	query	string	false
owner_id	The ID of the user that is the designated owner of this batch.	query	string	false
description	The description of the batch.	query	string	false

Responses

Status	Description	Schema
200	A single batch	Batch

Company

Get companies

GET /public/companies returns companies related to the company

GET /public/v1/companies
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NjMsImlhdCI6MTc0NzE0Mjg2MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiNzEyYjBiMDgtZDU2MS00Y2FlLWI5ZTMtM2I4ZmQ0ZjJmYzEwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODYyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjg2NDgiLCJ0eXAiOiJhY2Nlc3MifQ.Lbxq3FIbjMPngAiKtCHV6n1gjcPuBYlDmMSDRitkLPw

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 1d02c31d70d00a000000000000000001-286ae513f68e196d-0

{
  "data": [
    {
      "category": "Retailer",
      "custom_data": [
        {
          "id": 68727,
          "name": "Custom Field 23",
          "value": "Custom Data 1"
        }
      ],
      "default_email": "company-1@example.com",
      "default_purchase_order_notes": "Default Purchase Order Notes 1",
      "default_sales_order_notes": "Default Order External Notes 1",
      "id": "00000000-0000-0000-0000-00000081f288",
      "invoice_email": "invoice email",
      "legal_business_name": "Company Legal Name 1",
      "licenses": [],
      "locations": [
        {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7f21",
          "id": "00000000-0000-0000-0000-00000059bcea",
          "license_id": null,
          "name": "Place 1518"
        }
      ],
      "name": "Company 3678",
      "order_shipment_email": "order shipment email",
      "outstanding_balance_threshold": 1000,
      "owner_id": "00000000-0000-0000-0000-00000126ee92",
      "phone_number": "1234567890",
      "purchase_order_email": "purchase email",
      "relationship_type": {
        "id": "00000000-0000-0000-0000-0000000400c5",
        "name": "Supplier"
      },
      "sales_order_email": "order email",
      "updated_datetime": "2023-11-03T00:00:00.000000Z",
      "website": "https://www.example.com"
    },
    {
      "category": "Manufacturer",
      "custom_data": [
        {
          "id": 68727,
          "name": "Custom Field 23",
          "value": null
        }
      ],
      "default_email": "company-8596@example.com",
      "default_purchase_order_notes": null,
      "default_sales_order_notes": null,
      "id": "00000000-0000-0000-0000-00000081f28a",
      "invoice_email": null,
      "legal_business_name": "Company Legal Name 3679",
      "licenses": [
        {
          "id": "00000000-0000-0000-0000-000000394082",
          "license_number": "CDPH-00001266"
        }
      ],
      "locations": [],
      "name": "Company 3679",
      "order_shipment_email": null,
      "outstanding_balance_threshold": null,
      "owner_id": null,
      "phone_number": null,
      "purchase_order_email": null,
      "relationship_type": null,
      "sales_order_email": null,
      "updated_datetime": "2023-12-02T00:00:00.000000Z",
      "website": null
    }
  ]
}

Get companies sorted by their creation date and filtered by various attributes

Note: The page size for this endpoint is 5000 companies per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/companies

Parameters

Parameter	Description	In	Type	Required	Example
inserted_datetime	Filter companies by their creation datetime	query	string	false	2022-07-10T00:00:00Z,
page	Pagination information	body	Page	false
updated_datetime	Filter companies by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of companies	Companies

Contact

Get contacts

GET /public/v1/contacts returns contacts related to the company

GET /public/v1/contacts
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NDAsImlhdCI6MTc0NzE0MzA0MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMDhjMTllYTItOWRhMC00NTBjLTg3ZDAtOGQ0OTQ0OTFmMDJkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDM5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjQ4NTkiLCJ0eXAiOiJhY2Nlc3MifQ._4P9eunuBL8H_W7kJ7WdP5NqED5i8SNauZtkS2CYKSk

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 5509466af5d390000000000000000001-8f593ddb5292fcf8-0

{
  "data": [
    {
      "company": {
        "id": "00000000-0000-0000-0000-000000822e6c"
      },
      "custom_data": [
        {
          "id": 68836,
          "name": "Custom Field 155",
          "value": "Custom Data 1"
        }
      ],
      "email": "email1",
      "full_name": "FirstName81291 LastName81292",
      "id": "00000000-0000-0000-0000-000000013a0c",
      "owner": {
        "id": "00000000-0000-0000-0000-000001277c04"
      },
      "phone_number": "1234567890",
      "title": null
    },
    {
      "company": {
        "id": "00000000-0000-0000-0000-000000822e70"
      },
      "custom_data": [
        {
          "id": 68836,
          "name": "Custom Field 155",
          "value": null
        }
      ],
      "email": "email2",
      "full_name": "FirstName81294 LastName81295",
      "id": "00000000-0000-0000-0000-000000013a0d",
      "owner": {
        "id": "00000000-0000-0000-0000-000001277c0e"
      },
      "phone_number": "1234567890",
      "title": null
    }
  ]
}

Get contacts sorted by their creation date and filtered by various attributes

Note: The page size for this endpoint is 1000 contacts per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/contacts

Parameters

Parameter	Description	In	Type	Required	Example
inserted_datetime	Filter contacts by their creation datetime	query	string	false	2022-07-10T00:00:00Z,
page	Pagination information	body	Page	false
updated_datetime	Filter contacts by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of contacts	Contacts

Inventory

Get inventory levels

GET /public/inventory returns stock quantities filtered by product IDs

GET /public/v1/inventory?grouping[]=PRODUCT&product_ids[]=ed5b900b-e9c1-48ff-91b1-a408da7522c6
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NjQsImlhdCI6MTc0NzE0MzA2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiM2RkYWExNGEtN2EwMy00NWFkLThmMTAtMTNjYWYyNmQ1OTNkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNzAzODIiLCJ0eXAiOiJhY2Nlc3MifQ.wQfm85XgylLTw_qyVPO1XXBxXjLVmkIQCHG7obmGKb4

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: af52dce82a02a0000000000000000001-9bb69d77e9dc472d-0

{
  "data": [
    {
      "active": "10.000000000",
      "available": "10.000000000",
      "product_id": "ed5b900b-e9c1-48ff-91b1-a408da7522c6",
      "updated_datetime": "2025-05-13T13:31:04.356961Z"
    }
  ]
}

GET /public/inventory returns stock quantities grouped by product

GET /public/v1/inventory?grouping[]=PRODUCT
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NjUsImlhdCI6MTc0NzE0MzA2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNmIxYjRhMTUtNTU1Zi00OGVjLTgzYWYtYzljYTAzMDEzYjRlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNzA2NDAiLCJ0eXAiOiJhY2Nlc3MifQ.x9VYvoFb2qh49Ht4PEVEApcLXAv7dCXUz0Qx_0nfh6w

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: d20d4f50228818000000000000000001-18cfd3a6991b5037-0

{
  "data": [
    {
      "active": "100.000000000",
      "available": "90.000000000",
      "product_id": "45d4aaba-f749-471e-a4bf-b5a6e32d4447",
      "updated_datetime": "2023-12-03T00:00:00.000000Z"
    },
    {
      "active": "50.000000000",
      "available": "50.000000000",
      "product_id": "4816152c-6ec5-402d-bca4-fc08073faf13",
      "updated_datetime": "2023-11-05T00:00:00.000000Z"
    },
    {
      "active": "95.000000000",
      "available": "80.000000000",
      "product_id": "5d8de2b0-5c2f-4907-9570-69816c31cde9",
      "updated_datetime": "2023-11-06T00:00:00.000000Z"
    }
  ]
}

GET /public/inventory returns stock quantities grouped by product & location

GET /public/v1/inventory?grouping[]=PRODUCT&grouping[]=LOCATION
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NjgsImlhdCI6MTc0NzE0MzA2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOGM0OGVkN2ItYTgyOC00NmU1LTg5YWMtNTc2NDc5YzNkOTFjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNzE1MjkiLCJ0eXAiOiJhY2Nlc3MifQ.6dYttj5fK_y43RJT1V3nVCaH2Ag9Lt2afL5r6qbnJJI

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: e9ce1cabfacca0000000000000000001-ec17425e9cad8a38-0

{
  "data": [
    {
      "active": "100.000000000",
      "available": "85.000000000",
      "location_id": "00000000-0000-0000-0000-00000059f023",
      "product_id": "d3f2a4f7-4081-434c-8102-701fbe0aee6c",
      "updated_datetime": "2030-10-03T00:00:00.000000Z"
    },
    {
      "active": "90.000000000",
      "available": "82.000000000",
      "location_id": "00000000-0000-0000-0000-00000059f024",
      "product_id": "d3f2a4f7-4081-434c-8102-701fbe0aee6c",
      "updated_datetime": "2030-10-04T00:00:00.000000Z"
    },
    {
      "active": "150.000000000",
      "available": "129.000000000",
      "location_id": "00000000-0000-0000-0000-00000059f025",
      "product_id": "d3f2a4f7-4081-434c-8102-701fbe0aee6c",
      "updated_datetime": "2030-10-05T00:00:00.000000Z"
    },
    {
      "active": "0.000000000",
      "available": "-1.000000000",
      "location_id": null,
      "product_id": "d3f2a4f7-4081-434c-8102-701fbe0aee6c",
      "updated_datetime": "2030-10-08T00:00:00.000000Z"
    },
    {
      "active": "100.000000000",
      "available": "90.000000000",
      "location_id": "00000000-0000-0000-0000-00000059f023",
      "product_id": "d7797dc9-d050-43df-b70c-28a5fc6b59c6",
      "updated_datetime": "2030-10-01T00:00:00.000000Z"
    },
    {
      "active": "0.000000000",
      "available": "-1.000000000",
      "location_id": "00000000-0000-0000-0000-00000059f024",
      "product_id": "d7797dc9-d050-43df-b70c-28a5fc6b59c6",
      "updated_datetime": "2030-10-02T00:00:00.000000Z"
    },
    {
      "active": "100.000000000",
      "available": "100.000000000",
      "location_id": "00000000-0000-0000-0000-00000059f024",
      "product_id": "d91d5262-eb1a-49c3-a024-e6addb6e8588",
      "updated_datetime": "2030-09-01T00:00:00.000000Z"
    },
    {
      "active": "30.000000000",
      "available": "26.000000000",
      "location_id": null,
      "product_id": "d91d5262-eb1a-49c3-a024-e6addb6e8588",
      "updated_datetime": "2030-10-07T00:00:00.000000Z"
    }
  ]
}

GET /public/inventory returns stock quantities grouped by product & batch number

GET /public/v1/inventory?grouping[]=PRODUCT&grouping[]=BATCH_NUMBER
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NjYsImlhdCI6MTc0NzE0MzA2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODg0Y2NkNDctYWYzNy00NmNjLWE5ZmItY2Q5MWM1YmI0ODRiIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNzA5NjAiLCJ0eXAiOiJhY2Nlc3MifQ.etabsdllQ0Y9HIu-JKhTtkbCxkLHUoYewcAJhX3w48w

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: f7c2ae22b7d810000000000000000001-4fbf539031daeed0-0

{
  "data": [
    {
      "active": "26.000000000",
      "available": "26.000000000",
      "batch_number": null,
      "product_id": "4e79bfc5-8b33-40e1-8dfc-affaa7fc5a42",
      "updated_datetime": "2030-12-01T00:00:00.000000Z"
    },
    {
      "active": "27.000000000",
      "available": "27.000000000",
      "batch_number": "1",
      "product_id": "4e79bfc5-8b33-40e1-8dfc-affaa7fc5a42",
      "updated_datetime": "2030-12-02T00:00:00.000000Z"
    },
    {
      "active": "43.000000000",
      "available": "43.000000000",
      "batch_number": null,
      "product_id": "6d4cb2f4-4a57-4c8b-9dc1-e49aa9f5b26c",
      "updated_datetime": "2030-11-02T00:00:00.000000Z"
    },
    {
      "active": "47.000000000",
      "available": "47.000000000",
      "batch_number": "1",
      "product_id": "6d4cb2f4-4a57-4c8b-9dc1-e49aa9f5b26c",
      "updated_datetime": "2030-11-04T00:00:00.000000Z"
    },
    {
      "active": "25.000000000",
      "available": "25.000000000",
      "batch_number": "2",
      "product_id": "6d4cb2f4-4a57-4c8b-9dc1-e49aa9f5b26c",
      "updated_datetime": "2030-11-05T00:00:00.000000Z"
    },
    {
      "active": "19.000000000",
      "available": "19.000000000",
      "batch_number": null,
      "product_id": "7ec41696-4c9d-406c-ba6d-0f7309852980",
      "updated_datetime": "2030-10-02T00:00:00.000000Z"
    },
    {
      "active": "13.000000000",
      "available": "13.000000000",
      "batch_number": "TEST-1",
      "product_id": "7ec41696-4c9d-406c-ba6d-0f7309852980",
      "updated_datetime": "2030-10-04T00:00:00.000000Z"
    },
    {
      "active": "8.000000000",
      "available": "8.000000000",
      "batch_number": "TEST-1",
      "product_id": "d7b01f2a-c066-43c4-b101-65eee24e5e5a",
      "updated_datetime": "2030-09-01T00:00:00.000000Z"
    }
  ]
}

GET /public/inventory returns stock quantities grouped by product & location & batch number

GET /public/v1/inventory?grouping[]=PRODUCT&grouping[]=LOCATION&grouping[]=BATCH_NUMBER
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NjcsImlhdCI6MTc0NzE0MzA2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTFmMWY0MDMtMGUzZC00YjBjLWI0YzgtMTU4MjVjZWZhOGQ1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNzEyOTYiLCJ0eXAiOiJhY2Nlc3MifQ.78UIF4PmJA068grmTy9zKaI60p33AddvV2kc45ihC3I

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 3b23d79244b642000000000000000001-51b567a117ae7f27-0

{
  "data": [
    {
      "active": "41.000000000",
      "available": "41.000000000",
      "batch_number": null,
      "location_id": "00000000-0000-0000-0000-00000059efd5",
      "product_id": "6cd185cd-3c9a-4ae9-b79b-863d469a41b1",
      "updated_datetime": "2031-01-02T00:00:00.000000Z"
    },
    {
      "active": "49.000000000",
      "available": "49.000000000",
      "batch_number": "TEST-1",
      "location_id": "00000000-0000-0000-0000-00000059efd5",
      "product_id": "6cd185cd-3c9a-4ae9-b79b-863d469a41b1",
      "updated_datetime": "2031-02-02T00:00:00.000000Z"
    },
    {
      "active": "45.000000000",
      "available": "45.000000000",
      "batch_number": null,
      "location_id": "00000000-0000-0000-0000-00000059efd6",
      "product_id": "6cd185cd-3c9a-4ae9-b79b-863d469a41b1",
      "updated_datetime": "2031-01-04T00:00:00.000000Z"
    },
    {
      "active": "53.000000000",
      "available": "53.000000000",
      "batch_number": "TEST-1",
      "location_id": "00000000-0000-0000-0000-00000059efd6",
      "product_id": "6cd185cd-3c9a-4ae9-b79b-863d469a41b1",
      "updated_datetime": "2031-02-04T00:00:00.000000Z"
    },
    {
      "active": "21.000000000",
      "available": "21.000000000",
      "batch_number": null,
      "location_id": "00000000-0000-0000-0000-00000059efd5",
      "product_id": "cf68f749-39cf-4176-97a9-2e8c1a2c4411",
      "updated_datetime": "2030-11-02T00:00:00.000000Z"
    },
    {
      "active": "29.000000000",
      "available": "29.000000000",
      "batch_number": "TEST-1",
      "location_id": "00000000-0000-0000-0000-00000059efd5",
      "product_id": "cf68f749-39cf-4176-97a9-2e8c1a2c4411",
      "updated_datetime": "2030-12-02T00:00:00.000000Z"
    },
    {
      "active": "25.000000000",
      "available": "25.000000000",
      "batch_number": null,
      "location_id": "00000000-0000-0000-0000-00000059efd6",
      "product_id": "cf68f749-39cf-4176-97a9-2e8c1a2c4411",
      "updated_datetime": "2030-11-04T00:00:00.000000Z"
    },
    {
      "active": "33.000000000",
      "available": "33.000000000",
      "batch_number": "TEST-1",
      "location_id": "00000000-0000-0000-0000-00000059efd6",
      "product_id": "cf68f749-39cf-4176-97a9-2e8c1a2c4411",
      "updated_datetime": "2030-12-04T00:00:00.000000Z"
    }
  ]
}

Get active and available quantities grouped by a specified list of attributes. Groups with 0 active and 0 available quantity won't be returned. Groups are sorted by the IDs of the attributes they are grouped by. Note: The page size for this endpoint is 5000 groups per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/inventory

Parameters

Parameter	Description	In	Type	Required	Example
grouping	Attributes to group inventory by. PRODUCT is required to be in the list. Accepted values are "BATCH_NUMBER", "LOCATION" and "PRODUCT".	query	array	false	["PRODUCT","LOCATION"]
page	Pagination information	body	Page	false
product_ids	Filter inventory levels by product IDs	query	array	false	["67ae9080-8dc2-4ab7-9704-19673f4d9f21","213c7080-8dc2-4ab7-9704-19673f4d9f22"]

Responses

Status	Description	Schema
200	A list of active and available quantity for each group	Inventories

Invoice

Get invoices

GET /invoices/ returns invoices related to the access token's company

GET /public/v1/invoices
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0MzQsImlhdCI6MTc0NzE0MjgzNCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNzg1Yzk4YmYtYjU2OS00ZDU1LWFiZTEtYTQ5NjhlZThiMjMzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODMzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjQwOTciLCJ0eXAiOiJhY2Nlc3MifQ.WDbX5TkULDWotPjH24dPEhm0-iv5NBYdsvpwGf2REs0

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: f7eb1df2418a38000000000000000001-42f776a0623edb58-0

{
  "data": [
    {
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081ec8b",
        "name": "Company 502",
        "updated_datetime": "2025-05-13T13:27:17.220562Z"
      },
      "creator": {
        "banned": false,
        "email": "owner-539@example.com",
        "full_name": "FirstName1050 LastName1051",
        "id": "00000000-0000-0000-0000-00000126dd70",
        "role": {
          "id": "00000000-0000-0000-0000-000001251c73",
          "name": "Admin 512"
        }
      },
      "custom_data": [
        {
          "id": 68707,
          "name": "Custom Field 3",
          "value": null
        }
      ],
      "due_datetime": "2025-05-13T13:27:17.391719Z",
      "id": "00000000-0000-0000-0000-000000070ff6",
      "inserted_datetime": "2025-05-13T13:27:17.393276Z",
      "invoice_datetime": "2025-05-13T13:27:17.391716Z",
      "invoice_number": "Invoice #11",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd4b3",
            "name": "B393"
          },
          "id": "00000000-0000-0000-0000-00000008bfbe",
          "order_item_id": "24d2ed88-f64b-4704-8ab2-1d2f4fe31b14",
          "package": null,
          "price": "10.000000000",
          "product": {
            "id": "be21d036-79df-4241-b579-2690b14a9549",
            "name": "Product 391",
            "sku": "sku 392",
            "updated_datetime": "2025-05-13T13:27:17.241644Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd4b4",
            "name": "B396"
          },
          "id": "00000000-0000-0000-0000-00000008bfbf",
          "order_item_id": "3a535818-8193-455c-b75d-d93f52b39d6f",
          "package": null,
          "price": "10.000000000",
          "product": {
            "id": "aec3c1d3-e1cc-4852-a881-c34297957f80",
            "name": "Product 394",
            "sku": "sku 395",
            "updated_datetime": "2025-05-13T13:27:17.265541Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "order": {
        "id": "7da63a5e-8760-4f42-baaf-42b513ae3014",
        "order_number": "SO-34",
        "status": "Pending",
        "total": "320.00"
      },
      "owner": {
        "banned": false,
        "email": "owner-539@example.com",
        "full_name": "FirstName1050 LastName1051",
        "id": "00000000-0000-0000-0000-00000126dd70",
        "role": {
          "id": "00000000-0000-0000-0000-000001251c73",
          "name": "Admin 512"
        }
      },
      "paid_amount": "0.0",
      "status": "NOT_PAID",
      "total": "32.00",
      "updated_datetime": "2025-05-13T13:27:17.393276Z"
    },
    {
      "charges": [
        {
          "id": "415f0252-a69e-4a20-a707-e20cd6d9876d",
          "name": "C1",
          "percent": "10.0000",
          "price": "1.00",
          "type": "CHARGE",
          "unit_type": "PERCENT"
        }
      ],
      "company": {
        "id": "00000000-0000-0000-0000-00000081ec41",
        "name": "Company 337",
        "updated_datetime": "2025-05-13T13:27:14.969887Z"
      },
      "creator": {
        "banned": false,
        "email": "user1@a.com",
        "full_name": "John Foo",
        "id": "00000000-0000-0000-0000-00000126dcbe",
        "role": {
          "id": "00000000-0000-0000-0000-000001251bc7",
          "name": "Admin 340"
        }
      },
      "custom_data": [
        {
          "id": 68707,
          "name": "Custom Field 3",
          "value": "Custom Field Value 1"
        }
      ],
      "due_datetime": "2020-01-01T00:00:01.000000Z",
      "id": "00000000-0000-0000-0000-000000070fec",
      "inserted_datetime": "2025-05-13T13:27:15.018861Z",
      "invoice_datetime": "2020-01-01T00:00:02.000000Z",
      "invoice_number": "INV-123",
      "items": [
        {
          "batch": {
            "batch_number": "UID1",
            "id": "00000000-0000-0000-0000-0000004fd497",
            "name": "B1"
          },
          "id": "00000000-0000-0000-0000-00000008bfae",
          "order_item_id": "d998b219-1332-4479-8f45-89aa45f5d3d0",
          "package": {
            "batch_number": "B1",
            "compliance_label": "ABCDEF012345670000000109",
            "id": "00000000-0000-0000-0000-0000001cd49c",
            "metrc_label": "ABCDEF012345670000000109",
            "status": "active"
          },
          "price": "10.000000000",
          "product": {
            "id": "f29bceec-f93a-4b91-8bf7-d6d68b667977",
            "name": "P1",
            "sku": "SKU1",
            "updated_datetime": "2025-05-13T13:27:14.919088Z"
          },
          "quantity": "1.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "order": {
        "id": "50c9dc68-c27e-4fd6-857c-0e6c49f00b09",
        "order_number": "SO-123",
        "status": "Completed",
        "total": "10.00"
      },
      "owner": {
        "banned": false,
        "email": "user2@a.com",
        "full_name": "John Bar",
        "id": "00000000-0000-0000-0000-00000126dcbf",
        "role": {
          "id": "00000000-0000-0000-0000-000001251bc9",
          "name": "Admin 342"
        }
      },
      "paid_amount": "5.00",
      "status": "PARTIALLY_PAID",
      "total": "8.00",
      "updated_datetime": "2025-05-13T13:27:15.761805Z"
    }
  ]
}

GET /invoices/ returns cost/returned_quantity data for invoice items

GET /public/v1/invoices
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NjIsImlhdCI6MTc0NzE0Mjg2MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZDE1MTQyMmEtNDIzNS00MTdjLTk1NDMtZDE5YTJmMDJmZjdjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODYxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjg1NjgiLCJ0eXAiOiJhY2Nlc3MifQ.tl5Ui25xh7pFLtVyGmrWTX4cngO2zNIMMWkuffGdteE

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 43c9356aa23bfc000000000000000001-367275a4f8870197-0

{
  "data": [
    {
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081f273",
        "name": "Company 3629",
        "updated_datetime": "2025-05-13T13:27:42.969866Z"
      },
      "creator": {
        "banned": false,
        "email": "owner-4925@example.com",
        "full_name": "FirstName9674 LastName9675",
        "id": "00000000-0000-0000-0000-00000126ee85",
        "role": {
          "id": "00000000-0000-0000-0000-000001252dd0",
          "name": "Admin 4911"
        }
      },
      "custom_data": [],
      "due_datetime": "2025-05-13T13:27:43.243823Z",
      "id": "00000000-0000-0000-0000-000000071056",
      "inserted_datetime": "2025-05-13T13:27:43.244853Z",
      "invoice_datetime": "2025-05-13T13:27:43.243820Z",
      "invoice_number": "Invoice #99",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd86f",
            "name": "B3599"
          },
          "id": "00000000-0000-0000-0000-00000008c037",
          "order_item_id": "a474feb4-99cb-48cf-b3ff-735dc49560db",
          "package": null,
          "price": "219319.000000000",
          "product": {
            "id": "9e8f0a8c-4aa2-4323-80a4-27e7ce8f9c58",
            "name": "Product 3597",
            "sku": "sku 3598",
            "updated_datetime": "2025-05-13T13:27:42.883682Z"
          },
          "quantity": "2.000000000",
          "returned_quantity": "2",
          "total_cost_actual": "20.052",
          "total_cost_default": "10"
        }
      ],
      "order": {
        "id": "57c95a67-bd52-48e7-a8bc-90038bf7b7fc",
        "order_number": "SO-0000001",
        "status": "Processing",
        "total": "438638.00"
      },
      "owner": {
        "banned": false,
        "email": "owner-4925@example.com",
        "full_name": "FirstName9674 LastName9675",
        "id": "00000000-0000-0000-0000-00000126ee85",
        "role": {
          "id": "00000000-0000-0000-0000-000001252dd0",
          "name": "Admin 4911"
        }
      },
      "paid_amount": "0.0",
      "status": "NOT_PAID",
      "total": "32.00",
      "updated_datetime": "2025-05-13T13:27:43.244853Z"
    }
  ]
}

GET /invoices/ allows filtering by several statuses

GET /public/v1/invoices?status[]=Fully+Paid&status[]=Not+Paid
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NDcsImlhdCI6MTc0NzE0Mjg0NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiY2VkYTMwNGEtZGI1YS00YTU1LTg2ZTEtZWM2ZGNmZTZkMzZmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjU4NjUiLCJ0eXAiOiJhY2Nlc3MifQ.MZgRm3EC8jYqjCt34gk9BaJYPJK49hxl-zOj14GS8l4

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 7e7cd3ffc20c10000000000000000001-ce7f12d7ab93060b-0

{
  "data": [
    {
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081eeec",
        "name": "Company 1755",
        "updated_datetime": "2025-05-13T13:27:28.171812Z"
      },
      "creator": {
        "banned": false,
        "email": "owner-2311@example.com",
        "full_name": "FirstName4492 LastName4493",
        "id": "00000000-0000-0000-0000-00000126e446",
        "role": {
          "id": "00000000-0000-0000-0000-000001252366",
          "name": "Admin 2258"
        }
      },
      "custom_data": [],
      "due_datetime": "2025-05-13T13:27:28.390634Z",
      "id": "00000000-0000-0000-0000-000000071022",
      "inserted_datetime": "2025-05-13T13:27:28.392541Z",
      "invoice_datetime": "2020-01-01T12:30:00.000000Z",
      "invoice_number": "Invoice #52",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd632",
            "name": "B1616"
          },
          "id": "00000000-0000-0000-0000-00000008bffc",
          "order_item_id": "d95ab00a-56a3-4af5-ae5c-dd7dd33e7bee",
          "package": null,
          "price": "10.000000000",
          "product": {
            "id": "d5647fd0-e397-41ac-9845-ff955195417d",
            "name": "Product 1614",
            "sku": "sku 1615",
            "updated_datetime": "2025-05-13T13:27:28.209570Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd635",
            "name": "B1625"
          },
          "id": "00000000-0000-0000-0000-00000008bffd",
          "order_item_id": "dd529bf5-12d5-48be-a40b-4a6b52a16731",
          "package": null,
          "price": "10.000000000",
          "product": {
            "id": "809ca2ec-2ea1-4bf7-8a9e-dc8eb5b460e9",
            "name": "Product 1623",
            "sku": "sku 1624",
            "updated_datetime": "2025-05-13T13:27:28.243164Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "order": {
        "id": "d662b8f5-d2d9-4cbc-b15c-9bd9a1815ab0",
        "order_number": "SO-155",
        "status": "Pending",
        "total": "320.00"
      },
      "owner": {
        "banned": false,
        "email": "owner-2311@example.com",
        "full_name": "FirstName4492 LastName4493",
        "id": "00000000-0000-0000-0000-00000126e446",
        "role": {
          "id": "00000000-0000-0000-0000-000001252366",
          "name": "Admin 2258"
        }
      },
      "paid_amount": "0.0",
      "status": "NOT_PAID",
      "total": "32.00",
      "updated_datetime": "2025-05-13T13:27:28.392541Z"
    },
    {
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081eeda",
        "name": "Company 1718",
        "updated_datetime": "2025-05-13T13:27:27.868979Z"
      },
      "creator": {
        "banned": false,
        "email": "owner-2251@example.com",
        "full_name": "FirstName4381 LastName4383",
        "id": "00000000-0000-0000-0000-00000126e40f",
        "role": {
          "id": "00000000-0000-0000-0000-00000125232a",
          "name": "Admin 2199"
        }
      },
      "custom_data": [],
      "due_datetime": "2025-05-13T13:27:28.074949Z",
      "id": "00000000-0000-0000-0000-000000071020",
      "inserted_datetime": "2025-05-13T13:27:28.076378Z",
      "invoice_datetime": "2020-01-01T12:20:00.000000Z",
      "invoice_number": "Invoice #50",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd621",
            "name": "B1569"
          },
          "id": "00000000-0000-0000-0000-00000008bffa",
          "order_item_id": "db9261c7-b335-4990-8091-2e48fb6ae0b9",
          "package": null,
          "price": "10.000000000",
          "product": {
            "id": "10f8d29d-956d-49f1-a62f-d84af5729783",
            "name": "Product 1567",
            "sku": "sku 1568",
            "updated_datetime": "2025-05-13T13:27:27.903672Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd626",
            "name": "B1578"
          },
          "id": "00000000-0000-0000-0000-00000008bffb",
          "order_item_id": "da745fc8-473b-492d-aacc-d23d559ed75f",
          "package": null,
          "price": "10.000000000",
          "product": {
            "id": "724c3bb7-7cf6-4ca4-a0c4-ddee228c7eb4",
            "name": "Product 1576",
            "sku": "sku 1577",
            "updated_datetime": "2025-05-13T13:27:27.942001Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "order": {
        "id": "63e92ec2-4dc5-4664-ba04-c3d5dc6a3fb2",
        "order_number": "SO-154",
        "status": "Pending",
        "total": "320.00"
      },
      "owner": {
        "banned": false,
        "email": "owner-2251@example.com",
        "full_name": "FirstName4381 LastName4383",
        "id": "00000000-0000-0000-0000-00000126e40f",
        "role": {
          "id": "00000000-0000-0000-0000-00000125232a",
          "name": "Admin 2199"
        }
      },
      "paid_amount": "0.0",
      "status": "FULLY_PAID",
      "total": "32.00",
      "updated_datetime": "2025-05-13T13:27:28.076378Z"
    },
    {
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081eebc",
        "name": "Company 1646",
        "updated_datetime": "2025-05-13T13:27:27.294326Z"
      },
      "creator": {
        "banned": false,
        "email": "owner-2153@example.com",
        "full_name": "FirstName4186 LastName4187",
        "id": "00000000-0000-0000-0000-00000126e3ad",
        "role": {
          "id": "00000000-0000-0000-0000-0000012522c2",
          "name": "Admin 2096"
        }
      },
      "custom_data": [],
      "due_datetime": "2025-05-13T13:27:27.479251Z",
      "id": "00000000-0000-0000-0000-00000007101e",
      "inserted_datetime": "2025-05-13T13:27:27.481357Z",
      "invoice_datetime": "2020-01-01T12:00:00.000000Z",
      "invoice_number": "Invoice #48",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd611",
            "name": "B1507"
          },
          "id": "00000000-0000-0000-0000-00000008bff6",
          "order_item_id": "369dfbc1-365b-4c7e-9ea5-0f5a2ac24cf3",
          "package": null,
          "price": "10.000000000",
          "product": {
            "id": "36bdbc81-0651-4dcc-9edb-8df4eaa5babf",
            "name": "Product 1505",
            "sku": "sku 1506",
            "updated_datetime": "2025-05-13T13:27:27.315741Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd612",
            "name": "B1512"
          },
          "id": "00000000-0000-0000-0000-00000008bff7",
          "order_item_id": "10eeb96b-a504-4d92-940a-74734f502d42",
          "package": null,
          "price": "10.000000000",
          "product": {
            "id": "981ba6e8-43d2-4136-ae5a-6e1168b7cd2e",
            "name": "Product 1510",
            "sku": "sku 1511",
            "updated_datetime": "2025-05-13T13:27:27.342699Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "order": {
        "id": "f7dd0972-1d41-4c91-b864-f2424dc17ebb",
        "order_number": "SO-152",
        "status": "Pending",
        "total": "320.00"
      },
      "owner": {
        "banned": false,
        "email": "owner-2153@example.com",
        "full_name": "FirstName4186 LastName4187",
        "id": "00000000-0000-0000-0000-00000126e3ad",
        "role": {
          "id": "00000000-0000-0000-0000-0000012522c2",
          "name": "Admin 2096"
        }
      },
      "paid_amount": "0.0",
      "status": "FULLY_PAID",
      "total": "32.00",
      "updated_datetime": "2025-05-13T13:27:27.481357Z"
    }
  ]
}

GET /invoices/:id returns cost/returned_quantity data for invoice items

GET /public/v1/invoices
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NDUsImlhdCI6MTc0NzE0Mjg0NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNTNiNjRlNGItNmVkMS00YzI5LWI3OGYtNmQ3NWQwMjJiMWI5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjU2OTAiLCJ0eXAiOiJhY2Nlc3MifQ.6jFYWrtkb-afVieu-1yj71Ky8zBA8kNj9VL7JLWG25o

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 725f5ca0ccd080000000000000000001-d3a2d391ef25c30e-0

{
  "data": [
    {
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081ee90",
        "name": "Company 1531",
        "updated_datetime": "2025-05-13T13:27:25.921345Z"
      },
      "creator": {
        "banned": false,
        "email": "owner-2034@example.com",
        "full_name": "FirstName3950 LastName3951",
        "id": "00000000-0000-0000-0000-00000126e333",
        "role": {
          "id": "00000000-0000-0000-0000-00000125223e",
          "name": "Admin 1967"
        }
      },
      "custom_data": [],
      "due_datetime": "2025-05-13T13:27:26.224335Z",
      "id": "00000000-0000-0000-0000-00000007101c",
      "inserted_datetime": "2025-05-13T13:27:26.225701Z",
      "invoice_datetime": "2025-05-13T13:27:26.224333Z",
      "invoice_number": "Invoice #47",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5f3",
            "name": "B1407"
          },
          "id": "00000000-0000-0000-0000-00000008bff3",
          "order_item_id": "e064d02a-6d3d-4770-92d2-95ad6b3ac787",
          "package": null,
          "price": "939166.000000000",
          "product": {
            "id": "a3f06aef-ca0e-43ea-8411-a2c302fe4273",
            "name": "Product 1403",
            "sku": "sku 1404",
            "updated_datetime": "2025-05-13T13:27:25.829133Z"
          },
          "quantity": "1.000000000",
          "returned_quantity": "1",
          "total_cost_actual": "10.026",
          "total_cost_default": "5"
        }
      ],
      "order": {
        "id": "13992399-133a-4e96-b5a3-6760dc3313d2",
        "order_number": "SO-0000001",
        "status": "Processing",
        "total": "1878332.00"
      },
      "owner": {
        "banned": false,
        "email": "owner-2034@example.com",
        "full_name": "FirstName3950 LastName3951",
        "id": "00000000-0000-0000-0000-00000126e333",
        "role": {
          "id": "00000000-0000-0000-0000-00000125223e",
          "name": "Admin 1967"
        }
      },
      "paid_amount": "0.0",
      "status": "NOT_PAID",
      "total": "32.00",
      "updated_datetime": "2025-05-13T13:27:26.225701Z"
    }
  ]
}

Get invoices sorted by Invoice Date descendingly date and filtered by various attributes

Note: The page size for this endpoint is 500 invoices per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/invoices

Parameters

Parameter	Description	In	Type	Required	Example
due_datetime	Filter invoices by the due datetime	query	string	false	,2022-07-10T00:00:00Z
inserted_datetime	Filter invoices by their creation datetime	query	string	false	2022-07-10T00:00:00Z,2022-07-11T00:00:00Z
invoice_datetime	Filter invoices by the invoice datetime	query	string	false	2022-07-10T00:00:00Z,
invoice_number	Filter invoices by whether their invoice number contains the given string	query	string	false	001
order_id	Filter invoices by order IDs	query	array	false	["67ae9080-8dc2-4ab7-9704-19673f4d9f21","213c7080-8dc2-4ab7-9704-19673f4d9f22"]
page	Pagination information	body	Page	false
status	Filter invoices by their status. Accepted values are "Not Paid", "Over Paid", "Fully Paid" and "Partially Paid".	query	array	false	["Not Paid","Over Paid"]
updated_datetime	Filter invoices by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of invoices	Invoices

Insert a payment for an invoice

POST /invoices/:id/payments can create a payment for an invoice with both quickbooks id and name

POST /public/v1/invoices/00000000-0000-0000-0000-000000071057/payments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NjMsImlhdCI6MTc0NzE0Mjg2MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGQ5MzkzY2QtZmRmMS00MjcyLWE4NjgtOGMxYzQxMzQ1NjliIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODYyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjg2NzIiLCJ0eXAiOiJhY2Nlc3MifQ.kiKoWRpFJ6pef-FANyCnhisOpgAKopBxuiG_ARSFrOQ

{
  "amount": 100.01,
  "description": "Payment for invoice",
  "payment_datetime": "2020-01-01T00:00:00.000000Z",
  "payment_method_id": "00000000-0000-0000-0000-000000018d31",
  "quickbooks_deposit_account_id": "QBD-123"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 423c02a1c0acd4000000000000000001-3ebba8ea7769d1b5-0

{
  "data": {
    "amount": "100.01",
    "description": "Payment for invoice",
    "id": "00000000-0000-0000-0000-000000017214",
    "inserted_datetime": "2025-05-13T13:27:43.438084Z",
    "invoice_id": "00000000-0000-0000-0000-000000071057",
    "payment_date": "2020-01-01T00:00:00.000000Z",
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000018d31",
      "name": "Payment Method 0"
    },
    "payment_number": "PYT-0000001",
    "quickbooks_deposit_account_id": "QBD-123"
  }
}

POST /invoices/:id/payments can create a payment for an invoice with both quickbooks id and name

POST /public/v1/invoices/00000000-0000-0000-0000-000000071057/payments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NjMsImlhdCI6MTc0NzE0Mjg2MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGQ5MzkzY2QtZmRmMS00MjcyLWE4NjgtOGMxYzQxMzQ1NjliIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODYyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjg2NzIiLCJ0eXAiOiJhY2Nlc3MifQ.kiKoWRpFJ6pef-FANyCnhisOpgAKopBxuiG_ARSFrOQ

{
  "amount": 100.01,
  "description": "Payment for invoice",
  "payment_datetime": "2020-01-01T00:00:00.000000Z",
  "payment_method_id": "00000000-0000-0000-0000-000000018d31",
  "quickbooks_deposit_account_name": "QBD-NAME"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 423c02a1c0acd4000000000000000001-b2afe343c468d577-0

{
  "data": {
    "amount": "100.01",
    "description": "Payment for invoice",
    "id": "00000000-0000-0000-0000-000000017215",
    "inserted_datetime": "2025-05-13T13:27:43.660989Z",
    "invoice_id": "00000000-0000-0000-0000-000000071057",
    "payment_date": "2020-01-01T00:00:00.000000Z",
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000018d31",
      "name": "Payment Method 0"
    },
    "payment_number": "PYT-0000002",
    "quickbooks_deposit_account_id": "QBD-123"
  }
}

Request

POST /public/v1/invoices/{id}/payments

Parameters

Parameter	Description	In	Type	Required
payment_method_id	Payment method ID	query	string	true
amount	Amount of the payment. Will round to 2 decimal places	query	decimal	true
payment_datetime	Payment date	query	string	true
description	Description of the payment	query	string	true
quickbooks_deposit_account_id	Quickbooks deposit account ID. Cannot include both this and quickbooks_deposit_account_name. If user's company is integrated with Quickbooks, either this or quickbooks_deposit_account_name must be provided. Account type must be "Bank" or "Other Current Asset"	query	string	false
quickbooks_deposit_account_name	Quickbooks deposit account name. Cannot include both this and quickbooks_deposit_account_id. If user's company is integrated with Quickbooks, either this or quickbooks_deposit_account_id must be provided. Account type must be "Bank" or "Other Current Asset"	query	string	false

Responses

Status	Description	Schema
200	A single payment	InvoicePayment

Get an invoice

GET /invoices/:id returns the expected invoice

GET /public/v1/invoices/00000000-0000-0000-0000-000000071029
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NDksImlhdCI6MTc0NzE0Mjg0OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGQ1Zjk1ZjQtYTE1OS00YTBjLWIzODEtMzlmOTBjY2M1Mjg0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjYxOTQiLCJ0eXAiOiJhY2Nlc3MifQ.jPj_1jLkNnt7e4cDsFfyoQ27XK0kn9cnYvnXQWuHj4o

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 5778a9a3e03864000000000000000001-63bb57695727f927-0

{
  "data": {
    "charges": [],
    "company": {
      "id": "00000000-0000-0000-0000-00000081ef20",
      "name": "Company 1882",
      "updated_datetime": "2025-05-13T13:27:29.104576Z"
    },
    "creator": {
      "banned": false,
      "email": "owner-2496@example.com",
      "full_name": "FirstName4848 LastName4849",
      "id": "00000000-0000-0000-0000-00000126e4fa",
      "role": {
        "id": "00000000-0000-0000-0000-00000125241f",
        "name": "Admin 2441"
      }
    },
    "custom_data": [
      {
        "id": 68719,
        "name": "Custom Field 15",
        "value": "Custom Field Value 1"
      }
    ],
    "due_datetime": "2025-05-13T13:27:29.268676Z",
    "id": "00000000-0000-0000-0000-000000071029",
    "inserted_datetime": "2025-05-13T13:27:29.270307Z",
    "invoice_datetime": "2025-05-13T13:27:29.268673Z",
    "invoice_number": "Invoice #59",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd64c",
          "name": "B1712"
        },
        "id": "00000000-0000-0000-0000-00000008c000",
        "order_item_id": "4138ed64-30d8-4dc8-84b9-f641c00c1ce1",
        "package": null,
        "price": "10.000000000",
        "product": {
          "id": "c49f35bf-f9ec-4ad9-9455-f1ec7947b69d",
          "name": "Product 1710",
          "sku": "sku 1711",
          "updated_datetime": "2025-05-13T13:27:29.134140Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd64e",
          "name": "B1718"
        },
        "id": "00000000-0000-0000-0000-00000008c001",
        "order_item_id": "79443cbf-55af-4ef1-a5cc-3eefbeb6fb8c",
        "package": null,
        "price": "10.000000000",
        "product": {
          "id": "98d40c7f-f7b6-4b80-b62e-9c5bb3bf9cda",
          "name": "Product 1716",
          "sku": "sku 1717",
          "updated_datetime": "2025-05-13T13:27:29.160538Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "order": {
      "id": "458b7d06-cea1-4aaf-93b8-a760307897ba",
      "order_number": "SO-163",
      "status": "Pending",
      "total": "320.00"
    },
    "owner": {
      "banned": false,
      "email": "owner-2496@example.com",
      "full_name": "FirstName4848 LastName4849",
      "id": "00000000-0000-0000-0000-00000126e4fa",
      "role": {
        "id": "00000000-0000-0000-0000-00000125241f",
        "name": "Admin 2441"
      }
    },
    "paid_amount": "0.0",
    "status": "NOT_PAID",
    "total": "32.00",
    "updated_datetime": "2025-05-13T13:27:29.270307Z"
  }
}

Get a single invoice given the ID

Request

GET /public/v1/invoices/{id}

Parameters

Parameter	Description	In	Type	Required	Default	Example
id	Unique ID for an invoice	path	string	true

Responses

Status	Description	Schema
200	An invoice	Invoice

Upsert an invoice

POST /invoices creates an invoice

POST /public/v1/invoices
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTAsImlhdCI6MTc0NzE0Mjg1MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNWEwYzEwYmQtMWY3ZC00ZTQ2LWI3NmEtYzhhYWFjMWQ5ZWI4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjY1MDYiLCJ0eXAiOiJhY2Nlc3MifQ.BGwl9znFAoZ6Fa47cwiRQgYkpJaEwm0O5cE1EYSWQv4

{
  "billing_location_id": "00000000-0000-0000-0000-00000059ba6e",
  "charges": [
    {
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    },
    {
      "name": "C2",
      "price": "-5.0000",
      "type": "DISCOUNT",
      "unit_type": "PRICE"
    }
  ],
  "due_datetime": "2020-01-30T00:00:01.000000Z",
  "invoice_datetime": "2020-01-01T00:00:00.000000Z",
  "items": [
    {
      "order_item_id": "c9e74547-4d01-4cf1-9d71-cf05f5fb0ac9",
      "quantity": "1.000000000"
    },
    {
      "order_item_id": "f709ff31-3fe2-4af2-94c7-307d6ee46a57",
      "quantity": "10.000000000"
    }
  ],
  "order_id": "2d81417f-e1cb-4da8-935c-20f756aeeb11"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 90911c13cbb6a0000000000000000001-d1a74dbb89f09ac1-0

{
  "data": {
    "charges": [
      {
        "id": "5321f8fc-b921-487c-8cd5-b54f459161ff",
        "name": "C1",
        "percent": "10.0000",
        "price": "5.30",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "4b3276e0-5288-41c5-8882-2dadffa27627",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-00000081ef7d",
      "name": "Company 2059",
      "updated_datetime": "2025-05-13T13:27:30.408517Z"
    },
    "creator": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126e62a",
      "role": {
        "id": "00000000-0000-0000-0000-000001252551",
        "name": "Admin 2745"
      }
    },
    "custom_data": [],
    "due_datetime": "2020-01-30T00:00:01.000000Z",
    "id": "00000000-0000-0000-0000-000000071032",
    "inserted_datetime": "2025-05-13T13:27:30.680924Z",
    "invoice_datetime": "2020-01-01T00:00:00.000000Z",
    "invoice_number": "INV-0000001",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd687",
          "name": "B1"
        },
        "id": "00000000-0000-0000-0000-00000008c007",
        "order_item_id": "c9e74547-4d01-4cf1-9d71-cf05f5fb0ac9",
        "package": null,
        "price": "3.000000000",
        "product": {
          "id": "de38b6e4-0c62-428b-8378-b3d8bc97bb28",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:30.546701Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd688",
          "name": "B2"
        },
        "id": "00000000-0000-0000-0000-00000008c008",
        "order_item_id": "f709ff31-3fe2-4af2-94c7-307d6ee46a57",
        "package": null,
        "price": "5.000000000",
        "product": {
          "id": "fe279f9d-4b3f-45df-99e9-ba8ef021c087",
          "name": "P2",
          "sku": "SKU2",
          "updated_datetime": "2025-05-13T13:27:30.569811Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "order": {
      "id": "2d81417f-e1cb-4da8-935c-20f756aeeb11",
      "order_number": "SO-183",
      "status": "Processing",
      "total": "0.00"
    },
    "owner": null,
    "paid_amount": "0.0",
    "status": "NOT_PAID",
    "total": "53.30",
    "updated_datetime": "2025-05-13T13:27:30.722544Z"
  }
}

POST /invoices updates an invoice

POST /public/v1/invoices
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NjAsImlhdCI6MTc0NzE0Mjg2MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMmIwYmE3N2QtZjkwMC00NzZkLTk2Y2MtMDA1OTVhYmM1ZWRjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODU5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjgxNDMiLCJ0eXAiOiJhY2Nlc3MifQ.xAOmibBA39unBlFwWW1ZFwMvR9H0LI7dAJEDLS7785Q

{
  "billing_location_id": "00000000-0000-0000-0000-00000059bc37",
  "charges": [
    {
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    },
    {
      "name": "C2",
      "price": "-5.0000",
      "type": "DISCOUNT",
      "unit_type": "PRICE"
    }
  ],
  "due_datetime": "2020-01-30T00:00:01.000000Z",
  "invoice_datetime": "2020-01-01T00:00:00.000000Z",
  "items": [
    {
      "order_item_id": "dcc3e4a1-7455-4b91-ac1d-4692b7850db6",
      "quantity": "1.000000000"
    },
    {
      "order_item_id": "de280507-a9c9-4980-a314-061fa57be089",
      "quantity": "10.000000000"
    }
  ],
  "order_id": "d827c6f4-558e-4e5a-bd24-5e19bd02c1bd"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 2e42ae5e79914c000000000000000001-b0bcebdb06cb518c-0

{
  "data": {
    "charges": [
      {
        "id": "54e3f63c-c34a-431a-9f80-90ac69128f9b",
        "name": "C1",
        "percent": "10.0000",
        "price": "5.30",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "6d2a64f2-e900-4966-91cc-ca4771caf261",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f1c7",
      "name": "Company 3270",
      "updated_datetime": "2025-05-13T13:27:40.737110Z"
    },
    "creator": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126ec8f",
      "role": {
        "id": "00000000-0000-0000-0000-000001252bcd",
        "name": "Admin 4396"
      }
    },
    "custom_data": [],
    "due_datetime": "2020-01-30T00:00:01.000000Z",
    "id": "00000000-0000-0000-0000-000000071047",
    "inserted_datetime": "2025-05-13T13:27:40.976192Z",
    "invoice_datetime": "2020-01-01T00:00:00.000000Z",
    "invoice_number": "INV-0000001",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd816",
          "name": "B1"
        },
        "id": "00000000-0000-0000-0000-00000008c030",
        "order_item_id": "dcc3e4a1-7455-4b91-ac1d-4692b7850db6",
        "package": null,
        "price": "3.000000000",
        "product": {
          "id": "4f067fbe-5902-4923-80f7-776491486da0",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:40.798739Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd818",
          "name": "B2"
        },
        "id": "00000000-0000-0000-0000-00000008c031",
        "order_item_id": "de280507-a9c9-4980-a314-061fa57be089",
        "package": null,
        "price": "5.000000000",
        "product": {
          "id": "af5ed9d8-5b0c-45b6-ac94-f6e800a63cee",
          "name": "P2",
          "sku": "SKU2",
          "updated_datetime": "2025-05-13T13:27:40.838377Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "order": {
      "id": "d827c6f4-558e-4e5a-bd24-5e19bd02c1bd",
      "order_number": "SO-232",
      "status": "Processing",
      "total": "0.00"
    },
    "owner": null,
    "paid_amount": "0.0",
    "status": "NOT_PAID",
    "total": "53.30",
    "updated_datetime": "2025-05-13T13:27:41.030337Z"
  }
}

POST /invoices updates an invoice

POST /public/v1/invoices
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NjAsImlhdCI6MTc0NzE0Mjg2MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMmIwYmE3N2QtZjkwMC00NzZkLTk2Y2MtMDA1OTVhYmM1ZWRjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODU5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjgxNDMiLCJ0eXAiOiJhY2Nlc3MifQ.xAOmibBA39unBlFwWW1ZFwMvR9H0LI7dAJEDLS7785Q

{
  "billing_location_id": "00000000-0000-0000-0000-00000059bc39",
  "charges": [
    {
      "id": "54e3f63c-c34a-431a-9f80-90ac69128f9b",
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    },
    {
      "name": "C3",
      "price": "-5.0000",
      "type": "DISCOUNT",
      "unit_type": "PRICE"
    }
  ],
  "due_datetime": "2020-01-28T00:00:01.000000Z",
  "id": "00000000-0000-0000-0000-000000071047",
  "invoice_datetime": "2020-01-02T00:00:00.000000Z",
  "items": [
    {
      "id": "00000000-0000-0000-0000-00000008c030",
      "order_item_id": "dcc3e4a1-7455-4b91-ac1d-4692b7850db6",
      "quantity": "1.000000000"
    },
    {
      "order_item_id": "de280507-a9c9-4980-a314-061fa57be089",
      "quantity": "8.000000000"
    }
  ],
  "order_id": "d827c6f4-558e-4e5a-bd24-5e19bd02c1bd"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 2e42ae5e79914c000000000000000001-ee52eb05dcf18feb-0

{
  "data": {
    "charges": [
      {
        "id": "54e3f63c-c34a-431a-9f80-90ac69128f9b",
        "name": "C1",
        "percent": "10.0000",
        "price": "4.30",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "aaa5655f-ff23-4efd-a353-a21ed00fe60c",
        "name": "C3",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f1c7",
      "name": "Company 3270",
      "updated_datetime": "2025-05-13T13:27:40.737110Z"
    },
    "creator": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126ec8f",
      "role": {
        "id": "00000000-0000-0000-0000-000001252bcd",
        "name": "Admin 4396"
      }
    },
    "custom_data": [],
    "due_datetime": "2020-01-28T00:00:01.000000Z",
    "id": "00000000-0000-0000-0000-000000071047",
    "inserted_datetime": "2025-05-13T13:27:40.976192Z",
    "invoice_datetime": "2020-01-02T00:00:00.000000Z",
    "invoice_number": "INV-0000001",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd816",
          "name": "B1"
        },
        "id": "00000000-0000-0000-0000-00000008c030",
        "order_item_id": "dcc3e4a1-7455-4b91-ac1d-4692b7850db6",
        "package": null,
        "price": "3.000000000",
        "product": {
          "id": "4f067fbe-5902-4923-80f7-776491486da0",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:40.798739Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd818",
          "name": "B2"
        },
        "id": "00000000-0000-0000-0000-00000008c032",
        "order_item_id": "de280507-a9c9-4980-a314-061fa57be089",
        "package": null,
        "price": "5.000000000",
        "product": {
          "id": "af5ed9d8-5b0c-45b6-ac94-f6e800a63cee",
          "name": "P2",
          "sku": "SKU2",
          "updated_datetime": "2025-05-13T13:27:40.838377Z"
        },
        "quantity": "8.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "order": {
      "id": "d827c6f4-558e-4e5a-bd24-5e19bd02c1bd",
      "order_number": "SO-232",
      "status": "Processing",
      "total": "0.00"
    },
    "owner": null,
    "paid_amount": "0.0",
    "status": "NOT_PAID",
    "total": "42.30",
    "updated_datetime": "2025-05-13T13:27:41.264597Z"
  }
}

POST /invoices reports various errors correctly on update

POST /public/v1/invoices
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NDYsImlhdCI6MTc0NzE0Mjg0NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjI5NTVmYzEtZjdlMC00ODYzLWE4ZDAtNzk4ZjBhOGQ4ZjYzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjU3NzMiLCJ0eXAiOiJhY2Nlc3MifQ.myYE8friNUly_M4dgIE0kzG4gSUf66ORXwyDtp7Rs8M

{
  "billing_location_id": "00000000-0000-0000-0000-00000059b9a7",
  "charges": [
    {
      "name": "C1",
      "percent": "-1000.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    }
  ],
  "due_datetime": "2020-01-30T00:00:01.000000Z",
  "id": "00000000-0000-0000-0000-00000007101d",
  "invoice_datetime": "2020-01-01T00:00:00.000000Z",
  "items": [
    {
      "order_item_id": "00000000-0000-0000-0000-000000000000",
      "quantity": "15.000"
    },
    {
      "order_item_id": "2bf66bb4-d4e3-4f19-a241-6d190981d7ce",
      "quantity": "19.000"
    }
  ],
  "order_id": "4f8002e5-2537-4e6a-9e62-c15dcaf5d075"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: bd958bbcd63d60000000000000000001-a0e58b710b8a8c21-0

{
  "errors": [
    {
      "context": {
        "id": "ff475d8d-dcf4-434c-935c-017fb9782c53"
      },
      "message": "Must be less than or equal to 100",
      "pointer": ["charges", 0, "percent"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Order item not found",
      "pointer": ["items", 2, "order_item_id"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Only 10 left uninvoiced",
      "pointer": ["items", 3, "quantity"],
      "section": "body"
    }
  ]
}

Upsert a single invoice. To update an existing invoice, pass in an existing invoice ID in the id field. When updating an invoice, you must pass in all fields (no sparse update currently supported). Any existing invoice item or charge you do not pass in to items and charges respectively will be deleted

Request

POST /public/v1/invoices

Parameters

Parameter	Description	In	Type	Required
due_datetime	The datetime at which the invoice is due	query	string	false
id	Unique ID for this invoice. If it exists, an update will be performed; otherwise, it will be used as the ID of a new invoice record	query	string	false
invoice_datetime	The datetime on which the invoice was placed	query	string	false
charges	The additional lines of Charge, Discount, or Tax added to this invoice	body	InvoiceChargesRequest	false
items	The invoice items present on this order	body	InvoiceItemsRequest	false
billing_location_id	The billing location's ID	query	string	false

Responses

Status	Description	Schema
200	A single invoice	Invoice

Location

Get locations

GET /public/v1/locations returns locations related to the company

GET /public/v1/locations
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI1OTcsImlhdCI6MTc0NzE0Mjk5NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiOTI4NzY2MmQtYTYwNy00ODU4LWFlMDQtMjhhM2M2ODhkYTQ5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyOTk2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNTI3MzMiLCJ0eXAiOiJhY2Nlc3MifQ.COr-73K2fdkHc7gH9bcRGOBT0wiJQMv1ShexoG1jYoo

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: d81c888bd29568000000000000000001-c12b8ba149d7a64b-0

{
  "data": [
    {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000ddc334",
      "id": "00000000-0000-0000-0000-00000059d8c5",
      "license": null,
      "license_id": null,
      "name": "Place 8569"
    },
    {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000ddc334",
      "id": "00000000-0000-0000-0000-00000059d8c6",
      "license": {
        "id": "00000000-0000-0000-0000-000000395339",
        "license_number": "CDPH-00006508"
      },
      "license_id": "00000000-0000-0000-0000-000000395339",
      "name": "Place 8570"
    }
  ]
}

Get locations sorted by their creation date and filtered by various attributes

Note: The page size for this endpoint is 1000 locations per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/locations

Parameters

Parameter	Description	In	Type	Required	Example
inserted_datetime	Filter locations by their creation datetime	query	string	false	2022-07-10T00:00:00Z,
page	Pagination information	body	Page	false
updated_datetime	Filter locations by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of locations	Locations

Order

Get orders

GET /public/v1/orders returns orders related to the company

GET /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0MzgsImlhdCI6MTc0NzE0MjgzOCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGJkYTczOTctYWIwMi00YmI2LThlYTItMjI2NTNjNmY3MzAyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODM3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjQ0MDMiLCJ0eXAiOiJhY2Nlc3MifQ.jaiHqIJhuzoHjX90CQnE9UVXPuzxhRe9Ni6Ck6k9s60

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: fc1b4edd59b278000000000000000001-2a88c18b0fd95f4c-0

{
  "data": [
    {
      "billing_location": {
        "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
        "company_id": "00000000-0000-0000-0000-000000dd7205",
        "id": "00000000-0000-0000-0000-00000059b789",
        "license_id": null,
        "name": "Place 158"
      },
      "charges": [
        {
          "id": "62c3c871-ce3e-4a4d-b0cb-b0e278f6e4bc",
          "name": "C1",
          "percent": "10.0000",
          "price": "1.00",
          "type": "CHARGE",
          "unit_type": "PERCENT"
        }
      ],
      "company": {
        "id": "00000000-0000-0000-0000-00000081ecc0",
        "name": "Company 627",
        "updated_datetime": "2030-11-01T00:00:00.000000Z"
      },
      "creator": {
        "banned": false,
        "email": "user1@a.com",
        "full_name": "John Foo",
        "id": "00000000-0000-0000-0000-00000126dd03",
        "role": {
          "id": "00000000-0000-0000-0000-000001251c06",
          "name": "Admin 403"
        }
      },
      "custom_data": [
        {
          "id": 68715,
          "name": "Custom Field 11",
          "value": "Custom Field Value 1"
        }
      ],
      "delivery_datetime": "2020-01-01T00:00:00.000000Z",
      "due_datetime": "2020-01-01T00:00:01.000000Z",
      "external_notes": null,
      "id": "bb1ba8b6-b9ce-4b68-9f6e-7d7a093affbf",
      "inserted_datetime": "2020-01-01T00:00:03.000000Z",
      "internal_notes": "Internal notes for this order",
      "items": [
        {
          "batch": {
            "batch_number": "UID1",
            "id": "00000000-0000-0000-0000-0000004fd4d1",
            "name": "B1"
          },
          "compliance_quantity": "10.0000",
          "id": "a7de7baa-953b-42c7-a903-3f1e423b9eaa",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd7205",
            "id": "00000000-0000-0000-0000-00000059b789",
            "license_id": null,
            "name": "Place 158"
          },
          "package": {
            "batch_number": "B1",
            "compliance_label": "ABCDEF012345670000000150",
            "id": "00000000-0000-0000-0000-0000001cd4b0",
            "metrc_label": "ABCDEF012345670000000150",
            "status": "active"
          },
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "fc13d9ad-26d4-4ad7-995d-758d5a5682c7",
            "name": "P1",
            "sku": "SKU1",
            "updated_datetime": "2023-11-02T00:00:00.000000Z"
          },
          "quantity": "1.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "leaflink_order_number": "7dfc7d66-b100-4486-95ee-a38e75fa8b01",
      "order_datetime": "2020-01-01T00:00:02.000000Z",
      "order_number": "SO-123",
      "owner": {
        "banned": false,
        "email": "user2@a.com",
        "full_name": "John Bar",
        "id": "00000000-0000-0000-0000-00000126ddf2",
        "role": {
          "id": "00000000-0000-0000-0000-000001251cf8",
          "name": "Admin 643"
        }
      },
      "shipping_location": {
        "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
        "company_id": "00000000-0000-0000-0000-000000dd7205",
        "id": "00000000-0000-0000-0000-00000059b789",
        "license_id": null,
        "name": "Place 158"
      },
      "status": "COMPLETED",
      "total": "11.00",
      "updated_datetime": "2020-01-01T00:00:04.000000Z"
    }
  ]
}

GET /public/v1/orders returns cost/returned_quantity data for order items

GET /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NjUsImlhdCI6MTc0NzE0Mjg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiM2MyYzhmZWUtZWE5OC00NjIzLWJhMzMtYzAwOWY0YjFhYzEzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjkwNDEiLCJ0eXAiOiJhY2Nlc3MifQ.u5MebZ8dF7Btbm9SU7AFAmtM8mgo24JtjqfJRN7vbjU

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: aa6b9edf27d460000000000000000001-d1b81c51a1ce3718-0

{
  "data": [
    {
      "billing_location": null,
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081f32c",
        "name": "Company 3984",
        "updated_datetime": "2025-05-13T13:27:45.433480Z"
      },
      "creator": {
        "banned": false,
        "email": "owner-5343@example.com",
        "full_name": "FirstName10500 LastName10501",
        "id": "00000000-0000-0000-0000-00000126f027",
        "role": {
          "id": "00000000-0000-0000-0000-000001252f76",
          "name": "Admin 5331"
        }
      },
      "custom_data": [],
      "delivery_datetime": null,
      "due_datetime": "2025-05-13T13:27:45.440326Z",
      "external_notes": null,
      "id": "7a97cb75-e352-4a98-881e-f6741d47af6b",
      "inserted_datetime": "2025-05-13T13:27:45.499193Z",
      "internal_notes": null,
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd8d2",
            "name": "B3954"
          },
          "compliance_quantity": null,
          "id": "e9a9aae5-84a7-4805-bd1c-a1101d925cfd",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd803c",
            "id": "00000000-0000-0000-0000-00000059bd5e",
            "license_id": null,
            "name": "Place 1630"
          },
          "package": null,
          "price": "373044.000000000",
          "price_base": "373044",
          "product": {
            "id": "0a8e5d53-c383-4112-a4a9-1111322d761d",
            "name": "Product 3952",
            "sku": "sku 3953",
            "updated_datetime": "2025-05-13T13:27:45.275057Z"
          },
          "quantity": "2.000000000",
          "returned_quantity": "2",
          "total_cost_actual": "20.052",
          "total_cost_default": "10"
        }
      ],
      "leaflink_order_number": null,
      "order_datetime": "2025-05-13T13:27:45.440329Z",
      "order_number": "SO-0000001",
      "owner": null,
      "shipping_location": null,
      "status": "PROCESSING",
      "total": "746088.00",
      "updated_datetime": "2025-05-13T13:27:45.499193Z"
    }
  ]
}

GET /public/v1/orders allows filtering by several statuses

GET /public/v1/orders?status[]=COMPLETED&status[]=CANCELED
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NDQsImlhdCI6MTc0NzE0Mjg0NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjZjMjNhNzQtOGU3MS00YWRkLTlkYWYtODU4NDM5YTIyNjIwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjU0ODQiLCJ0eXAiOiJhY2Nlc3MifQ.WZoUNkqULvbdyOjGBi1lL_eobbqJMqe6AhUC9GFQxTg

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 6938858de4109c000000000000000001-504f2ef0dbe57a17-0

{
  "data": [
    {
      "billing_location": null,
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081ee72",
        "name": "Company 1441",
        "updated_datetime": "2025-05-13T13:27:24.866902Z"
      },
      "creator": {
        "banned": false,
        "email": "owner-1875@example.com",
        "full_name": "FirstName3638 LastName3639",
        "id": "00000000-0000-0000-0000-00000126e292",
        "role": {
          "id": "00000000-0000-0000-0000-000001252195",
          "name": "Admin 1801"
        }
      },
      "custom_data": [],
      "delivery_datetime": null,
      "due_datetime": "2025-05-13T13:27:24.935515Z",
      "external_notes": null,
      "id": "57cc8fd9-fe6b-4a2e-a637-1aeaeeee908f",
      "inserted_datetime": "2025-05-13T13:27:24.937452Z",
      "internal_notes": null,
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5eb",
            "name": "B1375"
          },
          "compliance_quantity": null,
          "id": "3d8c66d0-f75c-4e53-984c-991b2d897f59",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "b008ef98-6d7b-46fd-9c5a-0ebdc74b9c76",
            "name": "Product 1373",
            "sku": "sku 1374",
            "updated_datetime": "2025-05-13T13:27:24.984002Z"
          },
          "quantity": "15.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5ec",
            "name": "B1378"
          },
          "compliance_quantity": null,
          "id": "b8c7acae-d0b8-4053-b1f9-1a95410ac47e",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "f41182de-b5e9-4c48-a4b8-c5d52a418979",
            "name": "Product 1376",
            "sku": "sku 1377",
            "updated_datetime": "2025-05-13T13:27:25.043631Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5ed",
            "name": "B1381"
          },
          "compliance_quantity": null,
          "id": "3f997411-8cdd-4b95-8d13-408fef5bfc02",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "fa0fef5f-9538-420e-892d-57cabe8160ba",
            "name": "Product 1379",
            "sku": "sku 1380",
            "updated_datetime": "2025-05-13T13:27:25.087856Z"
          },
          "quantity": "5.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5ee",
            "name": "B1384"
          },
          "compliance_quantity": null,
          "id": "9a729b0a-a121-4c63-b54e-25b4d4b89616",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "2ba16008-3089-4cb5-81f4-22bd73843b16",
            "name": "Product 1382",
            "sku": "sku 1383",
            "updated_datetime": "2025-05-13T13:27:25.125806Z"
          },
          "quantity": "2.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "leaflink_order_number": null,
      "order_datetime": "2020-01-01T12:30:00.000000Z",
      "order_number": "SO-140",
      "owner": {
        "banned": false,
        "email": "owner-1875@example.com",
        "full_name": "FirstName3638 LastName3639",
        "id": "00000000-0000-0000-0000-00000126e292",
        "role": {
          "id": "00000000-0000-0000-0000-000001252195",
          "name": "Admin 1801"
        }
      },
      "shipping_location": null,
      "status": "CANCELED",
      "total": "320.00",
      "updated_datetime": "2025-05-13T13:27:25.194992Z"
    },
    {
      "billing_location": null,
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081ee69",
        "name": "Company 1409",
        "updated_datetime": "2025-05-13T13:27:24.636056Z"
      },
      "creator": {
        "banned": false,
        "email": "owner-1831@example.com",
        "full_name": "FirstName3550 LastName3551",
        "id": "00000000-0000-0000-0000-00000126e266",
        "role": {
          "id": "00000000-0000-0000-0000-000001252168",
          "name": "Admin 1757"
        }
      },
      "custom_data": [],
      "delivery_datetime": null,
      "due_datetime": "2025-05-13T13:27:24.671792Z",
      "external_notes": null,
      "id": "3042396d-776b-4253-8af5-2497ebdf84cb",
      "inserted_datetime": "2025-05-13T13:27:24.673038Z",
      "internal_notes": null,
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5e3",
            "name": "B1351"
          },
          "compliance_quantity": null,
          "id": "d66a79a8-b945-4f1e-99b1-debb6be6d3be",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "7fdf57bc-3b53-4b5f-bbf0-371c74711c04",
            "name": "Product 1349",
            "sku": "sku 1350",
            "updated_datetime": "2025-05-13T13:27:24.698303Z"
          },
          "quantity": "15.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5e4",
            "name": "B1354"
          },
          "compliance_quantity": null,
          "id": "9c870e72-6baf-40ba-877d-5fbc6657786b",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "42ac4749-69ab-4154-b9a3-e88cab76d400",
            "name": "Product 1352",
            "sku": "sku 1353",
            "updated_datetime": "2025-05-13T13:27:24.724918Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5e6",
            "name": "B1360"
          },
          "compliance_quantity": null,
          "id": "bb747b25-5a01-43bc-9a57-5ae8fa1eda69",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "7320d3da-b833-4308-b41e-fc3557fab5b9",
            "name": "Product 1358",
            "sku": "sku 1359",
            "updated_datetime": "2025-05-13T13:27:24.751987Z"
          },
          "quantity": "5.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5e7",
            "name": "B1363"
          },
          "compliance_quantity": null,
          "id": "6f90ea87-ab7c-44cf-a80c-bc8711e13cb7",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "84dd735d-36a9-44ff-99cc-ef225b0cdffe",
            "name": "Product 1361",
            "sku": "sku 1362",
            "updated_datetime": "2025-05-13T13:27:24.778579Z"
          },
          "quantity": "2.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "leaflink_order_number": null,
      "order_datetime": "2020-01-01T12:20:00.000000Z",
      "order_number": "SO-139",
      "owner": {
        "banned": false,
        "email": "owner-1831@example.com",
        "full_name": "FirstName3550 LastName3551",
        "id": "00000000-0000-0000-0000-00000126e266",
        "role": {
          "id": "00000000-0000-0000-0000-000001252168",
          "name": "Admin 1757"
        }
      },
      "shipping_location": null,
      "status": "COMPLETED",
      "total": "320.00",
      "updated_datetime": "2025-05-13T13:27:24.842587Z"
    },
    {
      "billing_location": null,
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081ee55",
        "name": "Company 1364",
        "updated_datetime": "2025-05-13T13:27:24.175412Z"
      },
      "creator": {
        "banned": false,
        "email": "owner-1775@example.com",
        "full_name": "FirstName3438 LastName3439",
        "id": "00000000-0000-0000-0000-00000126e22e",
        "role": {
          "id": "00000000-0000-0000-0000-000001252131",
          "name": "Admin 1703"
        }
      },
      "custom_data": [],
      "delivery_datetime": null,
      "due_datetime": "2025-05-13T13:27:24.208652Z",
      "external_notes": null,
      "id": "f1e4472b-0e12-4e3d-960b-5c9dad40db90",
      "inserted_datetime": "2025-05-13T13:27:24.209652Z",
      "internal_notes": null,
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5d4",
            "name": "B1304"
          },
          "compliance_quantity": null,
          "id": "fe2e7956-588e-435a-8a2c-4e340e88ac9b",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "146947c4-b39c-4236-ba6f-93754e597b1e",
            "name": "Product 1302",
            "sku": "sku 1303",
            "updated_datetime": "2025-05-13T13:27:24.229345Z"
          },
          "quantity": "15.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5d5",
            "name": "B1309"
          },
          "compliance_quantity": null,
          "id": "31f8bd46-b147-446e-96ba-d62910de1b3e",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "e8b02975-5d56-42fd-974b-3dfce1d18265",
            "name": "Product 1307",
            "sku": "sku 1308",
            "updated_datetime": "2025-05-13T13:27:24.250669Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5d7",
            "name": "B1313"
          },
          "compliance_quantity": null,
          "id": "b21fbb46-68ab-469a-94dc-aa609c43f80b",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "951d6357-9c70-4ced-961e-520ac77ef88f",
            "name": "Product 1310",
            "sku": "sku 1311",
            "updated_datetime": "2025-05-13T13:27:24.270142Z"
          },
          "quantity": "5.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fd5d8",
            "name": "B1316"
          },
          "compliance_quantity": null,
          "id": "c07d34f5-dcea-4567-a16a-5a8090225a7a",
          "location": null,
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "78d554fc-72f7-4752-a6fb-b998d5eadc7c",
            "name": "Product 1314",
            "sku": "sku 1315",
            "updated_datetime": "2025-05-13T13:27:24.291747Z"
          },
          "quantity": "2.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "leaflink_order_number": null,
      "order_datetime": "2020-01-01T12:00:00.000000Z",
      "order_number": "SO-135",
      "owner": {
        "banned": false,
        "email": "owner-1775@example.com",
        "full_name": "FirstName3438 LastName3439",
        "id": "00000000-0000-0000-0000-00000126e22e",
        "role": {
          "id": "00000000-0000-0000-0000-000001252131",
          "name": "Admin 1703"
        }
      },
      "shipping_location": null,
      "status": "COMPLETED",
      "total": "320.00",
      "updated_datetime": "2025-05-13T13:27:24.342359Z"
    }
  ]
}

Get orders sorted by Order Date descendingly date and filtered by various attributes

Note: The page size for this endpoint is 500 orders per page.

Request

GET /public/v1/orders

Parameters

Parameter	Description	In	Type	Required	Example
delivery_datetime	Filter orders by the delivery datetime	query	string	false	2022-07-10T00:00:00Z,
due_datetime	Filter orders by the due datetime	query	string	false	,2022-07-10T00:00:00Z
inserted_datetime	Filter orders by their creation datetime	query	string	false	2022-07-10T00:00:00Z,
order_datetime	Filter orders by the order datetime	query	string	false	2022-07-10T00:00:00Z,2022-07-11T00:00:00Z
page	Pagination information	body	Page	false
status	Filter orders by their status. Accepted values are "PENDING", "PROCESSING", "READY_TO_SHIP", "DELIVERING", "DELIVERED", "COMPLETED" and "CANCELED".	query	array	false	["PENDING","PROCESSING"]
updated_datetime	Filter orders by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of orders	Orders

Get an order

GET /orders/:id returns the expected order

GET /public/v1/orders/e8ea1b5f-3f45-4447-b4f3-e29cf52068e6
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTcsImlhdCI6MTc0NzE0Mjg1NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMzFlNjRkYmQtNjNlNC00N2Q1LTg5YzEtZTVlOTAzOTFhODhhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODU2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjc0ODMiLCJ0eXAiOiJhY2Nlc3MifQ.NKOCD89PZaAgDbftTuqJzz4qy4kPQw7Zb8WUMSRMAOk

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 92b57bfe4a29f8000000000000000001-0c1d588975cea0d2-0

{
  "data": {
    "billing_location": null,
    "charges": [],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f0c7",
      "name": "Company 2745",
      "updated_datetime": "2025-05-13T13:27:37.043762Z"
    },
    "creator": {
      "banned": false,
      "email": "owner-3772@example.com",
      "full_name": "FirstName7386 LastName7387",
      "id": "00000000-0000-0000-0000-00000126e9fe",
      "role": {
        "id": "00000000-0000-0000-0000-00000125292a",
        "name": "Admin 3724"
      }
    },
    "custom_data": [
      {
        "id": 68726,
        "name": "Custom Field 22",
        "value": "Custom Field Value 1"
      }
    ],
    "delivery_datetime": null,
    "due_datetime": "2025-05-13T13:27:37.126988Z",
    "external_notes": null,
    "id": "e8ea1b5f-3f45-4447-b4f3-e29cf52068e6",
    "inserted_datetime": "2025-05-13T13:27:37.128430Z",
    "internal_notes": null,
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd774",
          "name": "B2692"
        },
        "compliance_quantity": null,
        "id": "46b32fc7-9268-4d49-a71c-af01e552a284",
        "location": null,
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "1530e022-702e-417a-92ec-31a46718dc52",
          "name": "Product 2690",
          "sku": "sku 2691",
          "updated_datetime": "2025-05-13T13:27:37.168561Z"
        },
        "quantity": "15.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd776",
          "name": "B2702"
        },
        "compliance_quantity": null,
        "id": "814f1ed7-ba1e-4f14-95de-0d96f0fa02b5",
        "location": null,
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "b49d9c82-d064-4b5c-931a-c3c17cf4261c",
          "name": "Product 2700",
          "sku": "sku 2701",
          "updated_datetime": "2025-05-13T13:27:37.231138Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd777",
          "name": "B2705"
        },
        "compliance_quantity": null,
        "id": "98aa85c8-f999-4226-b1d3-5a75daf9ecfe",
        "location": null,
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "56f6c199-f9e4-4b9d-b827-2cf805f51f4d",
          "name": "Product 2703",
          "sku": "sku 2704",
          "updated_datetime": "2025-05-13T13:27:37.286310Z"
        },
        "quantity": "5.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd779",
          "name": "B2711"
        },
        "compliance_quantity": null,
        "id": "803d4fe2-9ead-477e-a2f5-255f37ba4583",
        "location": null,
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "b1ce2783-c6f3-46a3-952a-2b3cada2a1d3",
          "name": "Product 2709",
          "sku": "sku 2710",
          "updated_datetime": "2025-05-13T13:27:37.356167Z"
        },
        "quantity": "2.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2025-05-13T13:27:37.126987Z",
    "order_number": "SO-212",
    "owner": {
      "banned": false,
      "email": "owner-3772@example.com",
      "full_name": "FirstName7386 LastName7387",
      "id": "00000000-0000-0000-0000-00000126e9fe",
      "role": {
        "id": "00000000-0000-0000-0000-00000125292a",
        "name": "Admin 3724"
      }
    },
    "shipping_location": null,
    "status": "COMPLETED",
    "total": "320.00",
    "updated_datetime": "2025-05-13T13:27:37.470637Z"
  }
}

GET /orders/:id returns cost data for order items

GET /public/v1/orders/efbd17ed-7119-422c-a6e9-ea7bc923c92b
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTAsImlhdCI6MTc0NzE0Mjg1MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYzRkZTRjNTQtZWQ0ZS00YzMyLTk4MjktNzc5MWJkNjQ2NjVmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjY1NDEiLCJ0eXAiOiJhY2Nlc3MifQ.s0LrkrOd_TGNgpyzkRd59UEvZWQgdNAQdyTwmR8c_dc

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: c4d5c375760748000000000000000001-1f0eba5b53b748d6-0

{
  "data": {
    "billing_location": null,
    "charges": [],
    "company": {
      "id": "00000000-0000-0000-0000-00000081ef8c",
      "name": "Company 2096",
      "updated_datetime": "2025-05-13T13:27:30.719054Z"
    },
    "creator": {
      "banned": false,
      "email": "owner-2863@example.com",
      "full_name": "FirstName5568 LastName5569",
      "id": "00000000-0000-0000-0000-00000126e666",
      "role": {
        "id": "00000000-0000-0000-0000-00000125258e",
        "name": "Admin 2805"
      }
    },
    "custom_data": [],
    "delivery_datetime": null,
    "due_datetime": "2025-05-13T13:27:30.720617Z",
    "external_notes": null,
    "id": "efbd17ed-7119-422c-a6e9-ea7bc923c92b",
    "inserted_datetime": "2025-05-13T13:27:30.746882Z",
    "internal_notes": null,
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd689",
          "name": "B1923"
        },
        "compliance_quantity": null,
        "id": "44b8bba0-50b7-46a4-99cb-60cc7848f8d8",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd78dc",
          "id": "00000000-0000-0000-0000-00000059ba74",
          "license_id": null,
          "name": "Place 905"
        },
        "package": null,
        "price": "508250.000000000",
        "price_base": "508250",
        "product": {
          "id": "f3d51b3b-7c52-4416-9078-20b88bc1a26b",
          "name": "Product 1920",
          "sku": "sku 1921",
          "updated_datetime": "2025-05-13T13:27:30.595257Z"
        },
        "quantity": "2.000000000",
        "returned_quantity": "0",
        "total_cost_actual": "20.052",
        "total_cost_default": "10"
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2025-05-13T13:27:30.720620Z",
    "order_number": "SO-0000001",
    "owner": null,
    "shipping_location": null,
    "status": "PROCESSING",
    "total": "1016500.00",
    "updated_datetime": "2025-05-13T13:27:30.746882Z"
  }
}

Get a single order given the ID. Note: This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/orders/{id}

Parameters

Parameter	Description	In	Type	Required	Default	Example
id	Order ID	path	string	true

Responses

Status	Description	Schema
200	A single order	Order

Upsert an order

POST /public/v1/orders creates an order (with product-tracked item)

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTAsImlhdCI6MTc0NzE0Mjg1MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMzMxZmM1MWUtYzRmNC00OGJmLWFhOTgtMjVhNzM4N2RiNGM2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjY0NjAiLCJ0eXAiOiJhY2Nlc3MifQ.KVigf-4SgJBrMPmR6FPS55rMbUDqMdVWejHOYKE2ySc

{
  "billing_location_id": "00000000-0000-0000-0000-00000059ba65",
  "charges": [
    {
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    },
    {
      "name": "C2",
      "price": "-5.0000",
      "type": "DISCOUNT",
      "unit_type": "PRICE"
    }
  ],
  "company_id": "00000000-0000-0000-0000-00000081ef71",
  "delivery_datetime": "2020-01-01T00:00:00.000000Z",
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "external_notes": "Thank you for ordering!",
  "internal_notes": "Internal notes for this order",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059ba65",
      "price_base": "10.000000000",
      "product_id": "cfef0d8d-7bca-40ee-9212-9ea8b6e756a7",
      "quantity": "1.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "owner_id": "00000000-0000-0000-0000-00000126e5fc",
  "shipping_location_id": "00000000-0000-0000-0000-00000059ba65",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: fa51532ad86338000000000000000001-4f10d16555f415c5-0

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd78aa",
      "id": "00000000-0000-0000-0000-00000059ba65",
      "license_id": "00000000-0000-0000-0000-000000393e4e",
      "name": "Place 890"
    },
    "charges": [
      {
        "id": "f706d84e-c795-43ef-acc6-ccbd955b3389",
        "name": "C1",
        "percent": "10.0000",
        "price": "1.00",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "e71a626e-c6e4-4f36-9d08-008f6e58955e",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-00000081ef71",
      "name": "Company 2035",
      "updated_datetime": "2025-05-13T13:27:30.180893Z"
    },
    "creator": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126e5fc",
      "role": {
        "id": "00000000-0000-0000-0000-000001252525",
        "name": "Admin 2701"
      }
    },
    "custom_data": [
      {
        "id": 68721,
        "name": "Custom Field 17",
        "value": null
      }
    ],
    "delivery_datetime": "2020-01-01T00:00:00.000000Z",
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": "Thank you for ordering!",
    "id": "f980fe03-ca65-4c56-b71b-306ab0829642",
    "inserted_datetime": "2025-05-13T13:27:30.321438Z",
    "internal_notes": "Internal notes for this order",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd67d",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "9d731f54-c148-4e80-a609-a4f13331f041",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd78aa",
          "id": "00000000-0000-0000-0000-00000059ba65",
          "license_id": "00000000-0000-0000-0000-000000393e4e",
          "name": "Place 890"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "cfef0d8d-7bca-40ee-9212-9ea8b6e756a7",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:30.255472Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-0000001",
    "owner": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126e5fc",
      "role": {
        "id": "00000000-0000-0000-0000-000001252525",
        "name": "Admin 2701"
      }
    },
    "shipping_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd78aa",
      "id": "00000000-0000-0000-0000-00000059ba65",
      "license_id": "00000000-0000-0000-0000-000000393e4e",
      "name": "Place 890"
    },
    "status": "PROCESSING",
    "total": "6.00",
    "updated_datetime": "2025-05-13T13:27:30.378146Z"
  }
}

POST /public/v1/orders creates an order (with product-tracked item) for a Blaze retailer, fails if payment type not specified

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTEsImlhdCI6MTc0NzE0Mjg1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNDk2NWFlYjItOWQ2MC00NmQ4LTgyZWItZWEyYjA2YjU5YjkxIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjY2NTAiLCJ0eXAiOiJhY2Nlc3MifQ.BhqOXrQSIcUaYbqOFxFRrHZtkreXdSIx5gVtNgnH4Jo

{
  "billing_location_id": "00000000-0000-0000-0000-00000059ba8c",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081ef9f",
  "delivery_datetime": "2020-01-01T00:00:00.000000Z",
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059ba8c",
      "price_base": "10.000000000",
      "product_id": "4dc6c821-7f0c-4ebd-8784-49b5a4804363",
      "quantity": "1.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "shipping_location_id": "00000000-0000-0000-0000-00000059ba8c",
  "status": "PROCESSING"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 0d1016bcde900a800000000000000001-c9e33bd8eea04194-0

{
  "errors": [
    {
      "context": {
        "id": "4e77e9c1-30c6-4044-ab0b-8bf640dee52e"
      },
      "message": "can't be blank",
      "pointer": ["blaze_payment_type"],
      "section": "body"
    }
  ]
}

POST /public/v1/orders creates an order (with product-tracked item) for a Blaze retailer, fails if payment type not specified

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTEsImlhdCI6MTc0NzE0Mjg1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNDk2NWFlYjItOWQ2MC00NmQ4LTgyZWItZWEyYjA2YjU5YjkxIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjY2NTAiLCJ0eXAiOiJhY2Nlc3MifQ.BhqOXrQSIcUaYbqOFxFRrHZtkreXdSIx5gVtNgnH4Jo

{
  "billing_location_id": "00000000-0000-0000-0000-00000059ba8c",
  "blaze_payment_type": "CASH",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081ef9f",
  "delivery_datetime": "2020-01-01T00:00:00.000000Z",
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059ba8c",
      "price_base": "10.000000000",
      "product_id": "4dc6c821-7f0c-4ebd-8784-49b5a4804363",
      "quantity": "1.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "shipping_location_id": "00000000-0000-0000-0000-00000059ba8c",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 0d1016bcde900a800000000000000001-32eb5d7997e62670-0

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd7910",
      "id": "00000000-0000-0000-0000-00000059ba8c",
      "license_id": "00000000-0000-0000-0000-000000393e76",
      "name": "Place 929"
    },
    "charges": [],
    "company": {
      "id": "00000000-0000-0000-0000-00000081ef9f",
      "name": "Company 2139",
      "updated_datetime": "2025-05-13T13:27:31.140118Z"
    },
    "creator": {
      "banned": false,
      "email": "owner-2947@example.com",
      "full_name": "FirstName5732 LastName5735",
      "id": "00000000-0000-0000-0000-00000126e6ba",
      "role": {
        "id": "00000000-0000-0000-0000-0000012525e1",
        "name": "Admin 2889"
      }
    },
    "custom_data": [],
    "delivery_datetime": "2020-01-01T00:00:00.000000Z",
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": null,
    "id": "a2b5363d-ba80-4f90-9051-45c6fd5e9a15",
    "inserted_datetime": "2025-05-13T13:27:31.339844Z",
    "internal_notes": null,
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd6a1",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "fe9a0705-266b-4bca-aed2-8ad09ba1571b",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7910",
          "id": "00000000-0000-0000-0000-00000059ba8c",
          "license_id": "00000000-0000-0000-0000-000000393e76",
          "name": "Place 929"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "4dc6c821-7f0c-4ebd-8784-49b5a4804363",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:31.234617Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-0000001",
    "owner": null,
    "shipping_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd7910",
      "id": "00000000-0000-0000-0000-00000059ba8c",
      "license_id": "00000000-0000-0000-0000-000000393e76",
      "name": "Place 929"
    },
    "status": "PROCESSING",
    "total": "10.00",
    "updated_datetime": "2025-05-13T13:27:31.339844Z"
  }
}

POST /public/v1/orders applies the best fit price tier items to order items

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NjIsImlhdCI6MTc0NzE0Mjg2MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMmE2ZjBiMmEtMzJmMy00ZTIwLWEzZDktNmJmMDM0NmIxZjhmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODYxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjg0MDYiLCJ0eXAiOiJhY2Nlc3MifQ.2WNdtilbsxpcpCOJyw6SwDw8Tq1Ui8n7jRSwhiO3VYU

{
  "billing_location_id": "00000000-0000-0000-0000-00000059bc8c",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081f224",
  "delivery_datetime": "2020-01-01T00:00:00.000000Z",
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059bc8c",
      "position": 1,
      "price_base": "100.000000000",
      "product_id": "ff2a2bd2-e390-4bfc-83d4-0e155df75768",
      "quantity": "80.000000000"
    },
    {
      "location_id": "00000000-0000-0000-0000-00000059bc8c",
      "position": 2,
      "price_base": "200.000000000",
      "product_id": "ff2a2bd2-e390-4bfc-83d4-0e155df75768",
      "quantity": "10.000000000"
    },
    {
      "location_id": "00000000-0000-0000-0000-00000059bc8c",
      "position": 3,
      "price_base": "300.000000000",
      "product_id": "a440fe27-b861-42ff-a965-64223be85546",
      "quantity": "20.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "shipping_location_id": "00000000-0000-0000-0000-00000059bc8c",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 9dfaba09c1fbe8000000000000000001-92b8328293d38c6e-0

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd7e51",
      "id": "00000000-0000-0000-0000-00000059bc8c",
      "license_id": "00000000-0000-0000-0000-000000394052",
      "name": "Place 1428"
    },
    "charges": [],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f224",
      "name": "Company 3475",
      "updated_datetime": "2025-05-13T13:27:41.994277Z"
    },
    "creator": {
      "banned": false,
      "email": "owner-4689@example.com",
      "full_name": "FirstName9208 LastName9209",
      "id": "00000000-0000-0000-0000-00000126ed96",
      "role": {
        "id": "00000000-0000-0000-0000-000001252ce1",
        "name": "Admin 4672"
      }
    },
    "custom_data": [],
    "delivery_datetime": "2020-01-01T00:00:00.000000Z",
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": null,
    "id": "34823239-d09e-445a-8a2f-ddaef260533f",
    "inserted_datetime": "2025-05-13T13:27:42.355636Z",
    "internal_notes": null,
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd84c",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "3d95afb5-2b25-40c6-a71c-b1e20bc635b6",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7e51",
          "id": "00000000-0000-0000-0000-00000059bc8c",
          "license_id": "00000000-0000-0000-0000-000000394052",
          "name": "Place 1428"
        },
        "package": null,
        "price": "80.000000000",
        "price_base": "100.000000000",
        "product": {
          "id": "ff2a2bd2-e390-4bfc-83d4-0e155df75768",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:42.071069Z"
        },
        "quantity": "80.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd84c",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "5a8ec2ad-80a4-4d14-8d68-f1fb91d6cdbd",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7e51",
          "id": "00000000-0000-0000-0000-00000059bc8c",
          "license_id": "00000000-0000-0000-0000-000000394052",
          "name": "Place 1428"
        },
        "package": null,
        "price": "180.000000000",
        "price_base": "200.000000000",
        "product": {
          "id": "ff2a2bd2-e390-4bfc-83d4-0e155df75768",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:42.071069Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd84e",
          "name": "B2"
        },
        "compliance_quantity": null,
        "id": "90368a41-be51-4442-8db3-f9fb5ca5cd3b",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7e51",
          "id": "00000000-0000-0000-0000-00000059bc8c",
          "license_id": "00000000-0000-0000-0000-000000394052",
          "name": "Place 1428"
        },
        "package": null,
        "price": "270.000000000",
        "price_base": "300.000000000",
        "product": {
          "id": "a440fe27-b861-42ff-a965-64223be85546",
          "name": "P2",
          "sku": "SKU2",
          "updated_datetime": "2025-05-13T13:27:42.116766Z"
        },
        "quantity": "20.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-0000001",
    "owner": null,
    "shipping_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd7e51",
      "id": "00000000-0000-0000-0000-00000059bc8c",
      "license_id": "00000000-0000-0000-0000-000000394052",
      "name": "Place 1428"
    },
    "status": "PROCESSING",
    "total": "13600.00",
    "updated_datetime": "2025-05-13T13:27:42.433808Z"
  }
}

POST /public/v1/orders creates an order (with batch-tracked item)

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NjMsImlhdCI6MTc0NzE0Mjg2MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiNDk2NWYxNzgtZmJjMS00NWNlLWE3N2EtNDRiMjY3MzEyMTA2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODYyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjg2MTgiLCJ0eXAiOiJhY2Nlc3MifQ.YSX_5IfktHR9mJ45-iWEoR3tBZC07c6BSxhyJH3YaGI

{
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "items": [
    {
      "batch_id": "00000000-0000-0000-0000-0000004fd874",
      "location_id": "00000000-0000-0000-0000-00000059bcdc",
      "price_base": "10.000000000",
      "quantity": "1.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 2136472b2a907c000000000000000001-09733a3f29786e81-0

{
  "data": {
    "billing_location": null,
    "charges": [],
    "company": null,
    "creator": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126ee6a",
      "role": {
        "id": "00000000-0000-0000-0000-000001252db6",
        "name": "Admin 4885"
      }
    },
    "custom_data": [],
    "delivery_datetime": null,
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": null,
    "id": "c8036f44-c1fd-431f-8f26-e0c0472a0ec2",
    "inserted_datetime": "2025-05-13T13:27:43.154241Z",
    "internal_notes": null,
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd874",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "4f8da58a-68f0-44de-982c-57f869537dd6",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7ef9",
          "id": "00000000-0000-0000-0000-00000059bcdc",
          "license_id": "00000000-0000-0000-0000-00000039407b",
          "name": "Place 1504"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "d7d89508-89a3-4a9f-8ddb-21fabbcdd525",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:43.086989Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-0000001",
    "owner": null,
    "shipping_location": null,
    "status": "PROCESSING",
    "total": "10.00",
    "updated_datetime": "2025-05-13T13:27:43.154241Z"
  }
}

POST /public/v1/orders creates an order (with batch-tracked item without batch set)

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTYsImlhdCI6MTc0NzE0Mjg1NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZTYxMDBjN2EtNjM0MC00YTIwLTlkMWMtMzNhYThhNjA4NjM3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODU1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjc0MjgiLCJ0eXAiOiJhY2Nlc3MifQ.-x6N6PfvvpIn7qsph35GPzBxVukfr2f5cGEvzNWzd1M

{
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059bb54",
      "price_base": "10.000000000",
      "product_id": "8bec1ba0-e98f-4527-89d6-2de688c73d79",
      "quantity": "1.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 60b2564b9b6fe8000000000000000001-0b147ad5b5ed3f64-0

{
  "data": {
    "billing_location": null,
    "charges": [],
    "company": null,
    "creator": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126e9c4",
      "role": {
        "id": "00000000-0000-0000-0000-0000012528f0",
        "name": "Admin 3666"
      }
    },
    "custom_data": [],
    "delivery_datetime": null,
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": null,
    "id": "d4802cf2-616e-4d79-8320-b2754d9b2202",
    "inserted_datetime": "2025-05-13T13:27:36.692667Z",
    "internal_notes": null,
    "items": [
      {
        "batch": null,
        "compliance_quantity": null,
        "id": "c014e0a2-d8b8-4352-a6dd-f95f83a1619a",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7b45",
          "id": "00000000-0000-0000-0000-00000059bb54",
          "license_id": "00000000-0000-0000-0000-000000393f57",
          "name": "Place 1126"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "8bec1ba0-e98f-4527-89d6-2de688c73d79",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:36.640056Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-0000001",
    "owner": null,
    "shipping_location": null,
    "status": "PROCESSING",
    "total": "10.00",
    "updated_datetime": "2025-05-13T13:27:36.692667Z"
  }
}

POST /public/v1/orders creates an order (with package-tracked item)

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NDcsImlhdCI6MTc0NzE0Mjg0NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiN2Q0MWYxOGEtOGU5NC00ZmQwLWFhNmItODM0NmY2ZDllMDEyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjU4OTkiLCJ0eXAiOiJhY2Nlc3MifQ.M7eDnLvYoKcBgVfKQQoHXgj-IyBIARH9h8UxgHeKd5A

{
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "items": [
    {
      "compliance_quantity": "1.0000",
      "location_id": "00000000-0000-0000-0000-00000059b9c6",
      "package_id": "00000000-0000-0000-0000-0000001cd505",
      "price_base": "10.000000000",
      "quantity": "1.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 067b915461d47cc00000000000000001-b29a52e15f8269e5-0

{
  "data": {
    "billing_location": null,
    "charges": [],
    "company": null,
    "creator": {
      "banned": false,
      "email": "owner-2183@example.com",
      "full_name": "FirstName4245 LastName4246",
      "id": "00000000-0000-0000-0000-00000126e3cb",
      "role": {
        "id": "00000000-0000-0000-0000-0000012522e1",
        "name": "Admin 2127"
      }
    },
    "custom_data": [],
    "delivery_datetime": null,
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": null,
    "id": "57789cc5-4cc4-46a0-b54f-66a6d45dd074",
    "inserted_datetime": "2025-05-13T13:27:27.559579Z",
    "internal_notes": null,
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd615",
          "name": "B1"
        },
        "compliance_quantity": "1.0000",
        "id": "333b1ba2-f179-4cdb-bca7-023700da8500",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd772c",
          "id": "00000000-0000-0000-0000-00000059b9c6",
          "license_id": "00000000-0000-0000-0000-000000393dc9",
          "name": "Place 731"
        },
        "package": {
          "batch_number": "B1",
          "compliance_label": "ABCDEF012345670000000424",
          "id": "00000000-0000-0000-0000-0000001cd505",
          "metrc_label": "ABCDEF012345670000000424",
          "status": "selling"
        },
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "a2bda842-6341-4d24-8aae-cb590acc24c2",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:27.397263Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-0000001",
    "owner": null,
    "shipping_location": null,
    "status": "PROCESSING",
    "total": "10.00",
    "updated_datetime": "2025-05-13T13:27:27.559579Z"
  }
}

POST /public/v1/orders creates an order (with package-tracked item without package set)

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NDUsImlhdCI6MTc0NzE0Mjg0NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjlkMzM0NzMtNmYzNS00YzMxLTlhOWUtNTc5YTg5YmI3ZmY2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjU2ODYiLCJ0eXAiOiJhY2Nlc3MifQ.lfez_yc6j8_MGm8Pa5bN4zTppNkUnBJFQBwMYPGDx_o

{
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059b98a",
      "price_base": "10.000000000",
      "product_id": "82f6d91f-2da0-4ed8-ac59-7501aa0b0fea",
      "quantity": "1.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: bdc55490a10b40000000000000000001-61dd2fe10ea9a8ec-0

{
  "data": {
    "billing_location": null,
    "charges": [],
    "company": null,
    "creator": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126e2f6",
      "role": {
        "id": "00000000-0000-0000-0000-0000012521fe",
        "name": "Admin 1904"
      }
    },
    "custom_data": [],
    "delivery_datetime": null,
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": null,
    "id": "81214017-ae5f-43ae-ab90-7445e147e996",
    "inserted_datetime": "2025-05-13T13:27:25.841492Z",
    "internal_notes": null,
    "items": [
      {
        "batch": null,
        "compliance_quantity": null,
        "id": "d238aac4-0aa9-4bb2-b4dc-983ed4fa604b",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7698",
          "id": "00000000-0000-0000-0000-00000059b98a",
          "license_id": "00000000-0000-0000-0000-000000393d96",
          "name": "Place 671"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "82f6d91f-2da0-4ed8-ac59-7501aa0b0fea",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:25.790576Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-0000001",
    "owner": null,
    "shipping_location": null,
    "status": "PROCESSING",
    "total": "10.00",
    "updated_datetime": "2025-05-13T13:27:25.841492Z"
  }
}

POST /public/v1/orders creates an order with metrc transfer template

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NDgsImlhdCI6MTc0NzE0Mjg0OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiN2RmN2FkNWMtZTRkNy00NTU3LWE2YTgtOTg1ZWEwNjRmOWRmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQ3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjYwNTQiLCJ0eXAiOiJhY2Nlc3MifQ.n5elWmZ6FWD0jFMZPO-qx6iTaNS-Wj5MIMRPBK12xFI

{
  "billing_location_id": "00000000-0000-0000-0000-00000059b9eb",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081eef4",
  "delivery_datetime": "2020-01-01T00:00:00.000000Z",
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "external_notes": null,
  "items": [
    {
      "compliance_quantity": "1.0000",
      "id": "47b16fd2-5d75-487b-acb9-9cf642391a19",
      "location_id": "00000000-0000-0000-0000-00000059b9eb",
      "package_id": "00000000-0000-0000-0000-0000001cd50e",
      "price_base": "10.000000000",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059b9eb",
  "metrc_transfer_template_directions": "Go to the store around the corner",
  "metrc_transfer_template_recipient_license_number": "C12-0123458-LIC",
  "metrc_transfer_template_status": "PENDING",
  "metrc_transfer_template_transporter_info": [
    {
      "driver_license_number": "1234567890",
      "driver_name": "John Doe",
      "driver_occupational_license_number": "1234567890",
      "driver_phone_number": "1234567890",
      "transporter_license_number": "C12-0123456-LIC",
      "vehicle_license_plate_number": "1234567890",
      "vehicle_make": "Toyota",
      "vehicle_model": "Prius"
    },
    {
      "driver_license_number": "1234567891",
      "driver_name": "Jane Doe",
      "driver_occupational_license_number": "1234567891",
      "driver_phone_number": "1234567891",
      "transporter_license_number": "C12-0123457-LIC",
      "vehicle_license_plate_number": "1234567891",
      "vehicle_make": "Toyota",
      "vehicle_model": "Corolla"
    }
  ],
  "metrc_transfer_template_type": "Transfer",
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "owner_id": "00000000-0000-0000-0000-00000126e466",
  "shipping_location_id": "00000000-0000-0000-0000-00000059b9eb",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 3641d3c2155880000000000000000001-da72b5471dcec5be-0

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd7795",
      "id": "00000000-0000-0000-0000-00000059b9eb",
      "license_id": "00000000-0000-0000-0000-000000393def",
      "name": "Place 768"
    },
    "charges": [],
    "company": {
      "id": "00000000-0000-0000-0000-00000081eef4",
      "name": "Company 1768",
      "updated_datetime": "2025-05-13T13:27:28.239141Z"
    },
    "creator": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126e466",
      "role": {
        "id": "00000000-0000-0000-0000-000001252387",
        "name": "Admin 2291"
      }
    },
    "custom_data": [],
    "delivery_datetime": "2020-01-01T00:00:00.000000Z",
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": null,
    "id": "218bfd62-7ee1-457f-8e25-21c7a809f163",
    "inserted_datetime": "2025-05-13T13:27:28.486573Z",
    "internal_notes": null,
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd637",
          "name": "B2"
        },
        "compliance_quantity": "1.0000",
        "id": "47b16fd2-5d75-487b-acb9-9cf642391a19",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7795",
          "id": "00000000-0000-0000-0000-00000059b9eb",
          "license_id": "00000000-0000-0000-0000-000000393def",
          "name": "Place 768"
        },
        "package": {
          "batch_number": "B1",
          "compliance_label": "ABCDEF012345670000000446",
          "id": "00000000-0000-0000-0000-0000001cd50e",
          "metrc_label": "ABCDEF012345670000000446",
          "status": "selling"
        },
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "21656b6e-dec0-4003-a342-6315452446bf",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:28.297477Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-0000001",
    "owner": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126e466",
      "role": {
        "id": "00000000-0000-0000-0000-000001252387",
        "name": "Admin 2291"
      }
    },
    "shipping_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd7795",
      "id": "00000000-0000-0000-0000-00000059b9eb",
      "license_id": "00000000-0000-0000-0000-000000393def",
      "name": "Place 768"
    },
    "status": "PROCESSING",
    "total": "10.00",
    "updated_datetime": "2025-05-13T13:27:28.722326Z"
  }
}

POST /public/v1/orders updates an order

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NDIsImlhdCI6MTc0NzE0Mjg0MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNmVlNDZjM2YtZjRhOC00ZWJjLWExNzAtOGE2MDc1ZjNjMDQ4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODQxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjUwMzMiLCJ0eXAiOiJhY2Nlc3MifQ.u3Ix0ucuraodF1nEno34CGrmHuzmoZEYBZ_MYRdZMfA

{
  "billing_location_id": "00000000-0000-0000-0000-00000059b899",
  "charges": [
    {
      "id": "24e4a6a7-0707-4896-a388-ff130da9505c",
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    },
    {
      "id": "d42d0e43-7f63-42c7-a15e-e3c906e6b169",
      "name": "C2",
      "price": "-5.00",
      "type": "DISCOUNT",
      "unit_type": "PRICE"
    }
  ],
  "company_id": "00000000-0000-0000-0000-00000081edda",
  "delivery_datetime": "2020-01-01T00:00:00.000000Z",
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "external_notes": "gonna make you sweat",
  "id": "cc1ba65c-af6a-4f03-842b-a054e9d9a3f1",
  "items": [
    {
      "id": "2edf9294-f284-4bf6-9fcc-3e5ead339fdc",
      "location_id": "00000000-0000-0000-0000-00000059b899",
      "price_base": "10.000000000",
      "product_id": "ae51ef10-cc3a-414a-bd80-cc4bdb09eb97",
      "quantity": "2.000000000"
    },
    {
      "id": "edb4f423-c49c-4444-b25d-eab89f140ec5",
      "location_id": "00000000-0000-0000-0000-00000059b899",
      "price_base": "100.000000000",
      "product_id": "ae51ef10-cc3a-414a-bd80-cc4bdb09eb97",
      "quantity": "3.000000000"
    },
    {
      "compliance_quantity": "1.0000",
      "id": "27c2d9a2-5cd9-4e17-b582-ff128e1d58e0",
      "location_id": "00000000-0000-0000-0000-00000059b899",
      "package_id": "00000000-0000-0000-0000-0000001cd4e4",
      "price_base": "10.000000000",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059b899",
  "metrc_transfer_template_directions": "Go to the store around the corner",
  "metrc_transfer_template_recipient_license_number": "C12-0123458-LIC",
  "metrc_transfer_template_status": "PENDING",
  "metrc_transfer_template_transporter_info": [
    {
      "driver_license_number": "1234567890",
      "driver_name": "John Doe",
      "driver_occupational_license_number": "1234567890",
      "driver_phone_number": "1234567890",
      "transporter_license_number": "C12-0123456-LIC",
      "vehicle_license_plate_number": "1234567890",
      "vehicle_make": "Toyota",
      "vehicle_model": "Prius"
    },
    {
      "driver_license_number": "1234567891",
      "driver_name": "Jane Doe",
      "driver_occupational_license_number": "1234567891",
      "driver_phone_number": "1234567891",
      "transporter_license_number": "C12-0123457-LIC",
      "vehicle_license_plate_number": "1234567891",
      "vehicle_make": "Toyota",
      "vehicle_model": "Corolla"
    }
  ],
  "metrc_transfer_template_type": "Transfer",
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "owner_id": "00000000-0000-0000-0000-00000126e0aa",
  "shipping_location_id": "00000000-0000-0000-0000-00000059b899",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 52fa7ef3f400f0000000000000000001-aeab58d64ddc7374-0

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd74c9",
      "id": "00000000-0000-0000-0000-00000059b899",
      "license_id": "00000000-0000-0000-0000-000000393cdd",
      "name": "Place 430"
    },
    "charges": [
      {
        "id": "24e4a6a7-0707-4896-a388-ff130da9505c",
        "name": "C1",
        "percent": "10.0000",
        "price": "33.00",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "d42d0e43-7f63-42c7-a15e-e3c906e6b169",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-00000081edda",
      "name": "Company 1081",
      "updated_datetime": "2025-05-13T13:27:22.301083Z"
    },
    "creator": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126e068",
      "role": {
        "id": "00000000-0000-0000-0000-000001251f71",
        "name": "Admin 1262"
      }
    },
    "custom_data": [],
    "delivery_datetime": "2020-01-01T00:00:00.000000Z",
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": "gonna make you sweat",
    "id": "cc1ba65c-af6a-4f03-842b-a054e9d9a3f1",
    "inserted_datetime": "2025-05-13T13:27:22.373073Z",
    "internal_notes": null,
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd598",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "2edf9294-f284-4bf6-9fcc-3e5ead339fdc",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd74c9",
          "id": "00000000-0000-0000-0000-00000059b899",
          "license_id": "00000000-0000-0000-0000-000000393cdd",
          "name": "Place 430"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "ae51ef10-cc3a-414a-bd80-cc4bdb09eb97",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:22.342748Z"
        },
        "quantity": "2.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd598",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "edb4f423-c49c-4444-b25d-eab89f140ec5",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd74c9",
          "id": "00000000-0000-0000-0000-00000059b899",
          "license_id": "00000000-0000-0000-0000-000000393cdd",
          "name": "Place 430"
        },
        "package": null,
        "price": "100.000000000",
        "price_base": "100.000000000",
        "product": {
          "id": "ae51ef10-cc3a-414a-bd80-cc4bdb09eb97",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:22.342748Z"
        },
        "quantity": "3.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd59e",
          "name": "B2"
        },
        "compliance_quantity": "1.0000",
        "id": "27c2d9a2-5cd9-4e17-b582-ff128e1d58e0",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd74c9",
          "id": "00000000-0000-0000-0000-00000059b899",
          "license_id": "00000000-0000-0000-0000-000000393cdd",
          "name": "Place 430"
        },
        "package": {
          "batch_number": "B2",
          "compliance_label": "ABCDEF012345670000000287",
          "id": "00000000-0000-0000-0000-0000001cd4e4",
          "metrc_label": "ABCDEF012345670000000287",
          "status": "selling"
        },
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "a52c1d49-546c-48a6-be48-f9a325d5d0e4",
          "name": "P2",
          "sku": "SKU2",
          "updated_datetime": "2025-05-13T13:27:22.409808Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-107",
    "owner": {
      "banned": false,
      "email": "owner-1389@example.com",
      "full_name": "FirstName2652 LastName2653",
      "id": "00000000-0000-0000-0000-00000126e0aa",
      "role": {
        "id": "00000000-0000-0000-0000-000001251fb2",
        "name": "Admin 1326"
      }
    },
    "shipping_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd74c9",
      "id": "00000000-0000-0000-0000-00000059b899",
      "license_id": "00000000-0000-0000-0000-000000393cdd",
      "name": "Place 430"
    },
    "status": "PROCESSING",
    "total": "358.00",
    "updated_datetime": "2025-05-13T13:27:22.891502Z"
  }
}

POST /public/v1/orders does not alter locked price tier items on update

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NjMsImlhdCI6MTc0NzE0Mjg2MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiNzJmOWQ4ZDgtOTc3NC00ZDM4LTlkMmEtN2FiMTcxNzU3ZTBmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODYyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjg2OTYiLCJ0eXAiOiJhY2Nlc3MifQ.oNyM5ObRbe3s6sMsIEJzJlEtKWRU6Jul7nnw_jJc6TQ

{
  "billing_location_id": "00000000-0000-0000-0000-00000059bcf7",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081f294",
  "delivery_datetime": "2020-01-01T00:00:00.000000Z",
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059bcf7",
      "position": 1,
      "price_base": "100.000000000",
      "product_id": "9203d48d-1474-4e48-b243-70f42432c1c1",
      "quantity": "10.000000000"
    },
    {
      "location_id": "00000000-0000-0000-0000-00000059bcf7",
      "position": 2,
      "price_base": "200.000000000",
      "product_id": "58fdacfb-5b4c-433f-b16a-31e55545f40f",
      "quantity": "10.000000000"
    },
    {
      "location_id": "00000000-0000-0000-0000-00000059bcf7",
      "position": 3,
      "price_base": "300.000000000",
      "product_id": "652ab938-8788-487c-99f5-13b3cd5fa954",
      "quantity": "10.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "shipping_location_id": "00000000-0000-0000-0000-00000059bcf7",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: e0ca9b3a1b1a10000000000000000001-8a07ae00e2a94c5b-0

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd7f34",
      "id": "00000000-0000-0000-0000-00000059bcf7",
      "license_id": "00000000-0000-0000-0000-000000394089",
      "name": "Place 1531"
    },
    "charges": [],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f294",
      "name": "Company 3700",
      "updated_datetime": "2025-05-13T13:27:43.416440Z"
    },
    "creator": {
      "banned": false,
      "email": "owner-4977@example.com",
      "full_name": "FirstName9778 LastName9779",
      "id": "00000000-0000-0000-0000-00000126eeb8",
      "role": {
        "id": "00000000-0000-0000-0000-000001252e03",
        "name": "Admin 4962"
      }
    },
    "custom_data": [],
    "delivery_datetime": "2020-01-01T00:00:00.000000Z",
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": null,
    "id": "ef7b69fb-671c-4ba3-af68-7cca1959083a",
    "inserted_datetime": "2025-05-13T13:27:43.766841Z",
    "internal_notes": null,
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd885",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "efdd9ac1-ebf2-4a1e-9c0a-78436a7d59bc",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7f34",
          "id": "00000000-0000-0000-0000-00000059bcf7",
          "license_id": "00000000-0000-0000-0000-000000394089",
          "name": "Place 1531"
        },
        "package": null,
        "price": "90.000000000",
        "price_base": "100.000000000",
        "product": {
          "id": "9203d48d-1474-4e48-b243-70f42432c1c1",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:43.468978Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd886",
          "name": "B2"
        },
        "compliance_quantity": null,
        "id": "4bf3a71a-05c3-451c-9df6-bf63b753ab72",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7f34",
          "id": "00000000-0000-0000-0000-00000059bcf7",
          "license_id": "00000000-0000-0000-0000-000000394089",
          "name": "Place 1531"
        },
        "package": null,
        "price": "200.000000000",
        "price_base": "200.000000000",
        "product": {
          "id": "58fdacfb-5b4c-433f-b16a-31e55545f40f",
          "name": "P2",
          "sku": "SKU2",
          "updated_datetime": "2025-05-13T13:27:43.526268Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd888",
          "name": "B3"
        },
        "compliance_quantity": null,
        "id": "ba8f3eb6-795c-4ce9-bf2f-1f781db693f0",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7f34",
          "id": "00000000-0000-0000-0000-00000059bcf7",
          "license_id": "00000000-0000-0000-0000-000000394089",
          "name": "Place 1531"
        },
        "package": null,
        "price": "290.000000000",
        "price_base": "300.000000000",
        "product": {
          "id": "652ab938-8788-487c-99f5-13b3cd5fa954",
          "name": "P3",
          "sku": "SKU3",
          "updated_datetime": "2025-05-13T13:27:43.596929Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-0000001",
    "owner": null,
    "shipping_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd7f34",
      "id": "00000000-0000-0000-0000-00000059bcf7",
      "license_id": "00000000-0000-0000-0000-000000394089",
      "name": "Place 1531"
    },
    "status": "PROCESSING",
    "total": "5800.00",
    "updated_datetime": "2025-05-13T13:27:43.823789Z"
  }
}

POST /public/v1/orders deleting order items & charges

POST /public/v1/orders
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NTcsImlhdCI6MTc0NzE0Mjg1NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiNzNmN2RjNjEtNWE3NS00ZDk0LWJhNGQtMDBkMzczNDRkY2UzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODU2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMjc1OTUiLCJ0eXAiOiJhY2Nlc3MifQ.8E7B_I5MauT3Ct0CrCZdHNcFeTdbnrWsQLFS9BAY2Mc

{
  "billing_location_id": "00000000-0000-0000-0000-00000059bb8c",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081f0ef",
  "delivery_datetime": "2020-01-01T00:00:00.000000Z",
  "due_datetime": "2020-01-01T00:00:01.000000Z",
  "id": "03a2cb68-2d0d-4298-a058-54877ec3dc28",
  "items": [
    {
      "id": "9f421896-6cf2-4760-a47f-f7dd44d93438",
      "location_id": "00000000-0000-0000-0000-00000059bb8c",
      "price_base": "10.000000000",
      "product_id": "6bca5dd6-0c5c-456c-b73b-c93860416d2c",
      "quantity": "1.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "shipping_location_id": "00000000-0000-0000-0000-00000059bb8c",
  "status": "PROCESSING"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 27ab5a0dff72c0000000000000000001-d3eae8557743af3d-0

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd7bc5",
      "id": "00000000-0000-0000-0000-00000059bb8c",
      "license_id": "00000000-0000-0000-0000-000000393f8c",
      "name": "Place 1179"
    },
    "charges": [],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f0ef",
      "name": "Company 2827",
      "updated_datetime": "2025-05-13T13:27:37.852530Z"
    },
    "creator": {
      "banned": false,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-00000126ea6b",
      "role": {
        "id": "00000000-0000-0000-0000-000001252998",
        "name": "Admin 3833"
      }
    },
    "custom_data": [],
    "delivery_datetime": "2020-01-01T00:00:00.000000Z",
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": null,
    "id": "03a2cb68-2d0d-4298-a058-54877ec3dc28",
    "inserted_datetime": "2025-05-13T13:27:38.022271Z",
    "internal_notes": null,
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fd786",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "9f421896-6cf2-4760-a47f-f7dd44d93438",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd7bc5",
          "id": "00000000-0000-0000-0000-00000059bb8c",
          "license_id": "00000000-0000-0000-0000-000000393f8c",
          "name": "Place 1179"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "6bca5dd6-0c5c-456c-b73b-c93860416d2c",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:37.941140Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_order_number": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-217",
    "owner": null,
    "shipping_location": {
      "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
      "company_id": "00000000-0000-0000-0000-000000dd7bc5",
      "id": "00000000-0000-0000-0000-00000059bb8c",
      "license_id": "00000000-0000-0000-0000-000000393f8c",
      "name": "Place 1179"
    },
    "status": "PROCESSING",
    "total": "10.00",
    "updated_datetime": "2025-05-13T13:27:38.181615Z"
  }
}

Upsert a single order. To update an existing order, pass in an existing order ID in the id field. When updating an order, you must pass in all fields (no sparse update currently supported). Any existing order item or charge you do not pass in to items and charges respectively will be deleted

Request

POST /public/v1/orders

Parameters

Parameter	Description	In	Type	Required	Example
blaze_payment_type	The payment type for an order shipping to a Blaze-associated company. Required when the company being used is mapped to a Blaze retailer via the Distru integration.	query	string	false	CASH
company_id	Company ID	query	string	false
delivery_datetime	The datetime on which the order was / will be delivered	query	string	false
due_datetime	The datetime by which the order should be completed for the customer	query	string	false
external_notes	This is a message that will be shown to the customer on order slips. This is the "Message to Customer" field in the Distru order form.	query	string	false
id	Unique ID for this order. If it exists, an update will be performed; otherwise, it will be used as the ID of a new order record	query	string	false
order_datetime	The datetime on which the order was placed	query	string	false
charges	The additional lines of Charge, Discount, or Tax added to this order	body	OrderChargesRequest	false
items	The order items present on this order	body	OrderItemsRequest	false
internal_notes	Internal notes for this order	query	string	false
metrc_transfer_template_transporter_info	The Metrc transfer template transporter(s) information about this order	body	OrderTransferTemplateTransporterInfosRequest	false
metrc_transfer_template_directions	The Metrc transfer template directions	query	string	false
metrc_transfer_template_recipient_license_number	The Metrc transfer template recipient license number	query	string	false
metrc_transfer_template_status	The Metrc transfer template status	query	string	false
metrc_transfer_template_type	The Metrc transfer template type	query	string	false
billing_location_id	The billing location's ID	query	string	false
shipping_location_id	The shipping location's ID	query	string	false
owner_id	The ID of the Distru user that owns this order	query	string	false
status	Filter orders by their status. Accepted values are "PENDING", "PROCESSING", "READY_TO_SHIP", "DELIVERING", "DELIVERED", "COMPLETED" and "CANCELED".	query	string	false	PENDING

Responses

Status	Description	Schema
200	A single order	Order

Package

Get packages

GET /public/v1/packages returns packages related to the company

GET /public/v1/packages
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI1NTksImlhdCI6MTc0NzE0Mjk1OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNmEzZDhjNTgtMjEzMi00ZWFjLTg1YzgtZWZkZmI5YmI1MTA0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyOTU4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNDQ4NjYiLCJ0eXAiOiJhY2Nlc3MifQ.L2_PqJf4Z5qXWQsGfHB9F3PEuhgxj69MQBfCRkUGGLY

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: d77db0a87e9638000000000000000001-0a8246aa7862a89e-0

{
  "data": [
    {
      "batch_number": null,
      "compliance_label": "ABCDEF012345670000005663",
      "custom_data": [
        {
          "id": 68781,
          "name": "Custom Field 108",
          "value": "Custom Field Value 1"
        }
      ],
      "expiration_date": "2024-01-01T00:00:00.000000Z",
      "id": "00000000-0000-0000-0000-0000001cdc95",
      "is_trade_sample": true,
      "license": {
        "id": "00000000-0000-0000-0000-000000394e04",
        "license_number": "CDPH-00005046"
      },
      "location": {
        "id": "00000000-0000-0000-0000-00000059cfc0",
        "name": "Place 6312"
      },
      "metrc_label": "ABCDEF012345670000005663",
      "primary_test_result": null,
      "product_id": "4fba0713-ad65-48a7-bfc5-93e2379dcf44",
      "product_unit_quantity": "7.500000000",
      "product_unit_type": {
        "id": "00000000-0000-0000-0000-00000c39a078",
        "name": "3"
      },
      "quantity": "5.000000000",
      "quantity_assembling": "0.000000000",
      "quantity_available": "5.000000000",
      "status": "active",
      "unit_type": {
        "id": "00000000-0000-0000-0000-00000c39a079",
        "name": "2"
      }
    },
    {
      "batch_number": null,
      "compliance_label": "ABCDEF012345670000005668",
      "custom_data": [
        {
          "id": 68781,
          "name": "Custom Field 108",
          "value": null
        }
      ],
      "expiration_date": null,
      "id": "00000000-0000-0000-0000-0000001cdc98",
      "is_trade_sample": false,
      "license": {
        "id": "00000000-0000-0000-0000-000000394e04",
        "license_number": "CDPH-00005046"
      },
      "location": {
        "id": "00000000-0000-0000-0000-00000059cfc4",
        "name": "Place 6315"
      },
      "metrc_label": "ABCDEF012345670000005668",
      "primary_test_result": {
        "cbd_mg_per_unit": "1",
        "cbd_mg_per_unit_total": "2",
        "cbd_percentage": "3",
        "cbd_percentage_total": "4",
        "mg_per_unit_type": "mg/mL",
        "name": "File.pdf",
        "thc_mg_per_unit": "5",
        "thc_mg_per_unit_total": "6",
        "thc_percentage": "7",
        "thc_percentage_total": "8"
      },
      "product_id": "4fba0713-ad65-48a7-bfc5-93e2379dcf44",
      "product_unit_quantity": "15.000000000",
      "product_unit_type": {
        "id": "00000000-0000-0000-0000-00000c39a078",
        "name": "3"
      },
      "quantity": "20.000000000",
      "quantity_assembling": "0.000000000",
      "quantity_available": "20.000000000",
      "status": "active",
      "unit_type": {
        "id": "00000000-0000-0000-0000-00000c39a07a",
        "name": "4"
      }
    }
  ]
}

Get packages sorted by their creation date and filtered by various attributes

Note: The page size for this endpoint is 5000 packages per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/packages

Parameters

Parameter	Description	In	Type	Required	Example
inserted_datetime	Filter packages by their creation datetime	query	string	false	2022-07-10T00:00:00Z,
page	Pagination information	body	Page	false
location_ids	A list of location UUIDs to filter packages by.
query	array	false		["123e4567-e89b-12d3-a456-426655440000","456e89b1-2d3a-4564-2665-544000000000"]
license_number	Filter packages by license number	query	string	false	1234567890
statuses	Filter packages by their status	query	array	false	["active","selling","sold"]
updated_datetime	Filter packages by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of packages	Packages

PaymentMethod

Get payment methods

GET /public/v1/payments/methods returns payment methods related to the user's company only

GET /public/v1/payment-methods
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI1NjMsImlhdCI6MTc0NzE0Mjk2MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiZGQ2MDhkNGMtMTE4OS00NWUyLTlhNTMtMDA4NzllMmE5ZWRhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyOTYyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNDU3OTQiLCJ0eXAiOiJhY2Nlc3MifQ.jlBxI3InKHFEWRKuRe5tFoQoZ83nNPwppeM4kOQj-sU

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 615ec384dfb1d4000000000000000001-12ce3d5f5b860fa5-0

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000018d9e",
      "name": "Payment Method 131"
    }
  ]
}

Get payment methods. Note: This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/payment-methods

Responses

Status	Description	Schema
200	A list of payment methods	PaymentMethods

Product

Get products

GET /public/products returns products related to the company

GET /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NDgsImlhdCI6MTc0NzE0MzA0OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiY2IzZGQ3M2YtM2JiNS00Mzc4LWI2ZWMtNzZmYTdkMTcyNjc0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjY4MTkiLCJ0eXAiOiJhY2Nlc3MifQ.2onTUkNwn7aZ2snxlh_euJl_rJvH_W0j9br-f1cdpDo

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 552cf10e01b3e4000000000000000001-0d2dca7142cde274-0

{
  "data": [
    {
      "brand": {
        "id": "00000000-0000-0000-0000-0000008231dd",
        "name": "Company 31365",
        "updated_datetime": "2030-11-01T00:00:00.000000Z"
      },
      "category": {
        "id": "00000000-0000-0000-0000-0000006beeaa",
        "name": "Some category 13050",
        "type": "OTHER"
      },
      "custom_data": [
        {
          "id": 68879,
          "name": "Custom Field 198",
          "value": "Custom Field Value 1"
        }
      ],
      "description": "test",
      "id": "5383de67-6d4f-4c26-b612-54c386ef4591",
      "images": [
        {
          "id": "00000000-0000-0000-0000-00000000a3e7",
          "name": "Image Name 630",
          "rank": 0,
          "url": "https://google.com/original-103.jpg"
        },
        {
          "id": "00000000-0000-0000-0000-00000000a3e8",
          "name": "Image Name 631",
          "rank": 1,
          "url": "https://google.com/original-104.jpg"
        }
      ],
      "is_active": true,
      "msrp": null,
      "name": "Product 36167",
      "sku": "sku 36168",
      "strain": {
        "id": "00000000-0000-0000-0000-0000000288aa",
        "name": "Strain 576"
      },
      "subcategory": {
        "id": "00000000-0000-0000-0000-0000006c8df8",
        "name": "Some subcategory 12237"
      },
      "unit_price": "1",
      "unit_type": {
        "id": "00000000-0000-0000-0000-00000c3d0d05",
        "name": "Gram"
      },
      "units_per_case": null,
      "updated_datetime": "2023-11-01T00:00:00.000000Z",
      "vendor": {
        "id": "00000000-0000-0000-0000-0000008231e0",
        "name": "Company 31373",
        "updated_datetime": "2030-11-03T00:00:00.000000Z"
      }
    },
    {
      "brand": {
        "id": "00000000-0000-0000-0000-0000008231de",
        "name": "Company 31368",
        "updated_datetime": "2030-11-02T00:00:00.000000Z"
      },
      "category": {
        "id": "00000000-0000-0000-0000-0000006beeac",
        "name": "Some category 13052",
        "type": "OTHER"
      },
      "custom_data": [
        {
          "id": 68879,
          "name": "Custom Field 198",
          "value": null
        }
      ],
      "description": null,
      "id": "90ff29f2-4de0-404a-80ce-9bfd589b75e1",
      "images": [],
      "is_active": false,
      "msrp": "100",
      "name": "Product 36173",
      "sku": "sku 36174",
      "strain": null,
      "subcategory": {
        "id": "00000000-0000-0000-0000-0000006c8dfb",
        "name": "Some subcategory 12240"
      },
      "unit_price": "1",
      "unit_type": {
        "id": "00000000-0000-0000-0000-00000c3d0d03",
        "name": "Pound"
      },
      "units_per_case": null,
      "updated_datetime": "2023-11-02T00:00:00.000000Z",
      "vendor": {
        "id": "00000000-0000-0000-0000-0000008231e3",
        "name": "Company 31379",
        "updated_datetime": "2030-11-04T00:00:00.000000Z"
      }
    }
  ]
}

Get products sorted by their creation date and filtered by various attributes.

Note: The page size for this endpoint is 5000 products per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/products

Parameters

Parameter	Description	In	Type	Required	Example
inserted_datetime	Filter products by their creation datetime	query	string	false	2022-07-10T00:00:00Z,
page	Pagination information	body	Page	false
updated_datetime	Filter products by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of products	Products

Upsert a product

POST /public/v1/orders Creates a product with all optional fields set

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTAsImlhdCI6MTc0NzE0MzA1MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYjZjNmYwMDUtOTYxMy00OGYwLWExOTYtZGE3MmE4ZDA1MGJkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjcyMDQiLCJ0eXAiOiJhY2Nlc3MifQ.yCGjypnTmpM7Zs8ZiiOTl6h6CUBXSQGa1lbLHJcVN_A

{
  "brand_id": "00000000-0000-0000-0000-000000823284",
  "category_id": "00000000-0000-0000-0000-0000006bef1d",
  "description": "My Product Description",
  "group_id": "00000000-0000-0000-0000-000000583810",
  "id": "3f0e1b51-f910-47da-858e-3cc77919b681",
  "inventory_tracking_method": "PACKAGE",
  "is_featured": true,
  "is_inactive": true,
  "menu_visibility": "INCLUDE_IN_ALL",
  "menus": ["00000000-0000-0000-0000-00000003c316"],
  "msrp": "100.5",
  "name": "My Product",
  "owner_id": "00000000-0000-0000-0000-00000127851d",
  "quantity_available_threshold_max": "10.5",
  "quantity_available_threshold_min": "5.5",
  "sku": "12345",
  "strain_id": "00000000-0000-0000-0000-0000000288ac",
  "subcategory_id": "00000000-0000-0000-0000-0000006c8e6a",
  "tags": ["00000000-0000-0000-0000-00000000b064"],
  "total_cannabinoid_unit": "PERCENT",
  "total_cbd": "5.2",
  "total_thc": "10.4",
  "unit_cost": "50.4",
  "unit_net_weight": "3.1",
  "unit_net_weight_and_serving_size_unit_type_id": "00000000-0000-0000-0000-00000c3d1d39",
  "unit_price": "100",
  "unit_serving_size": "2.2",
  "unit_type_id": "00000000-0000-0000-0000-00000c3d1d42",
  "units_per_case": "0.2",
  "upc": "036000291452",
  "vendor_id": "00000000-0000-0000-0000-00000082327f",
  "wholesale_unit_price": "90.50"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: cde589a784d3b0000000000000000001-804a20d701b7fd68-0

{
  "data": {
    "brand": {
      "id": "00000000-0000-0000-0000-000000823284",
      "name": "Company 31681",
      "updated_datetime": "2025-05-13T13:30:50.815081Z"
    },
    "category": {
      "id": "00000000-0000-0000-0000-0000006bef1d",
      "name": "Some category 13166",
      "type": "OTHER"
    },
    "custom_data": [
      {
        "id": 68880,
        "name": "Custom Field 199",
        "value": null
      }
    ],
    "description": "My Product Description",
    "id": "3f0e1b51-f910-47da-858e-3cc77919b681",
    "images": [],
    "is_active": false,
    "msrp": "100.5",
    "name": "My Product",
    "sku": "12345",
    "strain": {
      "id": "00000000-0000-0000-0000-0000000288ac",
      "name": "Strain 578"
    },
    "subcategory": {
      "id": "00000000-0000-0000-0000-0000006c8e6a",
      "name": "Some subcategory 12351"
    },
    "unit_price": "100",
    "unit_type": {
      "id": "00000000-0000-0000-0000-00000c3d1d42",
      "name": "Unit"
    },
    "units_per_case": "0.2",
    "updated_datetime": "2025-05-13T13:30:50.940369Z",
    "vendor": {
      "id": "00000000-0000-0000-0000-00000082327f",
      "name": "Company 31670",
      "updated_datetime": "2025-05-13T13:30:50.783057Z"
    }
  }
}

POST /public/v1/orders Updates a product with all optional fields set

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTEsImlhdCI6MTc0NzE0MzA1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTUzNTUzNzktZDM0NC00YzZiLWFlMzQtNmQyNWM1MjI3OGMyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjc0MjEiLCJ0eXAiOiJhY2Nlc3MifQ.uYU9sQ1IfrTbsSJC1NgJ64RHpc_xvQAfPDHIJ6lOBIQ

{
  "category_id": "00000000-0000-0000-0000-0000006bef69",
  "id": "717de007-193f-4f30-b3f6-45f084325a90",
  "inventory_tracking_method": "PACKAGE",
  "name": "My Product",
  "sku": "12345",
  "unit_price": "100",
  "unit_type_id": "00000000-0000-0000-0000-00000c3d2759",
  "upc": "036000291452",
  "vendor_id": "00000000-0000-0000-0000-0000008232f2"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 60a49d7833c1d0000000000000000001-e11a2fd70a46462e-0

{
  "data": {
    "brand": null,
    "category": {
      "id": "00000000-0000-0000-0000-0000006bef69",
      "name": "Some category 13241",
      "type": "OTHER"
    },
    "custom_data": [],
    "description": null,
    "id": "717de007-193f-4f30-b3f6-45f084325a90",
    "images": [],
    "is_active": true,
    "msrp": null,
    "name": "My Product",
    "sku": "12345",
    "strain": null,
    "subcategory": null,
    "unit_price": "100",
    "unit_type": {
      "id": "00000000-0000-0000-0000-00000c3d2759",
      "name": "Gram"
    },
    "units_per_case": null,
    "updated_datetime": "2025-05-13T13:30:51.763326Z",
    "vendor": {
      "id": "00000000-0000-0000-0000-0000008232f2",
      "name": "Company 31864",
      "updated_datetime": "2025-05-13T13:30:51.696966Z"
    }
  }
}

POST /public/v1/orders Updates a product with all optional fields set

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTEsImlhdCI6MTc0NzE0MzA1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTUzNTUzNzktZDM0NC00YzZiLWFlMzQtNmQyNWM1MjI3OGMyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjc0MjEiLCJ0eXAiOiJhY2Nlc3MifQ.uYU9sQ1IfrTbsSJC1NgJ64RHpc_xvQAfPDHIJ6lOBIQ

{
  "brand_id": "00000000-0000-0000-0000-000000823314",
  "category_id": "00000000-0000-0000-0000-0000006bef7f",
  "description": "My Product Description",
  "group_id": "00000000-0000-0000-0000-000000583872",
  "id": "717de007-193f-4f30-b3f6-45f084325a90",
  "inventory_tracking_method": "PACKAGE",
  "is_featured": true,
  "is_inactive": true,
  "menu_visibility": "INCLUDE_IN_ALL",
  "menus": ["00000000-0000-0000-0000-00000003c317"],
  "msrp": "100.5",
  "name": "Updated Name",
  "owner_id": "00000000-0000-0000-0000-000001278652",
  "quantity_available_threshold_max": "10.5",
  "quantity_available_threshold_min": "5.5",
  "sku": "45678",
  "strain_id": "00000000-0000-0000-0000-0000000288ad",
  "subcategory_id": "00000000-0000-0000-0000-0000006c8ecb",
  "tags": ["00000000-0000-0000-0000-00000000b065"],
  "total_cannabinoid_unit": "PERCENT",
  "total_cbd": "5.2",
  "total_thc": "10.4",
  "unit_cost": "50.4",
  "unit_net_weight": "3.1",
  "unit_net_weight_and_serving_size_unit_type_id": "00000000-0000-0000-0000-00000c3d275b",
  "unit_price": "200",
  "unit_serving_size": "2.2",
  "unit_type_id": "00000000-0000-0000-0000-00000c3d2762",
  "units_per_case": "0.2",
  "upc": "036000291453",
  "vendor_id": "00000000-0000-0000-0000-00000082330d",
  "wholesale_unit_price": "90.50"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 60a49d7833c1d0000000000000000001-02766fcdf84955e0-0

{
  "data": {
    "brand": {
      "id": "00000000-0000-0000-0000-000000823314",
      "name": "Company 31919",
      "updated_datetime": "2025-05-13T13:30:51.894862Z"
    },
    "category": {
      "id": "00000000-0000-0000-0000-0000006bef7f",
      "name": "Some category 13263",
      "type": "OTHER"
    },
    "custom_data": [],
    "description": "My Product Description",
    "id": "717de007-193f-4f30-b3f6-45f084325a90",
    "images": [],
    "is_active": false,
    "msrp": "100.5",
    "name": "Updated Name",
    "sku": "45678",
    "strain": {
      "id": "00000000-0000-0000-0000-0000000288ad",
      "name": "Strain 579"
    },
    "subcategory": {
      "id": "00000000-0000-0000-0000-0000006c8ecb",
      "name": "Some subcategory 12448"
    },
    "unit_price": "200",
    "unit_type": {
      "id": "00000000-0000-0000-0000-00000c3d2762",
      "name": "Unit"
    },
    "units_per_case": "0.2",
    "updated_datetime": "2025-05-13T13:30:51.982657Z",
    "vendor": {
      "id": "00000000-0000-0000-0000-00000082330d",
      "name": "Company 31907",
      "updated_datetime": "2025-05-13T13:30:51.863159Z"
    }
  }
}

POST /public/v1/orders Menus act as expected

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NDgsImlhdCI6MTc0NzE0MzA0OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTcwYjFlNjUtNzJkNC00OTBmLTk5NjMtODE3NGZlZWNiOTJkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjY4ODUiLCJ0eXAiOiJhY2Nlc3MifQ.JbxRSL-v_4cL42wzhVK0ZgKwj7WkyCgztQJu7IxR5Y0

{
  "category_id": "00000000-0000-0000-0000-0000006beeba",
  "id": "1e8c8b7f-dbcc-4a73-aab1-a8c8b248eb60",
  "inventory_tracking_method": "PACKAGE",
  "menu_visibility": "INCLUDE_IN_ALL",
  "menus": ["00000000-0000-0000-0000-00000003c310"],
  "name": "My Product",
  "sku": "12345",
  "unit_price": "100",
  "unit_type_id": "00000000-0000-0000-0000-00000c3d104f",
  "upc": "036000291452",
  "vendor_id": "00000000-0000-0000-0000-0000008231f4"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: a582f5dc995f98000000000000000001-4929831878b86034-0

{
  "data": {
    "brand": null,
    "category": {
      "id": "00000000-0000-0000-0000-0000006beeba",
      "name": "Some category 13066",
      "type": "OTHER"
    },
    "custom_data": [],
    "description": null,
    "id": "1e8c8b7f-dbcc-4a73-aab1-a8c8b248eb60",
    "images": [],
    "is_active": true,
    "msrp": null,
    "name": "My Product",
    "sku": "12345",
    "strain": null,
    "subcategory": null,
    "unit_price": "100",
    "unit_type": {
      "id": "00000000-0000-0000-0000-00000c3d104f",
      "name": "Gram"
    },
    "units_per_case": null,
    "updated_datetime": "2025-05-13T13:30:48.717654Z",
    "vendor": {
      "id": "00000000-0000-0000-0000-0000008231f4",
      "name": "Company 31428",
      "updated_datetime": "2025-05-13T13:30:48.534070Z"
    }
  }
}

POST /public/v1/orders Menus act as expected

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NDgsImlhdCI6MTc0NzE0MzA0OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTcwYjFlNjUtNzJkNC00OTBmLTk5NjMtODE3NGZlZWNiOTJkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjY4ODUiLCJ0eXAiOiJhY2Nlc3MifQ.JbxRSL-v_4cL42wzhVK0ZgKwj7WkyCgztQJu7IxR5Y0

{
  "category_id": "00000000-0000-0000-0000-0000006beeba",
  "id": "1e8c8b7f-dbcc-4a73-aab1-a8c8b248eb60",
  "inventory_tracking_method": "PACKAGE",
  "menu_visibility": "DO_NOT_INCLUDE",
  "menus": [
    "00000000-0000-0000-0000-00000003c310",
    "00000000-0000-0000-0000-00000003c311"
  ],
  "name": "My Product",
  "sku": "12345",
  "tags": [],
  "unit_price": "100",
  "unit_type_id": "00000000-0000-0000-0000-00000c3d104f",
  "upc": "036000291452",
  "vendor_id": "00000000-0000-0000-0000-0000008231f4"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: a582f5dc995f98000000000000000001-e8bbcd4d6ebf52a0-0

{
  "data": {
    "brand": null,
    "category": {
      "id": "00000000-0000-0000-0000-0000006beeba",
      "name": "Some category 13066",
      "type": "OTHER"
    },
    "custom_data": [],
    "description": null,
    "id": "1e8c8b7f-dbcc-4a73-aab1-a8c8b248eb60",
    "images": [],
    "is_active": true,
    "msrp": null,
    "name": "My Product",
    "sku": "12345",
    "strain": null,
    "subcategory": null,
    "unit_price": "100",
    "unit_type": {
      "id": "00000000-0000-0000-0000-00000c3d104f",
      "name": "Gram"
    },
    "units_per_case": null,
    "updated_datetime": "2025-05-13T13:30:48.910250Z",
    "vendor": {
      "id": "00000000-0000-0000-0000-0000008231f4",
      "name": "Company 31428",
      "updated_datetime": "2025-05-13T13:30:48.534070Z"
    }
  }
}

POST /public/v1/orders Menus act as expected

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NDgsImlhdCI6MTc0NzE0MzA0OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTcwYjFlNjUtNzJkNC00OTBmLTk5NjMtODE3NGZlZWNiOTJkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjY4ODUiLCJ0eXAiOiJhY2Nlc3MifQ.JbxRSL-v_4cL42wzhVK0ZgKwj7WkyCgztQJu7IxR5Y0

{
  "category_id": "00000000-0000-0000-0000-0000006beeba",
  "id": "1e8c8b7f-dbcc-4a73-aab1-a8c8b248eb60",
  "inventory_tracking_method": "PACKAGE",
  "menu_visibility": "INCLUDE_IN_SELECT",
  "menus": [
    "00000000-0000-0000-0000-00000003c310",
    "00000000-0000-0000-0000-00000003c311"
  ],
  "name": "My Product",
  "sku": "12345",
  "tags": [],
  "unit_price": "100",
  "unit_type_id": "00000000-0000-0000-0000-00000c3d104f",
  "upc": "036000291452",
  "vendor_id": "00000000-0000-0000-0000-0000008231f4"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: a582f5dc995f98000000000000000001-06592909c1ce27be-0

{
  "data": {
    "brand": null,
    "category": {
      "id": "00000000-0000-0000-0000-0000006beeba",
      "name": "Some category 13066",
      "type": "OTHER"
    },
    "custom_data": [],
    "description": null,
    "id": "1e8c8b7f-dbcc-4a73-aab1-a8c8b248eb60",
    "images": [],
    "is_active": true,
    "msrp": null,
    "name": "My Product",
    "sku": "12345",
    "strain": null,
    "subcategory": null,
    "unit_price": "100",
    "unit_type": {
      "id": "00000000-0000-0000-0000-00000c3d104f",
      "name": "Gram"
    },
    "units_per_case": null,
    "updated_datetime": "2025-05-13T13:30:49.047427Z",
    "vendor": {
      "id": "00000000-0000-0000-0000-0000008231f4",
      "name": "Company 31428",
      "updated_datetime": "2025-05-13T13:30:48.534070Z"
    }
  }
}

POST /public/v1/orders Menus act as expected

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NDgsImlhdCI6MTc0NzE0MzA0OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTcwYjFlNjUtNzJkNC00OTBmLTk5NjMtODE3NGZlZWNiOTJkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjY4ODUiLCJ0eXAiOiJhY2Nlc3MifQ.JbxRSL-v_4cL42wzhVK0ZgKwj7WkyCgztQJu7IxR5Y0

{
  "category_id": "00000000-0000-0000-0000-0000006beeba",
  "id": "1e8c8b7f-dbcc-4a73-aab1-a8c8b248eb60",
  "inventory_tracking_method": "PACKAGE",
  "menu_visibility": "INCLUDE_IN_SELECT",
  "menus": ["00000000-0000-0000-0000-00000003c311"],
  "name": "My Product",
  "sku": "12345",
  "unit_price": "100",
  "unit_type_id": "00000000-0000-0000-0000-00000c3d104f",
  "upc": "036000291452",
  "vendor_id": "00000000-0000-0000-0000-0000008231f4"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: a582f5dc995f98000000000000000001-c71dc5d255d94b77-0

{
  "data": {
    "brand": null,
    "category": {
      "id": "00000000-0000-0000-0000-0000006beeba",
      "name": "Some category 13066",
      "type": "OTHER"
    },
    "custom_data": [],
    "description": null,
    "id": "1e8c8b7f-dbcc-4a73-aab1-a8c8b248eb60",
    "images": [],
    "is_active": true,
    "msrp": null,
    "name": "My Product",
    "sku": "12345",
    "strain": null,
    "subcategory": null,
    "unit_price": "100",
    "unit_type": {
      "id": "00000000-0000-0000-0000-00000c3d104f",
      "name": "Gram"
    },
    "units_per_case": null,
    "updated_datetime": "2025-05-13T13:30:49.186120Z",
    "vendor": {
      "id": "00000000-0000-0000-0000-0000008231f4",
      "name": "Company 31428",
      "updated_datetime": "2025-05-13T13:30:48.534070Z"
    }
  }
}

POST /public/v1/orders Menus act as expected

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NDgsImlhdCI6MTc0NzE0MzA0OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTcwYjFlNjUtNzJkNC00OTBmLTk5NjMtODE3NGZlZWNiOTJkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjY4ODUiLCJ0eXAiOiJhY2Nlc3MifQ.JbxRSL-v_4cL42wzhVK0ZgKwj7WkyCgztQJu7IxR5Y0

{
  "category_id": "00000000-0000-0000-0000-0000006beeba",
  "id": "1e8c8b7f-dbcc-4a73-aab1-a8c8b248eb60",
  "inventory_tracking_method": "PACKAGE",
  "menu_visibility": "INCLUDE_IN_SELECT",
  "menus": [],
  "name": "My Product",
  "sku": "12345",
  "unit_price": "100",
  "unit_type_id": "00000000-0000-0000-0000-00000c3d104f",
  "upc": "036000291452",
  "vendor_id": "00000000-0000-0000-0000-0000008231f4"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: a582f5dc995f98000000000000000001-bf464c2ac73e9fd8-0

{
  "data": {
    "brand": null,
    "category": {
      "id": "00000000-0000-0000-0000-0000006beeba",
      "name": "Some category 13066",
      "type": "OTHER"
    },
    "custom_data": [],
    "description": null,
    "id": "1e8c8b7f-dbcc-4a73-aab1-a8c8b248eb60",
    "images": [],
    "is_active": true,
    "msrp": null,
    "name": "My Product",
    "sku": "12345",
    "strain": null,
    "subcategory": null,
    "unit_price": "100",
    "unit_type": {
      "id": "00000000-0000-0000-0000-00000c3d104f",
      "name": "Gram"
    },
    "units_per_case": null,
    "updated_datetime": "2025-05-13T13:30:49.270786Z",
    "vendor": {
      "id": "00000000-0000-0000-0000-0000008231f4",
      "name": "Company 31428",
      "updated_datetime": "2025-05-13T13:30:48.534070Z"
    }
  }
}

POST /public/v1/orders Error pointers are properly transformed to reflect the field name that our api users expect

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTEsImlhdCI6MTc0NzE0MzA1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNzY0NDcwZjItMzg0My00NWVlLWJkM2YtNjg0ZDZlOWExYzM1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjczNjAiLCJ0eXAiOiJhY2Nlc3MifQ.BRZgxedHzYArGh918_tadGVazsR5yhyRt-l_z1zdROU

{
  "id": "ee6de46f-9132-480a-bca5-caa2aa8f4c8d",
  "menu_visibility": "INCLUDE_IN_ALL",
  "quantity_available_threshold_max": "-4.5",
  "quantity_available_threshold_min": "-5.5",
  "unit_net_weight": "3.1",
  "unit_serving_size": "5.2"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 3f0da45039e914000000000000000001-0f2799f7a267e0ec-0

{
  "errors": [
    {
      "context": {
        "id": "ee6de46f-9132-480a-bca5-caa2aa8f4c8d"
      },
      "message": "A unit type needs to be selected when setting Unit Net Weight/Volume or Unit Serving Size",
      "pointer": ["unit_net_weight_and_serving_size_unit_type_id"],
      "section": "body"
    },
    {
      "context": {
        "id": "ee6de46f-9132-480a-bca5-caa2aa8f4c8d"
      },
      "message": "Unit Serving Size can't be greater than Unit Net Weight/Volume",
      "pointer": ["unit_serving_size"],
      "section": "body"
    },
    {
      "context": {
        "id": "ee6de46f-9132-480a-bca5-caa2aa8f4c8d"
      },
      "message": "Cannot be negative",
      "pointer": ["quantity_available_threshold_max"],
      "section": "body"
    },
    {
      "context": {
        "id": "ee6de46f-9132-480a-bca5-caa2aa8f4c8d"
      },
      "message": "Cannot be negative",
      "pointer": ["quantity_available_threshold_min"],
      "section": "body"
    }
  ]
}

POST /public/v1/orders Errors when threshold max is less than threshold min

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTIsImlhdCI6MTc0NzE0MzA1MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiM2U2YjViOGMtNmQzMy00MmYyLWJkZTItNmRkMjI0NGE5MmY5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjc2NTciLCJ0eXAiOiJhY2Nlc3MifQ.Zp3ABSM4BRT_FkZd0j_l7IwJBF_nkZwV8vIfTLrSLso

{
  "id": "a5a4cf64-82d1-419b-a7f0-f0450927a8f8",
  "quantity_available_threshold_max": "4.5",
  "quantity_available_threshold_min": "5.5"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 6cc26a2b9cbaec000000000000000001-2268b24aedd7afef-0

{
  "errors": [
    {
      "context": {
        "id": "a5a4cf64-82d1-419b-a7f0-f0450927a8f8"
      },
      "message": "Must be greater than threshold min",
      "pointer": ["quantity_available_threshold_max"],
      "section": "body"
    },
    {
      "context": {
        "id": "a5a4cf64-82d1-419b-a7f0-f0450927a8f8"
      },
      "message": "Must be less than threshold max",
      "pointer": ["quantity_available_threshold_min"],
      "section": "body"
    }
  ]
}

POST /public/v1/orders Cannot use associations from another company

POST /public/v1/products
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NDksImlhdCI6MTc0NzE0MzA0OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjJhZGQ5OGEtZjgxNy00ZjdhLTllZmEtZmE1MWNkYWRkMmI1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjcwNTQiLCJ0eXAiOiJhY2Nlc3MifQ.GRvECXN_wqG4ereCB4H9t-e0VGoDBl7s2Sav16GldoI

{
  "brand_id": "00000000-0000-0000-0000-000000823242",
  "category_id": "00000000-0000-0000-0000-0000006beeec",
  "cbd": "5.2",
  "description": "My Product Description",
  "group_id": "00000000-0000-0000-0000-0000005837e1",
  "id": "268d042b-ebea-4444-bee9-8481ad91839c",
  "inventory_tracking_method": "PACKAGE",
  "is_featured": true,
  "is_inactive": true,
  "menu_visibility": "INCLUDE_IN_ALL",
  "menus": [
    "00000000-0000-0000-0000-00000003c313",
    "00000000-0000-0000-0000-00000003c314",
    "00000000-0000-0000-0000-00000003c315"
  ],
  "msrp": "100.5",
  "name": "My Product",
  "owner_id": "00000000-0000-0000-0000-000001278494",
  "quantity_available_threshold_max": "10.5",
  "quantity_available_threshold_min": "5.5555",
  "sku": "12345",
  "strain_id": "00000000-0000-0000-0000-0000000288ab",
  "subcategory_id": "00000000-0000-0000-0000-0000006c8e3b",
  "tags": [
    "00000000-0000-0000-0000-00000000b061",
    "00000000-0000-0000-0000-00000000b062",
    "00000000-0000-0000-0000-00000000b063"
  ],
  "thc": "10.4",
  "unit_cost": "50.4",
  "unit_net_weight": "3.1",
  "unit_net_weight_and_serving_size_unit_type_id": "00000000-0000-0000-0000-00000c3d178a",
  "unit_price": "100",
  "unit_serving_size": "2.2",
  "unit_type_id": "00000000-0000-0000-0000-00000c3d1791",
  "units_per_case": "0.2",
  "upc": "036000291452",
  "vendor_id": "00000000-0000-0000-0000-00000082323e",
  "wholesale_unit_price": "90.50"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 9474b3f4b6be28000000000000000001-4c81679e028e1b33-0

{
  "errors": [
    {
      "context": {
        "id": "268d042b-ebea-4444-bee9-8481ad91839c"
      },
      "message": "Brand does not exist",
      "pointer": ["brand_id"],
      "section": "body"
    },
    {
      "context": {
        "id": "268d042b-ebea-4444-bee9-8481ad91839c"
      },
      "message": "Category does not exist",
      "pointer": ["category_id"],
      "section": "body"
    },
    {
      "context": {
        "id": "268d042b-ebea-4444-bee9-8481ad91839c"
      },
      "message": "Vendor does not exist",
      "pointer": ["vendor_id"],
      "section": "body"
    },
    {
      "context": {
        "id": "268d042b-ebea-4444-bee9-8481ad91839c"
      },
      "message": "Group does not exist",
      "pointer": ["group_id"],
      "section": "body"
    },
    {
      "context": {
        "id": "268d042b-ebea-4444-bee9-8481ad91839c"
      },
      "message": "Serving unit type does not exist",
      "pointer": ["unit_net_weight_and_serving_size_unit_type_id"],
      "section": "body"
    },
    {
      "context": {
        "id": "268d042b-ebea-4444-bee9-8481ad91839c"
      },
      "message": "Owner does not exist",
      "pointer": ["owner_id"],
      "section": "body"
    },
    {
      "context": {
        "id": "268d042b-ebea-4444-bee9-8481ad91839c"
      },
      "message": "Strain does not exist",
      "pointer": ["strain_id"],
      "section": "body"
    },
    {
      "context": {
        "id": "268d042b-ebea-4444-bee9-8481ad91839c"
      },
      "message": "Subcategory does not belong to the product category",
      "pointer": ["subcategory_id"],
      "section": "body"
    },
    {
      "context": {
        "id": "268d042b-ebea-4444-bee9-8481ad91839c"
      },
      "message": "One or more of the provided tags do not exist",
      "pointer": ["tags"],
      "section": "body"
    },
    {
      "context": {
        "id": "268d042b-ebea-4444-bee9-8481ad91839c"
      },
      "message": "Unit type does not exist",
      "pointer": ["unit_type_id"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Menu does not exist",
      "pointer": ["menus", 0, "00000000-0000-0000-0000-00000003c313"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Menu does not exist",
      "pointer": ["menus", 1, "00000000-0000-0000-0000-00000003c314"],
      "section": "body"
    }
  ]
}

Upsert a single product. To update an existing product, pass in an existing product ID in the id field. When updating a product, you must pass in all fields (no sparse update currently supported).Any existing tag you do not pass in to tags will be deleted. If the menu_visibility field isset to INCLUDE_IN_SELECT, any existing menu that you do not pass into menus will be deleted.

Request

POST /public/v1/products

Parameters

Parameter	Description	In	Type	Required	Example
id	Unique ID for this product. If it exists, an update will be performed; otherwise, it will be used as the ID of a new product record	query	string	false
inventory_tracking_method	Once the tracking method is set for a product, it cannot be changed. The tracking method can be one of the following: PACKAGE: The inventory will be defined by packages. PRODUCT: Not grouped in any manner. The inventory simply exists on your product that you can add or remove as you transact. BATCH: Grouped by batches. Batches share common traits such as expiration dates and test results.	query	string	false	PACKAGE
sku	Stock Keeping Unit (SKU) for this product	query	string	false	SKU123
name	Name of the product	query	string	false	King Size Pre-rolls
vendor_id	The ID of the company_relationship association with the vendor (company) that supplies this product.	query	string	false
category_id	The ID of the product category of the product.	query	string	false
unit_type_id	The ID of the unit type the product.	query	string	false
unit_price	The sale price of the product per unit.	query	number	false
description	Description of the product	query	string	false	A pack of 5 pre-rolls
upc	Universal Product Code (UPC) for this product	query	string	false	123456789012
subcategory_id	The ID of the product subcategory of the product. The provided subcategory must be a child of the provided category.	query	string	false
group_id	The ID of the product's group.	query	string	false
brand_id	The ID of the company_relationship association with the brand (company) that is associated with this product.	query	query	false
quantity_available_threshold_min	The minimum quantity of the product you'd like to maintain. When the product inventory count dips below this number, it will automatically be included in scheduled Low Inventory Reports.	query	number	false
quantity_available_threshold_max	The maximum quantity of the product you'd like to maintain. When the product inventory count exceeds this number, it will automatically be included in scheduled Inventory Reports.	query	number	false
units_per_case	The number of units in a case of the product.	query	number	false
unit_cost	The cost of the product per unit.	query	number	false
msrp	The Manufacturer's Suggested Retail Price (MSRP) of the product per unit. If you have POS integrations enabled in Distru, this may be synced to your POS	query	number	false
wholesale_unit_price	The wholesale price of the product per unit.	query	number	false
is_featured	Whether the product is featured. Featured products will be displayed at the top of menus.	query	boolean	false
strain_id	The ID of the strain associated with the product.	query	string	false
owner_id	The ID of the user that is deemed to be the owner of the product.	query	string	false
is_inactive	Whether the product is inactive from use. Inactive products can be set to active at any time.	query	boolean	false
total_cannabinoid_unit	The unit of the THC/CBD content of the product (MG or PERCENT).	query	string	false
total_thc	The THC content of the product in the unit specified by total_cannabinoid_unit. Must also include total_cannabinoid_unit.	query	string	false
total_cbd	The CBD content of the product in the unit specified by total_cannabinoid_unit. Must also include total_cannabinoid_unit.	query	string	false
menu_visibility	This key is responsible for which menus (if any) the product will be displayed in. DO_NOT_INCLUDE: The product will not be displayed in any menus. INCLUDE_IN_ALL: The product will be displayed in all menus. INCLUDE_IN_SELECT: The product will be displayed in menus that have been explicitly selected (passed into the menus list).	query	string	false
unit_net_weight	The net weight of the product per unit.	query	number	false
unit_serving_size	The serving size of the product per unit.	query	number	false
unit_net_weight_and_serving_size_unit_type_id	The ID of the unit type that the net quantity per unit and serving size are measured in. This field should be null unless the product's unit type is count-based. If this field is set, the act of changing the category from 'Unit' will throw an error.	query	string	false
tags	A list of tags associated with the product.	query	array	false	["0ef8347c-b714-4cd9-ba0e-872488bc9244", "daa0294c-833c-42bd-a133-b4c9e7f64017"]
menus	A list of menus you would like this product to be included in. This field will only be used if the menu_visibility key is set to INCLUDE_IN_SELECT.	query	array	false	["0ef8347c-b714-4cd9-ba0e-872488bc9244", "daa0294c-833c-42bd-a133-b4c9e7f64017"]

Responses

Status	Description	Schema
200	A single product	Product

Purchase

Get purchases

GET /public/v1/purchases returns purchases related to the company

GET /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NzcsImlhdCI6MTc0NzE0Mjg3NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiZmViM2VlMWMtNWU0Yy00NjljLThiOWItNDJhMjRkMmJmNzlhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODc2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzA4MzAiLCJ0eXAiOiJhY2Nlc3MifQ.ZVgOiDMNU5v0raxKuEj9RjbhFKcNO4B9ThWuLZxjR98

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 41722ada9f1cf4000000000000000001-d58009baa2bb4a89-0

{
  "data": [
    {
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081f5f2",
        "name": "Company 5451",
        "updated_datetime": "2025-05-13T13:27:57.244189Z"
      },
      "custom_data": [
        {
          "id": 68736,
          "name": "Custom Field 58",
          "value": null
        }
      ],
      "due_datetime": "2025-05-13T13:27:57.299858Z",
      "id": "00000000-0000-0000-0000-00000004fe84",
      "inserted_datetime": "2025-05-13T13:27:57.301528Z",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdab7",
            "name": "B5575"
          },
          "compliance_quantity": null,
          "id": "461b6d9c-04ea-4484-85d2-7ef8a989d48d",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd85ac",
            "id": "00000000-0000-0000-0000-00000059bf35",
            "license_id": null,
            "name": "Place 2129"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "989b753a-7d18-4349-bd13-8191efebdfbf",
            "name": "Product 5552",
            "sku": "sku 5553",
            "updated_datetime": "2025-05-13T13:27:57.324010Z"
          },
          "quantity": "15.000000000",
          "received_quantity": "0.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdab9",
            "name": "B5577"
          },
          "compliance_quantity": null,
          "id": "d61a6152-0dca-465d-b867-47ed449da705",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd85ac",
            "id": "00000000-0000-0000-0000-00000059bf35",
            "license_id": null,
            "name": "Place 2129"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "f035c834-f9ef-4794-ba47-79120e18defa",
            "name": "Product 5562",
            "sku": "sku 5563",
            "updated_datetime": "2025-05-13T13:27:57.348260Z"
          },
          "quantity": "10.000000000",
          "received_quantity": "0.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdaba",
            "name": "B5578"
          },
          "compliance_quantity": null,
          "id": "8ecdeef9-a9c9-4217-9688-e74c2a39df57",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd85ac",
            "id": "00000000-0000-0000-0000-00000059bf35",
            "license_id": null,
            "name": "Place 2129"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "27e82bba-0d1c-43b4-8711-30470a583e59",
            "name": "Product 5567",
            "sku": "sku 5568",
            "updated_datetime": "2025-05-13T13:27:57.378800Z"
          },
          "quantity": "5.000000000",
          "received_quantity": "0.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdabb",
            "name": "B5579"
          },
          "compliance_quantity": null,
          "id": "e30bce68-29b8-4554-ba4b-6189757edf39",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd85ac",
            "id": "00000000-0000-0000-0000-00000059bf35",
            "license_id": null,
            "name": "Place 2129"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "60c10a50-85e0-440e-8dce-4200afc9256a",
            "name": "Product 5573",
            "sku": "sku 5574",
            "updated_datetime": "2025-05-13T13:27:57.395515Z"
          },
          "quantity": "2.000000000",
          "received_quantity": "0.000000000"
        }
      ],
      "order_datetime": "2025-05-13T13:27:57.299855Z",
      "purchase_number": "Purchase #45",
      "status": "PENDING",
      "total": "32.00",
      "updated_datetime": "2025-05-13T13:27:57.301528Z"
    },
    {
      "charges": [
        {
          "id": "289e4ab9-39f5-4b7d-a464-d48a04877513",
          "name": "C1",
          "percent": "10.0000",
          "price": "1.00",
          "type": "CHARGE",
          "unit_type": "PERCENT"
        }
      ],
      "company": {
        "id": "00000000-0000-0000-0000-00000081f5eb",
        "name": "Company 5441",
        "updated_datetime": "2030-11-01T00:00:00.000000Z"
      },
      "custom_data": [
        {
          "id": 68736,
          "name": "Custom Field 58",
          "value": "Custom Field Value 1"
        }
      ],
      "due_datetime": "2020-01-01T00:00:01.000000Z",
      "id": "00000000-0000-0000-0000-00000004fe83",
      "inserted_datetime": "2020-01-01T00:00:03.000000Z",
      "items": [
        {
          "batch": {
            "batch_number": "UID1",
            "id": "00000000-0000-0000-0000-0000004fdaa5",
            "name": "B1"
          },
          "compliance_quantity": "1.0000",
          "id": "b79b9035-7170-4451-85fc-458dc7e2a948",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd85ac",
            "id": "00000000-0000-0000-0000-00000059bf25",
            "license_id": "00000000-0000-0000-0000-0000003941fe",
            "name": "Place 2114"
          },
          "package": {
            "batch_number": "B1",
            "compliance_label": "ABCDEF012345670000001943",
            "id": "00000000-0000-0000-0000-0000001cd6c0",
            "metrc_label": "ABCDEF012345670000001943",
            "status": "active"
          },
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "8dea2057-4c82-4cd4-acc5-9ebfe7ca2337",
            "name": "P1",
            "sku": "SKU1",
            "updated_datetime": "2023-11-02T00:00:00.000000Z"
          },
          "quantity": "1.000000000",
          "received_quantity": "1.000000000"
        }
      ],
      "order_datetime": "2020-01-01T00:00:02.000000Z",
      "purchase_number": "SO-123",
      "status": "COMPLETED",
      "total": "10.00",
      "updated_datetime": "2020-01-01T00:00:04.000000Z"
    }
  ]
}

GET /public/v1/purchases allows filtering by several statuses

GET /public/v1/purchases?status[]=Completed&status[]=Pending
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODUsImlhdCI6MTc0NzE0Mjg4NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYTgwMTVhYTktM2JiYS00NDg4LTkxMGUtOTNkOTY3YWE5ZDFlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODg0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzIzNDgiLCJ0eXAiOiJhY2Nlc3MifQ.0z94ayBBc1F4i7dXA_AQd76C289FxR9g0RUFG_38mbM

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 958fd6ea4896a8000000000000000001-b767527087393eaa-0

{
  "data": [
    {
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081f8b6",
        "name": "Company 6577",
        "updated_datetime": "2025-05-13T13:28:06.228044Z"
      },
      "custom_data": [],
      "due_datetime": "2025-05-13T13:28:06.288398Z",
      "id": "00000000-0000-0000-0000-00000004feb7",
      "inserted_datetime": "2025-05-13T13:28:06.290327Z",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc7c",
            "name": "B7017"
          },
          "compliance_quantity": null,
          "id": "82920c84-cbd4-45da-9b35-6b4e7f9f335b",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c10f",
            "license_id": null,
            "name": "Place 2598"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "4591067b-c5bb-43f6-baf7-1287d4814943",
            "name": "Product 7001",
            "sku": "sku 7002",
            "updated_datetime": "2025-05-13T13:28:06.317185Z"
          },
          "quantity": "15.000000000",
          "received_quantity": "0.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc7d",
            "name": "B7018"
          },
          "compliance_quantity": null,
          "id": "c03d3f01-e650-4c0b-8279-a4b64a5f3acd",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c10f",
            "license_id": null,
            "name": "Place 2598"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "222b0733-51ac-43f1-badb-d5358954fd81",
            "name": "Product 7007",
            "sku": "sku 7008",
            "updated_datetime": "2025-05-13T13:28:06.343736Z"
          },
          "quantity": "10.000000000",
          "received_quantity": "0.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc80",
            "name": "B7021"
          },
          "compliance_quantity": null,
          "id": "7a4db765-b947-4d9f-8d10-22439d6eed74",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c10f",
            "license_id": null,
            "name": "Place 2598"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "f0f03035-348a-4c29-8b61-5605c4ecfda9",
            "name": "Product 7009",
            "sku": "sku 7010",
            "updated_datetime": "2025-05-13T13:28:06.367517Z"
          },
          "quantity": "5.000000000",
          "received_quantity": "0.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc81",
            "name": "B7022"
          },
          "compliance_quantity": null,
          "id": "4dd20c3f-c023-4e09-b74b-b8ff37ecf8a3",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c10f",
            "license_id": null,
            "name": "Place 2598"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "9f121c5f-0aa3-4055-b3fc-341ac7a32e68",
            "name": "Product 7015",
            "sku": "sku 7016",
            "updated_datetime": "2025-05-13T13:28:06.390520Z"
          },
          "quantity": "2.000000000",
          "received_quantity": "0.000000000"
        }
      ],
      "order_datetime": "2020-01-01T12:30:00.000000Z",
      "purchase_number": "Purchase #81",
      "status": "PENDING",
      "total": "32.00",
      "updated_datetime": "2025-05-13T13:28:06.290327Z"
    },
    {
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081f8a4",
        "name": "Company 6546",
        "updated_datetime": "2025-05-13T13:28:05.947330Z"
      },
      "custom_data": [],
      "due_datetime": "2025-05-13T13:28:06.048292Z",
      "id": "00000000-0000-0000-0000-00000004feb5",
      "inserted_datetime": "2025-05-13T13:28:06.052676Z",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc6f",
            "name": "B6980"
          },
          "compliance_quantity": null,
          "id": "2692f0ad-95a3-42b0-94db-4e4817820572",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c101",
            "license_id": null,
            "name": "Place 2583"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "ee20b14c-9faf-484b-a796-659418929b0d",
            "name": "Product 6967",
            "sku": "sku 6969",
            "updated_datetime": "2025-05-13T13:28:06.089859Z"
          },
          "quantity": "15.000000000",
          "received_quantity": "15.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc70",
            "name": "B6981"
          },
          "compliance_quantity": null,
          "id": "4a63fe8b-61b7-4796-9b40-33f64fdcc935",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c101",
            "license_id": null,
            "name": "Place 2583"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "0ed214b6-f0ce-4699-91e6-cbee8506ff97",
            "name": "Product 6971",
            "sku": "sku 6972",
            "updated_datetime": "2025-05-13T13:28:06.120917Z"
          },
          "quantity": "10.000000000",
          "received_quantity": "10.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc71",
            "name": "B6982"
          },
          "compliance_quantity": null,
          "id": "1e6924f6-fd51-4a03-b117-f0336b290d1d",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c101",
            "license_id": null,
            "name": "Place 2583"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "dfc52c48-68f3-47f0-88ed-4822738f9822",
            "name": "Product 6973",
            "sku": "sku 6974",
            "updated_datetime": "2025-05-13T13:28:06.148023Z"
          },
          "quantity": "5.000000000",
          "received_quantity": "5.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc72",
            "name": "B6983"
          },
          "compliance_quantity": null,
          "id": "1ddf3923-7342-4ca6-b88e-30292045c273",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c101",
            "license_id": null,
            "name": "Place 2583"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "614ae0b5-c3dd-49d0-9d7f-a20f9bd3ca1a",
            "name": "Product 6978",
            "sku": "sku 6979",
            "updated_datetime": "2025-05-13T13:28:06.172853Z"
          },
          "quantity": "2.000000000",
          "received_quantity": "2.000000000"
        }
      ],
      "order_datetime": "2020-01-01T12:20:00.000000Z",
      "purchase_number": "Purchase #80",
      "status": "COMPLETED",
      "total": "32.00",
      "updated_datetime": "2025-05-13T13:28:06.052676Z"
    },
    {
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-00000081f87c",
        "name": "Company 6489",
        "updated_datetime": "2025-05-13T13:28:05.474570Z"
      },
      "custom_data": [],
      "due_datetime": "2025-05-13T13:28:05.538620Z",
      "id": "00000000-0000-0000-0000-00000004feb2",
      "inserted_datetime": "2025-05-13T13:28:05.540121Z",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc51",
            "name": "B6888"
          },
          "compliance_quantity": null,
          "id": "62219a1b-eb00-4a1a-92f4-f5df21ee31e3",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c0e6",
            "license_id": null,
            "name": "Place 2557"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "30e38bf3-8434-498a-9496-fe0e047fc57e",
            "name": "Product 6875",
            "sku": "sku 6876",
            "updated_datetime": "2025-05-13T13:28:05.563414Z"
          },
          "quantity": "15.000000000",
          "received_quantity": "15.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc52",
            "name": "B6889"
          },
          "compliance_quantity": null,
          "id": "5dac00f6-b783-4352-a9e4-07be206353bb",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c0e6",
            "license_id": null,
            "name": "Place 2557"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "013f21db-297e-4ec7-ab9d-2ccebc02a3e1",
            "name": "Product 6877",
            "sku": "sku 6878",
            "updated_datetime": "2025-05-13T13:28:05.583057Z"
          },
          "quantity": "10.000000000",
          "received_quantity": "10.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc53",
            "name": "B6890"
          },
          "compliance_quantity": null,
          "id": "665327b0-357d-4557-b45a-f7264288e42d",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c0e6",
            "license_id": null,
            "name": "Place 2557"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "5cb59ce0-cd2e-4bd6-af04-0040e96657ac",
            "name": "Product 6883",
            "sku": "sku 6884",
            "updated_datetime": "2025-05-13T13:28:05.608341Z"
          },
          "quantity": "5.000000000",
          "received_quantity": "5.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000004fdc54",
            "name": "B6891"
          },
          "compliance_quantity": null,
          "id": "d1a4c6cd-c1fc-401f-9b11-991700c0bed2",
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
            "company_id": "00000000-0000-0000-0000-000000dd89d6",
            "id": "00000000-0000-0000-0000-00000059c0e6",
            "license_id": null,
            "name": "Place 2557"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "fa5b796d-50d0-450e-bb20-617af52b1596",
            "name": "Product 6886",
            "sku": "sku 6887",
            "updated_datetime": "2025-05-13T13:28:05.627473Z"
          },
          "quantity": "2.000000000",
          "received_quantity": "2.000000000"
        }
      ],
      "order_datetime": "2020-01-01T12:00:00.000000Z",
      "purchase_number": "Purchase #78",
      "status": "COMPLETED",
      "total": "32.00",
      "updated_datetime": "2025-05-13T13:28:05.540121Z"
    }
  ]
}

Get purchases sorted by Order Date descendingly date and filtered by various attributes.

Note: The page size for this endpoint is 500 purchase orders per page.

Request

GET /public/v1/purchases

Parameters

Parameter	Description	In	Type	Required	Example
due_datetime	Filter purchases by the due datetime	query	string	false	,2022-07-10T00:00:00Z
inserted_datetime	Filter purchases by their creation datetime	query	string	false	2022-07-10T00:00:00Z,
order_datetime	Filter purchases by the order datetime	query	string	false	2022-07-10T00:00:00Z,2022-07-11T00:00:00Z
page	Pagination information	body	Page	false
status	Filter purchases by their status. Accepted values are "Completed", "Delivering", "Partially Received", "Pending", "Processing".	query	array	false	["Pending","Processing"]
updated_datetime	Filter purchases by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of purchases	Purchases

Insert a payment for a purchase

POST /purchases/:id/payments can create a payment for an purchase with both quickbooks id and name

POST /public/v1/purchases/00000000-0000-0000-0000-00000004fe9c/payments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODEsImlhdCI6MTc0NzE0Mjg4MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjFhY2YxN2MtNGFkMy00NjFmLWI5YjAtZDc3YWU4OTczNjA4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODgwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzE1NzMiLCJ0eXAiOiJhY2Nlc3MifQ.W2_UT6pxrtgSx_Y_bB4nrkWn67dTvXNJGJqO9-BoyUw

{
  "amount": 100.01,
  "description": "Payment for purchase",
  "payment_datetime": "2020-01-01T00:00:00.000000Z",
  "payment_method_id": "00000000-0000-0000-0000-000000018d4b",
  "quickbooks_deposit_account_id": "QBD-123"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 04172532c8cb84000000000000000001-62ff7e6aee5f4ac4-0

{
  "data": {
    "amount": "100.01",
    "description": "Payment for purchase",
    "id": "00000000-0000-0000-0000-00000000730d",
    "inserted_datetime": "2025-05-13T13:28:01.918078Z",
    "payment_date": "2020-01-01T00:00:00.000000Z",
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000018d4b",
      "name": "Payment Method 0"
    },
    "payment_number": "PYT-0000001",
    "purchase_id": "00000000-0000-0000-0000-00000004fe9c",
    "quickbooks_deposit_account_id": "QBD-123"
  }
}

POST /purchases/:id/payments can create a payment for an purchase with both quickbooks id and name

POST /public/v1/purchases/00000000-0000-0000-0000-00000004fe9c/payments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODEsImlhdCI6MTc0NzE0Mjg4MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjFhY2YxN2MtNGFkMy00NjFmLWI5YjAtZDc3YWU4OTczNjA4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODgwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzE1NzMiLCJ0eXAiOiJhY2Nlc3MifQ.W2_UT6pxrtgSx_Y_bB4nrkWn67dTvXNJGJqO9-BoyUw

{
  "amount": 100.01,
  "description": "Payment for purchase",
  "payment_datetime": "2020-01-01T00:00:00.000000Z",
  "payment_method_id": "00000000-0000-0000-0000-000000018d4b",
  "quickbooks_deposit_account_name": "QBD-NAME"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 04172532c8cb84000000000000000001-97b9349f6b7778b4-0

{
  "data": {
    "amount": "100.01",
    "description": "Payment for purchase",
    "id": "00000000-0000-0000-0000-00000000730e",
    "inserted_datetime": "2025-05-13T13:28:02.143263Z",
    "payment_date": "2020-01-01T00:00:00.000000Z",
    "payment_method": {
      "id": "00000000-0000-0000-0000-000000018d4b",
      "name": "Payment Method 0"
    },
    "payment_number": "PYT-0000002",
    "purchase_id": "00000000-0000-0000-0000-00000004fe9c",
    "quickbooks_deposit_account_id": "QBD-123"
  }
}

Request

POST /public/v1/purchases/{id}/payments

Parameters

Parameter	Description	In	Type	Required
payment_method_id	Payment method ID	query	string	true
amount	Amount of the payment. Will round to 2 decimal places	query	decimal	true
payment_datetime	Payment date	query	string	true
description	Description of the payment	query	string	true
quickbooks_deposit_account_id	Quickbooks deposit account ID. Cannot include both this and quickbooks_deposit_account_name. If user's company is integrated with Quickbooks, either this or quickbooks_deposit_account_name must be provided. Account type must be "Bank" or "Credit Card"	query	string	false
quickbooks_deposit_account_name	Quickbooks deposit account name. Cannot include both this and quickbooks_deposit_account_id. If user's company is integrated with Quickbooks, either this or quickbooks_deposit_account_id must be provided. Account type must be "Bank" or "Credit Card"	query	string	false

Responses

Status	Description	Schema
200	A single payment	PurchasePayment

Upsert a purchase order

POST /public/v1/purchases creates a purchase (with product-tracked item)

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NzksImlhdCI6MTc0NzE0Mjg3OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiN2I0NzhhYWQtMGJlZC00ODJmLThhNmQtNDg1YWQwNzQzMjc4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODc4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzEyNTQiLCJ0eXAiOiJhY2Nlc3MifQ.0Zp02yiu5Se2SBEhflbJ775WPVtyiElrKa5zLP9vpIQ

{
  "billing_location_id": "00000000-0000-0000-0000-00000059bfad",
  "charges": [
    {
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    },
    {
      "name": "C2",
      "price": "-5.0000",
      "type": "DISCOUNT",
      "unit_type": "PRICE"
    }
  ],
  "company_id": "00000000-0000-0000-0000-00000081f6a5",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059bfab",
      "price": "10.000000000",
      "product_id": "8d23fb68-f09b-41f0-a299-7cad77e121ab",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059bfab",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: f50534bc694998000000000000000001-2d9474a52fb5dac7-0

{
  "data": {
    "charges": [
      {
        "id": "9bb9c321-8b67-40bf-834c-33ea4d250e73",
        "name": "C1",
        "percent": "10.0000",
        "price": "1.00",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "f2377f73-e957-42f3-b37a-d340ff3fdde9",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f6a5",
      "name": "Company 5713",
      "updated_datetime": "2025-05-13T13:27:59.144735Z"
    },
    "custom_data": [
      {
        "id": 68738,
        "name": "Custom Field 65",
        "value": null
      }
    ],
    "due_datetime": "2020-01-30T00:00:00.000000Z",
    "id": "00000000-0000-0000-0000-00000004fe91",
    "inserted_datetime": "2025-05-13T13:27:59.391959Z",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fdb1d",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "342a2010-e329-401b-9e9d-3103e7760a70",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd86d3",
          "id": "00000000-0000-0000-0000-00000059bfab",
          "license_id": "00000000-0000-0000-0000-00000039424a",
          "name": "Place 2244"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "8d23fb68-f09b-41f0-a299-7cad77e121ab",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:27:59.198765Z"
        },
        "quantity": "1.000000000",
        "received_quantity": "0.000000000"
      }
    ],
    "order_datetime": "2020-01-01T00:00:00.000000Z",
    "purchase_number": "PO-0000001",
    "status": "PENDING",
    "total": "6.00",
    "updated_datetime": "2025-05-13T13:27:59.406606Z"
  }
}

POST /public/v1/purchases creates a purchase (with batch-tracked item)

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODgsImlhdCI6MTc0NzE0Mjg4OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZWZiMzg2ZmUtODk4Mi00ZDI2LThiZmYtOTczNjgyYTdjZGVhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODg3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzMwNDkiLCJ0eXAiOiJhY2Nlc3MifQ.iGdR7bYDhPAr5IEsGj4iu6nJYbFYc5Gqeqs2seC1Ri0

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c1b0",
  "charges": [
    {
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    },
    {
      "name": "C2",
      "price": "-5.0000",
      "type": "DISCOUNT",
      "unit_type": "PRICE"
    }
  ],
  "company_id": "00000000-0000-0000-0000-00000081f9af",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "items": [
    {
      "batch_id": "00000000-0000-0000-0000-0000004fdd06",
      "location_id": "00000000-0000-0000-0000-00000059c1b0",
      "price": "10.000000000",
      "product_id": "974f3a38-b427-49b3-baed-4c6e3f3b63e1",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c1b0",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 07f8938226697f400000000000000001-9c9743855f4d46bd-0

{
  "data": {
    "charges": [
      {
        "id": "9ceffbac-a57b-423d-8ba6-373e21ff23c3",
        "name": "C1",
        "percent": "10.0000",
        "price": "1.00",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "acb12454-c60a-4730-ad06-0bfb9eaddeb9",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f9af",
      "name": "Company 6983",
      "updated_datetime": "2025-05-13T13:28:08.802165Z"
    },
    "custom_data": [],
    "due_datetime": "2020-01-30T00:00:00.000000Z",
    "id": "00000000-0000-0000-0000-00000004fece",
    "inserted_datetime": "2025-05-13T13:28:08.902568Z",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fdd06",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "8223d6e0-76cf-4048-bc1c-f7db66ddc87d",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd8bca",
          "id": "00000000-0000-0000-0000-00000059c1b0",
          "license_id": "00000000-0000-0000-0000-00000039437d",
          "name": "Place 2759"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "974f3a38-b427-49b3-baed-4c6e3f3b63e1",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:28:08.857573Z"
        },
        "quantity": "1.000000000",
        "received_quantity": "0.000000000"
      }
    ],
    "order_datetime": "2020-01-01T00:00:00.000000Z",
    "purchase_number": "PO-0000001",
    "status": "PENDING",
    "total": "6.00",
    "updated_datetime": "2025-05-13T13:28:08.920220Z"
  }
}

POST /public/v1/purchases creates a purchase (with package-tracked item)

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODgsImlhdCI6MTc0NzE0Mjg4OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYWMxNGUxNzQtNWE1My00YmNkLWIwNTQtM2EyOGY5OTAyNjIxIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODg3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzI5ODIiLCJ0eXAiOiJhY2Nlc3MifQ.Z-tM7qkIbGu3Fkoj7WJg_XOaiolJtbJdHOALIq1c5Gg

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c1a1",
  "charges": [
    {
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    },
    {
      "name": "C2",
      "price": "-5.0000",
      "type": "DISCOUNT",
      "unit_type": "PRICE"
    }
  ],
  "company_id": "00000000-0000-0000-0000-00000081f98d",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059c1a1",
      "price": "10.000000000",
      "product_id": "f7d0f116-b7f3-4b26-802b-fa156934ab10",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c1a1",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: c8f50819430f48000000000000000001-49344dd0c78df712-0

{
  "data": {
    "charges": [
      {
        "id": "bc547528-bbfb-459a-9206-6dbdf466b4be",
        "name": "C1",
        "percent": "10.0000",
        "price": "1.00",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "4567384b-0dd8-4710-bf6d-f8110f0f38ce",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f98d",
      "name": "Company 6929",
      "updated_datetime": "2025-05-13T13:28:08.521029Z"
    },
    "custom_data": [],
    "due_datetime": "2020-01-30T00:00:00.000000Z",
    "id": "00000000-0000-0000-0000-00000004feca",
    "inserted_datetime": "2025-05-13T13:28:08.615913Z",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fdcf1",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "b42396eb-ba22-4097-a3a3-511f14fd241a",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd8b95",
          "id": "00000000-0000-0000-0000-00000059c1a1",
          "license_id": "00000000-0000-0000-0000-000000394374",
          "name": "Place 2744"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "f7d0f116-b7f3-4b26-802b-fa156934ab10",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:28:08.578475Z"
        },
        "quantity": "1.000000000",
        "received_quantity": "0.000000000"
      }
    ],
    "order_datetime": "2020-01-01T00:00:00.000000Z",
    "purchase_number": "PO-0000001",
    "status": "PENDING",
    "total": "6.00",
    "updated_datetime": "2025-05-13T13:28:08.628458Z"
  }
}

POST /public/v1/purchases updates a purchase

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODQsImlhdCI6MTc0NzE0Mjg4NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODAwMGIwNDUtZGM4ZS00MGQyLWI4OTYtOTc2NjY1ZTIyOGQ0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODgzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzIxNzkiLCJ0eXAiOiJhY2Nlc3MifQ._nDks5KfSGy19bZImVGEJ3biHD5zCLxbztVdBPWA7AM

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c0b9",
  "charges": [
    {
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    }
  ],
  "company_id": "00000000-0000-0000-0000-00000081f832",
  "due_datetime": "2020-01-20T00:00:00.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059c0b9",
      "price": "10.000000000",
      "product_id": "efa87141-396d-4ac5-8e3d-3f8783305bf7",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c0b9",
  "order_datetime": "2020-01-02T00:00:00.000000Z"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 0854964ed9206a800000000000000001-7f10e10c49bf38e1-0

{
  "data": {
    "charges": [
      {
        "id": "47c7f641-7f52-4d01-8171-65a1710e7650",
        "name": "C1",
        "percent": "10.0000",
        "price": "1.00",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f832",
      "name": "Company 6366",
      "updated_datetime": "2025-05-13T13:28:04.504300Z"
    },
    "custom_data": [],
    "due_datetime": "2020-01-20T00:00:00.000000Z",
    "id": "00000000-0000-0000-0000-00000004feb0",
    "inserted_datetime": "2025-05-13T13:28:04.676263Z",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fdc21",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "d2b1aeec-511f-43fe-b8c8-6771896ce0e4",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd8960",
          "id": "00000000-0000-0000-0000-00000059c0b9",
          "license_id": "00000000-0000-0000-0000-0000003942ea",
          "name": "Place 2512"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "efa87141-396d-4ac5-8e3d-3f8783305bf7",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:28:04.581746Z"
        },
        "quantity": "1.000000000",
        "received_quantity": "0.000000000"
      }
    ],
    "order_datetime": "2020-01-02T00:00:00.000000Z",
    "purchase_number": "PO-0000001",
    "status": "PENDING",
    "total": "11.00",
    "updated_datetime": "2025-05-13T13:28:04.694069Z"
  }
}

POST /public/v1/purchases updates a purchase

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODQsImlhdCI6MTc0NzE0Mjg4NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODAwMGIwNDUtZGM4ZS00MGQyLWI4OTYtOTc2NjY1ZTIyOGQ0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODgzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzIxNzkiLCJ0eXAiOiJhY2Nlc3MifQ._nDks5KfSGy19bZImVGEJ3biHD5zCLxbztVdBPWA7AM

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c0b9",
  "charges": [
    {
      "id": "47c7f641-7f52-4d01-8171-65a1710e7650",
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    },
    {
      "name": "C2",
      "percent": null,
      "price": "-5.00",
      "type": "DISCOUNT",
      "unit_type": "PRICE"
    }
  ],
  "company_id": "00000000-0000-0000-0000-00000081f832",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "id": "00000000-0000-0000-0000-00000004feb0",
  "items": [
    {
      "id": "d2b1aeec-511f-43fe-b8c8-6771896ce0e4",
      "location_id": "00000000-0000-0000-0000-00000059c0b9",
      "price": "10.000000000",
      "product_id": "efa87141-396d-4ac5-8e3d-3f8783305bf7",
      "quantity": "1.000000000"
    },
    {
      "batch_id": "00000000-0000-0000-0000-0000004fdc23",
      "location_id": "00000000-0000-0000-0000-00000059c0b9",
      "price": "5.000000000",
      "product_id": "d608d1cd-d195-4d15-a8d7-d3dcc8cefdfd",
      "quantity": "2.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c0b9",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 0854964ed9206a800000000000000001-ef956866c9c56434-0

{
  "data": {
    "charges": [
      {
        "id": "47c7f641-7f52-4d01-8171-65a1710e7650",
        "name": "C1",
        "percent": "10.0000",
        "price": "2.00",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "50d4364a-1e1b-4733-a68b-7b5ac232a762",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f832",
      "name": "Company 6366",
      "updated_datetime": "2025-05-13T13:28:04.504300Z"
    },
    "custom_data": [],
    "due_datetime": "2020-01-30T00:00:00.000000Z",
    "id": "00000000-0000-0000-0000-00000004feb0",
    "inserted_datetime": "2025-05-13T13:28:04.676263Z",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fdc21",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "d2b1aeec-511f-43fe-b8c8-6771896ce0e4",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd8960",
          "id": "00000000-0000-0000-0000-00000059c0b9",
          "license_id": "00000000-0000-0000-0000-0000003942ea",
          "name": "Place 2512"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "efa87141-396d-4ac5-8e3d-3f8783305bf7",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2025-05-13T13:28:04.581746Z"
        },
        "quantity": "1.000000000",
        "received_quantity": "0.000000000"
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fdc23",
          "name": "B2"
        },
        "compliance_quantity": null,
        "id": "d4707f97-77b2-4d7d-8fbb-62f1fdaaa77d",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd8960",
          "id": "00000000-0000-0000-0000-00000059c0b9",
          "license_id": "00000000-0000-0000-0000-0000003942ea",
          "name": "Place 2512"
        },
        "package": null,
        "price": "5.000000000",
        "price_base": "5.000000000",
        "product": {
          "id": "d608d1cd-d195-4d15-a8d7-d3dcc8cefdfd",
          "name": "P2",
          "sku": "SKU2",
          "updated_datetime": "2025-05-13T13:28:04.622952Z"
        },
        "quantity": "2.000000000",
        "received_quantity": "0.000000000"
      }
    ],
    "order_datetime": "2020-01-01T00:00:00.000000Z",
    "purchase_number": "PO-0000001",
    "status": "PENDING",
    "total": "17.00",
    "updated_datetime": "2025-05-13T13:28:04.976568Z"
  }
}

POST /public/v1/purchases updating a purchase removes line items that aren't included in the payload

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODIsImlhdCI6MTc0NzE0Mjg4MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODUyZDgxYTktM2YxOC00NTdiLWJlZmItZTRhYzdkOTUxZDk2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODgxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzE3NjkiLCJ0eXAiOiJhY2Nlc3MifQ.7QIvSoOrpJyuZT-AlD3EojlgKURd99utexjcI6va9JY

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c044",
  "company_id": "00000000-0000-0000-0000-00000081f77b",
  "due_datetime": "2020-01-20T00:00:00.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059c044",
      "price": "10",
      "product_id": "5a39ee82-ed43-441a-bd46-c2d622a39f01",
      "quantity": "1"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c044",
  "order_datetime": "2020-01-02T00:00:00.000000Z"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: bcf75f5068db78000000000000000001-126196c3e69de3ef-0

{
  "data": {
    "charges": [],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f77b",
      "name": "Company 6069",
      "updated_datetime": "2025-05-13T13:28:02.328309Z"
    },
    "custom_data": [],
    "due_datetime": "2020-01-20T00:00:00.000000Z",
    "id": "00000000-0000-0000-0000-00000004fea1",
    "inserted_datetime": "2025-05-13T13:28:02.408960Z",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fdbac",
          "name": "B6384"
        },
        "compliance_quantity": null,
        "id": "80485dbe-c049-48c9-957a-f0fa59e9eb4d",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd8835",
          "id": "00000000-0000-0000-0000-00000059c044",
          "license_id": "00000000-0000-0000-0000-0000003942a8",
          "name": "Place 2396"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "5a39ee82-ed43-441a-bd46-c2d622a39f01",
          "name": "Product 6377",
          "sku": "sku 6378",
          "updated_datetime": "2025-05-13T13:28:02.365490Z"
        },
        "quantity": "1.000000000",
        "received_quantity": "0.000000000"
      }
    ],
    "order_datetime": "2020-01-02T00:00:00.000000Z",
    "purchase_number": "PO-0000001",
    "status": "PENDING",
    "total": "10.00",
    "updated_datetime": "2025-05-13T13:28:02.408960Z"
  }
}

POST /public/v1/purchases updating a purchase removes line items that aren't included in the payload

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODIsImlhdCI6MTc0NzE0Mjg4MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODUyZDgxYTktM2YxOC00NTdiLWJlZmItZTRhYzdkOTUxZDk2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODgxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzE3NjkiLCJ0eXAiOiJhY2Nlc3MifQ.7QIvSoOrpJyuZT-AlD3EojlgKURd99utexjcI6va9JY

{
  "company_id": "00000000-0000-0000-0000-00000081f77b",
  "id": "00000000-0000-0000-0000-00000004fea1",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059c044",
      "price": "2",
      "product_id": "5a39ee82-ed43-441a-bd46-c2d622a39f01",
      "quantity": "1"
    }
  ]
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: bcf75f5068db78000000000000000001-fb0b1747519ef8ac-0

{
  "data": {
    "charges": [],
    "company": {
      "id": "00000000-0000-0000-0000-00000081f77b",
      "name": "Company 6069",
      "updated_datetime": "2025-05-13T13:28:02.328309Z"
    },
    "custom_data": [],
    "due_datetime": "2020-01-20T00:00:00.000000Z",
    "id": "00000000-0000-0000-0000-00000004fea1",
    "inserted_datetime": "2025-05-13T13:28:02.408960Z",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000004fdbac",
          "name": "B6384"
        },
        "compliance_quantity": null,
        "id": "ec9792e6-723f-4f32-b49e-438c62ea03f9",
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 88888, USA",
          "company_id": "00000000-0000-0000-0000-000000dd8835",
          "id": "00000000-0000-0000-0000-00000059c044",
          "license_id": "00000000-0000-0000-0000-0000003942a8",
          "name": "Place 2396"
        },
        "package": null,
        "price": "2.000000000",
        "price_base": "2.000000000",
        "product": {
          "id": "5a39ee82-ed43-441a-bd46-c2d622a39f01",
          "name": "Product 6377",
          "sku": "sku 6378",
          "updated_datetime": "2025-05-13T13:28:02.365490Z"
        },
        "quantity": "1.000000000",
        "received_quantity": "0.000000000"
      }
    ],
    "order_datetime": "2020-01-02T00:00:00.000000Z",
    "purchase_number": "PO-0000001",
    "status": "PENDING",
    "total": "2.00",
    "updated_datetime": "2025-05-13T13:28:02.550608Z"
  }
}

POST /public/v1/purchases does not update a purchase that has moved beyond Pending status

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0OTEsImlhdCI6MTc0NzE0Mjg5MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjZiMzg5ZWItM2EwZS00NjA4LTgwM2QtODE1ZjgyZGNjMzNkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODkwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzM2MjgiLCJ0eXAiOiJhY2Nlc3MifQ.xTqzOAVW61doPDDi7vdUQdsFmtSBtHkTsCRHgPdGo0E

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c24f",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081fb1f",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "id": "00000000-0000-0000-0000-00000004fee7",
  "items": [
    {
      "batch_id": "00000000-0000-0000-0000-0000004fddbf",
      "id": "71a72a5f-0e1d-4f78-96f5-7d5c884771e5",
      "location_id": "00000000-0000-0000-0000-00000059c24f",
      "price": "10.000000000",
      "product_id": "3572db3b-6af9-4862-b15e-6c81d795fcdc",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c24f",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 0708a2ea18a142c00000000000000001-2604e1781cbc8322-0

{
  "errors": [
    {
      "context": {},
      "message": "Cannot change this PO through the Distru API because it's beyond Pending status",
      "pointer": ["status"],
      "section": "body"
    }
  ]
}

POST /public/v1/purchases does not create a purchase with a company relationship that belongs to another company

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODQsImlhdCI6MTc0NzE0Mjg4NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOGVhNTAyMGQtN2QyNy00NjhhLTg1MzYtYmI5MzEyMmI0YTY2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODgzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzIxNDkiLCJ0eXAiOiJhY2Nlc3MifQ.Xtnwg_OHeCymtCq5A55vCfBI68qBSk3R7WeWFa05SVY

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c0b2",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081f828",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059c0b2",
      "price": "10.000000000",
      "product_id": "307be7b6-8a05-4a40-a2ae-abfeadcbc197",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c0b2",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 5151a8e73b21cc000000000000000001-0369b1f429033bf5-0

{
  "errors": [
    {
      "context": {},
      "message": "The provided supplier does not exist",
      "pointer": ["company_id"],
      "section": "body"
    }
  ]
}

POST /public/v1/purchases does not create a purchase with a product that belongs to another company

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODUsImlhdCI6MTc0NzE0Mjg4NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODMwZjMyMjctOGJlNS00NjMyLWFkZDgtNGIyODU0ZDUxY2U4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODg0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzIyOTgiLCJ0eXAiOiJhY2Nlc3MifQ.T99GU-E5Ee18EO7DBcZM8AGZUslGjeV0YL1pz0yaxLo

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c0da",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081f861",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059c0da",
      "price": "10.000000000",
      "product_id": "800b2dd9-3f68-473c-878f-ec61228ad31c",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c0da",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 53378784510880000000000000000001-9da0379880f655e5-0

{
  "errors": [
    {
      "context": {
        "id": "92e3f388-7160-42b8-9adb-0110d186dc94"
      },
      "message": "This record does not belong to your company.",
      "pointer": ["items", 0, "product_id"],
      "section": "body"
    }
  ]
}

POST /public/v1/purchases does not create a purchase with a batch that belongs to another company

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0OTEsImlhdCI6MTc0NzE0Mjg5MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiM2RiZDg0NmYtNDcwNS00MGY3LTkzNDgtODBjNDcwOTdkYzEwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODkwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzM1OTQiLCJ0eXAiOiJhY2Nlc3MifQ.-i3WW15HzsVEFA_HsjKEHrblyFtyqqjC6sQpSAJbWSE

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c24b",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081faff",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "items": [
    {
      "batch_id": "00000000-0000-0000-0000-0000004fddad",
      "location_id": "00000000-0000-0000-0000-00000059c24b",
      "price": "10.000000000",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c24b",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: a4b98269e570a0000000000000000001-e1e3879588ef6965-0

{
  "errors": [
    {
      "context": {
        "id": "6c3745a3-cfa5-4dc9-9f4c-11d93147b685"
      },
      "message": "This record does not belong to your company.",
      "pointer": ["items", 0, "product_id"],
      "section": "body"
    }
  ]
}

POST /public/v1/purchases does not create a purchase with a location that belongs to another company

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0OTIsImlhdCI6MTc0NzE0Mjg5MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGRjNGFmMTgtMWE2Yi00NzliLTg5ZjQtYzgzODE3Nzg0M2QwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODkxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzM2OTgiLCJ0eXAiOiJhY2Nlc3MifQ.pG4ybIXmn-pu-cjGt7uh-7CViM57S-_qsL6IZ5STM28

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c262",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081fb37",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059c265",
      "price": "10.000000000",
      "product_id": "4b6546dc-f15d-4d9e-9b23-8fbb4181fcfe",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c265",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: ddc5baf9ed6e90000000000000000001-d1121c075d1b0d10-0

{
  "errors": [
    {
      "context": {
        "id": "0d423931-99d7-4bce-a2fa-500708695f83"
      },
      "message": "This record does not belong to your company.",
      "pointer": ["items", 0, "location_id"],
      "section": "body"
    }
  ]
}

POST /public/v1/purchases does not create a purchase with a location different from the order items

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODgsImlhdCI6MTc0NzE0Mjg4OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOGI1NjM1MGQtMThjYS00ZjhiLWJmODgtMDc4YjFiYjFmMGMwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODg3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzI5NDIiLCJ0eXAiOiJhY2Nlc3MifQ.4FvYtXbDjMD6TfGbg9zxZRnFQHKXq0FYx5qaOVE7yAo

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c196",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081f978",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059c196",
      "price": "10.000000000",
      "product_id": "f1d753f4-8e2a-4a2e-a872-5581a8ad7656",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c198",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 1ec6cb526f75d3000000000000000001-9896cd1ddcc4b5ea-0

{
  "errors": [
    {
      "context": {
        "id": "900135c2-2173-4d00-a09e-68851671b1f5"
      },
      "message": "Purchase item delivery location must be the same as purchase delivery location.",
      "pointer": ["items", 0, "location_id"],
      "section": "body"
    }
  ]
}

POST /public/v1/purchases does not create a purchase with a billing location that belongs to another company

POST /public/v1/purchases
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0ODIsImlhdCI6MTc0NzE0Mjg4MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZTVjZTU2ZjEtZDI5MC00ZWZmLWIwYTktNjAwYjVkNGUxMWNmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODgxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzE4NjEiLCJ0eXAiOiJhY2Nlc3MifQ.c485M74xyeHN51_OzVFp8oI2lG3QMRRyo53VyGrdBGw

{
  "billing_location_id": "00000000-0000-0000-0000-00000059c064",
  "charges": [],
  "company_id": "00000000-0000-0000-0000-00000081f7a0",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-00000059c062",
      "price": "10.000000000",
      "product_id": "b23e648d-0317-4690-b5bd-c989ac474c6b",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-00000059c062",
  "order_datetime": "2020-01-01T00:00:00.000000Z"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: c12997a499c0a0000000000000000001-e0dd7316a76021eb-0

{
  "errors": [
    {
      "context": {},
      "message": "The provided billing address does not exist",
      "pointer": ["billing_location_id"],
      "section": "body"
    }
  ]
}

Upsert a single purchase order. To update an existing purchase order, pass in an existing purchase order ID in the id field. When updating a purchase order, you must pass in all fields (no sparse update currently supported). Any existing order item or charge you do not pass in to items and charges respectively will be deleted

Request

POST /public/v1/purchases

Parameters

Parameter	Description	In	Type	Required
id	Unique ID for this purchase order. If it exists, an update will be performed; otherwise, it will be used as the ID of a new purchase order record	query	string	false
description	A description of the purchase order	query	string	false
location_id	The location into which the inventory in this purchase will be received	query	string	false
billing_location_id	The billing address for this purchase order	query	string	false
company_id	The company that is the supplier for this purchase order	query	string	false
order_datetime	The datetime on which the purchase order was placed	query	string	false
due_datetime	The datetime by which the purchase order should be paid	query	string	false
charges	The additional lines of Charge, Discount, or Tax added to this purchase order	body	PurchaseChargesRequest	false
items	The items present on this purchase order	body	PurchaseItemsRequest	false
billing_location_id	The billing location's ID	query	string	false

Responses

Status	Description	Schema
200	A single purchase orders	Purchase

StockAdjustment

Get adjustments

GET /public/v1/adjustments returns proper data for stock adjustments of product/batch/package tracked

GET /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NDgsImlhdCI6MTc0NzE0MzA0OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTNkNDJlZTUtZmE2YS00MmFkLWJiOTEtOTAyMmYzM2JkYTRmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjY5MTkiLCJ0eXAiOiJhY2Nlc3MifQ.gNQ6XcNyM3pEKVDeVbzlMqt7k6PjcW7jZsk2O8Z17uE

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 57b59ce561f308000000000000000001-f76219782542c68f-0

{
  "data": [
    {
      "batch_id": null,
      "completion_datetime": "2025-05-13T13:30:48.776082Z",
      "compliance_quantity": null,
      "description": null,
      "id": "00000000-0000-0000-0000-000000021852",
      "license_id": null,
      "location_id": null,
      "owner_id": "00000000-0000-0000-0000-000001278407",
      "package_id": null,
      "product_id": "14ee7813-a732-4fa0-b475-56c854b2820c",
      "quantity": "10",
      "reason": "revaluation",
      "total_cost": "10000"
    },
    {
      "batch_id": null,
      "completion_datetime": "2025-05-13T13:30:49.016042Z",
      "compliance_quantity": "1",
      "description": "A default note describing this transaction",
      "id": "00000000-0000-0000-0000-000000021853",
      "license_id": "00000000-0000-0000-0000-000000395ce3",
      "location_id": "00000000-0000-0000-0000-00000059e8b0",
      "owner_id": null,
      "package_id": "00000000-0000-0000-0000-0000001ce513",
      "product_id": "72d3bb1e-3622-495d-ad80-f6bb1d45a2c7",
      "quantity": "1",
      "reason": "Voluntary Surrender",
      "total_cost": "900"
    },
    {
      "batch_id": "00000000-0000-0000-0000-000000500199",
      "completion_datetime": "2025-05-13T13:30:49.182638Z",
      "compliance_quantity": null,
      "description": null,
      "id": "00000000-0000-0000-0000-000000021854",
      "license_id": null,
      "location_id": "00000000-0000-0000-0000-00000059e8ad",
      "owner_id": null,
      "package_id": null,
      "product_id": "18c063c3-b38e-4104-8336-92156f7b1e0d",
      "quantity": "1",
      "reason": "revaluation",
      "total_cost": "-800"
    }
  ]
}

Get stock adjustments sorted by their creation date and filtered by various attributes

Note: The page size for this endpoint is 5000 stock adjustments per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/adjustments

Parameters

Parameter	Description	In	Type	Required	Default	Example
inserted_datetime	Filter stock adjustments by their creation datetime	query	string	false		2022-07-10T00:00:00Z,
page	Pagination information	body	Page	false

Responses

Status	Description	Schema
200	A list of stock adjustments	StockAdjustments

Insert a stock adjustment

POST /public/v1/adjustments creates an adjustment for a product tracked product

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTEsImlhdCI6MTc0NzE0MzA1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNDkwZmQxNTEtZDUyZC00ZTk3LThiMTEtMmM4N2M0N2Q3MmM0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjczNTYiLCJ0eXAiOiJhY2Nlc3MifQ.FQtphP3kV0c4nFcd7Mbo79hI-DNkGKqt3v2YYZBPOME

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "location_id": "00000000-0000-0000-0000-00000059e93d",
  "product_id": "973530a1-8882-46d0-b31f-f29de4b53951",
  "quantity": 10,
  "reason": "expired"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 74b8f1d8fbe968000000000000000001-c525b45eca525021-0

{
  "data": {
    "batch_id": null,
    "completion_datetime": "2020-01-03T12:20:00.000000Z",
    "compliance_quantity": null,
    "description": "test",
    "id": "00000000-0000-0000-0000-000000021857",
    "license_id": null,
    "location_id": "00000000-0000-0000-0000-00000059e93d",
    "owner_id": null,
    "package_id": null,
    "product_id": "973530a1-8882-46d0-b31f-f29de4b53951",
    "quantity": "10",
    "reason": "expired",
    "total_cost": null
  }
}

POST /public/v1/adjustments creates an adjustment for a batch tracked product

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTAsImlhdCI6MTc0NzE0MzA1MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNjFkOWVkNWMtZDIwNi00MWMzLWFhZGUtMmEwMjg1YTlhMmUxIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjcxMTQiLCJ0eXAiOiJhY2Nlc3MifQ.oA3oB2j4FzOG69TSJ29ClWNKj2ng9I7dgqhsTX0CJW4

{
  "batch_id": "00000000-0000-0000-0000-0000005001b5",
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "location_id": "00000000-0000-0000-0000-00000059e8ea",
  "quantity": 10,
  "reason": "expired"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 7ded08998e28cc000000000000000001-35535c4a6114de33-0

{
  "data": {
    "batch_id": "00000000-0000-0000-0000-0000005001b5",
    "completion_datetime": "2020-01-03T12:20:00.000000Z",
    "compliance_quantity": null,
    "description": "test",
    "id": "00000000-0000-0000-0000-000000021856",
    "license_id": null,
    "location_id": "00000000-0000-0000-0000-00000059e8ea",
    "owner_id": null,
    "package_id": null,
    "product_id": "dcc9b33d-c818-46d2-90fe-a432f4f9e8c2",
    "quantity": "10",
    "reason": "expired",
    "total_cost": null
  }
}

POST /public/v1/adjustments creates an adjustment for a package tracked product

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTIsImlhdCI6MTc0NzE0MzA1MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODRlOTg1YTYtNDQwMC00YTliLWE1NDgtY2JiMjViOWRhNzk2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjc1MjQiLCJ0eXAiOiJhY2Nlc3MifQ.22k5EbI5Fqe-rQO3-pAC3xN9_uTuzHS8JBrPq4Xp82k

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "compliance_quantity": 10,
  "description": "test",
  "package_id": "00000000-0000-0000-0000-0000001ce546",
  "reason": "Damage (BCC)"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 7befe85f2d585c000000000000000001-b37eaf98c8947e6f-0

{
  "data": {
    "batch_id": null,
    "completion_datetime": "2020-01-03T12:20:00.000000Z",
    "compliance_quantity": "10",
    "description": "test",
    "id": "00000000-0000-0000-0000-000000021859",
    "license_id": "00000000-0000-0000-0000-000000395d3a",
    "location_id": "00000000-0000-0000-0000-00000059e972",
    "owner_id": null,
    "package_id": "00000000-0000-0000-0000-0000001ce546",
    "product_id": "a201f470-8630-4e49-acef-394e27ba72a2",
    "quantity": "0.35274",
    "reason": "Damage (BCC)",
    "total_cost": null
  }
}

POST /public/v1/adjustments pointer translation works as intended

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTAsImlhdCI6MTc0NzE0MzA1MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMmUyMDg4NzQtNWU2OC00NDY4LTk3ODEtODE4YmI0NDQxOGVmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjcyNDIiLCJ0eXAiOiJhY2Nlc3MifQ.XG6D9ZYxXC1vtZdwYHx6g9sn5jvI8uAeThP6zhwr8RE

{
  "description": "test",
  "package_id": "00000000-0000-0000-0000-0000001ce529",
  "quantity": 10,
  "reason": "Damage (BCC)"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: c10ab69897e048000000000000000001-b0e1cff2bd0f474a-0

{
  "errors": [
    {
      "context": {},
      "message": "can't be blank",
      "pointer": ["completion_datetime"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Required for adjustments of package tracked products",
      "pointer": ["compliance_quantity"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Cannot be set for adjustments of package tracked products",
      "pointer": ["quantity"],
      "section": "body"
    }
  ]
}

POST /public/v1/adjustments pointer translation works for cost accounting as well

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTEsImlhdCI6MTc0NzE0MzA1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZWJiNGQ5MDktYTdiNC00NmY5LTlhM2YtNGZmZmNkNGNlNzlkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjc0ODUiLCJ0eXAiOiJhY2Nlc3MifQ.tVT_TEix-lJLkW_JWuEP-PiBfOJX-oiKKrv-YgyMovc

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "location_id": "00000000-0000-0000-0000-00000059e968",
  "product_id": "0482995b-b235-48e6-a874-69b4fec1adde",
  "quantity": 10,
  "reason": "expired"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 8b12526883b8c0000000000000000001-89dca59b714fc749-0

{
  "errors": [
    {
      "context": {},
      "message": "Your company cost settings require a cost to be set when adding quantity",
      "pointer": ["unit_cost"],
      "section": "body"
    }
  ]
}

POST /public/v1/adjustments validates quantity for non-compliance adjustments

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NDksImlhdCI6MTc0NzE0MzA0OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZWIxZDA4ODEtOTA0NC00MWZjLTg0Y2YtNGFlNGZkODczOWFmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjcwNTYiLCJ0eXAiOiJhY2Nlc3MifQ.oVg4ldfi849NBfmE52ZeNeJOYxBjnjONBe_g2QKeZLo

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "compliance_quantity": 10,
  "description": "test",
  "location_id": "00000000-0000-0000-0000-00000059e8d7",
  "product_id": "5d1460ed-9769-47ed-adcb-ceab65cebe3b",
  "reason": "expired"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: e3d326713f79c0000000000000000001-94015a3e726f135c-0

{
  "errors": [
    {
      "context": {},
      "message": "Cannot be set for adjustments of non-package tracked products",
      "pointer": ["compliance_quantity"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Required for adjustments of non-package tracked products",
      "pointer": ["quantity"],
      "section": "body"
    }
  ]
}

validates only one id can be passed

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTEsImlhdCI6MTc0NzE0MzA1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTM5YmRlMDgtZWU0Ny00YWJmLTk5NTYtM2ZlOTgxM2M5YjA0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjc0MDEiLCJ0eXAiOiJhY2Nlc3MifQ.TJJkz3m-mepMeDpGXhCBq4Gb1pdYjuwB2DvbSraSFy4

{
  "batch_id": "283a9f6c-d5dd-402b-b3ed-d69f41725b87",
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "location_id": "741b2840-202f-4c6d-a39d-23d28742ad13",
  "package_id": "0ab9319f-87f5-498f-b88b-228f3d3ec87a",
  "product_id": "b523850e-8bce-4ac5-aaf4-81260c491c2e",
  "reason": "expired"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: ad4c64c3eb6b18000000000000000001-071b7489d42b16ec-0

{
  "errors": [
    {
      "context": {},
      "message": "Only one of batch_id, package_id, or product_id can be set",
      "pointer": ["batch_id"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Required for adjustments of package tracked products",
      "pointer": ["compliance_quantity"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Cannot be set for adjustments of package tracked products because the source will automatically be set to the location of the package",
      "pointer": ["location_id"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Only one of batch_id, package_id, or product_id can be set",
      "pointer": ["package_id"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Only one of batch_id, package_id, or product_id can be set",
      "pointer": ["product_id"],
      "section": "body"
    }
  ]
}

validates at least one id is passed

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTMsImlhdCI6MTc0NzE0MzA1MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiY2UyMTE1ZGMtMDcyYi00YzNkLWIxNzEtMzgyNGUwODY2MjUzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjc3MzQiLCJ0eXAiOiJhY2Nlc3MifQ.v1_S0ABhR-Ukpxx2UpTtS8peZj1aMjPIqvC4bMVFelg

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "location_id": "16a03491-024b-4275-96db-de7355a7407d",
  "reason": "expired"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: a06090997b5288000000000000000001-f3a5aa3c0347f1ec-0

{
  "errors": [
    {
      "context": {},
      "message": "At least one of batch_id, package_id, or product_id must be set",
      "pointer": ["batch_id"],
      "section": "body"
    },
    {
      "context": {},
      "message": "At least one of batch_id, package_id, or product_id must be set",
      "pointer": ["package_id"],
      "section": "body"
    },
    {
      "context": {},
      "message": "At least one of batch_id, package_id, or product_id must be set",
      "pointer": ["product_id"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Required for adjustments of non-package tracked products",
      "pointer": ["quantity"],
      "section": "body"
    }
  ]
}

validate waste must be negative

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTAsImlhdCI6MTc0NzE0MzA1MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODQzNmYzNWEtMWU5NS00MWUxLWJiMjYtOWVlMGI5NjM5MjIzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjcwODQiLCJ0eXAiOiJhY2Nlc3MifQ.yFLSICVsF1ozpGwGq2TG5V4t80mmTCrhZwG9tuHkPm4

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "location_id": "a73d8d35-8266-42ba-8915-2ff6bf469d83",
  "product_id": "03c8899c-80b7-49d0-9dac-89cf1c54c3b7",
  "quantity": 10,
  "reason": "waste"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: a3d1bd5464d738000000000000000001-b2b9c3dc7418b808-0

{
  "errors": [
    {
      "context": {},
      "message": "Quantity must be negative for waste adjustments",
      "pointer": ["quantity"],
      "section": "body"
    }
  ]
}

validate compliance adjustments must not include location_id

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTEsImlhdCI6MTc0NzE0MzA1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZTQxOWJmZjUtZmMxOC00NjQxLThiNDctOTEyZWQyZTY3MWFhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjc0NTIiLCJ0eXAiOiJhY2Nlc3MifQ.7SCcaqdLg52jftu5k6PGnXSe9FvuPMz9VgxEca0O1uQ

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "compliance_quantity": 10,
  "description": "test",
  "location_id": "4efccb71-8ff2-46fe-94fa-364337858bd8",
  "package_id": "b5aacd3b-830a-408c-a683-f44f2e78be0a",
  "reason": "compliance"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 156a87a71a0946000000000000000001-747d1da4412d5eba-0

{
  "errors": [
    {
      "context": {},
      "message": "Cannot be set for adjustments of package tracked products because the source will automatically be set to the location of the package",
      "pointer": ["location_id"],
      "section": "body"
    }
  ]
}

validate compliance adjustments must include location_id

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTEsImlhdCI6MTc0NzE0MzA1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMzA3MjZjNmYtODJhMi00NGYyLWEwNTctYTMwYWE1ZGMxNTYwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjc0MjgiLCJ0eXAiOiJhY2Nlc3MifQ.VjnuPcP7SxAIb94ToA6J5c5XW0O5NgJUC6kYlAlgowU

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "product_id": "2d68524c-b219-4f52-901b-1a419da14c4f",
  "quantity": 10,
  "reason": "compliance"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 1689d83e5f26d8000000000000000001-544b5760e4e1d776-0

{
  "errors": [
    {
      "context": {},
      "message": "Source location is required for non-compliance adjustments",
      "pointer": ["location_id"],
      "section": "body"
    }
  ]
}

validates product exists

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTEsImlhdCI6MTc0NzE0MzA1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOGIwNjhkY2UtNjNkOS00YmU0LTk3ODEtYmE1NTExN2QyMjRhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjczMjkiLCJ0eXAiOiJhY2Nlc3MifQ.2-1tbesXNlkSDbREGIHY4lIo3bCVCjRa4Pavie23jFQ

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "location_id": "bc9a7b60-8e43-400f-a528-c72c9c22abba",
  "product_id": "a547aeef-ecd3-41b7-bd6e-625eb962d72f",
  "quantity": 10,
  "reason": "compliance"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 3c3bcb02f0feae000000000000000001-58c16ee56feda505-0

{
  "errors": [
    {
      "context": {},
      "message": "Product not found",
      "pointer": ["product_id"],
      "section": "body"
    }
  ]
}

validates batch exists

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTAsImlhdCI6MTc0NzE0MzA1MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNmZkNGQyMTgtZjJjMC00MTA3LWE0OTItMmQyZGI3NTY1OTc3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDQ5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjcxOTMiLCJ0eXAiOiJhY2Nlc3MifQ.DmuIS6S2kGhtAcc4N0NRG8ZJDOSozaAWDuKDUg_w_C4

{
  "batch_id": "00000000-0000-0000-0000-0000005001c0",
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "location_id": "1fed7138-9a26-4845-b56e-3266ef22332b",
  "quantity": 10,
  "reason": "compliance"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 79bf86cb77affc000000000000000001-a37867973a62f645-0

{
  "errors": [
    {
      "context": {},
      "message": "Batch not found",
      "pointer": ["batch_id"],
      "section": "body"
    }
  ]
}

validates package exists

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTIsImlhdCI6MTc0NzE0MzA1MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODc3NGZiNmYtY2I2YS00MDlhLTg2OGUtMDYyMTFiOTEzZGI1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjc2MTMiLCJ0eXAiOiJhY2Nlc3MifQ.LbjoeGi9CtT8KRno-9PfPo7t1wiNGNzzyXo0pvurNXk

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "compliance_quantity": 10,
  "description": "test",
  "package_id": "00000000-0000-0000-0000-0000001ce54d",
  "reason": "compliance"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: fb91afbb793c90000000000000000001-d263d6684f444b0f-0

{
  "errors": [
    {
      "context": {},
      "message": "Package not found",
      "pointer": ["package_id"],
      "section": "body"
    }
  ]
}

validates location exists

POST /public/v1/adjustments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2NTEsImlhdCI6MTc0NzE0MzA1MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNzE1ODAzYmUtMTkzYS00YWY2LTk4MmYtYThkM2RlZjBhMWU3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDUwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjcyODYiLCJ0eXAiOiJhY2Nlc3MifQ.KuKyU2boat4DknOtqDQ42YNoIQzHHrEbkMEdegbQXVA

{
  "batch_id": "00000000-0000-0000-0000-0000005001d7",
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "location_id": "00000000-0000-0000-0000-00000059e92c",
  "quantity": 10,
  "reason": "compliance"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 52756d9c4dbe30000000000000000001-343162141e1e73aa-0

{
  "errors": [
    {
      "context": {},
      "message": "Location not found",
      "pointer": ["location_id"],
      "section": "body"
    }
  ]
}

Request

POST /public/v1/adjustments

Parameters

Parameter	Description	In	Type	Required
product_id	The ID of the product to adjust. Must only be provided if the product is product-tracked.	query	string	false
batch_id	The ID of the batch to adjust. Must only be provided if the batch's associated product is batch-tracked.	query	string	false
package_id	The ID of the package to adjust. Must only be provided if the package's associated product is package-tracked.	query	string	false
quantity	The quantity to adjust the stock by. Must only be provided for non-compliance adjustments. Must be negative if the adjustment reason is 'waste'.	query	number	false
compliance_quantity	The quantity to adjust the stock by. Must only be provided for compliance adjustments.	query	number	false
description	The description of the stock adjustment. Required for compliance adjustmenst. Has a max length of 800 characters for non-compliance adjustments, and 250 characters for compliance adjustments.	query	string	false
unit_cost	The cost per unit of the stock adjustment. Can only be provided for companies with cost accounting enabled. Must be empty when the quantity is negative. Must be provided if the company setting 'Require Cost on Intake and Quantity Adjustments' is true.	query	number	false
completion_datetime	The datetime of the stock adjustment. Must only be provided for compliance adjustments.	query	string	false
reason	The reason for the stock adjustment. For non-compliance adjustments, must be one of the following: 'waste', 'stolen', 'damaged', 'fire', 'write-off', 'expired', 'lab-testing', 'revaluation', 'other.' For compliance adjustments, must be a reason that is accepted by the the compliance API	query	string	false
location_id	The ID of the source location of the stock adjustment. Must only be provided for non-compliance adjustments.	query	string	false

Responses

Status	Description	Schema
200	The stock adjustment was inserted successfully	StockAdjustment

Strain

Get strains

GET /public/v1/strains returns strains related to the company

GET /public/v1/strains
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI2MjcsImlhdCI6MTc0NzE0MzAyNywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMzdmNWFmNzktMGE3Ni00MjI5LTg3NjQtMDJjMzNkNDhlMGNlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQzMDI2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzNjA1MTUiLCJ0eXAiOiJhY2Nlc3MifQ.MEnMHjwlWbagRp4jIMOW8QEzzkWdL9L_p01svoTZ5Pw

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 28546f07a159a0000000000000000001-9c847aed54e4f56b-0

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-00000002887f",
      "name": "Strain 533"
    },
    {
      "id": "00000000-0000-0000-0000-000000028880",
      "name": "Strain 534"
    }
  ]
}

Get strains filtered by various attributes

Note: The page size for this endpoint is 50k strains per page.

Request

GET /public/v1/strains

Parameters

Parameter	Description	In	Type	Required	Example
inserted_datetime	Filter strains by their creation datetime	query	string	false	2022-07-10T00:00:00Z,
page	Pagination information	body	Page	false
updated_datetime	Filter strains by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of strains	Strains

TestResult

Get test results

GET /public/v1/test-results returns test results

GET /public/v1/test-results
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0OTIsImlhdCI6MTc0NzE0Mjg5MiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMGM1ZGEwN2ItZjlmMS00MzY4LWI0YjctMmNhMzA5NzIwYzFlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODkxLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzM2NjkiLCJ0eXAiOiJhY2Nlc3MifQ.FjKtYK8of4XMwPuRzzDi6MZlrhvFT-T73huA_isRSY4

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: d910797f1c8e70000000000000000001-738d16322cb9db42-0

{
  "data": [
    {
      "additional_test_results": {
        "thca_percentage": "12"
      },
      "batch_id": null,
      "cbd_mg_per_unit": "1.12345",
      "cbd_percentage": "60.1234",
      "id": "00000000-0000-0000-0000-00000002230f",
      "is_primary": false,
      "lab_license_number": "1234567890",
      "lab_name": "Test Lab",
      "mg_per_unit_type": "mg/g",
      "name": "Test result 1",
      "package_id": "00000000-0000-0000-0000-0000001cd7fd",
      "release_date": "2025-05-13",
      "thc_mg_per_unit": "2.12345",
      "thc_percentage": "20.1234",
      "total_cbd_mg_per_unit": "3.12345",
      "total_cbd_percentage": "80.1234",
      "total_thc_mg_per_unit": "4.12345",
      "total_thc_percentage": "40.1234",
      "updated_datetime": "2025-05-13T13:28:12.322773Z"
    },
    {
      "additional_test_results": {
        "thca_percentage": "12"
      },
      "batch_id": "00000000-0000-0000-0000-0000004fddcb",
      "cbd_mg_per_unit": null,
      "cbd_percentage": null,
      "id": "00000000-0000-0000-0000-000000022310",
      "is_primary": false,
      "lab_license_number": null,
      "lab_name": null,
      "mg_per_unit_type": "mg/g",
      "name": "File.pdf",
      "package_id": null,
      "release_date": null,
      "thc_mg_per_unit": null,
      "thc_percentage": null,
      "total_cbd_mg_per_unit": null,
      "total_cbd_percentage": null,
      "total_thc_mg_per_unit": null,
      "total_thc_percentage": null,
      "updated_datetime": "2025-05-13T13:28:12.351822Z"
    },
    {
      "additional_test_results": {},
      "batch_id": null,
      "cbd_mg_per_unit": null,
      "cbd_percentage": null,
      "id": "00000000-0000-0000-0000-000000022311",
      "is_primary": false,
      "lab_license_number": null,
      "lab_name": null,
      "mg_per_unit_type": "mg/g",
      "name": "File.pdf",
      "package_id": "00000000-0000-0000-0000-0000001cd800",
      "release_date": null,
      "thc_mg_per_unit": null,
      "thc_percentage": null,
      "total_cbd_mg_per_unit": null,
      "total_cbd_percentage": null,
      "total_thc_mg_per_unit": null,
      "total_thc_percentage": null,
      "updated_datetime": "2025-05-13T13:28:12.536306Z"
    }
  ]
}

GET /public/v1/test-results returns only the additional test results that are present in the test result settings

GET /public/v1/test-results
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0OTcsImlhdCI6MTc0NzE0Mjg5NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiNmQ4MDkzMjAtOTI0OC00MWI5LWEwZDItYWY4NzA4ZjI0MzZlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODk2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzQ2NjgiLCJ0eXAiOiJhY2Nlc3MifQ.b7UDStYFBoRvD7EtxZ-bF4kPYGoZhdOkedyLhy8FcSI

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 6e1f86c9275b3c000000000000000001-c695df34e4bc25b5-0

{
  "data": [
    {
      "additional_test_results": {
        "spiroxamine_a_ug_per_g": "13",
        "thiacloprid_ug_per_g": "14"
      },
      "batch_id": "00000000-0000-0000-0000-0000004fdef7",
      "cbd_mg_per_unit": null,
      "cbd_percentage": null,
      "id": "00000000-0000-0000-0000-000000022324",
      "is_primary": false,
      "lab_license_number": null,
      "lab_name": null,
      "mg_per_unit_type": "mg/g",
      "name": "File.pdf",
      "package_id": null,
      "release_date": null,
      "thc_mg_per_unit": null,
      "thc_percentage": null,
      "total_cbd_mg_per_unit": null,
      "total_cbd_percentage": null,
      "total_thc_mg_per_unit": null,
      "total_thc_percentage": null,
      "updated_datetime": "2025-05-13T13:28:17.260665Z"
    }
  ]
}

Get test results filtered by various attributes.

Note: The page size for this endpoint is 5000 test results per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/test-results

Parameters

Parameter	Description	In	Type	Required	Default	Example
updated_datetime	Filter test results by the datetime they were most recently modified	query	string	false		,2022-07-10T00:00:00Z
page	Pagination information	body	Page	false

Responses

Status	Description	Schema
200	A list of test results	TestResults

Upsert a test result

POST /public/v1/test-results creates a test result for a batch tracked product

POST /public/v1/test-results
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0OTYsImlhdCI6MTc0NzE0Mjg5NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODc1Njg0ZDAtZGZiYS00MjBjLTk2N2MtMmYwOWQ3MGUyZjdhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODk1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzQ1NzciLCJ0eXAiOiJhY2Nlc3MifQ.HCDLGarXKVAV9YqzpmiOfF6tqgJag2iUs0RH298axeE

{
  "additional_test_results": {
    "delta_8_thc_mg_per_unit": "17.3333",
    "delta_8_thc_percentage": "12.55",
    "thcva_percentage": "100"
  },
  "batch_id": "00000000-0000-0000-0000-0000004fdedd",
  "cbd_mg_per_unit": "1.1",
  "cbd_percentage": "2.2",
  "is_primary": true,
  "lab_license_number": "1234567890",
  "lab_name": "Test Lab",
  "mg_per_unit_type": "mg/g",
  "name": "Name",
  "release_date": "2025-05-22",
  "thc_mg_per_unit": "3.3",
  "thc_percentage": "4.4",
  "total_cbd_mg_per_unit": "5.5",
  "total_cbd_percentage": "6.6",
  "total_thc_mg_per_unit": "7.7",
  "total_thc_percentage": "8.8"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 988d8b272e2d30000000000000000001-dd980fb86fbc3cb3-0

{
  "data": {
    "additional_test_results": {
      "delta_8_thc_mg_per_unit": "17.3333",
      "delta_8_thc_percentage": "12.55",
      "thcva_percentage": "100"
    },
    "batch_id": "00000000-0000-0000-0000-0000004fdedd",
    "cbd_mg_per_unit": "1.1",
    "cbd_percentage": "2.2",
    "id": "00000000-0000-0000-0000-000000022323",
    "is_primary": true,
    "lab_license_number": "1234567890",
    "lab_name": "Test Lab",
    "mg_per_unit_type": "mg/g",
    "name": "Name",
    "package_id": null,
    "release_date": "2025-05-22",
    "thc_mg_per_unit": "3.3",
    "thc_percentage": "4.4",
    "total_cbd_mg_per_unit": "5.5",
    "total_cbd_percentage": "6.6",
    "total_thc_mg_per_unit": "7.7",
    "total_thc_percentage": "8.8",
    "updated_datetime": "2025-05-13T13:28:16.744980Z"
  }
}

POST /public/v1/test-results creates a test result for a package tracked product

POST /public/v1/test-results
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0OTQsImlhdCI6MTc0NzE0Mjg5NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOTAzMDc5Y2ItM2MxYS00Y2E3LWJiZjctMjc1YTFmMDAwZGU2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODkzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzQxNzYiLCJ0eXAiOiJhY2Nlc3MifQ.13mu2xnMn-NCJHMo5ArKBHCPJXB1h4ZZxImugbWsYtY

{
  "additional_test_results": {},
  "is_primary": false,
  "lab_license_number": "1234567890",
  "lab_name": "Test Lab",
  "mg_per_unit_type": "mg/mL",
  "name": "Name",
  "package_id": "00000000-0000-0000-0000-0000001cd839"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 655d82e80efbcc000000000000000001-cbbe6dad36538e62-0

{
  "data": {
    "additional_test_results": {},
    "batch_id": null,
    "cbd_mg_per_unit": null,
    "cbd_percentage": null,
    "id": "00000000-0000-0000-0000-000000022317",
    "is_primary": true,
    "lab_license_number": "1234567890",
    "lab_name": "Test Lab",
    "mg_per_unit_type": "mg/mL",
    "name": "Name",
    "package_id": "00000000-0000-0000-0000-0000001cd839",
    "release_date": null,
    "thc_mg_per_unit": null,
    "thc_percentage": null,
    "total_cbd_mg_per_unit": null,
    "total_cbd_percentage": null,
    "total_thc_mg_per_unit": null,
    "total_thc_percentage": null,
    "updated_datetime": "2025-05-13T13:28:14.996466Z"
  }
}

POST /public/v1/test-results properly transforms pointer on error

POST /public/v1/test-results
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0OTYsImlhdCI6MTc0NzE0Mjg5NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMGYxMTQxMTgtNTBkMS00OGU5LWEzMzMtZTI3OGQwNDNkNDI5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODk1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzQ1NDMiLCJ0eXAiOiJhY2Nlc3MifQ.QeV8d8U7MeJYctdjzi2dZookHbaYbtNBjfURY7cg70Q

{
  "batch_id": "00000000-0000-0000-0000-0000004fded5",
  "mg_per_unit_type": "mg/g",
  "name": "Name"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 5f9780bba20f0c000000000000000001-0ee19d131025183b-0

{
  "errors": [
    {
      "context": {},
      "message": "can't be blank",
      "pointer": ["additional_test_results"],
      "section": "body"
    },
    {
      "context": {},
      "message": "can't be blank",
      "pointer": ["is_primary"],
      "section": "body"
    }
  ]
}

POST /public/v1/test-results properly transforms pointer on service function error

POST /public/v1/test-results
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0OTMsImlhdCI6MTc0NzE0Mjg5MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiOWQxYmRkYWYtZDRiNS00NGFjLWFmYWEtYzQ0MWQzNWYyZGM4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODkyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzM4NjgiLCJ0eXAiOiJhY2Nlc3MifQ.SxrTrHoUqAsLiXVauBYTCR1lLLwLQzyI3yGXoFEq9e4

{
  "additional_test_results": {},
  "batch_id": "00000000-0000-0000-0000-0000004fde00",
  "is_primary": false,
  "mg_per_unit_type": "mg/g",
  "name": "Name",
  "total_cbd_mg_per_unit": "-3.3456",
  "total_cbd_percentage": "2.234567",
  "total_thc_mg_per_unit": "-4.4567",
  "total_thc_percentage": "1.123456"
}

Response

400
cache-control: max-age=0, private, must-revalidate
content-type: application/json; charset=utf-8
b3: 4ebee8893a0a18000000000000000001-ca3a6d20f9737004-0

{
  "errors": [
    {
      "context": {},
      "message": "must be greater than or equal to 0",
      "pointer": ["total_cbd_mg_per_unit"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Must have at most 4 decimal digits",
      "pointer": ["total_cbd_percentage"],
      "section": "body"
    },
    {
      "context": {},
      "message": "must be greater than or equal to 0",
      "pointer": ["total_thc_mg_per_unit"],
      "section": "body"
    },
    {
      "context": {},
      "message": "Must have at most 4 decimal digits",
      "pointer": ["total_thc_percentage"],
      "section": "body"
    }
  ]
}

POST /public/v1/test-results properly updates a test result

POST /public/v1/test-results
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0OTMsImlhdCI6MTc0NzE0Mjg5MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiYTkxNTVhYjMtNDYwMC00MzVmLTkyMmUtYjk5MjM1MGE1ZDIyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODkyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzQwMzUiLCJ0eXAiOiJhY2Nlc3MifQ.9CVPsU-NQGE8miBZ59PcnTzO_EZH-E1n-XCNuICmzzQ

{
  "additional_test_results": {
    "thca_percentage": "15"
  },
  "id": "00000000-0000-0000-0000-000000022312",
  "is_primary": true,
  "lab_name": "after lab name",
  "mg_per_unit_type": "mg/mL",
  "name": "after name",
  "release_date": "2025-05-23",
  "total_thc_percentage": "14"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 55946b6fb4f868000000000000000001-0ced18fdec3c68fa-0

{
  "data": {
    "additional_test_results": {
      "thca_percentage": "15"
    },
    "batch_id": "00000000-0000-0000-0000-0000004fde40",
    "cbd_mg_per_unit": null,
    "cbd_percentage": null,
    "id": "00000000-0000-0000-0000-000000022312",
    "is_primary": true,
    "lab_license_number": null,
    "lab_name": "after lab name",
    "mg_per_unit_type": "mg/mL",
    "name": "after name",
    "package_id": null,
    "release_date": "2025-05-23",
    "thc_mg_per_unit": null,
    "thc_percentage": null,
    "total_cbd_mg_per_unit": null,
    "total_cbd_percentage": null,
    "total_thc_mg_per_unit": null,
    "total_thc_percentage": "14",
    "updated_datetime": "2025-05-13T13:28:14.044757Z"
  }
}

Upsert a single test result. To update an existing test result, pass in an existing test result ID in the id field. When updating a test result, you must pass in all fields including all additional test results (no sparse update currently supported). Result percentage values can have no more than 4 decimal places.

Request

POST /public/v1/test-results

Parameters

Parameter	Description	In	Type	Required	Example
id	Unique ID for this test result. If it exists, an update will be performed, and will otherwise throw an error. Only non-compliance tracked test results can be updated.	query	string	false
package_id	The ID of the package this test result belongs to. Cannot be provided if either id or batch_id is provided.	query	string	false	123e4567-e89b-12d3-a456-426614174000
batch_id	The ID of the batch this test result belongs to. Cannot be provided if either id or package_id is provided.	query	string	false	123e4567-e89b-12d3-a456-426614174000
additional_test_results	The additional tests results for this test result. Check here for the valid options.	query	object	false
mg_per_unit_type	The unit type for the mg per unit fields	query	string	false	mg/g
is_primary	Setting a test result to is_primary: true will propagate the test result to child packages if applicable. Cannot update a test_result from is_primary: true to is_primary: false. If you want to do this, you must set a different test result on the same package/batch to is_primary: true. Once done, this test_result will be set to is_primary: false automatically.	query	boolean	false	true
release_date	The release date for this test result	query	string	false	2022-07-10
lab_license_number	The license number of this test result's lab	query	string	false	1234567890
lab_name	The name of this test result's lab	query	string	false	Lab Name
name	The name of this test result	query	string	false	Test Result Name
thc_percentage	The THC percentage for this test result. Max precision is 4 decimal places.	query	decimal	false	1.5
total_thc_percentage	The total THC percentage for this test result. Max precision is 4 decimal places.	query	decimal	false	1.5
thc_mg_per_unit	The THC mg per unit for this test result.	query	decimal	false	1.5
total_thc_mg_per_unit	The total THC mg per unit for this test result.	query	decimal	false	1.5
cbd_percentage	The CBD percentage for this test result. Max precision is 4 decimal places.	query	decimal	false	1.5
total_cbd_percentage	The total CBD percentage for this test result. Max precision is 4 decimal places.	query	decimal	false	1.5
cbd_mg_per_unit	The CBD mg per unit for this test result.	query	decimal	false	1.5
total_cbd_mg_per_unit	The total CBD mg per unit for this test result.	query	decimal	false	1.5

Responses

Status	Description	Schema
200	A single test result	TestResult

User

Get users

GET /public/v1/users returns users related to the company

GET /public/v1/users
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE3Nzg1OTI0NzgsImlhdCI6MTc0NzE0Mjg3OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMjc5ZDBjNTYtZTEwZS00NjI5LTlkN2ItODFhZGM3ZWYzYmY0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzQ3MTQyODc3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTkzMzExMjciLCJ0eXAiOiJhY2Nlc3MifQ.EYo6-eH8Hkxy98cQ3TXTOsv-t4Ebnj9uXf8pS-bafH0

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 53cc38f60803f8000000000000000001-051a5a9c5acc2524-0

{
  "data": [
    {
      "banned": false,
      "email": "owner-7405@example.com",
      "full_name": "FirstName14600 LastName14601",
      "id": "00000000-0000-0000-0000-00000126f837",
      "role": {
        "id": "00000000-0000-0000-0000-000001253778",
        "name": "Admin 7381"
      }
    },
    {
      "banned": false,
      "email": "owner-7408@example.com",
      "full_name": "FirstName14604 LastName14605",
      "id": "00000000-0000-0000-0000-00000126f839",
      "role": {
        "id": "00000000-0000-0000-0000-00000125377a",
        "name": "Admin 7383"
      }
    }
  ]
}

Get users sorted by their creation date and filtered by various attributes

Note: The page size for this endpoint is 1000 users per page. This endpoint returns eventually consistent data, with changes taking up to 1 second to propagate in responses.

Request

GET /public/v1/users

Parameters

Parameter	Description	In	Type	Required	Example
inserted_datetime	Filter users by their creation datetime	query	string	false	2022-07-10T00:00:00Z,
page	Pagination information	body	Page	false
updated_datetime	Filter users by the datetime they were most recently modified	query	string	false	,2022-07-10T00:00:00Z

Responses

Status	Description	Schema
200	A list of users	Users

Changelog

2024-10-2

Added GET /public/v1/strains endpoint.
In endpoint GET /public/v1/companies, added fields category and relationship to the response.

2024-11-6

Field thc of type string in the Product object was replaced with total_thc field of type number.
Field cbd of type string in the Product object was replaced with total_cbd field of type number.
Added total_cannabinoid_unit field to Product object. Allowed values are either "MG" or "PERCENT".

2024-12-24

Added billing_location_id to POST /public/v1/purchases endpoint.

2024-12-26

Added msrp, is_active, category.type and images.rank to GET /public/v1/products.

2025-01-08

Added GET /public/v1/payment-methods endpoint.

2025-01-15

Added POST /public/v1/purchases/:id/payments endpoint.
Added POST /public/v1/invoices/:id/payments endpoint.

2025-01-17

Added product_unit_quantity to GET /public/v1/packages endpoint.
Added product_unit_type to GET /public/v1/packages endpoint.

2025-01-31

Added POST /public/v1/batches endpoint.
Added batch_number, product_id, owner_id and description to GET /public/v1/batches endpoint.
Added title and phone_number to GET /public/v1/contacts endpoint.

2025-02-26

Page size change from 50,000 to 5000 for the following endpoints:
- GET /public/v1/batches
- GET /public/v1/companies
- GET /public/v1/contacts
- GET /public/v1/inventory
- GET /public/v1/packages
- GET /public/v1/products
- GET /public/v1/purchases
All GET endpoints now return eventually consistent data, with changes taking up to 1 second to propagate in responses

2025-03-05

Added GET /public/v1/assemblies endpoint.

2025-03-11

Added total_cost_actual, total_cost_default and returned_quantity to "items" in GET /public/v1/invoices endpoint.
Added total_cost_actual, total_cost_default and returned_quantity to "items" in GET /public/v1/invoices/:id endpoint.
Added total_cost_actual, total_cost_default and returned_quantity to "items" in GET /public/v1/orders endpoint.
Added total_cost_actual, total_cost_default and returned_quantity to "items" in GET /public/v1/orders/:id endpoint.

2025-03-18

Modified unit_net_weight and unit_serving_size in GET /public/v1/products endpoint: These fields can now be populated regardless of the product's unit type.

2025-04-09

Added the following fields to GET /public/v1/companies endpoint:
- legal_business_name
- default_email
- phone_number
- invoice_email
- sales_order_email
- purchase_order_email
- order_shipment_email
- website
- default_sales_order_notes
- default_purchase_order_notes
- outstanding_balance_threshold
- owner_id

2025-05-06

Added is_trade_sample to GET /public/v1/packages endpoint.

2025-05-13

Added GET /public/v1/adjustments endpoint.

2025-05-14

Added custom_data to the response of the following endpoints:
- GET /public/v1/assemblies
- GET /public/v1/batches
- POST /public/v1/batches
- GET /public/v1/companies
- GET /public/v1/contacts
- GET /public/v1/invoices
- GET /public/v1/invoices/:id
- POST /public/v1/invoices
- GET /public/v1/orders
- GET /public/v1/orders/:id
- POST /public/v1/orders
- GET /public/v1/packages
- GET /public/v1/products
- POST /public/v1/products
- GET /public/v1/purchases
- POST /public/v1/purchases

2025-05-15

Added POST /public/v1/stock_adjustments endpoint.

2025-05-16

Added GET /public/v1/test-results
Added POST /public/v1/test-results

2025-05-18

Added leaflink_order_number to GET /public/v1/orders