NAV Hide code

Need more from the API?

We're actively expanding the API and would love to build what your integration needs. Tell your Customer Support Representative which endpoints or functionality would help—we're eager to add them.

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.

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:

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

Using your API token

Example authenticated request

GET /public/v1/orders?page[number]=1
content-type: application/json
accept: application/json
authorization: Bearer YOUR_API_TOKEN

Every request must include your token in the Authorization header using the Bearer scheme, along with JSON content-type and accept headers:

Header Value
Authorization Bearer YOUR_API_TOKEN
Content-Type application/json
Accept application/json

Treat your token like a password: it carries the same permissions as the admin who created it. Keep it server-side and never expose it in client-side code.

Webhooks

Distru can push changes to your systems in real time via webhooks. A webhook fires whenever a record is created, edited, or deleted. We support webhooks for:

To set up webhooks, reach out to Customer Support to find out more.

Webhook payload shape

Every webhook is a JSON POST with three top-level fields:

Field Description
type The entity type, e.g. ORDER, PURCHASE, INVOICE, PRODUCT.
id The public id of the entity the webhook is about (the same value as object.id).
object The full entity, in the same structure the GET /public/v1/<type>/<id> endpoint returns.

object is the current version of the entity, fetched fresh when the webhook is sent — not a snapshot from when the change was committed. If other changes were committed in between, they are reflected. On a hard-delete event the entity no longer exists, so object is null; use type and id.

To keep integrations simple, object matches the corresponding GET endpoint exactly, so you can parse it with the same code you already use for that endpoint.

Webhook nested entities

A change to a nested record triggers a webhook at its parent level — never as its own webhook — and object is always the full parent entity. The nested records that trigger each parent are:

Parent Nested records
Sales Orders items, charges
Purchase Orders items, charges
Invoices items, charges, payments
Assemblies inputs, outputs, costs
Returns items
Companies the related company, its locations, its licenses, and its contacts (each with its profile)
Products bills of materials (and each bill of materials' inputs and costs)

For example, adding an order item to a sales order does not send an "order item" webhook — it sends a Sales Order webhook whose object is the full order, including the new item.

Note: inventory changes (adding or removing quantity) do not currently trigger Product webhooks.

Webhook signing & verification

The x-distru-signature header

x-distru-signature: sha256=<hex digest>

Node.js verification example

const crypto = require('crypto');

function isValid(rawBody, signatureHeader, secret) {
  const expected =
    'sha256=' +
    crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
  return crypto.timingSafeEqual(
    Buffer.from(signatureHeader),
    Buffer.from(expected)
  );
}

When Customer Support sets up your webhook, they provide a signing secret. Distru signs every request so you can confirm it came from us and was not tampered with. Each request includes an x-distru-signature header.

The digest is an HMAC-SHA256 of the raw request body using your signing secret. To verify a request:

  1. Read the raw request body exactly as received — do not re-serialize the JSON, since key order must match.
  2. Compute HMAC-SHA256(raw_body, your_secret) and hex-encode it.
  3. Compare sha256=<your digest> to the x-distru-signature header using a constant-time comparison.

Webhook retries & ordering

If your endpoint is unreachable or returns a non-2xx status, Distru retries delivery with an increasing delay between attempts (up to ~10 attempts over roughly 4 hours) before giving up.

Webhooks are delivered in the order the underlying changes were committed.

Webhook payload examples

A sales order is created or edited (object is the full order, same as GET /public/v1/orders/:id)

{
  "type": "ORDER",
  "id": "8f3c9d2e-1a4b-4c7d-9e0f-2b6a1c3d4e5f",
  "object": {
    "id": "8f3c9d2e-1a4b-4c7d-9e0f-2b6a1c3d4e5f",
    "order_number": "SO-0001",
    "status": "PENDING",
    "total": "60.00",
    "order_datetime": "2025-05-04T04:40:21.817570Z",
    "company": {"id": "b7e2…", "name": "Acme Dispensary"},
    "items": [
      {
        "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "product_id": "0c9e7f11-2a33-4b55-8c77-9d0e1f2a3b4c",
        "quantity": 5.0,
        "price": 10.0
      }
    ],
    "charges": []
  }
}

A sales order is hard-deleted (object is null)

{
  "type": "ORDER",
  "id": "8f3c9d2e-1a4b-4c7d-9e0f-2b6a1c3d4e5f",
  "object": null
}

The same shape is sent when a nested record changes: adding an order item sends an ORDER webhook whose object is the full order (with the new item under items).

Objects above are trimmed for readability; a real object includes the full set of fields returned by the matching GET endpoint.

Pagination

Endpoint query with page number example

https://app.distru.com/public/v1/products?page[number]=1

cURL example

curl --location --globoff 'https://app.distru.com/public/v1/products?page[number]=1' \
--header 'Authorization: Bearer ********* API KEY HERE *********'

Next page URL in the response body (if a next page exists)

"next_page": "https://app.distru.com/public/v1/products?page[number]=2"

Use the page[number]= query parameter to request a specific page. When another page is available, the response body includes a next_page URL you can follow.

Page size limits for each endpoint are listed in the API documentation.

Filtering by datetime parameters

On or after May 4th, 2025

products?updated_datetime=2025-05-04T04:40:21.817570Z,

On or before May 4th, 2025

products?updated_datetime=,2025-05-04T04:40:21.817570Z

Between May 4th and Sept 18th, 2025 (inclusive)

products?updated_datetime=2025-05-04T04:40:21.817570Z,2025-09-18T16:27:44.946871Z

Datetimes use the format YYYY-MM-DDTHH:MM:SS.MSZ.

The comma position controls the direction of the filter. All bounds are inclusive: a record matching the exact datetime in the query is returned.

Endpoints

Assembly

Get an assembly

GET /public/v1/assemblies/:id returns a single assembly with outputs

GET /public/v1/assemblies/57beb8ab-5664-46b4-aefd-baf56bc6e797
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOGUyNjNhMWMtYWI0ZS00MGU4LWE3OTMtY2E4Y2RlMGZlM2RkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Nzc5MSIsInR5cCI6ImFjY2VzcyJ9.h3x0XtTNEb6BWobSvHGSNOHoiJXd0v6kkLxrgTa4yDk

Response

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

{
  "data": {
    "assembly_number": "AS-0000001",
    "completion_datetime": "2026-08-17T21:24:28.173509Z",
    "compliance_type": "NONE",
    "creation_source": "MANUALLY_CREATED",
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-959@example.com",
      "full_name": "FirstName1966 LastName1967",
      "id": "00000000-0000-0000-0000-000000001e6f",
      "role": {
        "id": "00000000-0000-0000-0000-000000001f19",
        "name": "Admin 997"
      }
    },
    "custom_data": [],
    "description": null,
    "estimated_start_date": null,
    "estimated_work_hours": null,
    "estimated_work_minutes": null,
    "fulfilled": true,
    "id": "57beb8ab-5664-46b4-aefd-baf56bc6e797",
    "inserted_datetime": "2026-08-17T21:24:28.173509Z",
    "is_metrc_processing_job": false,
    "license": null,
    "metrc_processing_job_id": null,
    "metrc_processing_job_name": null,
    "metrc_processing_job_notes": null,
    "outputs": [
      {
        "additional_costs": [],
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000000008aa",
          "name": "B349"
        },
        "compliance_label": null,
        "compliance_quantity": null,
        "cost_per_unit": null,
        "cost_per_unit_default": null,
        "expiration_datetime": null,
        "ingredients": [
          {
            "batch": {
              "batch_number": null,
              "id": "00000000-0000-0000-0000-0000000008aa",
              "name": "B349"
            },
            "compliance_quantity": null,
            "cost_per_unit": null,
            "cost_per_unit_default": null,
            "location": {
              "address": "123 Fake Street, Beverly Hills, CA 90210, US",
              "company_id": "00000000-0000-0000-0000-00000000179b",
              "id": "00000000-0000-0000-0000-000000000830",
              "license_id": null,
              "name": "Place 246"
            },
            "package": null,
            "product": {
              "id": "9020f169-134b-42ce-89c1-e90dc0b7afff",
              "name": "Product 346",
              "sku": "sku 347",
              "updated_datetime": "2026-08-17T21:24:28.113829Z"
            },
            "quantity": "2",
            "total_cost_actual": null,
            "total_cost_default": null
          }
        ],
        "is_finished_good": false,
        "is_production_batch": false,
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 90210, US",
          "company_id": "00000000-0000-0000-0000-00000000179b",
          "id": "00000000-0000-0000-0000-000000000830",
          "license_id": null,
          "name": "Place 246"
        },
        "package": null,
        "package_datetime": null,
        "package_unit_type": null,
        "product": {
          "id": "9020f169-134b-42ce-89c1-e90dc0b7afff",
          "name": "Product 346",
          "sku": "sku 347",
          "updated_datetime": "2026-08-17T21:24:28.113829Z"
        },
        "quantity": "2",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "owner_id": "00000000-0000-0000-0000-000000001e6f",
    "status": "COMPLETED",
    "updated_datetime": "2026-08-17T21:24:28.173509Z",
    "waste_count_quantity": null,
    "waste_count_unit_name": null,
    "waste_volume_quantity": null,
    "waste_volume_unit_name": null,
    "waste_weight_quantity": null,
    "waste_weight_unit_name": null
  }
}

Get a single assembly given the ID.

Required permission: assemblies_permissions_view.

Request

GET /public/v1/assemblies/{id}

Parameters

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

Responses

Status Description Schema
200 A single assembly AssemblyResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYjcxZjNkNWQtNjJiMC00Y2I0LWE1ZTEtOWYyODgzMDc0ODRlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzE4MCIsInR5cCI6ImFjY2VzcyJ9.nN0pZo4qASzAYoCIizCiuEaH3Uh6r3QAhl42oFplXpk

Response

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

{
  "data": [
    {
      "assembly_number": "AS-0000001",
      "completion_datetime": "2026-08-17T21:24:26.991484Z",
      "compliance_type": "NONE",
      "creation_source": "MANUALLY_CREATED",
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-354@example.com",
        "full_name": "FirstName722 LastName723",
        "id": "00000000-0000-0000-0000-000000001c0c",
        "role": {
          "id": "00000000-0000-0000-0000-000000001c9e",
          "name": "Admin 362"
        }
      },
      "custom_data": [
        {
          "id": 159,
          "name": "Custom Field 3",
          "value": "Custom Field Value"
        }
      ],
      "description": null,
      "estimated_start_date": "2024-01-02T03:04:05.000000Z",
      "estimated_work_hours": 1,
      "estimated_work_minutes": 5,
      "fulfilled": true,
      "id": "da915453-58cb-401e-9765-087d1ccf5554",
      "inserted_datetime": "2026-08-17T21:24:26.991484Z",
      "is_metrc_processing_job": false,
      "license": null,
      "metrc_processing_job_id": null,
      "metrc_processing_job_name": null,
      "metrc_processing_job_notes": null,
      "outputs": [
        {
          "additional_costs": [
            {
              "cost_per_unit": "-1",
              "description": null,
              "name": "CostType 14",
              "quantity": "1",
              "total_cost_actual": "-1",
              "total_cost_default": "0",
              "unit_type": {
                "id": "00000000-0000-0000-0000-000000011578",
                "name": "Unit Type 18"
              }
            }
          ],
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-000000000864",
            "name": "B89"
          },
          "compliance_label": null,
          "compliance_quantity": null,
          "cost_per_unit": "-0.3",
          "cost_per_unit_default": "0.5",
          "expiration_datetime": null,
          "ingredients": [
            {
              "batch": {
                "batch_number": null,
                "id": "00000000-0000-0000-0000-000000000864",
                "name": "B89"
              },
              "compliance_quantity": null,
              "cost_per_unit": "0.2",
              "cost_per_unit_default": "1",
              "location": {
                "address": "123 Fake Street, Beverly Hills, CA 90210, US",
                "company_id": "00000000-0000-0000-0000-0000000015f0",
                "id": "00000000-0000-0000-0000-0000000007ac",
                "license_id": null,
                "name": "Place 114"
              },
              "package": null,
              "product": {
                "id": "642e5638-8c73-4013-a643-16fc383fbac2",
                "name": "Product 85",
                "sku": "sku 86",
                "updated_datetime": "2026-08-17T21:24:26.588584Z"
              },
              "quantity": "2",
              "total_cost_actual": "0.4",
              "total_cost_default": "2"
            }
          ],
          "is_finished_good": false,
          "is_production_batch": false,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 90210, US",
            "company_id": "00000000-0000-0000-0000-0000000015f0",
            "id": "00000000-0000-0000-0000-0000000007ac",
            "license_id": null,
            "name": "Place 114"
          },
          "package": null,
          "package_datetime": null,
          "package_unit_type": null,
          "product": {
            "id": "642e5638-8c73-4013-a643-16fc383fbac2",
            "name": "Product 85",
            "sku": "sku 86",
            "updated_datetime": "2026-08-17T21:24:26.588584Z"
          },
          "quantity": "2",
          "total_cost_actual": "-0.6",
          "total_cost_default": "1"
        }
      ],
      "owner_id": "00000000-0000-0000-0000-000000001c0c",
      "status": "COMPLETED",
      "updated_datetime": "2026-08-17T21:24:26.991484Z",
      "waste_count_quantity": null,
      "waste_count_unit_name": null,
      "waste_volume_quantity": null,
      "waste_volume_unit_name": null,
      "waste_weight_quantity": null,
      "waste_weight_unit_name": null
    }
  ],
  "next_page": null
}

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.

Required permission: assemblies_permissions_view. Results are filtered to only include assemblies the authenticated user can access under their team restrictions.

Request

GET /public/v1/assemblies

Parameters

Parameter Description In Type Required Default Example
completion_datetime Filter assemblies by their completion datetime query string false 2022-07-10T00:00:00Z,
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
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of assemblies Assemblies

Batch

Create or update a batch

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjksImlhdCI6MTc4NzAwMTg2OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZGI5ZWI5ZWUtN2Y5NC00OGJmLTgzZDgtYzBjZjA2Njc1N2I1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODQwOSIsInR5cCI6ImFjY2VzcyJ9.E9CWI9BWNCIGVMnuGeyWoVej_UVS6loObJLfxgQ7vJY

{
  "batch_number": "B1",
  "cbd": "0.3%",
  "custom_data": {
    "216": [
      "A",
      "B"
    ]
  },
  "description": "Test batch",
  "expiration_date": "2025-01-01T00:00:00.000000Z",
  "harvest_datetime": "2024-06-15T00:00:00.000000Z",
  "manufactured_datetime": "2025-01-02T03:04:05.000000Z",
  "name": "Custom Batch Name",
  "owner_id": "00000000-0000-0000-0000-0000000020e8",
  "product_id": "5feaf988-d4e6-493b-8d04-d73939513029",
  "thc": "18.5%"
}

Response

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

{
  "data": {
    "batch_number": "B1",
    "cbd": "0.3%",
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1572@example.com",
      "full_name": "FirstName3212 LastName3213",
      "id": "00000000-0000-0000-0000-0000000020d9",
      "role": {
        "id": "00000000-0000-0000-0000-000000002195",
        "name": "Admin 1633"
      }
    },
    "custom_data": [
      {
        "id": 216,
        "name": "Custom Field 37",
        "value": "A,B"
      }
    ],
    "deleted_at": null,
    "description": "Test batch",
    "expiration_date": "2025-01-01T00:00:00.000000Z",
    "harvest_datetime": "2024-06-15T00:00:00.000000Z",
    "id": "00000000-0000-0000-0000-00000000092f",
    "inserted_datetime": "2026-08-17T21:24:29.584454Z",
    "manufactured_datetime": "2025-01-02T03:04:05.000000Z",
    "name": "Custom Batch Name",
    "owner_id": "00000000-0000-0000-0000-0000000020e8",
    "product_id": "5feaf988-d4e6-493b-8d04-d73939513029",
    "thc": "18.5%",
    "updated_datetime": "2026-08-17T21:24:29.584454Z"
  }
}

Create or update a single batch. Omit id to create a new batch; pass the id of an existing batch to update it.

Required permission: products_permissions_create to create, products_permissions_edit to update.

Request

POST /public/v1/batches

Parameters

Parameter Description In Type Required Default Example
batch_number The batch number of the batch. query string false
bin_ids The IDs of the bins this batch is stored in. Behaviour: omit bin_ids to leave the batch's bins unchanged; pass null or an empty array to clear all bins; pass a non-empty array to replace the batch's bins with exactly those. Ignored unless bin inventory tracking is enabled for your company.
body array false
cbd A free-form CBD label for the batch, as displayed in Distru (e.g. "0.3%"). This is a static value stored on the batch record; it does not set or derive from any lab result — the batch's primary test result tracks potency separately. query string false
custom_data A map of custom field IDs to their values. Use GET /public/v1/custom-fields?model_name=batch to retrieve available custom fields and their IDs. body object false {"123":"Custom Value 1","456":"Custom Value 2"}
description The description of the batch. query string false
expiration_date The expiration date of the batch. query string false
harvest_datetime The harvest datetime of the batch (ISO 8601 format). query string false
id The ID of the batch to update. Omit to create a new batch. query string false
manufactured_datetime The manufactured datetime of the batch (ISO 8601 format). query string false
name The name of the batch. If omitted, a name is generated from the batch number. Ignored on update. query string false
owner_id The ID of the user that is the designated owner of this batch. query string false
product_id The ID of the product that this batch belongs to. query string false
thc A free-form THC label for the batch, as displayed in Distru (e.g. "18.5%"). This is a static value stored on the batch record; it does not set or derive from any lab result — the batch's primary test result tracks potency separately. query string false

Responses

Status Description Schema
200 A single batch BatchFullResponse

Get a batch

GET /public/v1/batches/:id returns a single batch

GET /public/v1/batches/00000000-0000-0000-0000-00000000091f
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjksImlhdCI6MTc4NzAwMTg2OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZWY5ZGY2MGUtOTFmMS00M2NlLWI0NGYtZmI0YzkyNTJkNzI5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODM2NSIsInR5cCI6ImFjY2VzcyJ9.T0PlTj3mZ63eMi9knTHtrMpxrJZYVTwMh2N07S1c8x8

Response

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

{
  "data": {
    "batch_number": "B001",
    "cbd": null,
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1543@example.com",
      "full_name": "FirstName3148 LastName3149",
      "id": "00000000-0000-0000-0000-0000000020ba",
      "role": {
        "id": "00000000-0000-0000-0000-000000002179",
        "name": "Admin 1605"
      }
    },
    "custom_data": [
      {
        "id": 213,
        "name": "Custom Field 36",
        "value": "Custom Data 1"
      }
    ],
    "deleted_at": null,
    "description": "Test batch",
    "expiration_date": null,
    "harvest_datetime": null,
    "id": "00000000-0000-0000-0000-00000000091f",
    "inserted_datetime": "2026-08-17T21:24:29.475003Z",
    "manufactured_datetime": "2026-08-17T21:24:29.417861Z",
    "name": "B765",
    "owner_id": "00000000-0000-0000-0000-0000000020bd",
    "primary_test_result": null,
    "product_id": "78240823-b9bf-47e3-aea4-6a893daff532",
    "thc": null,
    "updated_datetime": "2026-08-17T21:24:29.475003Z"
  }
}

Get a single batch given the ID.

Required permission: products_permissions_view.

Request

GET /public/v1/batches/{id}

Parameters

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

Responses

Status Description Schema
200 A single batch BatchFullResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiNjIxYWZiY2EtZWIzZC00YmZmLWJlMzctNDQ0ZWU2ODgwNzhkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzQwOCIsInR5cCI6ImFjY2VzcyJ9.AAhwUUDXbFekwxhL0PVe8eOcL6pEtIKuKvmrKcstqZk

Response

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

{
  "data": [
    {
      "batch_number": null,
      "cbd": null,
      "creator": null,
      "custom_data": [
        {
          "id": 163,
          "name": "Custom Field 7",
          "value": "Custom Data 1"
        }
      ],
      "deleted_at": null,
      "description": null,
      "expiration_date": "2024-01-01T00:00:00.000000Z",
      "harvest_datetime": null,
      "id": "00000000-0000-0000-0000-00000000087a",
      "inserted_datetime": "2026-08-17T21:24:27.201715Z",
      "manufactured_datetime": "2024-01-02T03:04:05.000000Z",
      "name": "B173",
      "owner_id": "00000000-0000-0000-0000-000000001cf5",
      "primary_test_result": null,
      "product_id": "24bc0333-e352-4f17-994d-5617ab0d0def",
      "thc": null,
      "updated_datetime": "2026-08-17T21:24:27.201715Z"
    },
    {
      "batch_number": null,
      "cbd": "0.5",
      "creator": null,
      "custom_data": [
        {
          "id": 163,
          "name": "Custom Field 7",
          "value": null
        }
      ],
      "deleted_at": null,
      "description": null,
      "expiration_date": null,
      "harvest_datetime": "2024-06-15T00:00:00.000000Z",
      "id": "00000000-0000-0000-0000-00000000087b",
      "inserted_datetime": "2026-08-17T21:24:27.220880Z",
      "manufactured_datetime": "2024-01-02T03:04:05.000000Z",
      "name": "B176",
      "owner_id": "00000000-0000-0000-0000-000000001cfb",
      "primary_test_result": {
        "cbd_mg_per_unit": "1",
        "cbd_mg_per_unit_total": "2",
        "cbd_percentage": "3",
        "cbd_percentage_total": "4",
        "coa_url": null,
        "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": "80d074d2-dc86-4f54-a879-1de8c64d0e29",
      "thc": "22.5",
      "updated_datetime": "2026-08-17T21:24:27.220880Z"
    }
  ],
  "next_page": null
}

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.

Required permission: products_permissions_view. Results are filtered to only include batches the authenticated user can access under their team restrictions.

Request

GET /public/v1/batches

Parameters

Parameter Description In Type Required Default Example
batch_ids Filter batches by batch IDs query array false ?batch_ids[]=00000000-0000-0000-0000-000000000001&batch_ids[]=00000000-0000-0000-0000-000000000002
batch_number Filter batches by batch number query string false
deleted Filter deleted batches. no returns non-deleted, only returns deleted, include returns both. query string false no
inserted_datetime Filter batches by their creation datetime query string false 2022-07-10T00:00:00Z,
page Pagination information query number false ?page[number]=1
product_id Filter batches by product ID query string 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

Bin

Delete a bin

DELETE /public/v1/bins/:id deletes a bin and its batch associations

DELETE /public/v1/bins/5d790a3c-13ad-42a7-8bec-299cc64f35e4
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYTQ2NzI4MDgtNmI3Ni00NThhLTg3MTItNTU4YjVhNDQxYTc2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzIzNiIsInR5cCI6ImFjY2VzcyJ9.heClOgSK3teTfCBwjnFPFi-1FVV9IU1Xb7yVg4GtJtc

Response

204
cache-control: max-age=0, private, must-revalidate
b3: 4775c971c50b56b79147aff25ca1fa07-3d51d79e6ca08b88-0

Permanently deletes the bin (hard delete — it is removed from the database, not soft-deleted) and removes it from any batches, packages, plants, plant groups and assembly outputs it is associated with.

Bins require bin inventory tracking to be enabled for your company; the request is rejected otherwise.

Required permission: settings_permissions_bins.

Request

DELETE /public/v1/bins/{id}

Parameters

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

Responses

Status Description Schema
204 No Content
404 Not Found

Get a bin

GET /public/v1/bins/:id returns a single bin

GET /public/v1/bins/b4cbc502-51d5-41e2-a20c-6f6cfab93505
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNDFhNTVlNTktOGJjOC00YTJlLTlhNjUtZWI3YjYzM2EyZTVkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzMyOSIsInR5cCI6ImFjY2VzcyJ9.DrqTyuyT0KINzt6sKnvYd4IscMU-cGE1nkM9_oEILdw

Response

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

{
  "data": {
    "id": "b4cbc502-51d5-41e2-a20c-6f6cfab93505",
    "inserted_datetime": "2026-08-17T21:24:26.983177Z",
    "name": "Cold Room",
    "updated_datetime": "2026-08-17T21:24:26.983177Z"
  }
}

Get a single bin given the ID.

Required permission: settings_permissions_bins.

Request

GET /public/v1/bins/{id}

Parameters

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

Responses

Status Description Schema
200 A single bin BinResponse
404 Not Found

Get bins

GET /public/v1/bins returns paginated bins sorted by name with next_page

GET /public/v1/bins
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYzgxNzFmMGMtZTVlZC00YmViLTg2NGUtOGIwZDlkODYzYWVmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjgzMCIsInR5cCI6ImFjY2VzcyJ9.ThEIv55bdXUL6S4Wni9vVj_a_RpeKDPWj80T4S69Q_w

Response

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

{
  "data": [
    {
      "id": "56cec30c-16d6-41da-ae63-78fa5f86e294",
      "inserted_datetime": "2026-08-17T21:24:25.000538Z",
      "name": "AAA",
      "updated_datetime": "2026-08-17T21:24:25.000538Z"
    },
    {
      "id": "035e0167-7139-4293-87c2-323240f36b3b",
      "inserted_datetime": "2026-08-17T21:24:25.002969Z",
      "name": "BBB",
      "updated_datetime": "2026-08-17T21:24:25.002969Z"
    },
    {
      "id": "e0d874af-cf9a-4514-9d44-7ba023dd810b",
      "inserted_datetime": "2026-08-17T21:24:25.003980Z",
      "name": "CCC",
      "updated_datetime": "2026-08-17T21:24:25.003980Z"
    }
  ],
  "next_page": "https://www.example.com/public/v1/bins?page[number]=2"
}

List bins for the authenticated company, sorted alphabetically by name.

Required permission: settings_permissions_bins.

Request

GET /public/v1/bins

Parameters

Parameter Description In Type Required Default Example
page Pagination information query number false ?page[number]=1
search If present, only bins whose name matches are returned query string false

Responses

Status Description Schema
200 A list of bins Bins

Upsert a bin

POST /public/v1/bins creates a bin

POST /public/v1/bins
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNTBhNWVmODktNmI0My00MmM2LWFiZDEtNjkwM2I5MzVlYzkyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzE5MyIsInR5cCI6ImFjY2VzcyJ9._ZAoc_-rOhDNlA4Fl_g38sGnpSqgOumZNG1RDZhSwZ0

{
  "name": "Vault"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 0b7d2f32a183a6e99eb291284d51ead0-bde19849eb39b1a4-0

{
  "data": {
    "id": "5e1295d4-ea50-4d7e-a131-1bbece36d072",
    "inserted_datetime": "2026-08-17T21:24:26.591186Z",
    "name": "Vault",
    "updated_datetime": "2026-08-17T21:24:26.591186Z"
  }
}

Upsert a single bin. To update an existing bin, pass its ID in the id field. If you do not pass an ID, a new bin is created.

Bin names must be unique within a company and cannot contain commas.

Bins require bin inventory tracking to be enabled for your company; the request is rejected otherwise.

Required permission: settings_permissions_bins.

Request

POST /public/v1/bins

Parameters

Parameter Description In Type Required Default Example
id Bin ID. If given, the matching bin is updated; otherwise a new one is created. query string false
name The name of the bin query string true

Responses

Status Description Schema
200 The updated bin BinResponse
201 The created bin BinResponse
400 Invalid parameters
404 Not Found

Company

Get a company

GET /public/v1/companies/:id returns a single company

GET /public/v1/companies/00000000-0000-0000-0000-000000000f2d
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYmNjYTQ4NDAtNWZiYi00ODFlLTgzNWYtMGIyNjUwMjRlZGE1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODE0OSIsInR5cCI6ImFjY2VzcyJ9.ChAdKe131UwTCKTEwNcRf5IY18ZKc7vVr75DUzcUJTE

Response

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

{
  "data": {
    "category": "Retailer",
    "custom_data": [
      {
        "id": 192,
        "name": "Custom Field 31",
        "value": "Custom Value"
      }
    ],
    "default_email": "co@example.com",
    "default_payment_term": {
      "days": 15,
      "id": "00000000-0000-0000-0000-000000000046",
      "inserted_datetime": "2026-08-17T21:24:28.972598Z",
      "locked": false,
      "name": "Net 15",
      "time_of_day": "17:00:00",
      "updated_datetime": "2026-08-17T21:24:28.972598Z"
    },
    "default_purchase_order_notes": null,
    "default_sales_order_notes": null,
    "deleted_at": null,
    "group": {
      "id": "00000000-0000-0000-0000-000000000035",
      "name": "Comp Rel Group 14"
    },
    "id": "00000000-0000-0000-0000-000000000f2d",
    "inserted_datetime": "2026-08-17T21:24:28.980654Z",
    "invoice_email": "inv@example.com",
    "leaflink_brand_id": null,
    "leaflink_customer_id": null,
    "legal_business_name": "Legal Co",
    "licenses": [
      {
        "active": true,
        "expiry_datetime": "2026-09-17T21:24:28.969003Z",
        "id": "00000000-0000-0000-0000-00000000022f",
        "issue_datetime": "2026-08-17T21:24:28.969001Z",
        "license_number": "CDPH-00000051",
        "license_type": "Type 6 Non Volatile Solvent Extraction"
      }
    ],
    "locations": [
      {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-0000000018b9",
        "id": "00000000-0000-0000-0000-000000000882",
        "license_id": null,
        "name": "Place 328"
      }
    ],
    "name": "Company 984",
    "order_shipment_email": null,
    "outstanding_balance": "0",
    "outstanding_balance_threshold": null,
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1344@example.com",
      "full_name": "FirstName2744 LastName2745",
      "id": "00000000-0000-0000-0000-000000001ff3",
      "role": {
        "id": "00000000-0000-0000-0000-0000000020a5",
        "name": "Admin 1393"
      }
    },
    "owner_id": "00000000-0000-0000-0000-000000001ff3",
    "phone_number": null,
    "purchase_order_email": null,
    "qb_customer_id": null,
    "qb_vendor_id": null,
    "relationship_type": {
      "id": "00000000-0000-0000-0000-000000000071",
      "name": "Supplier"
    },
    "sales_order_email": "order@example.com",
    "updated_datetime": "2026-08-17T21:24:28.980654Z",
    "website": null
  }
}

Get a single company given the ID.

Required permission: companies_permissions_view.

Request

GET /public/v1/companies/{id}

Parameters

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

Responses

Status Description Schema
200 A single company CompanyResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiZDRmMTQ5NDctN2Q3ZS00ZGI1LWIwZTUtY2JlZmRiNjhkMzNkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzM4NiIsInR5cCI6ImFjY2VzcyJ9.naB8txzhVjFOxnOOSXMbc4P1fBBPVL83rUy6c_C7Iro

Response

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

{
  "data": [
    {
      "category": "Retailer",
      "custom_data": [
        {
          "id": 162,
          "name": "Custom Field 6",
          "value": "Custom Data 1"
        }
      ],
      "default_email": "company-1@example.com",
      "default_payment_term": null,
      "default_purchase_order_notes": "Default Purchase Order Notes 1",
      "default_sales_order_notes": "Default Order External Notes 1",
      "deleted_at": null,
      "group": {
        "id": "00000000-0000-0000-0000-000000000033",
        "name": "Comp Rel Group 12"
      },
      "id": "00000000-0000-0000-0000-000000000e00",
      "inserted_datetime": "2023-10-01T00:00:00.000000Z",
      "invoice_email": "invoice email",
      "leaflink_brand_id": 777,
      "leaflink_customer_id": 555,
      "legal_business_name": "Company Legal Name 1",
      "licenses": [
        {
          "active": true,
          "expiry_datetime": "2026-09-17T21:24:27.167293Z",
          "id": "00000000-0000-0000-0000-00000000020b",
          "issue_datetime": "2026-08-17T21:24:27.167292Z",
          "license_number": "CDPH-00000014",
          "license_type": "Small Indoor"
        }
      ],
      "locations": [
        {
          "address": "123 Fake Street, Beverly Hills, CA 90210, US",
          "company_id": "00000000-0000-0000-0000-00000000168e",
          "id": "00000000-0000-0000-0000-0000000007e1",
          "license_id": null,
          "name": "Place 167"
        }
      ],
      "name": "Company 430",
      "order_shipment_email": "order shipment email",
      "outstanding_balance": "0",
      "outstanding_balance_threshold": 1000,
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "owner@example.com",
        "full_name": "FirstName1144 LastName1145",
        "id": "00000000-0000-0000-0000-000000001cde",
        "role": {
          "id": "00000000-0000-0000-0000-000000001d74",
          "name": "Admin 576"
        }
      },
      "owner_id": "00000000-0000-0000-0000-000000001cde",
      "phone_number": "1234567890",
      "purchase_order_email": "purchase email",
      "qb_customer_id": "QB-CUST-1",
      "qb_vendor_id": "QB-VEND-1",
      "relationship_type": {
        "id": "00000000-0000-0000-0000-00000000006f",
        "name": "Supplier"
      },
      "sales_order_email": "order email",
      "updated_datetime": "2023-11-03T00:00:00.000000Z",
      "website": "https://www.example.com"
    },
    {
      "category": "Other",
      "custom_data": [
        {
          "id": 162,
          "name": "Custom Field 6",
          "value": null
        }
      ],
      "default_email": "company-1011@example.com",
      "default_payment_term": null,
      "default_purchase_order_notes": null,
      "default_sales_order_notes": null,
      "deleted_at": null,
      "group": null,
      "id": "00000000-0000-0000-0000-000000000e01",
      "inserted_datetime": "2023-10-02T00:00:00.000000Z",
      "invoice_email": null,
      "leaflink_brand_id": null,
      "leaflink_customer_id": null,
      "legal_business_name": "Company Legal Name 433",
      "licenses": [
        {
          "active": true,
          "expiry_datetime": "2026-09-17T21:24:27.176002Z",
          "id": "00000000-0000-0000-0000-00000000020c",
          "issue_datetime": "2026-08-17T21:24:27.176001Z",
          "license_number": "CDPH-00000015",
          "license_type": "Small Indoor"
        }
      ],
      "locations": [],
      "name": "Company 433",
      "order_shipment_email": null,
      "outstanding_balance": "0",
      "outstanding_balance_threshold": null,
      "owner": null,
      "owner_id": null,
      "phone_number": null,
      "purchase_order_email": null,
      "qb_customer_id": null,
      "qb_vendor_id": null,
      "relationship_type": null,
      "sales_order_email": null,
      "updated_datetime": "2023-12-02T00:00:00.000000Z",
      "website": null
    }
  ],
  "next_page": 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.

Required permission: companies_permissions_view. Results are filtered to only include companies the authenticated user can access under their team restrictions.

Request

GET /public/v1/companies

Parameters

Parameter Description In Type Required Default Example
deleted Filter deleted companies. no returns non-deleted, only returns deleted, include returns both. query string false no
inserted_datetime Filter companies by their creation datetime query string false 2022-07-10T00:00:00Z,
page Pagination information query number false ?page[number]=1
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

Upsert a company

POST /public/v1/companies upsert returns the related company's locations and licenses

POST /public/v1/companies
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjksImlhdCI6MTc4NzAwMTg2OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTQzNGFjN2EtODZjNS00ODJlLTlmMzUtMGFhMmViNmUxYjVlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODIwMiIsInR5cCI6ImFjY2VzcyJ9.P8BdK0W3OrYOwiksVzsDyrWRKGCWpSE1y0u6qH-Mi_I

{
  "id": "00000000-0000-0000-0000-000000000f39",
  "name": "Updated Name"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 90c88617dc86807f567ad2e9a0e34d34-882f24ad8b0a21fa-0

{
  "data": {
    "category": "Retail",
    "custom_data": [],
    "default_email": "company-2391@example.com",
    "default_payment_term": null,
    "default_purchase_order_notes": null,
    "default_sales_order_notes": null,
    "deleted_at": null,
    "group": null,
    "id": "00000000-0000-0000-0000-000000000f39",
    "inserted_datetime": "2026-08-17T21:24:29.061695Z",
    "invoice_email": null,
    "leaflink_brand_id": null,
    "leaflink_customer_id": null,
    "legal_business_name": "Company Legal Name 1013",
    "licenses": [
      {
        "active": true,
        "expiry_datetime": "2026-09-17T21:24:29.053267Z",
        "id": "00000000-0000-0000-0000-000000000231",
        "issue_datetime": "2026-08-17T21:24:29.053266Z",
        "license_number": "CDPH-00000053",
        "license_type": "Type N Infusions"
      }
    ],
    "locations": [
      {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-0000000018d7",
        "id": "00000000-0000-0000-0000-00000000088a",
        "license_id": null,
        "name": "Place 336"
      }
    ],
    "name": "Updated Name",
    "order_shipment_email": null,
    "outstanding_balance": "0",
    "outstanding_balance_threshold": null,
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1374@example.com",
      "full_name": "FirstName2804 LastName2805",
      "id": "00000000-0000-0000-0000-000000002011",
      "role": {
        "id": "00000000-0000-0000-0000-0000000020c2",
        "name": "Admin 1422"
      }
    },
    "owner_id": "00000000-0000-0000-0000-000000002011",
    "phone_number": null,
    "purchase_order_email": null,
    "qb_customer_id": null,
    "qb_vendor_id": null,
    "relationship_type": null,
    "sales_order_email": null,
    "updated_datetime": "2026-08-17T21:24:29.080768Z",
    "website": null
  }
}

Upsert a single company. To update an existing company, pass in an existing company ID in the id field. If you do not pass in an ID, a new company and its associated company will be created. Required permission: companies_permissions_create to create a new company, companies_permissions_edit (and access to the company under team restrictions) to update an existing company.

Request

POST /public/v1/companies

Parameters

Parameter Description In Type Required Default Example
category Category of the related company query string false Retailer
custom_data Custom data for this company relationship body object false
default_email Default email address for the related company query string false
default_payment_term_id The ID of the payment term to apply by default to this company relationship. Use GET /public/v1/payment-terms to look up available payment term IDs. query string false
default_purchase_order_notes Default notes included on purchase orders for this company query string false
default_sales_order_notes Default notes included on sales orders for this company query string false
group_id The ID of the group to assign to this company relationship query string false
id Unique ID for this company. If given, the matching record will be updated. If not given, a new company will be created. query string false
invoice_email Email address for invoices sent to this company query string false
legal_business_name Legal business name of the related company query string false
name Name of the related company query string false Acme Dispensary
order_shipment_email Email address for order shipment notifications sent to this company query string false
outstanding_balance_threshold Threshold amount (in cents) above which an outstanding balance warning is triggered query integer false
owner_id The ID of the user that owns this company relationship query string false
phone_number Phone number for the related company query string false
purchase_order_email Email address for purchase orders sent to this company query string false
relationship_type_id The ID of the relationship type to assign to this company relationship query string false
sales_order_email Email address for sales orders sent to this company query string false
website Website URL for the related company query string false

Responses

Status Description Schema
200 An updated company relationship CompanyResponse
201 A new company relationship CompanyResponse
400 Bad request
404 Not found

CompanyGroup

Delete a company group

DELETE /public/v1/company-groups/:id deletes a company group

DELETE /public/v1/company-groups/00000000-0000-0000-0000-000000000030
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMDRhOTc1NDYtZDllOC00ZmM2LTllZTEtNGRhOWI2ODU0ZTJkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzA4MCIsInR5cCI6ImFjY2VzcyJ9.cPgztLAwFPEOqOl2n00JKAXLGHpoOwI5CnPPv9SrRsA

Response

204
cache-control: max-age=0, private, must-revalidate
b3: 8b0f2f31567766868619f34ddacaf081-dbda862a07e1118c-0

Permanently deletes the company group. This is a hard delete: the record is removed from the database and cannot be recovered.

Required permission: settings_permissions_company_relationship_groups.

Request

DELETE /public/v1/company-groups/{id}

Parameters

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

Responses

Status Description Schema
204 No Content
404 Not Found

Get a company group

GET /public/v1/company-groups/:id returns a single company group

GET /public/v1/company-groups/00000000-0000-0000-0000-00000000002c
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYjZiODQ3OGEtMDc4OS00ZWFmLTlkNWMtODcyZTk2ZDcwN2MwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjkyMyIsInR5cCI6ImFjY2VzcyJ9.qhEPkO7OHxGUH-hs4o8z5cs70GZJCvQhqxSptJ0xSYs

Response

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

{
  "data": {
    "id": "00000000-0000-0000-0000-00000000002c",
    "inserted_datetime": "2026-08-17T21:24:25.568823Z",
    "name": "Key Accounts",
    "updated_datetime": "2026-08-17T21:24:25.568823Z"
  }
}

Get a single company group given the ID.

Required permission: settings_permissions_company_relationship_groups.

Request

GET /public/v1/company-groups/{id}

Parameters

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

Responses

Status Description Schema
200 A single company group CompanyGroupFullResponse
404 Not Found

Get company groups

GET /public/v1/company-groups returns paginated company groups for the company with next_page

GET /public/v1/company-groups
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGM4ZjNlMjYtNWQ1Ni00Njc3LTk1ODgtOWY3YmIzY2JhYzc5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjgzOSIsInR5cCI6ImFjY2VzcyJ9.MuWFkmwajofiG8ykVSefJDjTu27bR-veFNGZfJY-bfU

Response

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

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000026",
      "inserted_datetime": "2026-08-17T21:24:24.992157Z",
      "name": "CG1",
      "updated_datetime": "2026-08-17T21:24:24.992157Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000027",
      "inserted_datetime": "2026-08-17T21:24:24.996552Z",
      "name": "CG2",
      "updated_datetime": "2026-08-17T21:24:24.996552Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000028",
      "inserted_datetime": "2026-08-17T21:24:24.997339Z",
      "name": "CG3",
      "updated_datetime": "2026-08-17T21:24:24.997339Z"
    }
  ],
  "next_page": "https://www.example.com/public/v1/company-groups?page[number]=2"
}

List company groups for the authenticated company.

Required permission: settings_permissions_company_relationship_groups.

Request

GET /public/v1/company-groups

Parameters

Parameter Description In Type Required Default Example
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of company groups CompanyGroups

Upsert a company group

POST /public/v1/company-groups creates a company group

POST /public/v1/company-groups
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMWY5ZTM0ZjktZDM4MC00NTA4LTk4NDktZjY1YTU5MmQ0Mzg3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzA1NSIsInR5cCI6ImFjY2VzcyJ9.i6MOSYhuFwtkLwx8ZvTcDDIf0VG2nc75dANXe0swtgM

{
  "name": "Key Accounts"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 405f99fda41ecc6e6ed37160d0c23485-db8695a87c52914f-0

{
  "data": {
    "id": "00000000-0000-0000-0000-00000000002f",
    "inserted_datetime": "2026-08-17T21:24:26.051026Z",
    "name": "Key Accounts",
    "updated_datetime": "2026-08-17T21:24:26.051026Z"
  }
}

Upsert a single company group. To update an existing company group, pass its ID in the id field. If you do not pass an ID, a new company group is created.

Required permission: settings_permissions_company_relationship_groups.

Request

POST /public/v1/company-groups

Parameters

Parameter Description In Type Required Default Example
id Company group ID. If given, the matching company group is updated; otherwise a new one is created. query string false
name The name of the company group query string true

Responses

Status Description Schema
200 The updated company group CompanyGroupFullResponse
201 The created company group CompanyGroupFullResponse
400 Invalid parameters
404 Not Found

Contact

Get a contact

GET /public/v1/contacts/:id returns a single contact

GET /public/v1/contacts/00000000-0000-0000-0000-0000000000b3
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMzc3OWRmNGYtNWJkOC00MGZiLThiYTItODQxZjdjZmJlMTUyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODAxMCIsInR5cCI6ImFjY2VzcyJ9.Kle2t9ll5RMy0Cdq60rQlibrM_eFzFwX2E3o5bg6qeg

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 691711701d36c07a608a25eca93ebeb7-047f8ba4e84cdca2-0

{
  "data": {
    "company": {
      "id": "00000000-0000-0000-0000-000000000ee9"
    },
    "custom_data": [
      {
        "id": 188,
        "name": "Custom Field 28",
        "value": "Custom Data 1"
      }
    ],
    "deleted_at": null,
    "description": null,
    "driver_license_issuing_state": null,
    "driver_license_number": null,
    "email": null,
    "first_name": "John",
    "full_name": "John Doe",
    "id": "00000000-0000-0000-0000-0000000000b3",
    "inserted_datetime": "2026-08-17T21:24:28.616485Z",
    "last_name": "Doe",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1185@example.com",
      "full_name": "FirstName2420 LastName2421",
      "id": "00000000-0000-0000-0000-000000001f53",
      "role": {
        "id": "00000000-0000-0000-0000-000000002002",
        "name": "Admin 1230"
      }
    },
    "phone_number": null,
    "title": null,
    "updated_datetime": "2026-08-17T21:24:28.616485Z",
    "work_phone_number": null
  }
}

Get a single contact given the ID.

Required permission: contacts_permissions_view.

Request

GET /public/v1/contacts/{id}

Parameters

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

Responses

Status Description Schema
200 A single contact ContactResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYThiMjRlNDAtZGUyNS00YTNmLWI2ZGItNDY5ODNhOGY0YmMzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg3MiIsInR5cCI6ImFjY2VzcyJ9.z66kpSZJLnn43WxE3mRHcxMfej7bblkOVYhKWZCvN0Q

Response

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

{
  "data": [
    {
      "company": {
        "id": "00000000-0000-0000-0000-000000000d7c"
      },
      "custom_data": [
        {
          "id": 156,
          "name": "Custom Field 0",
          "value": "Custom Data 1"
        }
      ],
      "deleted_at": null,
      "description": "Description 1",
      "driver_license_issuing_state": "CA",
      "driver_license_number": "1234567890",
      "email": "email1",
      "first_name": "first",
      "full_name": "first name1",
      "id": "00000000-0000-0000-0000-000000000095",
      "inserted_datetime": "2026-08-17T21:24:25.410687Z",
      "last_name": "name1",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "contact-owner@example.com",
        "full_name": "FirstName108 LastName109",
        "id": "00000000-0000-0000-0000-000000001ae2",
        "role": {
          "id": "00000000-0000-0000-0000-000000001b6d",
          "name": "Admin 57"
        }
      },
      "phone_number": "1234567890",
      "title": null,
      "updated_datetime": "2026-08-17T21:24:25.410687Z",
      "work_phone_number": "1234567891"
    },
    {
      "company": {
        "id": "00000000-0000-0000-0000-000000000d7d"
      },
      "custom_data": [
        {
          "id": 156,
          "name": "Custom Field 0",
          "value": null
        }
      ],
      "deleted_at": null,
      "description": "Description 2",
      "driver_license_issuing_state": "NV",
      "driver_license_number": "123456789",
      "email": "email2",
      "first_name": "first",
      "full_name": "first name2",
      "id": "00000000-0000-0000-0000-000000000096",
      "inserted_datetime": "2026-08-17T21:24:25.420393Z",
      "last_name": "name2",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "contact-owner@example.com",
        "full_name": "FirstName108 LastName109",
        "id": "00000000-0000-0000-0000-000000001ae2",
        "role": {
          "id": "00000000-0000-0000-0000-000000001b6d",
          "name": "Admin 57"
        }
      },
      "phone_number": "1234567890",
      "title": null,
      "updated_datetime": "2026-08-17T21:24:25.420393Z",
      "work_phone_number": "1234567892"
    }
  ],
  "next_page": 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.

Required permission: contacts_permissions_view. Results are filtered to only include contacts the authenticated user can access under their team restrictions.

Request

GET /public/v1/contacts

Parameters

Parameter Description In Type Required Default Example
deleted Filter deleted contacts. no returns non-deleted, only returns deleted, include returns both. query string false no
inserted_datetime Filter contacts by their creation datetime query string false 2022-07-10T00:00:00Z,
page Pagination information query number false ?page[number]=1
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

Upsert a contact

POST /public/v1/contacts creating a contact with all optional fields succeeds with a 201 response containing the new contact

POST /public/v1/contacts
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiM2RjNDhkY2ItYzA3Ny00YTcyLWE2YmYtYTk0NjAzOTljODQ3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzM2NyIsInR5cCI6ImFjY2VzcyJ9.bR-WU_wh1q2T82yhAvGKMEpwm5pXcnIEkUe1kgJkzzs

{
  "company_id": "00000000-0000-0000-0000-000000000df6",
  "custom_data": {
    "160": [
      "VIP",
      "Wholesale"
    ]
  },
  "description": "Notes",
  "driver_license_issuing_state": "CA",
  "driver_license_number": "D123",
  "email": "jane@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "owner_id": "00000000-0000-0000-0000-000000001cca",
  "phone_number": "555-1111",
  "title": "Buyer",
  "work_phone_number": "555-2222"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 4521f39646fe71d59ccbf3c3d24cd71c-f829bc577f162f0c-0

{
  "data": {
    "company": {
      "id": "00000000-0000-0000-0000-000000000df6"
    },
    "custom_data": [
      {
        "id": 160,
        "name": "Custom Field 4",
        "value": "VIP,Wholesale"
      }
    ],
    "deleted_at": null,
    "description": "Notes",
    "driver_license_issuing_state": "CA",
    "driver_license_number": "D123",
    "email": "jane@example.com",
    "first_name": "Jane",
    "full_name": "Jane Doe",
    "id": "00000000-0000-0000-0000-0000000000a2",
    "inserted_datetime": "2026-08-17T21:24:27.135173Z",
    "last_name": "Doe",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-544@example.com",
      "full_name": "FirstName1104 LastName1105",
      "id": "00000000-0000-0000-0000-000000001cca",
      "role": {
        "id": "00000000-0000-0000-0000-000000001d60",
        "name": "Admin 556"
      }
    },
    "phone_number": "555-1111",
    "title": "Buyer",
    "updated_datetime": "2026-08-17T21:24:27.135173Z",
    "work_phone_number": "555-2222"
  }
}

Upsert a single contact. To update an existing contact, pass in an existing contact ID in the id field as well as the other fields you want to update. If you do not pass in an ID, a new contact will be created. Required permission: contacts_permissions_create to create a new contact, contacts_permissions_edit (and access to the contact under team restrictions) to update an existing contact.

Request

POST /public/v1/contacts

Parameters

Parameter Description In Type Required Default Example
company_id The ID of the company relationship (company) this contact belongs to query string false
custom_data The custom data for this contact body object false
description Description for the contact query string false
driver_license_issuing_state Driver license issuing state for shipping manifests query string false
driver_license_number Driver license number for shipping manifests query string false
email Email address for the contact query string false
first_name First name for the contact query string true
id Unique ID for this contact. If given, the contact matching the ID will be updated. If not given, a new contact will be created. query string false
last_name Last name for the contact query string false
owner_id The ID of the user that owns this contact query string false
phone_number Phone number for the contact query string false
title Job title for the contact query string false
work_phone_number Work phone number for the contact query string false

Responses

Status Description Schema
200 An updated contact ContactResponse
201 A new contact ContactResponse
400 Bad request
404 Not found

Cost

Add costs to batches

POST /public/v1/batches/add-costs adds costs to a batch and distributes across batches by quantity

POST /public/v1/batches/add-costs
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjU5MzRjMjItMzhjZC00YTk1LThjMTgtODVjN2RiMDJjNDE5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzQxOCIsInR5cCI6ImFjY2VzcyJ9.hKphvIBwTrNgWhJPnzsLffAbOAj5zrNQsWP3t21U-n0

{
  "batch_ids": [
    "00000000-0000-0000-0000-00000000087c"
  ],
  "costs": [
    {
      "cost_per_unit": 3,
      "cost_type_id": "00000000-0000-0000-0000-000000000049",
      "quantity": 2
    }
  ]
}

Response

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

{
  "data": [
    {
      "batch_number": null,
      "cbd": null,
      "cost_per_unit_actual": "1.2",
      "cost_per_unit_default": "0.8",
      "creator": null,
      "custom_data": [],
      "deleted_at": null,
      "description": null,
      "expiration_date": null,
      "harvest_datetime": null,
      "id": "00000000-0000-0000-0000-00000000087c",
      "inserted_datetime": "2026-08-17T21:24:27.237432Z",
      "manufactured_datetime": "2026-08-17T21:24:27.184178Z",
      "name": "B179",
      "owner_id": "00000000-0000-0000-0000-000000001d06",
      "primary_test_result": null,
      "product_id": "ba3d49ca-d710-4c50-bfc6-3fbcdc489041",
      "thc": null,
      "total_cost_actual": "6",
      "total_cost_default": "4",
      "updated_datetime": "2026-08-17T21:24:27.237432Z"
    }
  ]
}

Add one or more costs to each of the given batches.

batch_ids is a non-empty list of batch UUIDs. Every batch must belong to a batch-tracked product. The cost is applied to each batch's active quantity. location_ids optionally scopes the batch stock the cost applies to; omit it to apply across all locations.

Each entry in costs accepts the following fields:

When distribute_by_quantity is true, the total of each cost (cost_per_unit × quantity) is split across the selected records in proportion to each record's quantity, instead of applying the full cost to every record. Quantities are converted to a common unit before the split, so all selected records must share the same unit type category. Selecting a single record is a no-op (the whole cost lands on it). When false or omitted, the same cost is applied in full to each selected record.

Common errors (HTTP 400 unless noted):

Required permission: costs_permissions_apply_to_inventory.

Request

POST /public/v1/batches/add-costs

Parameters

Parameter Description In Type Required Default Example
payload The batches and costs to apply body AddBatchCostsRequest true

Responses

Status Description Schema
200 The affected batches Batches
400 Invalid parameters
403 Cost Accounting disabled or missing permission

Add costs to packages

POST /public/v1/packages/add-costs adds a cost to a package

POST /public/v1/packages/add-costs
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNmViNjFhNzEtZjYzYy00OGVlLWJkNzgtY2M3MzYzNWUxZTNhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzI2OSIsInR5cCI6ImFjY2VzcyJ9.z02HQsdQFZnw2gV3JTTh3AS10FzYsoKHfBmBPTdvDQI

{
  "costs": [
    {
      "cost_type_id": "00000000-0000-0000-0000-000000000048",
      "quantity": 4
    }
  ],
  "package_ids": [
    "00000000-0000-0000-0000-0000000000db"
  ]
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 983862536550703e0efb0039644137a8-292a7cb8966d7179-0

{
  "data": [
    {
      "batch_number": null,
      "biotrack_id": null,
      "biotrack_inventory_type_id": null,
      "biotrack_net_quantity_per_unit": null,
      "biotrack_room_id": null,
      "biotrack_status": null,
      "biotrack_usable_weight": null,
      "compliance_label": "ABCDEF012345670000000004",
      "compliance_product_name": "Buds",
      "compliance_strain_name": "Cotton Candy",
      "compliance_transferred_datetime": null,
      "compliance_type": "METRC",
      "cost_per_unit_actual": "2.666666666666666666666666667",
      "cost_per_unit_default": "2.666666666666666666666666667",
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-475@example.com",
        "full_name": "FirstName966 LastName967",
        "id": "00000000-0000-0000-0000-000000001c85",
        "role": {
          "id": "00000000-0000-0000-0000-000000001d1d",
          "name": "Admin 489"
        }
      },
      "custom_data": [],
      "description": null,
      "expiration_date": null,
      "expiration_datetime": null,
      "finished_datetime": null,
      "harvest_date": null,
      "id": "00000000-0000-0000-0000-0000000000db",
      "inactivated_datetime": null,
      "is_production_batch": false,
      "is_test_sample": false,
      "is_trade_sample": false,
      "lab_testing_state": "NotSubmitted",
      "license": {
        "active": true,
        "expiry_datetime": "2026-09-17T21:24:26.806572Z",
        "id": "00000000-0000-0000-0000-000000000209",
        "issue_datetime": "2026-08-17T21:24:26.806570Z",
        "license_number": "CDPH-00000012",
        "license_type": "Type 13 Distributor-Transport Only"
      },
      "location": {
        "id": "00000000-0000-0000-0000-0000000007c6",
        "name": "Place 140"
      },
      "metrc_archived_date": null,
      "metrc_finished_date": null,
      "metrc_id": 4,
      "metrc_label": "ABCDEF012345670000000004",
      "metrc_production_batch_number": null,
      "metrc_received_datetime": null,
      "metrc_received_from_manifest_number": null,
      "metrc_source_harvest_names": null,
      "metrc_status": "ACTIVE",
      "metrc_transfer_id": null,
      "metrc_unit_name": "Ounces",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-464@example.com",
        "full_name": "FirstName944 LastName945",
        "id": "00000000-0000-0000-0000-000000001c7a",
        "role": {
          "id": "00000000-0000-0000-0000-000000001d10",
          "name": "Admin 476"
        }
      },
      "packaged_date": "2014-11-29",
      "primary_test_result": null,
      "product_id": "16b90b7e-be07-432e-ac86-28b1c1f865c4",
      "product_unit_quantity": "3.000000000",
      "product_unit_type": {
        "id": "00000000-0000-0000-0000-00000001179a",
        "name": "Ounce"
      },
      "quantity": "3.000000000",
      "quantity_assembling": "0.000000000",
      "quantity_available": "3.000000000",
      "status": "active",
      "total_cost_actual": "8",
      "total_cost_default": "8",
      "unit_type": {
        "id": "00000000-0000-0000-0000-00000001179a",
        "name": "Ounce"
      }
    }
  ]
}

Add one or more costs to each of the given packages.

package_ids is a non-empty list of package UUIDs. Packages carry their own location, so this endpoint does not accept location_ids. Unlike batches and products, the cost is applied to the package's full current quantity regardless of its status (active, selling, assembling, etc.).

Each entry in costs accepts the following fields:

When distribute_by_quantity is true, the total of each cost (cost_per_unit × quantity) is split across the selected records in proportion to each record's quantity, instead of applying the full cost to every record. Quantities are converted to a common unit before the split, so all selected records must share the same unit type category. Selecting a single record is a no-op (the whole cost lands on it). When false or omitted, the same cost is applied in full to each selected record.

Common errors (HTTP 400 unless noted):

Required permission: costs_permissions_apply_to_inventory.

Request

POST /public/v1/packages/add-costs

Parameters

Parameter Description In Type Required Default Example
payload The packages and costs to apply body AddPackageCostsRequest true

Responses

Status Description Schema
200 The affected packages Packages
400 Invalid parameters
403 Cost Accounting disabled or missing permission

Add costs to products

POST /public/v1/products/add-costs adds costs to a product, defaulting cost_per_unit to the cost type when omitted

POST /public/v1/products/add-costs
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMWZhOTYyZDUtNzcwNi00N2U2LWE5ZjUtMzRlN2ZjODU2NTY5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg3NiIsInR5cCI6ImFjY2VzcyJ9.CDhns0UaagMXCvsLRjgYTAdG71di_RIAWbRgR1z7Oto

{
  "costs": [
    {
      "cost_type_id": "00000000-0000-0000-0000-00000000003c",
      "quantity": 3
    },
    {
      "cost_per_unit": 5,
      "cost_type_id": "00000000-0000-0000-0000-00000000003c",
      "quantity": 1
    }
  ],
  "product_ids": [
    "c40515d5-0a96-45c8-b1ea-f5088f33b37d"
  ]
}

Response

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

{
  "data": [
    {
      "brand": null,
      "category": {
        "id": "00000000-0000-0000-0000-0000000008fb",
        "name": "Some category 16",
        "official_product_category_id": "OTHER"
      },
      "creator": null,
      "custom_data": [],
      "deleted_at": null,
      "description": null,
      "description_markdown": null,
      "external_name": null,
      "gross_weight": null,
      "gross_weight_unit_type": null,
      "id": "c40515d5-0a96-45c8-b1ea-f5088f33b37d",
      "images": [
        {
          "id": "00000000-0000-0000-0000-000000000018",
          "name": "Image Name 6",
          "rank": 0,
          "url": "https://google.com/original-0.jpg"
        }
      ],
      "inventory_tracking_method": "PRODUCT",
      "is_active": true,
      "is_featured": false,
      "leaflink_product_id": null,
      "menu_visibility": "DO_NOT_INCLUDE",
      "menus": [
        {
          "menu_id": "00000000-0000-0000-0000-00000000007e",
          "menu_name": "Menu 1"
        }
      ],
      "msrp": null,
      "name": "Product 19",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-55@example.com",
        "full_name": "FirstName104 LastName105",
        "id": "00000000-0000-0000-0000-000000001ae0",
        "role": {
          "id": "00000000-0000-0000-0000-000000001b6b",
          "name": "Admin 55"
        }
      },
      "product_group": {
        "id": "00000000-0000-0000-0000-0000000008cc",
        "name": "Product Group 7"
      },
      "quantity_available_threshold_max": null,
      "quantity_available_threshold_min": null,
      "sku": "sku 20",
      "strain": null,
      "subcategory": {
        "id": "00000000-0000-0000-0000-0000000008d6",
        "name": "Some subcategory 13"
      },
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000031",
          "name": "Tag 1"
        }
      ],
      "total_cannabinoid_unit": null,
      "total_cbd": null,
      "total_thc": null,
      "treez_wholesale_price": null,
      "unit_cost": null,
      "unit_net_weight": null,
      "unit_net_weight_serving_size_unit_type": null,
      "unit_price": "1",
      "unit_serving_size": null,
      "unit_type": {
        "id": "00000000-0000-0000-0000-000000010991",
        "name": "Gram"
      },
      "units_per_case": null,
      "upc": null,
      "updated_datetime": "2026-08-17T21:24:25.408827Z",
      "vendor": {
        "id": "00000000-0000-0000-0000-000000000d79",
        "name": "Company 59",
        "updated_datetime": "2026-08-17T21:24:25.400845Z"
      },
      "wholesale_unit_price": null
    }
  ]
}

Add one or more costs to each of the given product-tracked products.

product_ids is a non-empty list of product UUIDs. Every product must be product-tracked. The cost is applied to each product's active quantity. location_ids optionally scopes the product stock the cost applies to; omit it to apply across all locations.

Each entry in costs accepts the following fields:

When distribute_by_quantity is true, the total of each cost (cost_per_unit × quantity) is split across the selected records in proportion to each record's quantity, instead of applying the full cost to every record. Quantities are converted to a common unit before the split, so all selected records must share the same unit type category. Selecting a single record is a no-op (the whole cost lands on it). When false or omitted, the same cost is applied in full to each selected record.

Common errors (HTTP 400 unless noted):

Required permission: costs_permissions_apply_to_inventory.

Request

POST /public/v1/products/add-costs

Parameters

Parameter Description In Type Required Default Example
payload The products and costs to apply body AddProductCostsRequest true

Responses

Status Description Schema
200 The affected products Products
400 Invalid parameters
403 Cost Accounting disabled or missing permission

CostType

Delete a cost type

DELETE /public/v1/cost-types/:id soft-deletes a cost type

DELETE /public/v1/cost-types/00000000-0000-0000-0000-000000000042
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMGNlN2JhMzctYzM0MS00M2Y1LThhZjctZjg1NTIyZDBlYmRjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzEzNSIsInR5cCI6ImFjY2VzcyJ9.cxw0uleIY1cJbYSbLza3_DMVPNlC9s3eMgyPpfL5pj8

Response

204
cache-control: max-age=0, private, must-revalidate
b3: 604662a97db918312cec068877988776-2deb8cc5739b1b09-0

Deletes the cost type. This is a soft delete: the record's deleted_at is set and it is no longer returned by the API, but it is retained in the database.

Required permission: costs_permissions_manage_cost_types.

Request

DELETE /public/v1/cost-types/{id}

Parameters

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

Responses

Status Description Schema
204 No Content
404 Not Found

Get a cost type

GET /public/v1/cost-types/:id returns a single cost type with a string cost_per_unit and embedded unit_type

GET /public/v1/cost-types/00000000-0000-0000-0000-00000000003d
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNzkxM2E1N2EtM2E2MC00ZTM3LWI3ODMtMmExZWNkMDg5MTMyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njk0MiIsInR5cCI6ImFjY2VzcyJ9.Uxj4Wzn9e6CDbkDWyDgC8ZGZyc4ICmfSf1XSw-joZeg

Response

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

{
  "data": {
    "active": true,
    "allow_inline_edits": true,
    "cost_per_unit": "25.5",
    "deleted_at": null,
    "description": null,
    "id": "00000000-0000-0000-0000-00000000003d",
    "inserted_datetime": "2026-08-17T21:24:25.630352Z",
    "name": "Freight",
    "unit_type": {
      "id": "00000000-0000-0000-0000-000000010c33",
      "name": "Unit Type 10"
    },
    "updated_datetime": "2026-08-17T21:24:25.630352Z"
  }
}

Get a single cost type given the ID.

Required permission: costs_permissions_manage_cost_types.

Request

GET /public/v1/cost-types/{id}

Parameters

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

Responses

Status Description Schema
200 A single cost type CostTypeResponse
404 Not Found

Get cost types

GET /public/v1/cost-types returns paginated cost types for the company with next_page

GET /public/v1/cost-types
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZTAwYjFiZjMtMTNmZi00NGJmLTg2ZTMtMzViZGFhNWFiNmQ2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg2NCIsInR5cCI6ImFjY2VzcyJ9.s-x2sYXm1Ccz3jJv_vPDPt-PXT6DRRYN7B3bZFVujQM

Response

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

{
  "data": [
    {
      "active": true,
      "allow_inline_edits": true,
      "cost_per_unit": "1",
      "deleted_at": null,
      "description": null,
      "id": "00000000-0000-0000-0000-000000000035",
      "inserted_datetime": "2025-01-01T00:00:00.000000Z",
      "name": "CT1",
      "unit_type": {
        "id": "00000000-0000-0000-0000-000000010935",
        "name": "Unit Type 0"
      },
      "updated_datetime": "2026-08-17T21:24:25.239393Z"
    },
    {
      "active": true,
      "allow_inline_edits": true,
      "cost_per_unit": "1",
      "deleted_at": null,
      "description": null,
      "id": "00000000-0000-0000-0000-000000000036",
      "inserted_datetime": "2025-01-02T00:00:00.000000Z",
      "name": "CT2",
      "unit_type": {
        "id": "00000000-0000-0000-0000-000000010936",
        "name": "Unit Type 1"
      },
      "updated_datetime": "2026-08-17T21:24:25.242445Z"
    },
    {
      "active": true,
      "allow_inline_edits": true,
      "cost_per_unit": "1",
      "deleted_at": null,
      "description": null,
      "id": "00000000-0000-0000-0000-000000000037",
      "inserted_datetime": "2025-01-03T00:00:00.000000Z",
      "name": "CT3",
      "unit_type": {
        "id": "00000000-0000-0000-0000-000000010937",
        "name": "Unit Type 2"
      },
      "updated_datetime": "2026-08-17T21:24:25.254933Z"
    }
  ],
  "next_page": "https://www.example.com/public/v1/cost-types?page[number]=2"
}

List cost types for the authenticated company.

Required permission: costs_permissions_manage_cost_types.

Request

GET /public/v1/cost-types

Parameters

Parameter Description In Type Required Default Example
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of cost types CostTypes

Upsert a cost type

POST /public/v1/cost-types creates a cost type

POST /public/v1/cost-types
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNmZkOGE1NDYtMDdlNy00NzFiLTgyZTctOWQ5YWRmNzAyMTdiIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzA4MSIsInR5cCI6ImFjY2VzcyJ9.udfwsK9sIZns7as20srNV7gNrwEjI6WKefKWvwLdR3U

{
  "active": true,
  "allow_inline_edits": true,
  "cost_per_unit": "25.5",
  "description": "Inbound shipping",
  "name": "Freight",
  "unit_type_id": "00000000-0000-0000-0000-000000011146"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: cb89dea5971d3f96d6ea1ece9471cb48-dbfb893f75682fef-0

{
  "data": {
    "active": true,
    "allow_inline_edits": true,
    "cost_per_unit": "25.5",
    "deleted_at": null,
    "description": "Inbound shipping",
    "id": "00000000-0000-0000-0000-000000000040",
    "inserted_datetime": "2026-08-17T21:24:26.213996Z",
    "name": "Freight",
    "unit_type": {
      "id": "00000000-0000-0000-0000-000000011146",
      "name": "Unit Type 13"
    },
    "updated_datetime": "2026-08-17T21:24:26.213996Z"
  }
}

Upsert a single cost type. To update an existing cost type, pass its ID in the id field. If you do not pass an ID, a new cost type is created. When creating, name, cost_per_unit, unit_type_id and allow_inline_edits are required. The unit type cannot be changed once set.

Required permission: costs_permissions_manage_cost_types.

Request

POST /public/v1/cost-types

Parameters

Parameter Description In Type Required Default Example
active Whether the cost type is active query boolean false
allow_inline_edits Whether inline edits are allowed query boolean true
cost_per_unit The cost per unit as a decimal string query string true
description A description of the cost type query string false
id Cost type ID. If given, the matching cost type is updated; otherwise a new one is created. query string false
name The name of the cost type query string true
unit_type_id The ID of the unit type query string true

Responses

Status Description Schema
200 The updated cost type CostTypeResponse
201 The created cost type CostTypeResponse
400 Invalid parameters
404 Not Found

Credit

Cancel a credit

POST /public/v1/credits/:id/cancel cancels a credit, idempotently, and can delete its credit uses

POST /public/v1/credits/42bf0d8f-9fe0-42e6-8a2e-c3a718452c73/cancel
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NzAsImlhdCI6MTc4NzAwMTg3MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNjY5ZWRkMjktNjU4Ni00NDY1LTlmZWQtNzg0YTMwMGM4ODgwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODYwNiIsInR5cCI6ImFjY2VzcyJ9.08pIXf9FhKmtnGnvOHT1IunI8qRSj81s_LhvATk5BTI

Response

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

{
  "data": {
    "amount": "100",
    "canceled_datetime": "2026-08-17T21:24:30.069308Z",
    "company": {
      "id": "00000000-0000-0000-0000-000000001000",
      "name": "Company 1337",
      "updated_datetime": "2026-08-17T21:24:30.045929Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1783@example.com",
      "full_name": "FirstName3636 LastName3637",
      "id": "00000000-0000-0000-0000-0000000021ab",
      "role": {
        "id": "00000000-0000-0000-0000-00000000226f",
        "name": "Admin 1851"
      }
    },
    "credit_number": "CRT-00000079",
    "credit_uses": [
      {
        "amount": "40",
        "credit": {
          "amount": "100",
          "credit_number": "CRT-00000079",
          "id": "42bf0d8f-9fe0-42e6-8a2e-c3a718452c73",
          "source": "USER"
        },
        "id": "2e6abe5c-8e28-4fb0-9a62-40c7df9927ae",
        "inserted_datetime": "2026-08-17T21:24:30.052630Z",
        "payment": null
      }
    ],
    "deleted_in_qbo": false,
    "external_note": "External note",
    "id": "42bf0d8f-9fe0-42e6-8a2e-c3a718452c73",
    "inserted_datetime": "2026-08-17T21:24:30.051463Z",
    "internal_note": "Internal note",
    "original_amount": "100",
    "owner": null,
    "payment": null,
    "qb_credit_memo_id": null,
    "qb_payment_id": null,
    "qb_sync_status": null,
    "remaining_balance": "60",
    "return": null,
    "source": "USER",
    "status": "CANCELED",
    "updated_datetime": "2026-08-17T21:24:30.069323Z"
  }
}

Cancel (void) a credit. A canceled credit keeps its record and history, but its remaining balance can no longer be applied to invoices.

By default the credit's existing applications to invoices are left in place. Set should_delete_credit_uses to true to also remove those applications, returning the used amounts to the affected invoices.

Overpayment credits (created from an invoice overpayment or a QuickBooks payment) cannot be canceled — void the associated payment instead. Canceling an already-canceled credit is a no-op that returns the credit unchanged.

Required permission: credits_permissions_edit.

Request

POST /public/v1/credits/{id}/cancel

Parameters

Parameter Description In Type Required Default Example
cancel Cancel options body CancelCredit false
id Credit ID path string true

Responses

Status Description Schema
200 The canceled credit CreditResponse
400 Bad Request
403 Forbidden
404 Not Found

Create or update a credit

POST /public/v1/credits creates a manually-created credit then updates it

POST /public/v1/credits
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODg5OGMzY2MtOGUwNC00YTQxLWJlOWMtYzRlMzNlZjIzOGM1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzkyNyIsInR5cCI6ImFjY2VzcyJ9._Si3wGE8eqPhz6VePHjh4S-RoxIxWyrfbhn1qU38ges

{
  "amount": 80,
  "id": "ab41db1b-bac9-4b55-94db-153970bfe846",
  "internal_note": "updated"
}

Response

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

{
  "data": {
    "amount": "80",
    "canceled_datetime": null,
    "company": {
      "id": "00000000-0000-0000-0000-000000000ec7",
      "name": "Company 813",
      "updated_datetime": "2026-08-17T21:24:28.423441Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1094@example.com",
      "full_name": "FirstName2238 LastName2239",
      "id": "00000000-0000-0000-0000-000000001ef7",
      "role": {
        "id": "00000000-0000-0000-0000-000000001fa7",
        "name": "Admin 1139"
      }
    },
    "credit_number": "CRT-0000001",
    "credit_uses": [
      {
        "amount": "40",
        "credit": {
          "amount": "80",
          "credit_number": "CRT-0000001",
          "id": "ab41db1b-bac9-4b55-94db-153970bfe846",
          "source": "USER"
        },
        "id": "f4c67636-9762-416b-aa23-a00f2181a82c",
        "inserted_datetime": "2026-08-17T21:24:28.505617Z",
        "payment": {
          "amount": "10",
          "company": {
            "id": "00000000-0000-0000-0000-000000000ed4",
            "name": "Company 834",
            "updated_datetime": "2026-08-17T21:24:28.477882Z"
          },
          "credit_uses": [
            {
              "amount": "40",
              "credit": {
                "amount": "80",
                "credit_number": "CRT-0000001",
                "id": "ab41db1b-bac9-4b55-94db-153970bfe846",
                "source": "USER"
              },
              "id": "f4c67636-9762-416b-aa23-a00f2181a82c"
            }
          ],
          "description": null,
          "fully_paid_with_credits": false,
          "id": "00000000-0000-0000-0000-000000000059",
          "inserted_datetime": "2026-08-17T21:24:28.502200Z",
          "invoice": {
            "id": "00000000-0000-0000-0000-0000000000d1",
            "invoice_number": "Invoice #29",
            "status": "NOT_PAID",
            "total": "32.00"
          },
          "overpayment_credits": [],
          "payment_date": "2026-08-17T21:24:28.496506Z",
          "payment_method": {
            "active": true,
            "deleted_at": null,
            "id": "00000000-0000-0000-0000-000000000079",
            "inserted_datetime": "2026-08-17T21:24:28.495294Z",
            "name": "Payment Method 30",
            "qb_payment_method_id": null,
            "type": "CREDIT_CARD",
            "updated_datetime": "2026-08-17T21:24:28.495294Z"
          },
          "payment_number": "Payment #19",
          "payment_type": "INVOICE",
          "purchase": null,
          "quickbooks_deposit_account_id": null,
          "status": "POSTED",
          "updated_datetime": "2026-08-17T21:24:28.502200Z"
        }
      }
    ],
    "deleted_in_qbo": false,
    "external_note": "ext",
    "id": "ab41db1b-bac9-4b55-94db-153970bfe846",
    "inserted_datetime": "2026-08-17T21:24:28.444088Z",
    "internal_note": "updated",
    "original_amount": "150",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1094@example.com",
      "full_name": "FirstName2238 LastName2239",
      "id": "00000000-0000-0000-0000-000000001ef7",
      "role": {
        "id": "00000000-0000-0000-0000-000000001fa7",
        "name": "Admin 1139"
      }
    },
    "payment": null,
    "qb_credit_memo_id": null,
    "qb_payment_id": null,
    "qb_sync_status": null,
    "remaining_balance": "40",
    "return": null,
    "source": "USER",
    "status": "ACTIVE",
    "updated_datetime": "2026-08-17T21:24:28.532920Z"
  }
}

Create a new credit or update an existing one.

Omit id to create a new credit; include the id of an existing credit to update it. Only the fields you send are changed; omitted fields keep their current value.

Credits created through the API are always manually-created (USER source) credits — the same as a credit you would add by hand in the Distru UI. Only these manually-created credits can be updated through the API. Credits generated automatically (from a return, an invoice overpayment, or QuickBooks) cannot be created or modified here.

On update the customer (company_id) cannot be changed. amount must be greater than 0 and, on update, cannot be set below the amount already used by the credit.

Required permission: credits_permissions_create to create, credits_permissions_edit to update.

Request

POST /public/v1/credits

Parameters

Parameter Description In Type Required Default Example
credit Credit data body UpsertCredit true

Responses

Status Description Schema
200 The updated credit CreditResponse
201 The created credit CreditResponse
400 Bad Request
403 Forbidden
404 Not Found

Delete a credit

DELETE /public/v1/credits/:id soft-deletes a credit

DELETE /public/v1/credits/b07b893e-1e6b-4846-8346-62d319d56f7a
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjksImlhdCI6MTc4NzAwMTg2OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMWQ2YmMwNmMtMTk0ZS00ZDBkLWJmNmItYTE2MzMwZjM2N2E5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODUxMSIsInR5cCI6ImFjY2VzcyJ9.UHWbz9nnUpeuexT4yIalEYwrW1yL72O32vL0S_hFUPY

Response

204
cache-control: max-age=0, private, must-revalidate
b3: 7d0400a9681cce0cdca9e345387d1874-d4e1a2228d14d480-0

Soft-delete a credit. The credit is marked as deleted and stops appearing in the API and the Distru UI, but the record is retained rather than being permanently removed.

A credit cannot be deleted once it has been used (applied to an invoice). Overpayment credits (created from an invoice overpayment or a QuickBooks payment) cannot be deleted unless they have already been canceled — void the associated payment instead.

Required permission: credits_permissions_delete.

Request

DELETE /public/v1/credits/{id}

Parameters

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

Responses

Status Description Schema
204 No Content
400 Bad Request
403 Forbidden
404 Not Found

Get a credit

GET /public/v1/credits/:id returns a single credit with its active credit uses

GET /public/v1/credits/e8c1f3fe-4aeb-47c0-b0a0-e9b4c0a85efd
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjksImlhdCI6MTc4NzAwMTg2OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNWJkOGYwNGQtZjBiMi00NTgzLWFkMTItZjdlMzNjMWE1NTkxIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODU0MSIsInR5cCI6ImFjY2VzcyJ9.P0yQn8JeH01AWOel-7R9gmDmQkGQ_To0ttStEBrnuxw

Response

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

{
  "data": {
    "amount": "100",
    "canceled_datetime": null,
    "company": {
      "id": "00000000-0000-0000-0000-000000000fe7",
      "name": "Company 1307",
      "updated_datetime": "2026-08-17T21:24:29.884342Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1736@example.com",
      "full_name": "FirstName3542 LastName3543",
      "id": "00000000-0000-0000-0000-00000000217c",
      "role": {
        "id": "00000000-0000-0000-0000-000000002241",
        "name": "Admin 1805"
      }
    },
    "credit_number": "CRT-00000075",
    "credit_uses": [
      {
        "amount": "25",
        "credit": {
          "amount": "100",
          "credit_number": "CRT-00000075",
          "id": "e8c1f3fe-4aeb-47c0-b0a0-e9b4c0a85efd",
          "source": "USER"
        },
        "id": "9dba7024-cc83-49aa-9307-d6947d74c032",
        "inserted_datetime": "2026-08-17T21:24:29.895097Z",
        "payment": {
          "amount": "10",
          "company": {
            "id": "00000000-0000-0000-0000-000000000fda",
            "name": "Company 1293",
            "updated_datetime": "2026-08-17T21:24:29.833541Z"
          },
          "credit_uses": [
            {
              "amount": "25",
              "credit": {
                "amount": "100",
                "credit_number": "CRT-00000075",
                "id": "e8c1f3fe-4aeb-47c0-b0a0-e9b4c0a85efd",
                "source": "USER"
              },
              "id": "9dba7024-cc83-49aa-9307-d6947d74c032"
            }
          ],
          "description": null,
          "fully_paid_with_credits": false,
          "id": "00000000-0000-0000-0000-00000000005c",
          "inserted_datetime": "2026-08-17T21:24:29.845957Z",
          "invoice": {
            "id": "00000000-0000-0000-0000-0000000000d7",
            "invoice_number": "Invoice #35",
            "status": "NOT_PAID",
            "total": "32.00"
          },
          "overpayment_credits": [],
          "payment_date": "2026-08-17T21:24:29.845036Z",
          "payment_method": {
            "active": true,
            "deleted_at": null,
            "id": "00000000-0000-0000-0000-00000000007d",
            "inserted_datetime": "2026-08-17T21:24:29.843814Z",
            "name": "Payment Method 34",
            "qb_payment_method_id": null,
            "type": "CREDIT_CARD",
            "updated_datetime": "2026-08-17T21:24:29.843814Z"
          },
          "payment_number": "Payment #21",
          "payment_type": "INVOICE",
          "purchase": null,
          "quickbooks_deposit_account_id": null,
          "status": "POSTED",
          "updated_datetime": "2026-08-17T21:24:29.845957Z"
        }
      }
    ],
    "deleted_in_qbo": false,
    "external_note": "External note",
    "id": "e8c1f3fe-4aeb-47c0-b0a0-e9b4c0a85efd",
    "inserted_datetime": "2026-08-17T21:24:29.892740Z",
    "internal_note": "Internal note",
    "original_amount": "150",
    "owner": null,
    "payment": null,
    "qb_credit_memo_id": null,
    "qb_payment_id": null,
    "qb_sync_status": null,
    "remaining_balance": "75",
    "return": null,
    "source": "USER",
    "status": "ACTIVE",
    "updated_datetime": "2026-08-17T21:24:29.893957Z"
  }
}

Get a single credit given the ID.

Required permission: credits_permissions_view.

Request

GET /public/v1/credits/{id}

Parameters

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

Responses

Status Description Schema
200 A single credit CreditResponse
404 Not Found

Get credits

GET /public/v1/credits returns credits for the company with status and remaining balance

GET /public/v1/credits
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMzVmNTc4YzctMDRiMi00MWQyLWE2MWUtMDJlNzExYTM1ZTkyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzM5NCIsInR5cCI6ImFjY2VzcyJ9.ANT6JN8dARCCyXPAgR9BQQENSuxsPLF45MRC7AWs6zE

Response

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

{
  "data": [
    {
      "amount": "100",
      "canceled_datetime": null,
      "company": {
        "id": "00000000-0000-0000-0000-000000000dfe",
        "name": "Company 432",
        "updated_datetime": "2026-08-17T21:24:27.171957Z"
      },
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-583@example.com",
        "full_name": "FirstName1184 LastName1185",
        "id": "00000000-0000-0000-0000-000000001cf2",
        "role": {
          "id": "00000000-0000-0000-0000-000000001d88",
          "name": "Admin 596"
        }
      },
      "credit_number": "CRT-A",
      "credit_uses": [
        {
          "amount": "40",
          "credit": {
            "amount": "100",
            "credit_number": "CRT-A",
            "id": "3d3ae0f9-aa22-44b4-a473-91ee47caa7d2",
            "source": "USER"
          },
          "id": "e43ea491-6991-4863-8230-86675a26fcbd",
          "inserted_datetime": "2026-08-17T21:24:27.186194Z",
          "payment": null
        }
      ],
      "deleted_in_qbo": false,
      "external_note": "ext",
      "id": "3d3ae0f9-aa22-44b4-a473-91ee47caa7d2",
      "inserted_datetime": "2026-08-17T21:24:27.183527Z",
      "internal_note": "int",
      "original_amount": "150",
      "owner": null,
      "payment": null,
      "qb_credit_memo_id": null,
      "qb_payment_id": null,
      "qb_sync_status": null,
      "remaining_balance": "60",
      "return": null,
      "source": "USER",
      "status": "ACTIVE",
      "updated_datetime": "2026-08-17T21:24:27.185281Z"
    }
  ],
  "next_page": null
}

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

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

Required permission: credits_permissions_view.

Request

GET /public/v1/credits

Parameters

Parameter Description In Type Required Default Example
credit_number Filter credits whose credit number contains this value query string false
inserted_datetime Filter credits by their creation datetime query string false 2022-07-10T00:00:00Z,
page Pagination information query number false ?page[number]=1
source Filter credits by how they were created query string false
status Filter credits by their status query string false
updated_datetime Filter credits by the datetime they were most recently modified query string false ,2022-07-10T00:00:00Z

Responses

Status Description Schema
200 A list of credits Credits

CustomField

Create a custom field

POST /public/v1/custom-fields can create a custom field of type dropdown

POST /public/v1/custom-fields
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiYThkN2YxODYtYTdhMi00NmVkLTlmMGEtYzE0Zjc5N2JlNDYyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzU2NSIsInR5cCI6ImFjY2VzcyJ9.KVpEYM28f6JqmpfLGsG1TVtWo7x-MuyjbFbv8Z-aweY

{
  "field_options": [
    "A",
    "B"
  ],
  "field_type": "dropdown",
  "filterable": true,
  "name": "Dropdown Field",
  "parent_object": "product"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 5e6681ce17085e8da94fa699722c9d0e-e6e826379986d3b8-0

{
  "data": {
    "description": null,
    "disabled_field_options": [],
    "field_options": [
      "A",
      "B"
    ],
    "field_type": "dropdown",
    "filterable": true,
    "id": 171,
    "name": "Dropdown Field",
    "parent_object": "product",
    "required": false
  }
}

Create a custom field for the specified parent object. Updates are not supported for this endpoint.

Required permission: settings_permissions_custom_fields.

Request

POST /public/v1/custom-fields

Parameters

Parameter Description In Type Required Default Example
description Description of the custom field query string false
field_options Field options query array false
field_type Field type query string true
filterable Whether the field is filterable query boolean false
name Name of the custom field query string true
parent_object Parent object attached to the field query string true
required Whether a value for the field is required when saving a record query boolean false

Responses

Status Description Schema
201 Custom field created CustomFieldDefinitionResponse
400 Invalid parameters

Get a custom field definition

GET /public/v1/custom-fields/:id returns a single custom field

GET /public/v1/custom-fields/187
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYjNlODlkMzUtMDc2MC00ZDQyLWI4ODEtYzcwMDIyNTMxOGUxIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Nzk5OCIsInR5cCI6ImFjY2VzcyJ9.kyHRrDQI5rfQ251NMuN59DitJ4jnnejWnxyPQW1ABkk

Response

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

{
  "data": {
    "description": "A test field",
    "disabled_field_options": [
      "B"
    ],
    "field_options": [
      "A",
      "B",
      "C"
    ],
    "field_type": "dropdown",
    "filterable": true,
    "id": 187,
    "name": "Test Field",
    "parent_object": "product",
    "required": false
  }
}

Get a single custom field definition given the ID.

Required permission: settings_permissions_custom_fields.

Request

GET /public/v1/custom-fields/{id}

Parameters

Parameter Description In Type Required Default Example
id Custom field ID path integer true

Responses

Status Description Schema
200 A single custom field definition CustomFieldDefinitionResponse
404 Not Found

List custom field definitions

GET /public/v1/custom-fields returns custom fields for the company

GET /public/v1/custom-fields
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiY2NkMWE3ZDUtNzYyZi00MWUwLWI4MWMtZmYwZTI2Mzc2NTcwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzQ2NSIsInR5cCI6ImFjY2VzcyJ9.jm57f0_XvxglrCSdQTVCrXieq6yoiZdFC7witgpH5J8

Response

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

{
  "data": [
    {
      "description": null,
      "disabled_field_options": [],
      "field_options": [],
      "field_type": "text",
      "filterable": false,
      "id": 165,
      "name": "Field 1",
      "parent_object": "product",
      "required": false
    },
    {
      "description": null,
      "disabled_field_options": [
        "A"
      ],
      "field_options": [
        "A",
        "B"
      ],
      "field_type": "dropdown",
      "filterable": true,
      "id": 166,
      "name": "Field 2",
      "parent_object": "product",
      "required": false
    }
  ]
}

List all custom field definitions for the authenticated company. Optionally filter by parent_object to get fields for a specific entity type.

Required permission: settings_permissions_custom_fields.

Request

GET /public/v1/custom-fields

Parameters

Parameter Description In Type Required Default Example
parent_object Filter by parent object type (e.g., order, invoice, product) query string false

Responses

Status Description Schema
200 List of custom field definitions CustomFieldDefinitions

Update a custom field

POST /public/v1/custom-fields/:id can update a custom field name

POST /public/v1/custom-fields/177
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMWJiNzMyZWYtODUyYS00YTQxLTgyODYtMjMxZDc1MThiNTM0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzY4NCIsInR5cCI6ImFjY2VzcyJ9.EFrNYoY0i4SXzc4fTkehBCx0TGArnJKq-ojhQ6cdkng

{
  "name": "Updated Name"
}

Response

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

{
  "data": {
    "description": null,
    "disabled_field_options": [
      "Medium"
    ],
    "field_options": [
      "Large",
      "Medium",
      "Small"
    ],
    "field_type": "dropdown",
    "filterable": false,
    "id": 177,
    "name": "Updated Name",
    "parent_object": "product",
    "required": false
  }
}

Update an existing custom field. Only name, description, required, and field_options can be updated. Field type and parent object cannot be changed after creation.

Required permission: settings_permissions_custom_fields.

Request

POST /public/v1/custom-fields/{id}

Parameters

Parameter Description In Type Required Default Example
description Description of the custom field body string false
field_options Field options (replaces existing options) body array false
id Custom field ID path integer true
name Name of the custom field body string false
required Whether a value for the field is required when saving a record body boolean false

Responses

Status Description Schema
200 Custom field updated CustomFieldDefinitionResponse
400 Invalid parameters
404 Not Found

Driver

Delete a driver

DELETE /public/v1/drivers/:id soft-deletes a driver

DELETE /public/v1/drivers/00000000-0000-0000-0000-000000000027
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYTVkMmU0OTktYTg0My00N2ExLWE0ZTktZjljNmJmMWQyZTNkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzAwMCIsInR5cCI6ImFjY2VzcyJ9.JI4pQBcLZFecURHLElrGmpyyfEplmG2Ojq-jJaeo5QU

Response

204
cache-control: max-age=0, private, must-revalidate
b3: 44f3a4828aaeae3b5ce66c7173583cfc-5b1ea7b0f151db4e-0

Deletes the driver. This is a soft delete: the record's deleted_at is set and it is no longer returned by the API, but it is retained in the database.

Required permission: settings_permissions_drivers.

Request

DELETE /public/v1/drivers/{id}

Parameters

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

Responses

Status Description Schema
204 No Content
404 Not Found

Get a driver

GET /public/v1/drivers/:id returns a single driver

GET /public/v1/drivers/00000000-0000-0000-0000-000000000026
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNTAwYmI1M2EtZTdhNy00NjFjLWI2ZjYtZjYwMTI3YzMxYTcyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjkyNCIsInR5cCI6ImFjY2VzcyJ9.iE8s0qKmmZP5PYI5Mo4xT0UpAd6ixVCuNC5hiY2NBpo

Response

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

{
  "data": {
    "birth_date": "1990-01-01",
    "driver_license": "D1234567",
    "email": "test@example.com",
    "first_name": "Sam",
    "hire_date": "2020-01-01",
    "id": "00000000-0000-0000-0000-000000000026",
    "inserted_datetime": "2026-08-17T21:24:25.576373Z",
    "last_name": "Rivera",
    "occupational_license_number": null,
    "phone_number": null,
    "updated_datetime": "2026-08-17T21:24:25.576373Z",
    "us_state": "CA"
  }
}

Get a single driver given the ID.

Required permission: settings_permissions_drivers.

Request

GET /public/v1/drivers/{id}

Parameters

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

Responses

Status Description Schema
200 A single driver DriverResponse
404 Not Found

Get drivers

GET /public/v1/drivers returns paginated drivers for the company with next_page

GET /public/v1/drivers
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZTUxYWMxMjktYTAwYy00OWY2LTg2OWMtZmYxMDExYjRhY2NiIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjgzMSIsInR5cCI6ImFjY2VzcyJ9.jVejCuGxIGXhT9tU1-9vk10hl8x-hzgEbPRbA2a4S1o

Response

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

{
  "data": [
    {
      "birth_date": "1990-01-01",
      "driver_license": "D1234567",
      "email": "d1@example.com",
      "first_name": "Test",
      "hire_date": "2020-01-01",
      "id": "00000000-0000-0000-0000-00000000001f",
      "inserted_datetime": "2025-01-01T00:00:00.000000Z",
      "last_name": "Driver",
      "occupational_license_number": null,
      "phone_number": null,
      "updated_datetime": "2026-08-17T21:24:25.028618Z",
      "us_state": "CA"
    },
    {
      "birth_date": "1990-01-01",
      "driver_license": "D1234567",
      "email": "d2@example.com",
      "first_name": "Test",
      "hire_date": "2020-01-01",
      "id": "00000000-0000-0000-0000-000000000020",
      "inserted_datetime": "2025-01-02T00:00:00.000000Z",
      "last_name": "Driver",
      "occupational_license_number": null,
      "phone_number": null,
      "updated_datetime": "2026-08-17T21:24:25.038162Z",
      "us_state": "CA"
    },
    {
      "birth_date": "1990-01-01",
      "driver_license": "D1234567",
      "email": "d3@example.com",
      "first_name": "Test",
      "hire_date": "2020-01-01",
      "id": "00000000-0000-0000-0000-000000000021",
      "inserted_datetime": "2025-01-03T00:00:00.000000Z",
      "last_name": "Driver",
      "occupational_license_number": null,
      "phone_number": null,
      "updated_datetime": "2026-08-17T21:24:25.046501Z",
      "us_state": "CA"
    }
  ],
  "next_page": "https://www.example.com/public/v1/drivers?page[number]=2"
}

List drivers for the authenticated company.

Required permission: settings_permissions_drivers.

Request

GET /public/v1/drivers

Parameters

Parameter Description In Type Required Default Example
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of drivers Drivers

Upsert a driver

POST /public/v1/drivers creates a driver for a METRC company

POST /public/v1/drivers
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODY5Yjk4MWMtOGExOC00MmEwLTk5NjctZjZlYWQzODFhNmU0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzA4NiIsInR5cCI6ImFjY2VzcyJ9.vOB2bIMyeuaBR2a5IDrf7LKzGHh793GeM9N6WNMpdEc

{
  "driver_license": "D1234567",
  "first_name": "Sam",
  "last_name": "Rivera",
  "occupational_license_number": "OCC-889",
  "phone_number": "555-0100"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 72e38dadc9c219f87cede14182144f2e-a3916d74b0f765ba-0

{
  "data": {
    "birth_date": null,
    "driver_license": "D1234567",
    "email": null,
    "first_name": "Sam",
    "hire_date": null,
    "id": "00000000-0000-0000-0000-000000000029",
    "inserted_datetime": "2026-08-17T21:24:26.234022Z",
    "last_name": "Rivera",
    "occupational_license_number": "OCC-889",
    "phone_number": "555-0100",
    "updated_datetime": "2026-08-17T21:24:26.234022Z",
    "us_state": null
  }
}

Upsert a single driver. To update an existing driver, pass its ID in the id field. If you do not pass an ID, a new driver is created.

Driver management is only available for companies with a METRC or BIOTRACK compliance type. Requests from companies with any other compliance type are rejected.

Required fields depend on the company's compliance type and apply only when CREATING a driver. On update (when an id is given) all fields are optional and only the fields you send are changed; omitted fields keep their stored value. - METRC: first_name, last_name, phone_number, driver_license, occupational_license_number. - BIOTRACK: first_name, last_name, birth_date, email, driver_license, us_state, hire_date.

Required permission: settings_permissions_drivers.

Request

POST /public/v1/drivers

Parameters

Parameter Description In Type Required Default Example
birth_date The driver's birth date, ISO-8601 (required when creating a driver for BIOTRACK companies) query string false
driver_license The driver's license number (required when creating a driver) query string false
email The driver's email (required when creating a driver for BIOTRACK companies) query string false
first_name The driver's first name (required when creating a driver) query string false
hire_date The driver's hire date, ISO-8601 (required when creating a driver for BIOTRACK companies) query string false
id Driver ID. If given, the matching driver is updated; otherwise a new one is created. query string false
last_name The driver's last name (required when creating a driver) query string false
occupational_license_number The driver's occupational license number (required when creating a driver for METRC companies) query string false
phone_number The driver's phone number (required when creating a driver for METRC companies) query string false
us_state The driver's US state (required when creating a driver for BIOTRACK companies) query string false

Responses

Status Description Schema
200 The updated driver DriverResponse
201 The created driver DriverResponse
400 Invalid parameters
404 Not Found

FileAttachment

Insert a file attachment

POST /public/v1/file-attachments uploads and creates a file attachment successfully with simplified reference

POST /public/v1/file-attachments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiZWY4OTQ0ZDAtMWE2OC00NmE1LWE0NmUtZTZiMzRhMDU1NDJjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzM5MiIsInR5cCI6ImFjY2VzcyJ9.k8L4VgBZwlACT-GEgbkwsLLjQZocYbVJP6Mua0_V8Qo

{
  "file": {
    "filename": "test-image.png",
    "content_type": "image/png"
  },
  "name": "My Test Image",
  "product_id": "3afe71e0-d28f-4012-8213-d8d282ae4b1f"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 297bf5523db54c51285773408568fdde-e49a5eae50d92d34-0

{
  "data": {
    "assembly_id": null,
    "batch_id": null,
    "company_relationship_id": null,
    "contact_id": null,
    "id": "00000000-0000-0000-0000-000000000037",
    "invoice_id": null,
    "license_id": null,
    "mime_type": "image/png",
    "name": "My Test Image",
    "order_id": null,
    "order_shipment_id": null,
    "product_id": "3afe71e0-d28f-4012-8213-d8d282ae4b1f",
    "purchase_id": null,
    "request_id": null,
    "return_id": null,
    "size_in_bytes": 355974,
    "stock_transfer_id": null,
    "task_id": null,
    "upload_datetime": "2026-08-17T21:24:27.234405Z",
    "uploader": {
      "id": "00000000-0000-0000-0000-000000001ce0",
      "name": "FirstName1148 LastName1149"
    },
    "url": "/var/folders/2z/jg98hkm57rx18c_x3bnqbr8c0000gn/T/c9a6a0da-5821-40f5-a41d-2351ae2be9bb/test-image.png"
  }
}

Insert a new file attachment. The file will be uploaded to S3 and associated with the specified entity. Exactly one reference ID must be provided (product_id, order_id, purchase_id, etc.).

Required permission: products_permissions_edit.

Request

POST /public/v1/file-attachments

Parameters

Parameter Description In Type Required Default Example
assembly_id Assembly ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
batch_id Batch ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
company_relationship_id Company relationship ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
contact_id Contact ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
file The file to upload formData file true
invoice_id Invoice ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
license_id License ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
name Display name for the attachment (defaults to filename if not provided) formData string false
order_id Order ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
order_shipment_id Order shipment ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
product_id Product ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
purchase_id Purchase ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
request_id Request ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
return_id Return ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
stock_transfer_id Stock transfer ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000
task_id Task ID to attach file to formData string false 550e8400-e29b-41d4-a716-446655440000

Responses

Status Description Schema
201 File attachment inserted successfully FileAttachmentResponse
400 Invalid parameters
422 Storage quota exceeded or other validation error

Inventory

Get inventory levels

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

GET /public/v1/inventory?grouping[]=PRODUCT&product_ids[]=6d177a6d-f947-4b33-8358-309e66f97d8c
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMmZiN2NmNTUtZGNiOC00ZmQ1LTgyNDAtZDYzYTBlNjljMTA2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzIxNSIsInR5cCI6ImFjY2VzcyJ9.qIh44i23RwNaF4p38ZaTbn_wie_MoJ-8KdgMaSOWXlg

Response

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

{
  "data": [
    {
      "active": "10.000000000",
      "available": "10.000000000",
      "cost_default_per_unit": null,
      "cost_per_unit_actual": null,
      "product_id": "6d177a6d-f947-4b33-8358-309e66f97d8c",
      "reserved": "0.000000000",
      "total_cost_actual": null,
      "total_cost_default": null,
      "updated_datetime": "2026-08-17T21:24:26.749556Z"
    }
  ],
  "next_page": null
}

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.

Required permission: products_permissions_view.

Request

GET /public/v1/inventory

Parameters

Parameter Description In Type Required Default Example
batch_ids Filter inventory levels by batch IDs query array false ["00000000-0000-0000-0000-000000000101","00000000-0000-0000-0000-000000000102"]
grouping Attributes to group inventory by. PRODUCT is required to be in the list. Accepted values are "BATCH_NUMBER", "LOCATION" and "PRODUCT". query array true ["PRODUCT","LOCATION"]
location_ids Filter inventory levels by location IDs query array false ["00000000-0000-0000-0000-000000000001","00000000-0000-0000-0000-000000000002"]
page Pagination information query number false ?page[number]=1
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 an invoice

GET /invoices/:id renders charges and payments

GET /public/v1/invoices/00000000-0000-0000-0000-0000000000d3
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGU2ZTk2NTAtODdhYi00YjNhLWI5MDctMTcyZDIyYjg2Mzg3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODA1OSIsInR5cCI6ImFjY2VzcyJ9.XYUyHdnuwvBYmzLwsJ326duGlCLcmjVZXOF2zCi332c

Response

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

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "company_id": "00000000-0000-0000-0000-000000001884",
      "id": "00000000-0000-0000-0000-00000000087f",
      "license_id": "00000000-0000-0000-0000-00000000022d",
      "license_number": "CDPH-00000049",
      "name": "Place 325"
    },
    "charges": [
      {
        "id": "600c32a2-564d-40fd-82e7-3ff078e27850",
        "name": "C1",
        "percent": "10.0000",
        "price": "1.00",
        "tax": {
          "id": "00000000-0000-0000-0000-00000000002b",
          "name": "T1"
        },
        "type": "CHARGE",
        "unit_type": "PERCENT"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-000000000f07",
      "name": "Company 931",
      "updated_datetime": "2026-08-17T21:24:28.730720Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1231@example.com",
      "full_name": "FirstName2514 LastName2515",
      "id": "00000000-0000-0000-0000-000000001f82",
      "role": {
        "id": "00000000-0000-0000-0000-000000002031",
        "name": "Admin 1277"
      }
    },
    "custom_data": [],
    "due_datetime": "2026-08-17T21:24:28.880712Z",
    "external_notes": null,
    "id": "00000000-0000-0000-0000-0000000000d3",
    "inserted_datetime": "2026-08-17T21:24:28.881806Z",
    "internal_notes": null,
    "invoice_datetime": "2026-08-17T21:24:28.880710Z",
    "invoice_number": "Invoice #31",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000000008e6",
          "name": "B557"
        },
        "cost_per_unit": null,
        "cost_per_unit_default": null,
        "description": null,
        "id": "00000000-0000-0000-0000-0000000000aa",
        "order_item_id": "cd107609-1c6a-49e5-a1b8-280513bf57df",
        "package": null,
        "price": "10.000000000",
        "product": {
          "id": "8c33c73d-8e90-4ec5-8d06-45d131c97cd2",
          "name": "Product 553",
          "sku": "sku 554",
          "updated_datetime": "2026-08-17T21:24:28.748453Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-0000000008e8",
          "name": "B567"
        },
        "cost_per_unit": null,
        "cost_per_unit_default": null,
        "description": null,
        "id": "00000000-0000-0000-0000-0000000000ab",
        "order_item_id": "644cb854-2c9f-48b4-8086-d29a6aab543f",
        "package": null,
        "price": "10.000000000",
        "product": {
          "id": "c628f0ca-4a11-4328-8a0a-89e25c471733",
          "name": "Product 565",
          "sku": "sku 566",
          "updated_datetime": "2026-08-17T21:24:28.772001Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "order": {
      "id": "dbb11c8a-16cc-456f-b472-7e21cf4c35fd",
      "order_number": "SO-56",
      "status": "PENDING",
      "total": "320.00"
    },
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1231@example.com",
      "full_name": "FirstName2514 LastName2515",
      "id": "00000000-0000-0000-0000-000000001f82",
      "role": {
        "id": "00000000-0000-0000-0000-000000002031",
        "name": "Admin 1277"
      }
    },
    "paid_amount": "5.00",
    "payment_term_name": null,
    "payments": [
      {
        "amount": "5",
        "company": {
          "id": "00000000-0000-0000-0000-000000000f07",
          "name": "Company 931",
          "updated_datetime": "2026-08-17T21:24:28.730720Z"
        },
        "credit_uses": [],
        "description": null,
        "fully_paid_with_credits": false,
        "id": "00000000-0000-0000-0000-00000000005a",
        "inserted_datetime": "2026-08-17T21:24:28.951047Z",
        "invoice": {
          "id": "00000000-0000-0000-0000-0000000000d3",
          "invoice_number": "Invoice #31",
          "status": "PARTIALLY_PAID",
          "total": "200.00"
        },
        "overpayment_credits": [],
        "payment_date": "2026-08-17T21:24:28.921893Z",
        "payment_method": {
          "active": true,
          "deleted_at": null,
          "id": "00000000-0000-0000-0000-00000000007a",
          "inserted_datetime": "2026-08-17T21:24:28.919508Z",
          "name": "Payment Method 31",
          "qb_payment_method_id": null,
          "type": "CREDIT_CARD",
          "updated_datetime": "2026-08-17T21:24:28.919508Z"
        },
        "payment_number": "PYT-0000001",
        "payment_type": "INVOICE",
        "purchase": null,
        "quickbooks_deposit_account_id": null,
        "status": "POSTED",
        "updated_datetime": "2026-08-17T21:24:28.951047Z"
      }
    ],
    "remaining_amount": null,
    "status": "PARTIALLY_PAID",
    "total": "200.00",
    "updated_datetime": "2026-08-17T21:24:28.956898Z",
    "voided_datetime": null
  }
}

Get a single invoice given the ID. Required permission: invoices_permissions_view. The authenticated user must also have access to the requested invoice under their team restrictions.

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 InvoiceResponse

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTRhZDhiNDctNzdjOS00NWRiLWEyNmYtN2RlZjFmZjZjNTBmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzUyNiIsInR5cCI6ImFjY2VzcyJ9.atLl_-glhpVfOEW9n_vtEossQfxb03zstaqy90LTgTg

Response

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

{
  "data": [
    {
      "billing_location": {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-00000000176b",
        "id": "00000000-0000-0000-0000-00000000082d",
        "license_id": "00000000-0000-0000-0000-00000000021a",
        "license_number": "CDPH-00000029",
        "name": "Place 243"
      },
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-000000000e6b",
        "name": "Company 651",
        "updated_datetime": "2026-08-17T21:24:27.920372Z"
      },
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-866@example.com",
        "full_name": "FirstName1776 LastName1777",
        "id": "00000000-0000-0000-0000-000000001e11",
        "role": {
          "id": "00000000-0000-0000-0000-000000001eb8",
          "name": "Admin 899"
        }
      },
      "custom_data": [
        {
          "id": 172,
          "name": "Custom Field 14",
          "value": null
        }
      ],
      "due_datetime": "2026-08-17T21:24:28.049093Z",
      "external_notes": null,
      "id": "00000000-0000-0000-0000-0000000000cd",
      "inserted_datetime": "2026-08-17T21:24:28.049980Z",
      "internal_notes": null,
      "invoice_datetime": "2026-08-17T21:24:28.049092Z",
      "invoice_number": "Invoice #25",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-00000000089c",
            "name": "B302"
          },
          "cost_per_unit": null,
          "cost_per_unit_default": null,
          "description": null,
          "id": "00000000-0000-0000-0000-0000000000a8",
          "order_item_id": "4be0cb12-24c9-4125-a8f2-5fe1aa99cf5a",
          "package": null,
          "price": "10.000000000",
          "product": {
            "id": "24d42dc8-f2a4-4e8f-9073-6a3db1c84513",
            "name": "Product 300",
            "sku": "sku 301",
            "updated_datetime": "2026-08-17T21:24:27.942724Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-00000000089f",
            "name": "B317"
          },
          "cost_per_unit": null,
          "cost_per_unit_default": null,
          "description": null,
          "id": "00000000-0000-0000-0000-0000000000a9",
          "order_item_id": "1141f1ea-f374-4a91-a6fc-2b3ae85c042f",
          "package": null,
          "price": "10.000000000",
          "product": {
            "id": "a3b7fc87-8c9a-4ec5-8385-bc5ecb92bc90",
            "name": "Product 315",
            "sku": "sku 316",
            "updated_datetime": "2026-08-17T21:24:27.964130Z"
          },
          "quantity": "10.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "order": {
        "id": "2400230f-13f1-4d7f-b2e5-ab783fee71ac",
        "order_number": "SO-50",
        "status": "PENDING",
        "total": "320.00"
      },
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-866@example.com",
        "full_name": "FirstName1776 LastName1777",
        "id": "00000000-0000-0000-0000-000000001e11",
        "role": {
          "id": "00000000-0000-0000-0000-000000001eb8",
          "name": "Admin 899"
        }
      },
      "paid_amount": "0.0",
      "payment_term_name": null,
      "payments": [],
      "remaining_amount": "200.00",
      "status": "NOT_PAID",
      "total": "200.00",
      "updated_datetime": "2026-08-17T21:24:28.049980Z",
      "voided_datetime": null
    },
    {
      "billing_location": {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-000000001703",
        "id": "00000000-0000-0000-0000-0000000007ff",
        "license_id": "00000000-0000-0000-0000-000000000210",
        "license_number": "CDPH-00000019",
        "name": "Place 197"
      },
      "charges": [
        {
          "id": "87939f81-7fb4-48b3-a6f9-7d0df323ff56",
          "name": "C1",
          "percent": "10.0000",
          "price": "1.00",
          "tax": {
            "id": "00000000-0000-0000-0000-000000000028",
            "name": "T1"
          },
          "type": "CHARGE",
          "unit_type": "PERCENT"
        }
      ],
      "company": {
        "id": "00000000-0000-0000-0000-000000000e31",
        "name": "Company 547",
        "updated_datetime": "2026-08-17T21:24:27.558959Z"
      },
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "user1@a.com",
        "full_name": "John Foo",
        "id": "00000000-0000-0000-0000-000000001d61",
        "role": {
          "id": "00000000-0000-0000-0000-000000001e05",
          "name": "Admin 720"
        }
      },
      "custom_data": [
        {
          "id": 172,
          "name": "Custom Field 14",
          "value": "Custom Field Value 1"
        }
      ],
      "due_datetime": "2020-01-01T00:00:01.000000Z",
      "external_notes": "Visible to the customer",
      "id": "00000000-0000-0000-0000-0000000000c9",
      "inserted_datetime": "2026-08-17T21:24:27.599500Z",
      "internal_notes": "Only visible internally",
      "invoice_datetime": "2020-01-01T00:00:02.000000Z",
      "invoice_number": "INV-123",
      "items": [
        {
          "batch": {
            "batch_number": "UID1",
            "id": "00000000-0000-0000-0000-00000000088b",
            "name": "B1"
          },
          "cost_per_unit": null,
          "cost_per_unit_default": null,
          "description": "Line description",
          "id": "00000000-0000-0000-0000-0000000000a7",
          "order_item_id": "9c256033-9d41-46ef-9de8-998a6a980ed7",
          "package": {
            "batch_number": "B1",
            "compliance_label": "ABCDEF012345670000000013",
            "id": "00000000-0000-0000-0000-0000000000df",
            "metrc_label": "ABCDEF012345670000000013",
            "status": "active"
          },
          "price": "10.000000000",
          "product": {
            "id": "35a4bcc2-ffec-4b41-981b-3399a99f21cb",
            "name": "P1",
            "sku": "SKU1",
            "updated_datetime": "2026-08-17T21:24:27.493593Z"
          },
          "quantity": "1.000000000",
          "returned_quantity": "0",
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "order": {
        "id": "06f3304c-3c99-4641-bbba-6f5674971e8b",
        "order_number": "SO-123",
        "status": "COMPLETED",
        "total": "10.00"
      },
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "user2@a.com",
        "full_name": "John Bar",
        "id": "00000000-0000-0000-0000-000000001d64",
        "role": {
          "id": "00000000-0000-0000-0000-000000001e08",
          "name": "Admin 724"
        }
      },
      "paid_amount": "5.00",
      "payment_term_name": "Net 30",
      "payments": [
        {
          "amount": "5",
          "company": {
            "id": "00000000-0000-0000-0000-000000000e31",
            "name": "Company 547",
            "updated_datetime": "2026-08-17T21:24:27.558959Z"
          },
          "credit_uses": [],
          "description": null,
          "fully_paid_with_credits": false,
          "id": "00000000-0000-0000-0000-000000000058",
          "inserted_datetime": "2026-08-17T21:24:27.663897Z",
          "invoice": {
            "id": "00000000-0000-0000-0000-0000000000c9",
            "invoice_number": "INV-123",
            "status": "PARTIALLY_PAID",
            "total": "8.00"
          },
          "overpayment_credits": [],
          "payment_date": "2026-08-17T21:24:27.627917Z",
          "payment_method": {
            "active": true,
            "deleted_at": null,
            "id": "00000000-0000-0000-0000-000000000077",
            "inserted_datetime": "2026-08-17T21:24:27.626779Z",
            "name": "Payment Method 28",
            "qb_payment_method_id": null,
            "type": "CREDIT_CARD",
            "updated_datetime": "2026-08-17T21:24:27.626779Z"
          },
          "payment_number": "PYT-0000001",
          "payment_type": "INVOICE",
          "purchase": null,
          "quickbooks_deposit_account_id": null,
          "status": "POSTED",
          "updated_datetime": "2026-08-17T21:24:27.663897Z"
        }
      ],
      "remaining_amount": "3.00",
      "status": "PARTIALLY_PAID",
      "total": "8.00",
      "updated_datetime": "2026-08-17T21:24:27.684988Z",
      "voided_datetime": null
    }
  ],
  "next_page": null
}

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.

Required permission: invoices_permissions_view. Results are filtered to only include invoices the authenticated user can access under their team restrictions.

Request

GET /public/v1/invoices

Parameters

Parameter Description In Type Required Default 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 query number false ?page[number]=1
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-0000000000fa/payments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NzMsImlhdCI6MTc4NzAwMTg3MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiYWYzZjY1OTItMTI3Yy00NzdmLTlkOWYtNDczYzA2Njc4OTMzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODcyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6OTU1NSIsInR5cCI6ImFjY2VzcyJ9.CGCTL8PyIUsUGotOQ988p3-RSVuuW9gpjocdUlS5hEU

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

Response

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

{
  "data": {
    "amount": "100",
    "company": {
      "id": "00000000-0000-0000-0000-0000000011f9",
      "name": "Company 1996",
      "updated_datetime": "2026-08-17T21:24:33.511136Z"
    },
    "credit_uses": [],
    "description": "Payment for invoice",
    "fully_paid_with_credits": false,
    "id": "00000000-0000-0000-0000-000000000061",
    "inserted_datetime": "2026-08-17T21:24:33.560204Z",
    "invoice": {
      "id": "00000000-0000-0000-0000-0000000000fa",
      "invoice_number": "Invoice #64",
      "status": "OVER_PAID",
      "total": "100.00"
    },
    "overpayment_credits": [
      {
        "amount": "0.01",
        "credit_number": "CRT-0000001",
        "id": "28fbcb6c-93db-442c-bf29-0a3a0802fe4c",
        "source": "INVOICE_PAYMENT"
      }
    ],
    "payment_date": "2020-01-01T00:00:00.000000Z",
    "payment_method": {
      "active": true,
      "deleted_at": null,
      "id": "00000000-0000-0000-0000-000000000082",
      "inserted_datetime": "2026-08-17T21:24:33.520693Z",
      "name": "Payment Method 0",
      "qb_payment_method_id": null,
      "type": "CREDIT_CARD",
      "updated_datetime": "2026-08-17T21:24:33.520693Z"
    },
    "payment_number": "PYT-0000001",
    "payment_type": "INVOICE",
    "purchase": null,
    "quickbooks_deposit_account_id": "QBD-123",
    "quickbooks_deposit_account_name": "QBD-NAME",
    "quickbooks_sync_enqueued": true,
    "status": "POSTED",
    "updated_datetime": "2026-08-17T21:24:33.560204Z"
  }
}

Required permission: invoices_permissions_receive_payment. The authenticated user must also be allowed to view invoices under their team restrictions.

Request

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

Parameters

Parameter Description In Type Required Default Example
amount Amount of the payment. Will round to 2 decimal places query decimal true
description Description of the payment query string true
payment_datetime Payment date query string true
payment_method_id Payment method ID 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 PaymentResponse

Upsert an invoice

POST /invoices creates an invoice

POST /public/v1/invoices
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NzUsImlhdCI6MTc4NzAwMTg3NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTZmOTEyNTctNjI5MS00MjlmLThjNTItNmRiMDI1NjM3NWVmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODc0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6OTkyMSIsInR5cCI6ImFjY2VzcyJ9.nHX-p8VmZ-1rDQRttDTDGxNqw0_K_LJpPLqbhzEzHjI

{
  "billing_location_id": "00000000-0000-0000-0000-000000000a1e",
  "charges": [
    {
      "name": "C1",
      "percent": "10.0000",
      "type": "CHARGE",
      "unit_type": "PERCENT"
    },
    {
      "name": "C2",
      "price": "-5.0000",
      "type": "DISCOUNT",
      "unit_type": "PRICE"
    }
  ],
  "custom_data": {
    "230": [
      "A",
      "B"
    ]
  },
  "due_datetime": "2020-01-30T00:00:01.000000Z",
  "external_notes": "Visible to the customer",
  "internal_notes": "Only visible internally",
  "invoice_datetime": "2020-01-01T00:00:00.000000Z",
  "items": [
    {
      "order_item_id": "062566d8-291b-4fef-bc16-94261f6ac646",
      "quantity": "1.000000000"
    },
    {
      "order_item_id": "55273cdd-1064-4f70-a9d2-1baaa9e7e804",
      "quantity": "10.000000000"
    }
  ],
  "order_id": "48edd2ef-06ea-4607-a90c-e24090975e4e",
  "owner_id": "00000000-0000-0000-0000-0000000026c1"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 252f84dd5c66ad999717a569de74a7ca-564076282a37e513-0

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "company_id": "00000000-0000-0000-0000-000000001dea",
      "id": "00000000-0000-0000-0000-000000000a1e",
      "license_id": null,
      "license_number": null,
      "name": "Place 740"
    },
    "charges": [
      {
        "id": "be0c7e04-c262-425f-9826-b1a85a529c89",
        "name": "C1",
        "percent": "10.0000",
        "price": "5.30",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "832c4232-7e84-487a-8300-41e3c355f941",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-000000001304",
      "name": "Company 2311",
      "updated_datetime": "2026-08-17T21:24:35.819705Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-0000000026c1",
      "role": {
        "id": "00000000-0000-0000-0000-00000000278a",
        "name": "Admin 3158"
      }
    },
    "custom_data": [
      {
        "id": 230,
        "name": "Custom Field 50",
        "value": "A,B"
      }
    ],
    "due_datetime": "2020-01-30T00:00:01.000000Z",
    "external_notes": "Visible to the customer",
    "id": "00000000-0000-0000-0000-00000000010f",
    "inserted_datetime": "2026-08-17T21:24:35.858615Z",
    "internal_notes": "Only visible internally",
    "invoice_datetime": "2020-01-01T00:00:00.000000Z",
    "invoice_number": "INV-0000001",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000be5",
          "name": "B1"
        },
        "cost_per_unit": null,
        "cost_per_unit_default": null,
        "description": null,
        "id": "00000000-0000-0000-0000-0000000000fa",
        "order_item_id": "062566d8-291b-4fef-bc16-94261f6ac646",
        "package": null,
        "price": "3.000000000",
        "product": {
          "id": "0a2c059d-7484-489f-b247-6a159713fa71",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2026-08-17T21:24:35.829413Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000be6",
          "name": "B2"
        },
        "cost_per_unit": null,
        "cost_per_unit_default": null,
        "description": null,
        "id": "00000000-0000-0000-0000-0000000000fb",
        "order_item_id": "55273cdd-1064-4f70-a9d2-1baaa9e7e804",
        "package": null,
        "price": "5.000000000",
        "product": {
          "id": "31444ba0-7280-4084-8e75-d59dea080d45",
          "name": "P2",
          "sku": "SKU2",
          "updated_datetime": "2026-08-17T21:24:35.836140Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "order": {
      "id": "48edd2ef-06ea-4607-a90c-e24090975e4e",
      "order_number": "SO-157",
      "status": "PROCESSING",
      "total": "0.00"
    },
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-0000000026c1",
      "role": {
        "id": "00000000-0000-0000-0000-00000000278a",
        "name": "Admin 3158"
      }
    },
    "paid_amount": "0.0",
    "payment_term_name": null,
    "payments": [],
    "remaining_amount": "53.30",
    "status": "NOT_PAID",
    "total": "53.30",
    "updated_datetime": "2026-08-17T21:24:35.862488Z",
    "voided_datetime": null
  }
}

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. Required permission: invoices_permissions_create to create a new invoice, invoices_permissions_edit (and access to the invoice under team restrictions) to update an existing invoice.

Request

POST /public/v1/invoices

Parameters

Parameter Description In Type Required Default Example
billing_location_id The billing location's ID query string false
charges The additional lines of Charge, Discount, or Tax added to this invoice body InvoiceChargesRequest false
custom_data A map of custom field IDs to their values. Use GET /public/v1/custom-fields?model_name=invoice to retrieve available custom fields and their IDs. body object false {"123":"Custom Value 1","456":"Custom Value 2"}
due_datetime The datetime at which the invoice is due query string false
external_notes Notes on this invoice that are visible to the customer 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
internal_notes Notes on this invoice that are only visible internally query string false
invoice_datetime The datetime on which the invoice was placed query string false
items The invoice items present on this order body InvoiceItemsRequest false
owner_id The ID of the Distru user that owns this invoice query string false

Responses

Status Description Schema
200 A single invoice InvoiceResponse

Location

Get a location

GET /public/v1/locations/:id returns the expected location

GET /public/v1/locations/00000000-0000-0000-0000-000000000804
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiZDgxZDQ1YzktZTY3ZC00ZmI3LTllYTMtZDQ4ODY3YzE4ZDZkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzU5OSIsInR5cCI6ImFjY2VzcyJ9.KIqKCB-0pXhxkntYUA9EMG0wbk9YFN07bvr7qhlM0UY

Response

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

{
  "data": {
    "address": "123 Fake Street, Beverly Hills, CA 90210, US",
    "apt": null,
    "city": "Beverly Hills",
    "company_id": "00000000-0000-0000-0000-000000001712",
    "country": "US",
    "deleted_at": null,
    "id": "00000000-0000-0000-0000-000000000804",
    "inserted_datetime": "2026-08-17T21:24:27.620707Z",
    "latitude": 33.5,
    "license": {
      "active": true,
      "expiry_datetime": "2026-09-17T21:24:27.612060Z",
      "id": "00000000-0000-0000-0000-000000000211",
      "issue_datetime": "2026-08-17T21:24:27.612058Z",
      "license_number": "CDPH-00000020",
      "license_type": "Specialty Cottage Outdoor"
    },
    "license_id": "00000000-0000-0000-0000-000000000211",
    "longitude": -117.2,
    "metrc_id": 42,
    "name": "Place 202",
    "state": "CA",
    "street_address": "123 Fake Street",
    "updated_datetime": "2026-08-17T21:24:27.620707Z",
    "zip": "90210"
  }
}

Get a single location given the ID.

Required permission: companies_permissions_view.

Request

GET /public/v1/locations/{id}

Parameters

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

Responses

Status Description Schema
200 A single location LocationResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiN2UxMzdiOTMtNGM4OC00OTVkLTgxYzEtZjJkYTBhZGNlYmJmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzAxNiIsInR5cCI6ImFjY2VzcyJ9.juJmWJ7VaYHg5JqJ76PMnR8QUT5PUKylHPhN2pYfZKQ

Response

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

{
  "data": [
    {
      "address": "123 Fake Street, Suite 100, Beverly Hills, CA 90210, US",
      "apt": "Suite 100",
      "city": "Beverly Hills",
      "company_id": "00000000-0000-0000-0000-00000000157a",
      "country": "US",
      "deleted_at": null,
      "id": "00000000-0000-0000-0000-00000000076e",
      "inserted_datetime": "2026-08-17T21:24:25.887279Z",
      "latitude": 12.34,
      "license": null,
      "license_id": null,
      "longitude": -56.78,
      "metrc_id": null,
      "name": "Place 52",
      "state": "CA",
      "street_address": "123 Fake Street",
      "updated_datetime": "2026-08-17T21:24:25.887279Z",
      "zip": "90210"
    },
    {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "apt": null,
      "city": "Beverly Hills",
      "company_id": "00000000-0000-0000-0000-00000000157a",
      "country": "US",
      "deleted_at": null,
      "id": "00000000-0000-0000-0000-000000000771",
      "inserted_datetime": "2026-08-17T21:24:25.906075Z",
      "latitude": 1.0,
      "license": {
        "active": true,
        "expiry_datetime": "2026-09-17T21:24:25.877313Z",
        "id": "00000000-0000-0000-0000-000000000204",
        "issue_datetime": "2026-08-17T21:24:25.877312Z",
        "license_number": "CDPH-00000005",
        "license_type": "Nursery"
      },
      "license_id": "00000000-0000-0000-0000-000000000204",
      "longitude": 2.0,
      "metrc_id": 999,
      "name": "Place 55",
      "state": "CA",
      "street_address": "123 Fake Street",
      "updated_datetime": "2026-08-17T21:24:25.906075Z",
      "zip": "90210"
    }
  ],
  "next_page": null
}

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.

Required permission: companies_permissions_view.

Request

GET /public/v1/locations

Parameters

Parameter Description In Type Required Default Example
deleted Filter deleted locations. no returns non-deleted, only returns deleted, include returns both. query string false no
inserted_datetime Filter locations by their creation datetime query string false 2022-07-10T00:00:00Z,
page Pagination information query number false ?page[number]=1
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

Get a menu

GET /public/v1/menus/:id returns the expected menu

GET /public/v1/menus/00000000-0000-0000-0000-000000000081
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNjM3ZTRiN2MtMjA3OC00NzY3LWFiZTMtYmI4ZGE1MzRkM2U1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njk5NyIsInR5cCI6ImFjY2VzcyJ9.n7GyU6ncP7nmaHVfWO46Q0YrEAsQXf8m4sFYGE_q4Zo

Response

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

{
  "data": {
    "active": true,
    "available_delivery_days": [
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY",
      "THURSDAY",
      "FRIDAY",
      "SATURDAY",
      "SUNDAY"
    ],
    "default_order_status": "PENDING",
    "discoverable": true,
    "external_name": "External Test Menu",
    "id": "00000000-0000-0000-0000-000000000081",
    "inserted_datetime": "2026-08-17T21:24:25.847675Z",
    "internal_name": "Test Menu",
    "minimum_order_lead_time_days": 0,
    "minimum_order_subtotal": "50.5",
    "product_count": 1,
    "updated_datetime": "2026-08-17T21:24:25.847675Z",
    "url": "https://distru.com/menu/company/test",
    "visibility": "PUBLIC"
  }
}

Get a single menu given the ID.

Required permission: products_permissions_view.

Request

GET /public/v1/menus/{id}

Parameters

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

Responses

Status Description Schema
200 A single menu MenuResponse
404 Not Found

Get menus

GET /public/v1/menus returns menus for the company with default pagination

GET /public/v1/menus
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZGQ0ZDgwYjgtM2M5OS00YzM2LTljNjQtMWMzOTFjZTFjYjZkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg3NSIsInR5cCI6ImFjY2VzcyJ9.UqpWhzLWrhnlYNz7F0cxeMRwNlwOimQPZ5NW3-ZYur8

Response

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

{
  "data": [
    {
      "active": true,
      "available_delivery_days": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY",
        "SUNDAY"
      ],
      "default_order_status": "PENDING",
      "discoverable": true,
      "external_name": "Ext A",
      "id": "00000000-0000-0000-0000-00000000007d",
      "inserted_datetime": "2026-08-17T21:24:25.576900Z",
      "internal_name": "Alpha",
      "minimum_order_lead_time_days": 0,
      "minimum_order_subtotal": null,
      "product_count": 0,
      "updated_datetime": "2026-08-17T21:24:25.576900Z",
      "url": null,
      "visibility": "PUBLIC"
    },
    {
      "active": true,
      "available_delivery_days": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY",
        "SUNDAY"
      ],
      "default_order_status": "PENDING",
      "discoverable": true,
      "external_name": "Ext B",
      "id": "00000000-0000-0000-0000-00000000007f",
      "inserted_datetime": "2026-08-17T21:24:25.592834Z",
      "internal_name": "Beta",
      "minimum_order_lead_time_days": 0,
      "minimum_order_subtotal": null,
      "product_count": 0,
      "updated_datetime": "2026-08-17T21:24:25.592834Z",
      "url": null,
      "visibility": "PUBLIC"
    }
  ],
  "next_page": null
}

List menus for the authenticated company with visibility, active state, and active product counts.

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

Required permission: products_permissions_view.

Request

GET /public/v1/menus

Parameters

Parameter Description In Type Required Default Example
active Filter by menu active flag: true, false, or true,false (both). query string false
page Pagination information query number false ?page[number]=1
visibility Comma-separated visibility: PUBLIC, PRIVATE, PASSCODE_PROTECTED. query string false

Responses

Status Description Schema
200 Menus index Menus

OfficialProductCategory

Get official product categories

GET /public/v1/official-product-categories returns the global official product categories with raw string ids

GET /public/v1/official-product-categories
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMmQ0ZTY3ZmItYjg1MS00MWQ2LTg4ZDAtZTM1NGI3NTQ3N2Q5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg3MyIsInR5cCI6ImFjY2VzcyJ9.rxZyV89vxjMOhsjzebZUWUcOr8_mzLTtP5vKR7x-6O8

Response

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

{
  "data": [
    {
      "id": "CAPSULES",
      "name": "Capsules"
    },
    {
      "id": "CLONES",
      "name": "Clones & Seeds"
    },
    {
      "id": "CONCENTRATES",
      "name": "Concentrates"
    },
    {
      "id": "EDIBLES",
      "name": "Edibles"
    },
    {
      "id": "FLOWER",
      "name": "Flower"
    },
    {
      "id": "MERCH",
      "name": "Merch"
    },
    {
      "id": "OTHER",
      "name": "Other"
    },
    {
      "id": "PREROLLS",
      "name": "Pre-Rolls"
    },
    {
      "id": "TINCTURES",
      "name": "Tinctures"
    },
    {
      "id": "TOPICALS",
      "name": "Topicals"
    },
    {
      "id": "VAPES",
      "name": "Vapes"
    }
  ]
}

List the official product categories in Distru. These are global, system-defined reference records.

Request

GET /public/v1/official-product-categories

Responses

Status Description Schema
200 A list of official product categories OfficialProductCategories

Order

Get an order

GET /orders/:id returns the expected order

GET /public/v1/orders/a2370e7a-4f4e-4230-a009-d914bf99d5d3
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NzksImlhdCI6MTc4NzAwMTg3OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZGZlZTIzOTAtYmZhMy00NWVjLWEyZDEtMzk4MjkzNDk2ZDI4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODc4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6MTAwOTciLCJ0eXAiOiJhY2Nlc3MifQ.PgPU3Wy9jR4KVygVUAx8JNJ_1j96yEKjmHt93YWR64k

Response

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

{
  "data": {
    "billing_location": null,
    "biotrack_id": null,
    "blaze_payment_type": null,
    "buyer_company": null,
    "buyer_note": null,
    "charges": [
      {
        "id": "02a70ede-ea4d-4d7c-86ff-9b89ed03d73b",
        "name": "C1",
        "percent": "10.0000",
        "price": "1.00",
        "tax": {
          "id": "00000000-0000-0000-0000-00000000002d",
          "name": "T1"
        },
        "type": "CHARGE",
        "unit_type": "PERCENT"
      }
    ],
    "combined_order": null,
    "company": {
      "id": "00000000-0000-0000-0000-000000001379",
      "name": "Company 2457",
      "updated_datetime": "2026-08-17T21:24:39.592558Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-3235@example.com",
      "full_name": "FirstName6544 LastName6545",
      "id": "00000000-0000-0000-0000-000000002772",
      "role": {
        "id": "00000000-0000-0000-0000-00000000283f",
        "name": "Admin 3339"
      }
    },
    "custom_data": [
      {
        "id": 231,
        "name": "Custom Field 51",
        "value": "Custom Field Value 1"
      }
    ],
    "delivered_datetime": "2026-08-17T21:24:39.605144Z",
    "delivery_datetime": null,
    "due_datetime": "2026-08-17T21:24:39.605149Z",
    "external_notes": null,
    "id": "a2370e7a-4f4e-4230-a009-d914bf99d5d3",
    "inserted_datetime": "2026-08-17T21:24:39.605451Z",
    "internal_notes": null,
    "inventory_source": {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "company_id": "00000000-0000-0000-0000-000000001e7b",
      "id": "00000000-0000-0000-0000-000000000a53",
      "license_id": null,
      "license_number": null,
      "name": "Place 792"
    },
    "invoices": [],
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000c35",
          "name": "B3078"
        },
        "compliance_quantity": null,
        "cost_per_unit": null,
        "cost_per_unit_default": null,
        "id": "7a956338-b960-4f91-a595-a6dade4cc683",
        "is_sample": false,
        "leaflink_id": null,
        "location": null,
        "note": null,
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "ce340da0-b439-4632-8e36-020c1494a9aa",
          "name": "Product 3076",
          "sku": "sku 3077",
          "updated_datetime": "2026-08-17T21:24:39.612198Z"
        },
        "quantity": "15.000000000",
        "returned_quantity": "0",
        "thc_percentage_total": null,
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000c36",
          "name": "B3081"
        },
        "compliance_quantity": null,
        "cost_per_unit": null,
        "cost_per_unit_default": null,
        "id": "257c0897-965b-4a64-a2dd-e929409bc18f",
        "is_sample": false,
        "leaflink_id": null,
        "location": null,
        "note": null,
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "8de297ce-adc7-4da6-8e69-3f50d9562c13",
          "name": "Product 3079",
          "sku": "sku 3080",
          "updated_datetime": "2026-08-17T21:24:39.619448Z"
        },
        "quantity": "10.000000000",
        "returned_quantity": "0",
        "thc_percentage_total": null,
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000c37",
          "name": "B3084"
        },
        "compliance_quantity": null,
        "cost_per_unit": null,
        "cost_per_unit_default": null,
        "id": "b33586aa-363c-40a2-899f-332b1d34b1f5",
        "is_sample": false,
        "leaflink_id": null,
        "location": null,
        "note": null,
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "3b7eaa9a-6cf1-43da-9e98-2463deeed168",
          "name": "Product 3082",
          "sku": "sku 3083",
          "updated_datetime": "2026-08-17T21:24:39.626462Z"
        },
        "quantity": "5.000000000",
        "returned_quantity": "0",
        "thc_percentage_total": null,
        "total_cost_actual": null,
        "total_cost_default": null
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000c38",
          "name": "B3087"
        },
        "compliance_quantity": null,
        "cost_per_unit": null,
        "cost_per_unit_default": null,
        "id": "ca5f3812-c6d7-42e6-a668-e8202d9d6b7e",
        "is_sample": false,
        "leaflink_id": null,
        "location": null,
        "note": null,
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "8e49439f-631b-4328-8774-73d155b98922",
          "name": "Product 3085",
          "sku": "sku 3086",
          "updated_datetime": "2026-08-17T21:24:39.633272Z"
        },
        "quantity": "2.000000000",
        "returned_quantity": "0",
        "thc_percentage_total": null,
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_id": null,
    "leaflink_order_number": null,
    "menu": null,
    "metrc_transfer_id": null,
    "order_datetime": "2026-08-17T21:24:39.605149Z",
    "order_number": "SO-179",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-3235@example.com",
      "full_name": "FirstName6544 LastName6545",
      "id": "00000000-0000-0000-0000-000000002772",
      "role": {
        "id": "00000000-0000-0000-0000-00000000283f",
        "name": "Admin 3339"
      }
    },
    "payment_term_name": null,
    "returns": [],
    "shipping_location": null,
    "status": "COMPLETED",
    "total": "320.00",
    "updated_datetime": "2026-08-17T21:24:39.646710Z"
  }
}

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.

Required permission: orders_permissions_view. The authenticated user must also have access to the requested order under their team restrictions.

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 OrderResponse

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYzQzMDJjMzMtMzljZS00NzVmLWIxNWEtYTY5Yjc3ZDY3NTdkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODA0MyIsInR5cCI6ImFjY2VzcyJ9.uHeugzeJV3VnvZ2sQrYtLBnD1fovLYK9qsKbhjkEyRs

Response

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

{
  "data": [
    {
      "billing_location": {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-000000001828",
        "id": "00000000-0000-0000-0000-000000000856",
        "license_id": null,
        "license_number": null,
        "name": "Place 284"
      },
      "biotrack_id": null,
      "blaze_payment_type": "CASH",
      "buyer_company": null,
      "buyer_note": null,
      "charges": [
        {
          "id": "f8483fce-75b1-4bdc-bbde-a42a1dfb2d2d",
          "name": "C1",
          "percent": "10.0000",
          "price": "1.00",
          "tax": {
            "id": "00000000-0000-0000-0000-00000000002a",
            "name": "T1"
          },
          "type": "CHARGE",
          "unit_type": "PERCENT"
        }
      ],
      "combined_order": null,
      "company": {
        "id": "00000000-0000-0000-0000-000000000f05",
        "name": "Company 924",
        "updated_datetime": "2030-11-01T00:00:00.000000Z"
      },
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "user1@a.com",
        "full_name": "John Foo",
        "id": "00000000-0000-0000-0000-000000001f32",
        "role": {
          "id": "00000000-0000-0000-0000-000000001fe3",
          "name": "Admin 1199"
        }
      },
      "custom_data": [
        {
          "id": 190,
          "name": "Custom Field 29",
          "value": "Custom Field Value 1"
        }
      ],
      "delivered_datetime": "2020-01-03T00:00:00.000000Z",
      "delivery_datetime": "2020-01-01T00:00:00.000000Z",
      "due_datetime": "2020-01-01T00:00:01.000000Z",
      "external_notes": null,
      "id": "18b95cf5-d9fc-4d2d-b9e5-95e9d2eeb4df",
      "inserted_datetime": "2020-01-01T00:00:03.000000Z",
      "internal_notes": "Internal notes for this order",
      "inventory_source": {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-000000001828",
        "id": "00000000-0000-0000-0000-000000000856",
        "license_id": null,
        "license_number": null,
        "name": "Place 284"
      },
      "invoices": [],
      "items": [
        {
          "batch": {
            "batch_number": "UID1",
            "id": "00000000-0000-0000-0000-0000000008de",
            "name": "B1"
          },
          "compliance_quantity": "10.0000",
          "cost_per_unit": null,
          "cost_per_unit_default": null,
          "id": "02fe10c8-754a-4cbe-80a1-31ee8d93e9ed",
          "is_sample": true,
          "leaflink_id": null,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 90210, US",
            "company_id": "00000000-0000-0000-0000-000000001828",
            "id": "00000000-0000-0000-0000-000000000856",
            "license_id": null,
            "name": "Place 284"
          },
          "note": null,
          "package": {
            "batch_number": "B1",
            "compliance_label": "ABCDEF012345670000000039",
            "id": "00000000-0000-0000-0000-0000000000ec",
            "metrc_label": "ABCDEF012345670000000039",
            "status": "active"
          },
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "27b734bc-57d5-41ee-b454-6cbc51c5de63",
            "name": "P1",
            "sku": "SKU1",
            "updated_datetime": "2023-11-02T00:00:00.000000Z"
          },
          "quantity": "1.000000000",
          "returned_quantity": "0",
          "thc_percentage_total": null,
          "total_cost_actual": null,
          "total_cost_default": null
        }
      ],
      "leaflink_id": "1",
      "leaflink_order_number": "c75a8945-325b-407a-b54d-5cf3bcb9ee04",
      "menu": null,
      "metrc_transfer_id": 1,
      "order_datetime": "2020-01-01T00:00:02.000000Z",
      "order_number": "SO-123",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "user2@a.com",
        "full_name": "John Bar",
        "id": "00000000-0000-0000-0000-000000001f69",
        "role": {
          "id": "00000000-0000-0000-0000-000000002017",
          "name": "Admin 1251"
        }
      },
      "payment_term_name": null,
      "returns": [],
      "shipping_location": {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-000000001828",
        "id": "00000000-0000-0000-0000-000000000856",
        "license_id": null,
        "license_number": null,
        "name": "Place 284"
      },
      "status": "COMPLETED",
      "total": "11.00",
      "updated_datetime": "2020-01-01T00:00:04.000000Z"
    }
  ],
  "next_page": null
}

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.

Required permission: orders_permissions_view. Results are filtered to only include orders the authenticated user can access under their team restrictions.

Request

GET /public/v1/orders

Parameters

Parameter Description In Type Required Default Example
company_id Filter orders by buyer company (company relationship ID — same UUID as each order's company.id and GET /public/v1/companies).
query string false 550e8400-e29b-41d4-a716-446655440000
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 query number false ?page[number]=1
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
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NzUsImlhdCI6MTc4NzAwMTg3NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMzgwZjBkNDAtZmM2Ny00OGFlLWFlZDAtYzE5N2Y0YzU0ZDg4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODc0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6OTg5NSIsInR5cCI6ImFjY2VzcyJ9.BopzQn93aviektSCTbivM4uoCfVOcdZ0mgoWKoKCr44

{
  "billing_location_id": "00000000-0000-0000-0000-000000000a15",
  "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-0000000012f2",
  "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-000000000a14",
      "price_base": "10.000000000",
      "product_id": "e0d0273b-b4e8-42f6-8255-d272445a3463",
      "quantity": "1.000000000"
    }
  ],
  "order_datetime": "2020-01-01T00:00:02.000000Z",
  "owner_id": "00000000-0000-0000-0000-0000000026a7",
  "shipping_location_id": "00000000-0000-0000-0000-000000000a15",
  "status": "PROCESSING"
}

Response

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

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "company_id": "00000000-0000-0000-0000-000000001dd4",
      "id": "00000000-0000-0000-0000-000000000a15",
      "license_id": null,
      "license_number": null,
      "name": "Place 731"
    },
    "biotrack_id": null,
    "blaze_payment_type": null,
    "buyer_company": null,
    "buyer_note": null,
    "charges": [
      {
        "id": "b76d4541-a9d7-45af-8bc7-cd587c621b8e",
        "name": "C1",
        "percent": "10.0000",
        "price": "1.00",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "8f32e707-2b2c-4fb6-b36c-6a22bae2d41a",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "combined_order": null,
    "company": {
      "id": "00000000-0000-0000-0000-0000000012f2",
      "name": "Company 2289",
      "updated_datetime": "2026-08-17T21:24:35.390651Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-0000000026a7",
      "role": {
        "id": "00000000-0000-0000-0000-000000002770",
        "name": "Admin 3132"
      }
    },
    "custom_data": [
      {
        "id": 229,
        "name": "Custom Field 49",
        "value": null
      }
    ],
    "delivered_datetime": null,
    "delivery_datetime": "2020-01-01T00:00:00.000000Z",
    "due_datetime": "2020-01-01T00:00:01.000000Z",
    "external_notes": "Thank you for ordering!",
    "id": "ff0eb899-02e5-41c1-bdde-c178e751ed8b",
    "inserted_datetime": "2026-08-17T21:24:35.433939Z",
    "internal_notes": "Internal notes for this order",
    "inventory_source": null,
    "invoices": [],
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000bd9",
          "name": "B1"
        },
        "compliance_quantity": null,
        "cost_per_unit": null,
        "cost_per_unit_default": null,
        "id": "cbe884b4-7bb3-4ede-9248-34e032fe8c4e",
        "is_sample": false,
        "leaflink_id": null,
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 90210, US",
          "company_id": "00000000-0000-0000-0000-000000001dd3",
          "id": "00000000-0000-0000-0000-000000000a14",
          "license_id": "00000000-0000-0000-0000-0000000002a9",
          "name": "Place 730"
        },
        "note": null,
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "e0d0273b-b4e8-42f6-8255-d272445a3463",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2026-08-17T21:24:35.409704Z"
        },
        "quantity": "1.000000000",
        "returned_quantity": "0",
        "thc_percentage_total": null,
        "total_cost_actual": null,
        "total_cost_default": null
      }
    ],
    "leaflink_id": null,
    "leaflink_order_number": null,
    "menu": null,
    "metrc_transfer_id": null,
    "order_datetime": "2020-01-01T00:00:02.000000Z",
    "order_number": "SO-0000001",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-0000000026a7",
      "role": {
        "id": "00000000-0000-0000-0000-000000002770",
        "name": "Admin 3132"
      }
    },
    "payment_term_name": null,
    "returns": [],
    "shipping_location": {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "company_id": "00000000-0000-0000-0000-000000001dd4",
      "id": "00000000-0000-0000-0000-000000000a15",
      "license_id": null,
      "license_number": null,
      "name": "Place 731"
    },
    "status": "PROCESSING",
    "total": "6.00",
    "updated_datetime": "2026-08-17T21:24:35.459010Z"
  }
}

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. Required permission: orders_permissions_create to create a new order, orders_permissions_edit (and access to the order under team restrictions) to update an existing order.

Request

POST /public/v1/orders

Parameters

Parameter Description In Type Required Default Example
billing_location_id The billing location's ID query string false
biotrack_id The Biotrack ID for this order query string false
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
charges The additional lines of Charge, Discount, or Tax added to this order body OrderChargesRequest false
company_id Company ID query string false
custom_data A map of custom field IDs to their values. Use GET /public/v1/custom-fields?model_name=order to retrieve available custom fields and their IDs. body object false {"123":"Custom Value 1","456":"Custom Value 2"}
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. Optional: when omitted, it is derived from the customer's default payment term, then the company default order payment term, then falls back to the order date (COD). query string false
email_invoice When true, email the order's invoice. No email is sent unless the order has an invoice (see upsert_invoice) and a recipient can be resolved from email_invoice_addresses or the buyer company relationship's invoice email. query boolean false
email_invoice_addresses Comma-separated list of email addresses to send the invoice to when email_invoice is true. Takes precedence over the company relationship's invoice email. Invalid addresses are rejected. query string false amy@distru.com,john@distru.com
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
internal_notes Internal notes for this order query string false
items The order items present on this order body OrderItemsRequest false
metrc_transfer_id The Metrc transfer ID for this order query integer 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_transporter_info The Metrc transfer template transporter(s) information about this order body OrderTransferTemplateTransporterInfosRequest false
metrc_transfer_template_type The Metrc transfer template type query string false
order_datetime The datetime on which the order was placed query string false
owner_id The ID of the Distru user that owns this order query string false
shipping_location_id The shipping location's ID 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
upsert_invoice When true, create an invoice for this order if it doesn't have one yet, or update the existing invoice with the order's latest changes. query boolean false

Responses

Status Description Schema
200 A single order OrderResponse

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiZWFkMzk1YjAtMDY3My00MTE3LWIxM2UtMzI2NGFjODJlZWJiIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzQ2NCIsInR5cCI6ImFjY2VzcyJ9.UXmvd6q0eTKM4RKt6nMzosCrhmSMVU37x0zx8JCoLJ8

Response

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

{
  "data": [
    {
      "batch_number": null,
      "biotrack_id": null,
      "biotrack_inventory_type_id": null,
      "biotrack_net_quantity_per_unit": null,
      "biotrack_room_id": null,
      "biotrack_status": null,
      "biotrack_usable_weight": null,
      "compliance_label": "ABCDEF012345670000000008",
      "compliance_product_name": "Buds",
      "compliance_strain_name": "Cotton Candy",
      "compliance_transferred_datetime": null,
      "compliance_type": "METRC",
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-666@example.com",
        "full_name": "FirstName1358 LastName1359",
        "id": "00000000-0000-0000-0000-000000001d45",
        "role": {
          "id": "00000000-0000-0000-0000-000000001de5",
          "name": "Admin 689"
        }
      },
      "custom_data": [
        {
          "id": 164,
          "name": "Custom Field 8",
          "value": "Custom Field Value 1"
        }
      ],
      "description": null,
      "expiration_date": "2024-01-01T00:00:00.000000Z",
      "expiration_datetime": "2024-01-01T00:00:00.000000Z",
      "finished_datetime": null,
      "harvest_date": "2024-06-15",
      "id": "00000000-0000-0000-0000-0000000000dd",
      "inactivated_datetime": null,
      "is_production_batch": false,
      "is_test_sample": false,
      "is_trade_sample": true,
      "lab_testing_state": "NotSubmitted",
      "license": {
        "active": true,
        "expiry_datetime": "2026-09-17T21:24:27.306275Z",
        "id": "00000000-0000-0000-0000-00000000020d",
        "issue_datetime": "2026-08-17T21:24:27.306273Z",
        "license_number": "CDPH-00000016",
        "license_type": "Specialty Cottage Indoor"
      },
      "location": {
        "id": "00000000-0000-0000-0000-0000000007eb",
        "name": "Place 177"
      },
      "metrc_archived_date": null,
      "metrc_finished_date": null,
      "metrc_id": 8,
      "metrc_label": "ABCDEF012345670000000008",
      "metrc_production_batch_number": null,
      "metrc_received_datetime": null,
      "metrc_received_from_manifest_number": null,
      "metrc_source_harvest_names": null,
      "metrc_status": "ACTIVE",
      "metrc_transfer_id": null,
      "metrc_unit_name": "Ounces",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-645@example.com",
        "full_name": "FirstName1310 LastName1311",
        "id": "00000000-0000-0000-0000-000000001d30",
        "role": {
          "id": "00000000-0000-0000-0000-000000001dcc",
          "name": "Admin 664"
        }
      },
      "packaged_date": "2024-07-01",
      "primary_test_result": null,
      "product_id": "aab58460-7d52-4996-9f7d-460f00b46361",
      "product_unit_quantity": "7.500000000",
      "product_unit_type": {
        "id": "00000000-0000-0000-0000-000000011e29",
        "name": "3"
      },
      "quantity": "5.000000000",
      "quantity_assembling": "0.000000000",
      "quantity_available": "5.000000000",
      "status": "active",
      "unit_type": {
        "id": "00000000-0000-0000-0000-000000011e2a",
        "name": "2"
      }
    },
    {
      "batch_number": null,
      "biotrack_id": null,
      "biotrack_inventory_type_id": null,
      "biotrack_net_quantity_per_unit": null,
      "biotrack_room_id": null,
      "biotrack_status": null,
      "biotrack_usable_weight": null,
      "compliance_label": "ABCDEF012345670000000010",
      "compliance_product_name": "Buds",
      "compliance_strain_name": "Cotton Candy",
      "compliance_transferred_datetime": null,
      "compliance_type": "METRC",
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-720@example.com",
        "full_name": "FirstName1466 LastName1467",
        "id": "00000000-0000-0000-0000-000000001d7e",
        "role": {
          "id": "00000000-0000-0000-0000-000000001e22",
          "name": "Admin 750"
        }
      },
      "custom_data": [
        {
          "id": 164,
          "name": "Custom Field 8",
          "value": null
        }
      ],
      "description": null,
      "expiration_date": null,
      "expiration_datetime": null,
      "finished_datetime": null,
      "harvest_date": null,
      "id": "00000000-0000-0000-0000-0000000000de",
      "inactivated_datetime": null,
      "is_production_batch": false,
      "is_test_sample": false,
      "is_trade_sample": false,
      "lab_testing_state": "NotSubmitted",
      "license": {
        "active": true,
        "expiry_datetime": "2026-09-17T21:24:27.306275Z",
        "id": "00000000-0000-0000-0000-00000000020d",
        "issue_datetime": "2026-08-17T21:24:27.306273Z",
        "license_number": "CDPH-00000016",
        "license_type": "Specialty Cottage Indoor"
      },
      "location": {
        "id": "00000000-0000-0000-0000-0000000007f3",
        "name": "Place 185"
      },
      "metrc_archived_date": null,
      "metrc_finished_date": null,
      "metrc_id": 10,
      "metrc_label": "ABCDEF012345670000000010",
      "metrc_production_batch_number": null,
      "metrc_received_datetime": null,
      "metrc_received_from_manifest_number": null,
      "metrc_source_harvest_names": null,
      "metrc_status": "ACTIVE",
      "metrc_transfer_id": null,
      "metrc_unit_name": "Ounces",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-645@example.com",
        "full_name": "FirstName1310 LastName1311",
        "id": "00000000-0000-0000-0000-000000001d30",
        "role": {
          "id": "00000000-0000-0000-0000-000000001dcc",
          "name": "Admin 664"
        }
      },
      "packaged_date": null,
      "primary_test_result": {
        "cbd_mg_per_unit": "1",
        "cbd_mg_per_unit_total": "2",
        "cbd_percentage": "3",
        "cbd_percentage_total": "4",
        "coa_url": null,
        "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": "aab58460-7d52-4996-9f7d-460f00b46361",
      "product_unit_quantity": "15.000000000",
      "product_unit_type": {
        "id": "00000000-0000-0000-0000-000000011e29",
        "name": "3"
      },
      "quantity": "20.000000000",
      "quantity_assembling": "0.000000000",
      "quantity_available": "20.000000000",
      "status": "active",
      "unit_type": {
        "id": "00000000-0000-0000-0000-000000011e2b",
        "name": "4"
      }
    }
  ],
  "next_page": null
}

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.

Required permission: products_permissions_view. Results are filtered to only include packages the authenticated user can access under their team restrictions.

Request

GET /public/v1/packages

Parameters

Parameter Description In Type Required Default Example
ids Filter packages by package ID (same UUID string as each package's id in responses). Values that do not decode to an internal package id match no rows. query array false ?ids[]=00000000-0000-0000-0000-000000000001&ids[]=00000000-0000-0000-0000-000000000002
inserted_datetime Filter packages by their creation datetime query string false 2022-07-10T00:00:00Z,
license_number Filter packages by license number query string false 1234567890
location_ids A list of location UUIDs to filter packages by. query array false ?location_ids[]=c40e87ce-0647-409b-89fa-620275d77fcc&location_ids[]=65ca530a-1ea2-439b-b4c2-598abb1fc6f3
page Pagination information query number false ?page[number]=1
product_ids Filter packages by product ID query array false ?product_ids[]=c40e87ce-0647-409b-89fa-620275d77fcc&product_ids[]=65ca530a-1ea2-439b-b4c2-598abb1fc6f3
statuses Filter packages by their status query array false ?statuses[]=active&statuses[]=selling&statuses[]=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

Update a package

POST /public/v1/packages/:id updates the Distru-tracked fields and returns the full package

POST /public/v1/packages/00000000-0000-0000-0000-00000000010f
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NzAsImlhdCI6MTc4NzAwMTg3MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTczMzQ3Y2YtNTgyYy00NjE0LWFmYmQtOTkzYWQ0Y2VlMmIwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODcwNSIsInR5cCI6ImFjY2VzcyJ9.QqXw5ytw7_-Rau2FW9QFFrw7zwEDdEPK4YVqtnWKah0

{
  "batch_number": "NEW-BATCH-001",
  "custom_data": {
    "223": "Updated Value"
  },
  "description": "Updated description",
  "expiration_datetime": "2025-02-02T03:04:05.000000Z",
  "harvest_date": "2025-03-03"
}

Response

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

{
  "data": {
    "batch_number": "NEW-BATCH-001",
    "biotrack_id": null,
    "biotrack_inventory_type_id": null,
    "biotrack_net_quantity_per_unit": null,
    "biotrack_room_id": null,
    "biotrack_status": null,
    "biotrack_usable_weight": null,
    "compliance_label": "ABCDEF012345670000000100",
    "compliance_product_name": "Buds",
    "compliance_strain_name": "Cotton Candy",
    "compliance_transferred_datetime": null,
    "compliance_type": "METRC",
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1882@example.com",
      "full_name": "FirstName3834 LastName3835",
      "id": "00000000-0000-0000-0000-00000000220e",
      "role": {
        "id": "00000000-0000-0000-0000-0000000022d4",
        "name": "Admin 1952"
      }
    },
    "custom_data": [
      {
        "id": 223,
        "name": "Custom Field 43",
        "value": "Updated Value"
      }
    ],
    "description": "Updated description",
    "expiration_date": "2025-02-02T03:04:05.000000Z",
    "expiration_datetime": "2025-02-02T03:04:05.000000Z",
    "finished_datetime": null,
    "harvest_date": "2025-03-03",
    "id": "00000000-0000-0000-0000-00000000010f",
    "inactivated_datetime": null,
    "is_production_batch": false,
    "is_test_sample": false,
    "is_trade_sample": false,
    "lab_testing_state": "NotSubmitted",
    "license": {
      "active": true,
      "expiry_datetime": "2026-09-17T21:24:30.300232Z",
      "id": "00000000-0000-0000-0000-00000000024e",
      "issue_datetime": "2026-08-17T21:24:30.300230Z",
      "license_number": "CDPH-00000082",
      "license_type": "Small Indoor"
    },
    "location": {
      "id": "00000000-0000-0000-0000-0000000008e0",
      "name": "Place 422"
    },
    "metrc_archived_date": null,
    "metrc_finished_date": null,
    "metrc_id": 100,
    "metrc_label": "ABCDEF012345670000000100",
    "metrc_production_batch_number": null,
    "metrc_received_datetime": null,
    "metrc_received_from_manifest_number": null,
    "metrc_source_harvest_names": null,
    "metrc_status": "ACTIVE",
    "metrc_transfer_id": null,
    "metrc_unit_name": "Ounces",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1873@example.com",
      "full_name": "FirstName3816 LastName3817",
      "id": "00000000-0000-0000-0000-000000002205",
      "role": {
        "id": "00000000-0000-0000-0000-0000000022cb",
        "name": "Admin 1943"
      }
    },
    "packaged_date": "2014-11-29",
    "primary_test_result": null,
    "product_id": "ef460757-032f-454f-b51e-de64ae7efcb9",
    "product_unit_quantity": "141.747462720",
    "product_unit_type": {
      "id": "00000000-0000-0000-0000-000000014b88",
      "name": "Gram"
    },
    "quantity": "5.000000000",
    "quantity_assembling": "0.000000000",
    "quantity_available": "5.000000000",
    "status": "active",
    "unit_type": {
      "id": "00000000-0000-0000-0000-000000014b8a",
      "name": "Ounce"
    }
  }
}

Update the Distru-tracked fields of an existing package. Packages cannot be created through the API, only updated.

Supports sparse updates: only the fields included in the request are changed; omitted fields are left untouched.

Required permission: products_permissions_edit.

Request

POST /public/v1/packages/{id}

Parameters

Parameter Description In Type Required Default Example
batch_number The batch number of the package query string false
bin_ids The IDs of the bins this package is stored in. Behaviour: omit bin_ids to leave the package's bins unchanged; pass null or an empty array to clear all bins; pass a non-empty array to replace the package's bins with exactly those. Ignored unless bin inventory tracking is enabled for your company.
body array false
custom_data A map of custom field IDs to their values. Use GET /public/v1/custom-fields?model_name=package to retrieve available custom fields and their IDs. body object false {"123":"Custom Value 1","456":"Custom Value 2"}
description Free-form text describing the package query string false
expiration_datetime The expiration datetime of the package (ISO 8601 format) query string false
harvest_date The harvest date of the package (YYYY-MM-DD) query string false
id Package ID path string true

Responses

Status Description Schema
200 The updated package PackageFullResponse
400 Invalid parameters
404 Not Found

Payment

Get a payment

GET /public/v1/payments/:id returns a single payment

GET /public/v1/payments/00000000-0000-0000-0000-000000000054
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYjI2MWMwY2YtNWY1NS00OTgwLThhY2YtYjAzODhkYTI4Zjc2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzI5MyIsInR5cCI6ImFjY2VzcyJ9.QG1uf5OG_iAe5b6Owq4y4YswUHZSg7MlEtsl0Rw0h3s

Response

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

{
  "data": {
    "amount": "10",
    "company": {
      "id": "00000000-0000-0000-0000-000000000de0",
      "name": "Company 368",
      "updated_datetime": "2026-08-17T21:24:26.904423Z"
    },
    "credit_uses": [
      {
        "amount": "30",
        "credit": {
          "amount": "100",
          "credit_number": "CRT-U",
          "id": "589267a0-99c6-4481-aaf9-c1e5fbac1643",
          "source": "USER"
        },
        "id": "a15f1bed-f160-4b0d-82e9-f53555292c84"
      }
    ],
    "description": null,
    "fully_paid_with_credits": false,
    "id": "00000000-0000-0000-0000-000000000054",
    "inserted_datetime": "2026-08-17T21:24:26.925095Z",
    "invoice": {
      "id": "00000000-0000-0000-0000-0000000000c5",
      "invoice_number": "Invoice #17",
      "status": "NOT_PAID",
      "total": "32.00"
    },
    "overpayment_credits": [
      {
        "amount": "20",
        "credit_number": "CRT-OP",
        "id": "4309aae5-3aa0-4a7d-8d61-dd6ce2728837",
        "source": "INVOICE_PAYMENT"
      }
    ],
    "payment_date": "2026-08-17T21:24:26.923949Z",
    "payment_method": {
      "active": true,
      "deleted_at": null,
      "id": "00000000-0000-0000-0000-00000000006a",
      "inserted_datetime": "2026-08-17T21:24:26.922585Z",
      "name": "Payment Method 15",
      "qb_payment_method_id": null,
      "type": "CREDIT_CARD",
      "updated_datetime": "2026-08-17T21:24:26.922585Z"
    },
    "payment_number": "Payment #15",
    "payment_type": "INVOICE",
    "purchase": null,
    "quickbooks_deposit_account_id": null,
    "quickbooks_deposit_account_name": null,
    "status": "POSTED",
    "updated_datetime": "2026-08-17T21:24:26.925095Z"
  }
}

Get a single payment given the ID.

Required permission: payments_permissions_view.

Request

GET /public/v1/payments/{id}

Parameters

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

Responses

Status Description Schema
200 A single payment PaymentResponse
404 Not Found

Get payments

GET /public/v1/payments returns invoice and purchase payments related to the company

GET /public/v1/payments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYjc0MDg1ZGItNWZkZS00NmM2LWIyYzMtZjUzMmQ4ODQzMzEwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjgyOCIsInR5cCI6ImFjY2VzcyJ9.SMDp69vkJdKHAfzPJnevuCue-Gr5QaNUaZ7YXQqUzwI

Response

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

{
  "data": [
    {
      "amount": "75.25",
      "company": {
        "id": "00000000-0000-0000-0000-000000000d74",
        "name": "Company 45",
        "updated_datetime": "2026-08-17T21:24:25.289687Z"
      },
      "credit_uses": null,
      "description": "pur payment",
      "fully_paid_with_credits": false,
      "id": "00000000-0000-0000-0000-000000000046",
      "inserted_datetime": "2026-08-17T21:24:25.331382Z",
      "invoice": null,
      "overpayment_credits": null,
      "payment_date": "2026-08-17T21:24:25.331091Z",
      "payment_method": {
        "active": true,
        "deleted_at": null,
        "id": "00000000-0000-0000-0000-00000000005c",
        "inserted_datetime": "2026-08-17T21:24:25.330294Z",
        "name": "Payment Method 1",
        "qb_payment_method_id": null,
        "type": "CREDIT_CARD",
        "updated_datetime": "2026-08-17T21:24:25.330294Z"
      },
      "payment_number": "Payment #1",
      "payment_type": "PURCHASE",
      "purchase": {
        "id": "00000000-0000-0000-0000-0000000000a9",
        "purchase_number": "Purchase #0",
        "status": "PENDING",
        "total": "32.00"
      },
      "quickbooks_deposit_account_id": null,
      "status": "POSTED",
      "updated_datetime": "2026-08-17T21:24:25.331382Z"
    },
    {
      "amount": "150.5",
      "company": {
        "id": "00000000-0000-0000-0000-000000000d71",
        "name": "Company 31",
        "updated_datetime": "2026-08-17T21:24:25.089145Z"
      },
      "credit_uses": [
        {
          "amount": "30",
          "credit": {
            "amount": "100",
            "credit_number": "CRT-U",
            "id": "7bde14ee-c186-41f0-b47c-baf091440d86",
            "source": "USER"
          },
          "id": "3756cd9a-a712-420f-8bcf-d183d1a615af"
        }
      ],
      "description": "inv payment",
      "fully_paid_with_credits": false,
      "id": "00000000-0000-0000-0000-000000000045",
      "inserted_datetime": "2026-08-17T21:24:25.178765Z",
      "invoice": {
        "id": "00000000-0000-0000-0000-0000000000b4",
        "invoice_number": "Invoice #0",
        "status": "NOT_PAID",
        "total": "32.00"
      },
      "overpayment_credits": [
        {
          "amount": "20",
          "credit_number": "CRT-OP",
          "id": "a6be6457-a202-4a45-b981-44c03c3cbe04",
          "source": "INVOICE_PAYMENT"
        }
      ],
      "payment_date": "2026-08-17T21:24:25.177525Z",
      "payment_method": {
        "active": true,
        "deleted_at": null,
        "id": "00000000-0000-0000-0000-00000000005b",
        "inserted_datetime": "2026-08-17T21:24:25.175821Z",
        "name": "Payment Method 0",
        "qb_payment_method_id": null,
        "type": "CREDIT_CARD",
        "updated_datetime": "2026-08-17T21:24:25.175821Z"
      },
      "payment_number": "Payment #0",
      "payment_type": "INVOICE",
      "purchase": null,
      "quickbooks_deposit_account_id": null,
      "status": "POSTED",
      "updated_datetime": "2026-08-17T21:24:25.178765Z"
    }
  ],
  "next_page": null
}

Get payments sorted by their creation date and filtered by various attributes. A payment is either an invoice payment (money received from a customer) or a purchase payment (money paid to a vendor), distinguished by the payment_type field.

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

Required permission: payments_permissions_view.

Request

GET /public/v1/payments

Parameters

Parameter Description In Type Required Default Example
inserted_datetime Filter payments by their creation datetime query string false 2022-07-10T00:00:00Z,
page Pagination information query number false ?page[number]=1
payment_date Filter payments by their payment datetime query string false 2022-07-10T00:00:00Z,
payment_number Filter payments whose payment number contains this value query string false
payment_status Filter payments by their status. Defaults to returning both posted and voided payments. query string false
payment_type Filter payments by whether they belong to an invoice or a purchase query string false
updated_datetime Filter payments by the datetime they were most recently modified query string false ,2022-07-10T00:00:00Z

Responses

Status Description Schema
200 A list of payments Payments

PaymentMethod

Get a payment method

GET /public/v1/payment-methods/:id returns a single payment method

GET /public/v1/payment-methods/00000000-0000-0000-0000-000000000076
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiOTJjMWM4MTAtNDlhNS00MGFjLThlNGEtZTlkMzYwMDJiNGE3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzU3NyIsInR5cCI6ImFjY2VzcyJ9.rjwSd4_iLP0yXtDus6Jk_f_8SIKxpUgwbFklRjn9Phc

Response

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

{
  "data": {
    "active": true,
    "deleted_at": null,
    "id": "00000000-0000-0000-0000-000000000076",
    "inserted_datetime": "2026-08-17T21:24:27.590902Z",
    "name": "Cash",
    "qb_payment_method_id": null,
    "type": "CASH",
    "updated_datetime": "2026-08-17T21:24:27.590902Z"
  }
}

Get a single payment method given the ID.

Required permission: settings_permissions_payment_methods.

Request

GET /public/v1/payment-methods/{id}

Parameters

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

Responses

Status Description Schema
200 A single payment method PaymentMethodResponse
404 Not Found

Get payment methods

GET /public/v1/payment-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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZDc5MDc5OGUtN2I4ZC00M2RiLTlmMjUtNmQyODEzMjZiZjg3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzI5OSIsInR5cCI6ImFjY2VzcyJ9.XYdIH_c3oyrl4f1RCiQ_rf_7gx2BBbbyHHXq_JHp0qI

Response

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

{
  "data": [
    {
      "active": true,
      "deleted_at": null,
      "id": "00000000-0000-0000-0000-00000000006b",
      "inserted_datetime": "2026-08-17T21:24:26.928681Z",
      "name": "Payment Method 16",
      "qb_payment_method_id": null,
      "type": "CREDIT_CARD",
      "updated_datetime": "2026-08-17T21:24:26.928681Z"
    }
  ],
  "next_page": null
}

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

Required permission: settings_permissions_payment_methods.

Request

GET /public/v1/payment-methods

Parameters

Parameter Description In Type Required Default Example
deleted Filter deleted payment methods. no returns non-deleted, only returns deleted, include returns both. query string false no

Responses

Status Description Schema
200 A list of payment methods PaymentMethods

PaymentTerm

Get payment terms

GET /public/v1/payment-terms returns payment terms related to the user's company only

GET /public/v1/payment-terms
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOWZiMGMxNDYtNGI5Ni00MDUxLTkxNzMtMDdhMmQyYzcyMTJjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg1MyIsInR5cCI6ImFjY2VzcyJ9.kCT10pXGFC2ljf_wh0hLKgq1AyF0FTM5ePsDOe48ito

Response

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

{
  "data": [
    {
      "days": 30,
      "id": "00000000-0000-0000-0000-000000000040",
      "inserted_datetime": "2026-08-17T21:24:25.107170Z",
      "locked": false,
      "name": "Net 30",
      "time_of_day": "17:00:00",
      "updated_datetime": "2026-08-17T21:24:25.107170Z"
    }
  ],
  "next_page": null
}

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

Required permission: settings_permissions_payment_terms.

Request

GET /public/v1/payment-terms

Responses

Status Description Schema
200 A list of payment terms PaymentTerms

Product

Get a product

GET /public/v1/products/:id returns a single product

GET /public/v1/products/e2e0e815-b09f-4b31-8a0c-15afe313cd52
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NzAsImlhdCI6MTc4NzAwMTg3MCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTdkZjY3MDgtZGRkNi00ODJkLTliNTUtMzNhMGEzNjA3ODkxIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY5LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODg5MyIsInR5cCI6ImFjY2VzcyJ9.fJvIfOu1Kj89Mn8PJ7Vqgr1kgpBa5VTKf2l_B4sW9Sc

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 7786bd0ae9ffdb9bcc082ef2aee86cd9-4833ee2ce9408660-0

{
  "data": {
    "bill_of_materials": null,
    "brand": null,
    "category": {
      "id": "00000000-0000-0000-0000-000000000af0",
      "name": "Some category 516",
      "official_product_category_id": "OTHER"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-2055@example.com",
      "full_name": "FirstName4184 LastName4185",
      "id": "00000000-0000-0000-0000-0000000022be",
      "role": {
        "id": "00000000-0000-0000-0000-000000002382",
        "name": "Admin 2126"
      }
    },
    "custom_data": [],
    "deleted_at": null,
    "description": null,
    "description_markdown": null,
    "external_name": null,
    "gross_weight": null,
    "gross_weight_unit_type": null,
    "id": "e2e0e815-b09f-4b31-8a0c-15afe313cd52",
    "images": [
      {
        "id": "00000000-0000-0000-0000-000000000026",
        "name": "Image Name 135",
        "rank": 0,
        "url": "https://google.com/original-10.jpg"
      }
    ],
    "inventory_tracking_method": "PRODUCT",
    "is_active": true,
    "is_featured": false,
    "leaflink_product_id": 777,
    "menu_visibility": "INCLUDE_IN_SELECT",
    "menus": [
      {
        "menu_id": "00000000-0000-0000-0000-0000000000b8",
        "menu_name": "Menu 1"
      }
    ],
    "msrp": null,
    "name": "Test Product",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-2055@example.com",
      "full_name": "FirstName4184 LastName4185",
      "id": "00000000-0000-0000-0000-0000000022be",
      "role": {
        "id": "00000000-0000-0000-0000-000000002382",
        "name": "Admin 2126"
      }
    },
    "product_group": {
      "id": "00000000-0000-0000-0000-000000000ab9",
      "name": "Product Group 499"
    },
    "quantity_available_threshold_max": null,
    "quantity_available_threshold_min": null,
    "sku": "SKU001",
    "strain": null,
    "subcategory": {
      "id": "00000000-0000-0000-0000-000000000ac0",
      "name": "Some subcategory 502"
    },
    "tags": [
      {
        "id": "00000000-0000-0000-0000-000000000042",
        "name": "Tag 1"
      }
    ],
    "total_cannabinoid_unit": null,
    "total_cbd": null,
    "total_thc": null,
    "treez_wholesale_price": "9.99",
    "unit_cost": null,
    "unit_net_weight": null,
    "unit_net_weight_serving_size_unit_type": null,
    "unit_price": "1",
    "unit_serving_size": null,
    "unit_type": {
      "id": "00000000-0000-0000-0000-000000015435",
      "name": "Gram"
    },
    "units_per_case": null,
    "upc": null,
    "updated_datetime": "2026-08-17T21:24:30.997334Z",
    "vendor": {
      "id": "00000000-0000-0000-0000-0000000010a6",
      "name": "Company 1560",
      "updated_datetime": "2026-08-17T21:24:30.995585Z"
    },
    "wholesale_unit_price": null
  }
}

Get a single product given the ID. The response always includes the product's bill_of_materials (or null if it has none).

Required permission: products_permissions_view.

Request

GET /public/v1/products/{id}

Parameters

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

Responses

Status Description Schema
200 A single product ProductResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiNzk4OTUwZjItMmRlMS00MmI4LWEyMjQtZjIwNzIxZTVkOWE1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzU1MiIsInR5cCI6ImFjY2VzcyJ9.56SY95EZlmaeBQaoHZiMtqfhBaJD6FCMpPZLC9ZS4v8

Response

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

{
  "data": [
    {
      "brand": {
        "id": "00000000-0000-0000-0000-000000000e2d",
        "name": "Company 539",
        "updated_datetime": "2030-11-01T00:00:00.000000Z"
      },
      "category": {
        "id": "00000000-0000-0000-0000-00000000095e",
        "name": "Some category 114",
        "official_product_category_id": "OTHER"
      },
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "product-owner@example.com",
        "full_name": "FirstName1522 LastName1523",
        "id": "00000000-0000-0000-0000-000000001d96",
        "role": {
          "id": "00000000-0000-0000-0000-000000001e3b",
          "name": "Admin 775"
        }
      },
      "custom_data": [
        {
          "id": 170,
          "name": "Custom Field 13",
          "value": "Custom Field Value 1"
        }
      ],
      "deleted_at": null,
      "description": "test",
      "description_markdown": "# test",
      "external_name": "External Name",
      "gross_weight": null,
      "gross_weight_unit_type": null,
      "id": "f002a041-70ee-4284-975e-97812f7ba50c",
      "images": [
        {
          "id": "00000000-0000-0000-0000-00000000001f",
          "name": "Image Name 54",
          "rank": 0,
          "url": "https://google.com/original-4.jpg"
        },
        {
          "id": "00000000-0000-0000-0000-000000000020",
          "name": "Image Name 56",
          "rank": 1,
          "url": "https://google.com/original-5.jpg"
        }
      ],
      "inventory_tracking_method": "BATCH",
      "is_active": true,
      "is_featured": true,
      "leaflink_product_id": 555,
      "menu_visibility": "INCLUDE_IN_ALL",
      "menus": [
        {
          "menu_id": "00000000-0000-0000-0000-00000000009f",
          "menu_name": "Menu 1"
        }
      ],
      "msrp": null,
      "name": "Product 243",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "product-owner@example.com",
        "full_name": "FirstName1522 LastName1523",
        "id": "00000000-0000-0000-0000-000000001d96",
        "role": {
          "id": "00000000-0000-0000-0000-000000001e3b",
          "name": "Admin 775"
        }
      },
      "product_group": {
        "id": "00000000-0000-0000-0000-000000000929",
        "name": "Product Group 99"
      },
      "quantity_available_threshold_max": "50",
      "quantity_available_threshold_min": "5",
      "sku": "sku 244",
      "strain": {
        "id": "00000000-0000-0000-0000-000000000063",
        "name": "Strain 14",
        "strain_type": "INDICA"
      },
      "subcategory": {
        "id": "00000000-0000-0000-0000-000000000932",
        "name": "Some subcategory 104"
      },
      "tags": [
        {
          "id": "00000000-0000-0000-0000-00000000003b",
          "name": "Tag 1"
        }
      ],
      "total_cannabinoid_unit": "PERCENT",
      "total_cbd": "3",
      "total_thc": "12",
      "treez_wholesale_price": "12.34",
      "unit_cost": null,
      "unit_net_weight": "20",
      "unit_net_weight_serving_size_unit_type": {
        "id": "00000000-0000-0000-0000-0000000120dc",
        "name": "Ounce"
      },
      "unit_price": "1",
      "unit_serving_size": "10",
      "unit_type": {
        "id": "00000000-0000-0000-0000-0000000120da",
        "name": "Gram"
      },
      "units_per_case": null,
      "upc": "036000291452",
      "updated_datetime": "2023-11-01T00:00:00.000000Z",
      "vendor": {
        "id": "00000000-0000-0000-0000-000000000e33",
        "name": "Company 548",
        "updated_datetime": "2030-11-03T00:00:00.000000Z"
      },
      "wholesale_unit_price": 90.5
    },
    {
      "brand": {
        "id": "00000000-0000-0000-0000-000000000e2f",
        "name": "Company 542",
        "updated_datetime": "2030-11-02T00:00:00.000000Z"
      },
      "category": {
        "id": "00000000-0000-0000-0000-000000000962",
        "name": "Some category 118",
        "official_product_category_id": "OTHER"
      },
      "creator": null,
      "custom_data": [
        {
          "id": 170,
          "name": "Custom Field 13",
          "value": null
        }
      ],
      "deleted_at": null,
      "description": null,
      "description_markdown": null,
      "external_name": null,
      "gross_weight": null,
      "gross_weight_unit_type": null,
      "id": "423c085a-c308-4777-bbe7-194665c899c3",
      "images": [],
      "inventory_tracking_method": "PACKAGE",
      "is_active": false,
      "is_featured": false,
      "leaflink_product_id": null,
      "menu_visibility": "DO_NOT_INCLUDE",
      "menus": [],
      "msrp": "100",
      "name": "Product 256",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "product-owner@example.com",
        "full_name": "FirstName1522 LastName1523",
        "id": "00000000-0000-0000-0000-000000001d96",
        "role": {
          "id": "00000000-0000-0000-0000-000000001e3b",
          "name": "Admin 775"
        }
      },
      "product_group": {
        "id": "00000000-0000-0000-0000-00000000092e",
        "name": "Product Group 104"
      },
      "quantity_available_threshold_max": null,
      "quantity_available_threshold_min": null,
      "sku": "sku 257",
      "strain": null,
      "subcategory": {
        "id": "00000000-0000-0000-0000-000000000937",
        "name": "Some subcategory 109"
      },
      "tags": [],
      "total_cannabinoid_unit": null,
      "total_cbd": null,
      "total_thc": null,
      "treez_wholesale_price": null,
      "unit_cost": null,
      "unit_net_weight": null,
      "unit_net_weight_serving_size_unit_type": null,
      "unit_price": "1",
      "unit_serving_size": null,
      "unit_type": {
        "id": "00000000-0000-0000-0000-0000000120d8",
        "name": "Pound"
      },
      "units_per_case": null,
      "upc": null,
      "updated_datetime": "2023-11-02T00:00:00.000000Z",
      "vendor": {
        "id": "00000000-0000-0000-0000-000000000e35",
        "name": "Company 556",
        "updated_datetime": "2030-11-04T00:00:00.000000Z"
      },
      "wholesale_unit_price": null
    }
  ],
  "next_page": null
}

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.

Required permission: products_permissions_view. Results are filtered to only include products the authenticated user can access under their team restrictions.

Request

GET /public/v1/products

Parameters

Parameter Description In Type Required Default Example
deleted Filter deleted products. no returns non-deleted, only returns deleted, include returns both. query string false no
ids Filter products by product ID (same UUID as each product's id in responses). query array false ?ids[]=550e8400-e29b-41d4-a716-446655440000&ids[]=6ba7b810-9dad-11d1-80b4-00c04fd430c8
include_bill_of_materials When true, each product includes its bill_of_materials (or null if it has none). Defaults to false. query boolean false false
inserted_datetime Filter products by their creation datetime query string false 2022-07-10T00:00:00Z,
menu_id Comma-separated public menu IDs; products in any of these menus are returned. Invalid tokens are ignored; if none remain, data is empty. query string false
menu_name Case-insensitive substring match on menu name. When combined with menu_id, both conditions apply (AND). query string false
page Pagination information query number false ?page[number]=1
product_name Filter products by name substring query string 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/products Updates a product with all optional fields set

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

{
  "brand_id": "00000000-0000-0000-0000-00000000106b",
  "category_id": "00000000-0000-0000-0000-000000000abc",
  "description": "My Product Description",
  "external_name": "External Name",
  "gross_weight": "9.9",
  "gross_weight_unit_type_id": "00000000-0000-0000-0000-000000014e89",
  "group_id": "00000000-0000-0000-0000-000000000a88",
  "id": "51c7c917-d7bc-4737-8fbc-143165b8d1b8",
  "inventory_tracking_method": "PACKAGE",
  "is_featured": true,
  "is_inactive": true,
  "menu_visibility": "INCLUDE_IN_ALL",
  "menus": [
    "00000000-0000-0000-0000-0000000000b4"
  ],
  "msrp": "100.5",
  "name": "Updated Name",
  "owner_id": "00000000-0000-0000-0000-000000002274",
  "quantity_available_threshold_max": "10.5",
  "quantity_available_threshold_min": "5.5",
  "sku": "45678",
  "strain_id": "00000000-0000-0000-0000-000000000079",
  "subcategory_id": "00000000-0000-0000-0000-000000000a8e",
  "tags": [
    "00000000-0000-0000-0000-00000000003e"
  ],
  "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-000000014e8b",
  "unit_price": "200",
  "unit_serving_size": "2.2",
  "unit_type_id": "00000000-0000-0000-0000-000000014e92",
  "units_per_case": "0.2",
  "upc": "036000291453",
  "vendor_id": "00000000-0000-0000-0000-000000001067",
  "wholesale_unit_price": "90.50"
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 76daa73870d395f6cee215ca221ffc4e-8689e0217ed4cbcb-0

{
  "data": {
    "brand": {
      "id": "00000000-0000-0000-0000-00000000106b",
      "name": "Company 1487",
      "updated_datetime": "2026-08-17T21:24:30.693914Z"
    },
    "category": {
      "id": "00000000-0000-0000-0000-000000000abc",
      "name": "Some category 464",
      "official_product_category_id": "OTHER"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1940@example.com",
      "full_name": "FirstName3950 LastName3951",
      "id": "00000000-0000-0000-0000-000000002248",
      "role": {
        "id": "00000000-0000-0000-0000-00000000230e",
        "name": "Admin 2010"
      }
    },
    "custom_data": [],
    "deleted_at": null,
    "description": "My Product Description",
    "description_markdown": "My Product Description",
    "external_name": "External Name",
    "gross_weight": "9.9",
    "gross_weight_unit_type": {
      "id": "00000000-0000-0000-0000-000000014e89",
      "name": "Gram"
    },
    "id": "51c7c917-d7bc-4737-8fbc-143165b8d1b8",
    "images": [
      {
        "id": "00000000-0000-0000-0000-000000000024",
        "name": "Image Name 132",
        "rank": 0,
        "url": "https://google.com/original-8.jpg"
      },
      {
        "id": "00000000-0000-0000-0000-000000000025",
        "name": "Image Name 133",
        "rank": 1,
        "url": "https://google.com/original-9.jpg"
      }
    ],
    "inventory_tracking_method": "PACKAGE",
    "is_active": false,
    "is_featured": true,
    "leaflink_product_id": null,
    "menu_visibility": "INCLUDE_IN_ALL",
    "menus": [
      {
        "menu_id": "00000000-0000-0000-0000-0000000000b4",
        "menu_name": "Menu 167"
      }
    ],
    "msrp": "100.5",
    "name": "Updated Name",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "user2@a.com",
      "full_name": "FirstName4040 LastName4041",
      "id": "00000000-0000-0000-0000-000000002274",
      "role": {
        "id": "00000000-0000-0000-0000-00000000233c",
        "name": "Admin 2056"
      }
    },
    "product_group": {
      "id": "00000000-0000-0000-0000-000000000a88",
      "name": "Product Group 450"
    },
    "quantity_available_threshold_max": "10.5",
    "quantity_available_threshold_min": "5.5",
    "sku": "45678",
    "strain": {
      "id": "00000000-0000-0000-0000-000000000079",
      "name": "Strain 34",
      "strain_type": null
    },
    "subcategory": {
      "id": "00000000-0000-0000-0000-000000000a8e",
      "name": "Some subcategory 452"
    },
    "tags": [
      {
        "id": "00000000-0000-0000-0000-00000000003e",
        "name": "Some tag 17"
      }
    ],
    "total_cannabinoid_unit": "PERCENT",
    "total_cbd": "5.2",
    "total_thc": "10.4",
    "treez_wholesale_price": null,
    "unit_cost": "50.4",
    "unit_net_weight": "3.1",
    "unit_net_weight_serving_size_unit_type": {
      "id": "00000000-0000-0000-0000-000000014e8b",
      "name": "Ounce"
    },
    "unit_price": "200",
    "unit_serving_size": "2.2",
    "unit_type": {
      "id": "00000000-0000-0000-0000-000000014e92",
      "name": "Unit"
    },
    "units_per_case": "0.2",
    "upc": "036000291453",
    "updated_datetime": "2026-08-17T21:24:30.726232Z",
    "vendor": {
      "id": "00000000-0000-0000-0000-000000001067",
      "name": "Company 1481",
      "updated_datetime": "2026-08-17T21:24:30.674997Z"
    },
    "wholesale_unit_price": 90.5
  }
}

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. Required permission: products_permissions_create to create a new product, products_permissions_edit (and access to the product under team restrictions) to update an existing product.

Request

POST /public/v1/products

Parameters

Parameter Description In Type Required Default Example
brand_id The ID of the company_relationship association with the brand (company) that is associated with this product. query query false
category_id The ID of the product category of the product. query string false
custom_data Custom data for this product body object false
description Description of the product. If this field is provided and description_markdown is not, the description field will overwrite any existing description_markdown field. query string false A pack of 5 pre-rolls
description_markdown The description of the product in markdown format. If this field is provided, description must also be provided. The markdown display only supports italic, bold, strikethrough and links. Use any other markdown formatting at your own risk. query string false A pack of 5 pre-rolls
external_name Customer-facing name for DistruCommerce menus and Order Tracker. Defaults to Product Name if left blank query string false
gross_weight The gross weight of the product. Must be set together with gross_weight_unit_type_id. query number false
gross_weight_unit_type_id The ID of the weight unit type the gross weight is measured in. Must be a weight-based unit type supported by Metrc, and set together with gross_weight. query string false
group_id The ID of the product's group. query string false
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
is_featured Whether the product is featured. Featured products will be displayed at the top of menus. query boolean false
is_inactive Whether the product is inactive from use. Inactive products can be set to active at any time. query boolean 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
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"]
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
name Name of the product query string false King Size Pre-rolls
owner_id The ID of the user that is deemed to be the owner of the product. query string 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
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
sku Stock Keeping Unit (SKU) for this product query string false SKU123
strain_id The ID of the strain associated with the product. query string false
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
tags A list of tags associated with the product. query array false ["0ef8347c-b714-4cd9-ba0e-872488bc9244", "daa0294c-833c-42bd-a133-b4c9e7f64017"]
total_cannabinoid_unit The unit of the THC/CBD content of the product (MG or PERCENT). 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
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
unit_cost The cost of the product per unit. query number false
unit_net_weight The net weight 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
unit_price The sale price of the product per unit. query number false
unit_serving_size The serving size of the product per unit. query number false
unit_type_id The ID of the unit type the product. query string false
units_per_case The number of units in a case of the product. query number false
upc Universal Product Code (UPC) for this product query string false 123456789012
vendor_id The ID of the company_relationship association with the vendor (company) that supplies this product. query string false
wholesale_unit_price The wholesale price of the product per unit. query number false

Responses

Status Description Schema
200 A single product ProductResponse

ProductCategory

Delete a product category

DELETE /public/v1/product-categories/:id soft-deletes a product category

DELETE /public/v1/product-categories/00000000-0000-0000-0000-00000000091b
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYzgxODExMjQtMDVhNy00NmU2LWJlOWQtZGUxZWNmZjU1ODk0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzE2MyIsInR5cCI6ImFjY2VzcyJ9.2_wuwRbu3E9GarbeFvO_NxO1S5Kf8-0V0N0YKu5jTUc

Response

204
cache-control: max-age=0, private, must-revalidate
b3: c2eb6c1fd4847bd02551702d9e209304-e1e3d3e88caa75af-0

Deletes the product category. This is a soft delete: the record's deleted_at is set and it is no longer returned by the API, but it is retained in the database.

Required permission: settings_permissions_product_categories.

Request

DELETE /public/v1/product-categories/{id}

Parameters

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

Responses

Status Description Schema
204 No Content
404 Not Found

Get a product category

GET /public/v1/product-categories/:id returns a single product category with embedded subcategories

GET /public/v1/product-categories/00000000-0000-0000-0000-000000000902
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZTBhN2RkNzgtOGUxMi00ZGY3LWE0NjAtOTQ1OGM1YmIyZDRhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjkzNyIsInR5cCI6ImFjY2VzcyJ9.tmpKZFCTEjgWaCv23JF6aPmQPfojYGUz3rRaIyXqEpY

Response

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

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000902",
    "inserted_datetime": "2026-08-17T21:24:25.618591Z",
    "name": "Edibles",
    "official_product_category_id": "OPC_2",
    "subcategories": [
      {
        "id": "00000000-0000-0000-0000-0000000008dc",
        "name": "Gummies"
      }
    ],
    "updated_datetime": "2026-08-17T21:24:25.618591Z"
  }
}

Get a single product category given the ID.

Required permission: settings_permissions_product_categories.

Request

GET /public/v1/product-categories/{id}

Parameters

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

Responses

Status Description Schema
200 A single product category ProductCategoryResponse
404 Not Found

Get product categories

GET /public/v1/product-categories returns paginated product categories with embedded subcategories

GET /public/v1/product-categories
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMmZmNDQ1NGQtOGM1Mi00NWVlLWJiYjYtOWM1NjdlOTRjZTYwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjgzOCIsInR5cCI6ImFjY2VzcyJ9.yeqZajpDIAte8F76iez8u74xNj9NvHb2VYPH_Zo65aA

Response

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

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-0000000008eb",
      "inserted_datetime": "2025-01-01T00:00:00.000000Z",
      "name": "PC1",
      "official_product_category_id": "OPC_1",
      "subcategories": [
        {
          "id": "00000000-0000-0000-0000-0000000008ca",
          "name": "SC1"
        }
      ],
      "updated_datetime": "2026-08-17T21:24:25.032586Z"
    },
    {
      "id": "00000000-0000-0000-0000-0000000008ee",
      "inserted_datetime": "2025-01-02T00:00:00.000000Z",
      "name": "PC2",
      "official_product_category_id": "OPC_1",
      "subcategories": [],
      "updated_datetime": "2026-08-17T21:24:25.035867Z"
    },
    {
      "id": "00000000-0000-0000-0000-0000000008ef",
      "inserted_datetime": "2025-01-03T00:00:00.000000Z",
      "name": "PC3",
      "official_product_category_id": "OPC_1",
      "subcategories": [],
      "updated_datetime": "2026-08-17T21:24:25.037179Z"
    }
  ],
  "next_page": "https://www.example.com/public/v1/product-categories?page[number]=2"
}

List product categories for the authenticated company.

Required permission: settings_permissions_product_categories.

Request

GET /public/v1/product-categories

Parameters

Parameter Description In Type Required Default Example
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of product categories ProductCategories

Upsert a product category

POST /public/v1/product-categories (update) updates a product category

POST /public/v1/product-categories
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGVmZDUyNTctYmQ3Yy00MTk1LThlNGItY2IwNDI3MzRkYjAwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njk5MyIsInR5cCI6ImFjY2VzcyJ9.BWW3CQopkomJ0pKB4A2EMDa_KkaTWVqqf6TvaqXtd1o

{
  "id": "00000000-0000-0000-0000-000000000907",
  "name": "New"
}

Response

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

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000907",
    "inserted_datetime": "2026-08-17T21:24:25.812691Z",
    "name": "New",
    "official_product_category_id": "OTHER",
    "subcategories": [
      {
        "id": "00000000-0000-0000-0000-0000000008e1",
        "name": "Gummies"
      }
    ],
    "updated_datetime": "2026-08-17T21:24:25.871073Z"
  }
}

Upsert a single product category. To update an existing product category, pass its ID in the id field. If you do not pass an ID, a new product category is created. When creating, name and official_product_category_id are required. The official_product_category_id cannot be changed once set.

Required permission: settings_permissions_product_categories.

Request

POST /public/v1/product-categories

Parameters

Parameter Description In Type Required Default Example
id Product category ID. If given, the matching product category is updated; otherwise a new one is created. query string false
name The name of the product category query string true
official_product_category_id The official product category ID this category maps to query string true

Responses

Status Description Schema
200 The updated product category ProductCategoryResponse
201 The created product category ProductCategoryResponse
400 Invalid parameters
404 Not Found

ProductGroup

Delete a product group

DELETE /public/v1/product-groups/:id deletes a product group

DELETE /public/v1/product-groups/00000000-0000-0000-0000-000000000928
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiYTMzYjBmYjUtMGJmZi00M2VmLWE4NTgtMzVlYWQ1MTU5ZjU4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzU3MyIsInR5cCI6ImFjY2VzcyJ9.abXTM0Lt43ed7dROP8VJTBJ79T7iSupfVsbtdKNz3XQ

Response

204
cache-control: max-age=0, private, must-revalidate
b3: 6bd11ab7a4c375d71fa09ad1b56e69bb-7107fe2b9c160a68-0

Permanently deletes the product group. This is a hard delete: the record is removed from the database and cannot be recovered.

Required permission: settings_permissions_product_groups.

Request

DELETE /public/v1/product-groups/{id}

Parameters

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

Responses

Status Description Schema
204 No Content
404 Not Found

Get a product group

GET /public/v1/product-groups/:id returns a single product group

GET /public/v1/product-groups/00000000-0000-0000-0000-0000000008fd
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiM2UzMTgzMmEtZDljMy00Y2M0LTg3NzAtNjQ1YjRhNDAzYzFmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzMyNiIsInR5cCI6ImFjY2VzcyJ9.taQiAaqb51Y4fOhGTtK22oNV1J_gRtznCPYqD7fgHhE

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 9451574a4e844f4d7396c68e4739275c-8667f0b2bd276f53-0

{
  "data": {
    "id": "00000000-0000-0000-0000-0000000008fd",
    "inserted_datetime": "2026-08-17T21:24:26.984075Z",
    "name": "Flower - Indoor",
    "updated_datetime": "2026-08-17T21:24:26.984075Z"
  }
}

Get a single product group given the ID.

Required permission: settings_permissions_product_groups.

Request

GET /public/v1/product-groups/{id}

Parameters

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

Responses

Status Description Schema
200 A single product group ProductGroupResponse
404 Not Found

Get product groups

GET /public/v1/product-groups returns paginated product groups for the company with next_page

GET /public/v1/product-groups
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMzljYjYzZDgtM2VhNi00ZTNiLWIzZGEtNWRkMWFjZTA4YzI4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzIyNyIsInR5cCI6ImFjY2VzcyJ9.Dimjir4s5J5tfMo_oOwQYuWWXLfhOWGD4NEnZI0UpWw

Response

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

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-0000000008eb",
      "inserted_datetime": "2026-08-17T21:24:26.687810Z",
      "name": "PG1",
      "updated_datetime": "2026-08-17T21:24:26.687810Z"
    },
    {
      "id": "00000000-0000-0000-0000-0000000008ec",
      "inserted_datetime": "2026-08-17T21:24:26.688200Z",
      "name": "PG2",
      "updated_datetime": "2026-08-17T21:24:26.688200Z"
    },
    {
      "id": "00000000-0000-0000-0000-0000000008ed",
      "inserted_datetime": "2026-08-17T21:24:26.688708Z",
      "name": "PG3",
      "updated_datetime": "2026-08-17T21:24:26.688708Z"
    }
  ],
  "next_page": "https://www.example.com/public/v1/product-groups?page[number]=2"
}

List product groups for the authenticated company.

Required permission: settings_permissions_product_groups.

Request

GET /public/v1/product-groups

Parameters

Parameter Description In Type Required Default Example
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of product groups ProductGroups

Upsert a product group

POST /public/v1/product-groups creates a product group

POST /public/v1/product-groups
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiNTg1ZjI0ZmItN2M4NC00NjAxLWJmNWEtYzk0MGJiMmIyYTY4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzUyOSIsInR5cCI6ImFjY2VzcyJ9.OipzFp9N9ujuMQV0tITuEh0aXLF3iNLtxI4WRMkSO58

{
  "name": "Flower - Indoor"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 412c7643e8de8f5516be7e82a4aa21cb-bec06637075c5214-0

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000921",
    "inserted_datetime": "2026-08-17T21:24:27.477071Z",
    "name": "Flower - Indoor",
    "updated_datetime": "2026-08-17T21:24:27.477071Z"
  }
}

Upsert a single product group. To update an existing product group, pass its ID in the id field. If you do not pass an ID, a new product group is created.

Required permission: settings_permissions_product_groups.

Request

POST /public/v1/product-groups

Parameters

Parameter Description In Type Required Default Example
id Product group ID. If given, the matching product group is updated; otherwise a new one is created. query string false
name The name of the product group query string true

Responses

Status Description Schema
200 The updated product group ProductGroupResponse
201 The created product group ProductGroupResponse
400 Invalid parameters
404 Not Found

ProductPosMapping

Create or update a product POS mapping

POST /public/v1/product-pos-mappings (upsert) creates a new Blaze mapping

POST /public/v1/product-pos-mappings
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYTVjN2JjZDQtZmM0OC00YWVmLWJjZTctMzJhMjMyMDVhMjY2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Nzc3OCIsInR5cCI6ImFjY2VzcyJ9.uacXLWNiYqYrAzSAdkgN2Qw8uY8qgVp6ZSH-JS4wOmY

{
  "blaze_product_id": "blaze_123",
  "blaze_retailer_id": "34e4c79f-eaf7-4d7a-b723-5c56599ab460",
  "product_id": "e7351672-cd47-412b-99d5-6dc77c74a5fa"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 62c83aa0a201625760e4b16cbc671da4-eb5e2a8cc417b13f-0

{
  "data": {
    "blaze_asset_id": null,
    "blaze_product_id": "blaze_123",
    "blaze_retailer_id": "34e4c79f-eaf7-4d7a-b723-5c56599ab460",
    "id": "00000000-0000-0000-0000-000000000021",
    "inserted_datetime": "2026-08-17T21:24:28.138036Z",
    "pos_type": "BLAZE",
    "product_id": "e7351672-cd47-412b-99d5-6dc77c74a5fa",
    "updated_datetime": "2026-08-17T21:24:28.138036Z"
  }
}

Upserts a POS mapping - creates if new, updates if exists.

The system determines if a mapping already exists by checking for an existing mapping with the same product_id and retailer_id combination. If found, it updates the existing mapping. If not found, it creates a new mapping.

Returns 201 for new mappings, 200 for updates.

Required permission: products_permissions_edit.

Request

POST /public/v1/product-pos-mappings

Parameters

Parameter Description In Type Required Default Example
mapping POS mapping data body UpsertProductPosMapping true

Responses

Status Description Schema
200 Updated existing mapping ProductPosMappingResponse
201 Created new mapping ProductPosMappingResponse
400 Bad Request
401 Unauthorized

Delete a product POS mapping

DELETE /public/v1/product-pos-mappings/:id deletes a POS mapping

DELETE /public/v1/product-pos-mappings/00000000-0000-0000-0000-000000000024
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiY2U2Mjg3MzItZWE1NC00NzdjLThhZjQtYzdiMmI2ODhlNWNhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODA0NSIsInR5cCI6ImFjY2VzcyJ9.9O7h_n3aPM0ueTGu2Rd77KoiIp8x9iucjE3eVbXAK8Y

Response

204
cache-control: max-age=0, private, must-revalidate
b3: f0998d38add98e2da66454fae348e6cf-bd803f308bcac4dd-0

Required permission: products_permissions_edit.

Request

DELETE /public/v1/product-pos-mappings/{id}

Parameters

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

Responses

Status Description Schema
204 No Content
401 Unauthorized
404 Not Found

Get a product POS mapping

GET /public/v1/product-pos-mappings/:id returns a single product POS mapping

GET /public/v1/product-pos-mappings/00000000-0000-0000-0000-000000000026
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjksImlhdCI6MTc4NzAwMTg2OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZmVhNmZmOGMtZjg1ZS00MDc5LThkZWYtZTBiZGMxODEwMWRmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODE5NCIsInR5cCI6ImFjY2VzcyJ9.z4QyG_I_9IeiCckeGJ2VgRIQU5eX2LVLD6vWD9UmTZM

Response

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

{
  "data": {
    "blaze_asset_id": null,
    "blaze_product_id": "blaze_123",
    "blaze_retailer_id": "d30533c6-e2b1-4235-8243-fe6cfc3f1457",
    "id": "00000000-0000-0000-0000-000000000026",
    "inserted_datetime": "2026-08-17T21:24:29.051169Z",
    "pos_type": "BLAZE",
    "product_id": "f69d0957-581b-40be-b971-79c270b48575",
    "updated_datetime": "2026-08-17T21:24:29.051169Z"
  }
}

Get a single product POS mapping given the ID.

Required permission: products_permissions_view.

Request

GET /public/v1/product-pos-mappings/{id}

Parameters

Parameter Description In Type Required Default Example
id Product POS Mapping ID path string true

Responses

Status Description Schema
200 A single product POS mapping ProductPosMappingResponse
404 Not Found

List product POS mappings

GET /public/v1/product-pos-mappings returns all POS mappings for company products and supports filtering

GET /public/v1/product-pos-mappings
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODI1MGZkZTAtZGY4NS00OWZkLWE0NWYtMzMyODE3MGUyMGU4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzE2MiIsInR5cCI6ImFjY2VzcyJ9._mhTGSfXKBF238wfYiY5ZBdKS08ZCfsSA3WCOjxXYq0

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 616abaf075e97db161aeaecdcc6bc930-03e3181ef567bb5d-0

{
  "data": [
    {
      "blaze_asset_id": null,
      "blaze_product_id": "blaze_123",
      "blaze_retailer_id": "a2b083df-46d4-4e23-891d-f3e2800f7b9b",
      "id": "00000000-0000-0000-0000-00000000001b",
      "inserted_datetime": "2026-08-17T21:24:26.586536Z",
      "pos_type": "BLAZE",
      "product_id": "61886d6c-f823-49b1-bc67-876f0c4ba321",
      "updated_datetime": "2026-08-17T21:24:26.586536Z"
    },
    {
      "dutchie_product_id": 456,
      "dutchie_retailer_id": "1cbbccbb-3661-4f3e-9c6b-eb5cacd3d367",
      "id": "00000000-0000-0000-0000-00000000001c",
      "inserted_datetime": "2026-08-17T21:24:26.618997Z",
      "pos_type": "DUTCHIE",
      "product_id": "d8bc648b-da80-4b09-887f-7d8e6b0ed7bc",
      "updated_datetime": "2026-08-17T21:24:26.618997Z"
    }
  ],
  "next_page": "https://www.example.com/public/v1/product-pos-mappings?page[number]=2"
}

Get POS mappings with optional filtering by product_id or retailer_id. Required permission: products_permissions_view.

Request

GET /public/v1/product-pos-mappings

Parameters

Parameter Description In Type Required Default Example
blaze_retailer_id Filter by Blaze retailer ID query string false
dutchie_retailer_id Filter by Dutchie retailer ID query string false
product_id Filter by product ID query string false
treez_retailer_id Filter by Treez retailer ID query string false

Responses

Status Description Schema
200 Success ProductPosMappingsResponse
400 Bad Request
401 Unauthorized

ProductSubcategory

Delete a product subcategory

DELETE /public/v1/product-subcategories/:id deletes the subcategory while leaving its siblings intact

DELETE /public/v1/product-subcategories/00000000-0000-0000-0000-0000000008e7
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOTVhZDUwMWEtNTBiNi00YWRmLWFiOWQtNzhjMDA3NTQxYTlmIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzA3MyIsInR5cCI6ImFjY2VzcyJ9.2tk691iKHqtimbmGLy8oC8KWvQ-z05SnCyM7qUtE1Lw

Response

204
cache-control: max-age=0, private, must-revalidate
b3: 754f1f7be20345a997e0a6013f2d7820-2c4eff0e9ce9fc74-0

Permanently deletes the product subcategory. Unlike product categories, subcategories are hard deleted: the record is removed from the database and cannot be recovered.

Required permission: settings_permissions_product_categories.

Request

DELETE /public/v1/product-subcategories/{id}

Parameters

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

Responses

Status Description Schema
204 No Content
404 Not Found

Get a product subcategory

GET /public/v1/product-subcategories/:id returns a single subcategory with embedded compact category

GET /public/v1/product-subcategories/00000000-0000-0000-0000-0000000008dd
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTY2NDM4N2EtMDFlOC00NjRlLWE2NGEtNzhhNWVlYzRiYjdjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njk0MSIsInR5cCI6ImFjY2VzcyJ9.Gly4WuOxu8w96y043eSlfvPOaOzGD-0qIHuRVPurqkM

Response

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

{
  "data": {
    "category": {
      "id": "00000000-0000-0000-0000-000000000903",
      "name": "Edibles",
      "official_product_category_id": "OPC_3"
    },
    "id": "00000000-0000-0000-0000-0000000008dd",
    "inserted_datetime": "2026-08-17T21:24:25.646609Z",
    "name": "Gummies",
    "updated_datetime": "2026-08-17T21:24:25.646609Z"
  }
}

Get a single product subcategory given the ID.

Required permission: settings_permissions_product_categories.

Request

GET /public/v1/product-subcategories/{id}

Parameters

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

Responses

Status Description Schema
200 A single product subcategory ProductSubcategoryResponse
404 Not Found

Get product subcategories

GET /public/v1/product-subcategories returns paginated subcategories for the company with next_page and category filter

GET /public/v1/product-subcategories
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTQ0Y2Q5NWMtYTQyZC00ZTJlLWFiMzMtMTE3M2M4YTc1N2Y2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg0MSIsInR5cCI6ImFjY2VzcyJ9.g9eshDiQeMhK9fvFu7qY8fQMFEN5YZaU5ls1-wwOoUo

Response

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

{
  "data": [
    {
      "category": {
        "id": "00000000-0000-0000-0000-0000000008ec",
        "name": "C1",
        "official_product_category_id": "OPC_0"
      },
      "id": "00000000-0000-0000-0000-0000000008c9",
      "inserted_datetime": "2025-01-01T00:00:00.000000Z",
      "name": "SC1",
      "updated_datetime": "2026-08-17T21:24:25.061461Z"
    },
    {
      "category": {
        "id": "00000000-0000-0000-0000-0000000008ec",
        "name": "C1",
        "official_product_category_id": "OPC_0"
      },
      "id": "00000000-0000-0000-0000-0000000008cb",
      "inserted_datetime": "2025-01-02T00:00:00.000000Z",
      "name": "SC2",
      "updated_datetime": "2026-08-17T21:24:25.079664Z"
    },
    {
      "category": {
        "id": "00000000-0000-0000-0000-0000000008ec",
        "name": "C1",
        "official_product_category_id": "OPC_0"
      },
      "id": "00000000-0000-0000-0000-0000000008cf",
      "inserted_datetime": "2025-01-03T00:00:00.000000Z",
      "name": "SC3",
      "updated_datetime": "2026-08-17T21:24:25.106002Z"
    }
  ],
  "next_page": "https://www.example.com/public/v1/product-subcategories?page[number]=2"
}

List product subcategories for the authenticated company.

Optionally filter by parent category with ?category_id=.

Required permission: settings_permissions_product_categories.

Request

GET /public/v1/product-subcategories

Parameters

Parameter Description In Type Required Default Example
category_id Only return subcategories belonging to this product category ID query string false
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of product subcategories ProductSubcategories

Upsert a product subcategory

POST /public/v1/product-subcategories creates a subcategory and returns the embedded compact category

POST /public/v1/product-subcategories
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjM1MzlhMTYtYWYzNi00NzUxLTg0NWItYTAzN2ExZjZhZjZjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzEyNyIsInR5cCI6ImFjY2VzcyJ9.nlpUc5Luq--vzuMzFKt8YdswaSZUFV0GwF1Q192qScM

{
  "name": "Gummies",
  "product_category_id": "00000000-0000-0000-0000-000000000916"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 0741f44055887f1cd33540457927125b-cf88e219c0dd030d-0

{
  "data": {
    "category": {
      "id": "00000000-0000-0000-0000-000000000916",
      "name": "Edibles",
      "official_product_category_id": "OPC_5"
    },
    "id": "00000000-0000-0000-0000-0000000008f0",
    "inserted_datetime": "2026-08-17T21:24:26.356044Z",
    "name": "Gummies",
    "updated_datetime": "2026-08-17T21:24:26.356044Z"
  }
}

Upsert a single product subcategory. To update an existing product subcategory, pass its ID in the id field. If you do not pass an ID, a new product subcategory is created. When creating, name and product_category_id are required. The parent category cannot be changed once set.

Required permission: settings_permissions_product_categories.

Request

POST /public/v1/product-subcategories

Parameters

Parameter Description In Type Required Default Example
id Product subcategory ID. If given, the matching product subcategory is updated; otherwise a new one is created. query string false
name The name of the product subcategory query string true
product_category_id The ID of the product category this subcategory belongs to query string true

Responses

Status Description Schema
200 The updated product subcategory ProductSubcategoryResponse
201 The created product subcategory ProductSubcategoryResponse
400 Invalid parameters
404 Not Found

Purchase

Get a purchase

GET /public/v1/purchases/:id returns a single purchase with its active payments

GET /public/v1/purchases/00000000-0000-0000-0000-0000000000ef
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NzMsImlhdCI6MTc4NzAwMTg3MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiYzNjNDg4ZmMtOWI3Ny00NDMzLTgyNmQtM2UwNzlhOTQ3MDBiIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODcyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6OTUyMCIsInR5cCI6ImFjY2VzcyJ9.X9oGVv-VSTlqxT-jPf5LEpS7SWbw58RSL9iET_6vlRw

Response

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

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "company_id": "00000000-0000-0000-0000-000000001c94",
      "id": "00000000-0000-0000-0000-0000000009b7",
      "license_id": null,
      "license_number": null,
      "name": "Place 637"
    },
    "biotrack_id": null,
    "charges": [
      {
        "id": "00f8ccdb-d6bc-441f-a51e-d4b3d3bf7f2e",
        "name": "C1",
        "percent": "10.0000",
        "price": "1.00",
        "tax": {
          "id": "00000000-0000-0000-0000-00000000002c",
          "name": "T1"
        },
        "type": "CHARGE",
        "unit_type": "PERCENT"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-0000000011e3",
      "name": "Company 1971",
      "updated_datetime": "2026-08-17T21:24:33.404871Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-2683@example.com",
      "full_name": "FirstName5440 LastName5441",
      "id": "00000000-0000-0000-0000-00000000253b",
      "role": {
        "id": "00000000-0000-0000-0000-0000000025f7",
        "name": "Admin 2755"
      }
    },
    "custom_data": [
      {
        "id": 226,
        "name": "Custom Field 46",
        "value": "Custom Field Value 1"
      }
    ],
    "description": null,
    "due_datetime": "2026-08-17T21:24:33.424950Z",
    "id": "00000000-0000-0000-0000-0000000000ef",
    "inserted_datetime": "2026-08-17T21:24:33.425286Z",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000b02",
          "name": "B2155"
        },
        "compliance_quantity": null,
        "id": "6e689fbb-9699-4bfb-8d56-9f4a3dff9df9",
        "is_sample": false,
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 90210, US",
          "company_id": "00000000-0000-0000-0000-000000001c94",
          "id": "00000000-0000-0000-0000-0000000009b6",
          "license_id": null,
          "name": "Place 636"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "5c536a88-9721-4b3b-8d32-2c300a3834a3",
          "name": "Product 2144",
          "sku": "sku 2145",
          "updated_datetime": "2026-08-17T21:24:33.430959Z"
        },
        "quantity": "15.000000000",
        "received_quantity": "0.000000000"
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000b03",
          "name": "B2158"
        },
        "compliance_quantity": null,
        "id": "27523b9f-f603-470c-bf4c-af23eaa1c9ed",
        "is_sample": false,
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 90210, US",
          "company_id": "00000000-0000-0000-0000-000000001c94",
          "id": "00000000-0000-0000-0000-0000000009b6",
          "license_id": null,
          "name": "Place 636"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "391f1f77-6078-4f33-8b92-d86f2180e248",
          "name": "Product 2148",
          "sku": "sku 2149",
          "updated_datetime": "2026-08-17T21:24:33.436113Z"
        },
        "quantity": "10.000000000",
        "received_quantity": "0.000000000"
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000b04",
          "name": "B2159"
        },
        "compliance_quantity": null,
        "id": "c298e148-c685-45ca-a243-e65d989defb1",
        "is_sample": false,
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 90210, US",
          "company_id": "00000000-0000-0000-0000-000000001c94",
          "id": "00000000-0000-0000-0000-0000000009b6",
          "license_id": null,
          "name": "Place 636"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "93f8c1a5-bbfd-46e6-8db9-8dcfb98ec71c",
          "name": "Product 2151",
          "sku": "sku 2152",
          "updated_datetime": "2026-08-17T21:24:33.441024Z"
        },
        "quantity": "5.000000000",
        "received_quantity": "0.000000000"
      },
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000b05",
          "name": "B2160"
        },
        "compliance_quantity": null,
        "id": "a0606649-5b14-4ec5-8f80-83cc0ad0990d",
        "is_sample": false,
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 90210, US",
          "company_id": "00000000-0000-0000-0000-000000001c94",
          "id": "00000000-0000-0000-0000-0000000009b6",
          "license_id": null,
          "name": "Place 636"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10",
        "product": {
          "id": "7da8e46d-32ee-4828-b023-b0b218145d6a",
          "name": "Product 2153",
          "sku": "sku 2154",
          "updated_datetime": "2026-08-17T21:24:33.446097Z"
        },
        "quantity": "2.000000000",
        "received_quantity": "0.000000000"
      }
    ],
    "location": {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "company_id": "00000000-0000-0000-0000-000000001c94",
      "id": "00000000-0000-0000-0000-0000000009b6",
      "license_id": null,
      "license_number": null,
      "name": "Place 636"
    },
    "metrc_transfer_id": null,
    "order_datetime": "2026-08-17T21:24:33.424950Z",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-2683@example.com",
      "full_name": "FirstName5440 LastName5441",
      "id": "00000000-0000-0000-0000-00000000253b",
      "role": {
        "id": "00000000-0000-0000-0000-0000000025f7",
        "name": "Admin 2755"
      }
    },
    "paid": "100.01",
    "payment_status": "NOT_PAID",
    "payments": [
      {
        "amount": "100.01",
        "company": {
          "id": "00000000-0000-0000-0000-0000000011e3",
          "name": "Company 1971",
          "updated_datetime": "2026-08-17T21:24:33.404871Z"
        },
        "credit_uses": null,
        "description": "Payment for purchase",
        "fully_paid_with_credits": false,
        "id": "00000000-0000-0000-0000-00000000005f",
        "inserted_datetime": "2026-08-17T21:24:33.465126Z",
        "invoice": null,
        "overpayment_credits": null,
        "payment_date": "2020-01-01T00:00:00.000000Z",
        "payment_method": {
          "active": true,
          "deleted_at": null,
          "id": "00000000-0000-0000-0000-000000000080",
          "inserted_datetime": "2026-08-17T21:24:33.464282Z",
          "name": "Payment Method 37",
          "qb_payment_method_id": null,
          "type": "CREDIT_CARD",
          "updated_datetime": "2026-08-17T21:24:33.464282Z"
        },
        "payment_number": "PYT-1",
        "payment_type": "PURCHASE",
        "purchase": {
          "id": "00000000-0000-0000-0000-0000000000ef",
          "purchase_number": "Purchase #66",
          "status": "PENDING",
          "total": "32.00"
        },
        "quickbooks_deposit_account_id": null,
        "status": "POSTED",
        "updated_datetime": "2026-08-17T21:24:33.465126Z"
      }
    ],
    "purchase_number": "Purchase #66",
    "qb_bill_id": null,
    "status": "PENDING",
    "supplier_location": null,
    "total": "32.00",
    "updated_datetime": "2026-08-17T21:24:33.425286Z"
  }
}

Get a single purchase given the ID.

Required permission: purchases_permissions_view.

Request

GET /public/v1/purchases/{id}

Parameters

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

Responses

Status Description Schema
200 A single purchase PurchaseResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMWI2MjI0MDgtNzFiZC00ODIxLTkxNzYtMmRkOWU4ZjAxMzU3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzYzOCIsInR5cCI6ImFjY2VzcyJ9.1xJpMgnPr6M-DnFsqKaH7TKgUpRrGySaKXEjBUboVBI

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 75b71365f708ed32b9149df14ed3b8c6-3513a30e5414926d-0

{
  "data": [
    {
      "billing_location": {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-00000000172b",
        "id": "00000000-0000-0000-0000-00000000081d",
        "license_id": null,
        "license_number": null,
        "name": "Place 227"
      },
      "biotrack_id": null,
      "charges": [],
      "company": {
        "id": "00000000-0000-0000-0000-000000000e65",
        "name": "Company 635",
        "updated_datetime": "2026-08-17T21:24:27.877809Z"
      },
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-887@example.com",
        "full_name": "FirstName1820 LastName1821",
        "id": "00000000-0000-0000-0000-000000001e26",
        "role": {
          "id": "00000000-0000-0000-0000-000000001e7c",
          "name": "Admin 840"
        }
      },
      "custom_data": [
        {
          "id": 175,
          "name": "Custom Field 17",
          "value": null
        }
      ],
      "description": null,
      "due_datetime": "2026-08-17T21:24:27.921391Z",
      "id": "00000000-0000-0000-0000-0000000000b9",
      "inserted_datetime": "2026-08-17T21:24:27.922246Z",
      "items": [
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000000008a1",
            "name": "B321"
          },
          "compliance_quantity": null,
          "id": "4aff4e0e-f407-45ad-bcad-30a1145cb748",
          "is_sample": false,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 90210, US",
            "company_id": "00000000-0000-0000-0000-00000000172b",
            "id": "00000000-0000-0000-0000-000000000817",
            "license_id": null,
            "name": "Place 222"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "096c980b-282e-47a0-9b5e-40781da48e8d",
            "name": "Product 298",
            "sku": "sku 299",
            "updated_datetime": "2026-08-17T21:24:27.933926Z"
          },
          "quantity": "15.000000000",
          "received_quantity": "0.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000000008a2",
            "name": "B322"
          },
          "compliance_quantity": null,
          "id": "da741bdc-c4b3-420f-9db2-7fd6cd59a12c",
          "is_sample": false,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 90210, US",
            "company_id": "00000000-0000-0000-0000-00000000172b",
            "id": "00000000-0000-0000-0000-000000000817",
            "license_id": null,
            "name": "Place 222"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "d6d0d7a1-ccd5-4466-aa36-31c50ee76b25",
            "name": "Product 305",
            "sku": "sku 306",
            "updated_datetime": "2026-08-17T21:24:27.948987Z"
          },
          "quantity": "10.000000000",
          "received_quantity": "0.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000000008a3",
            "name": "B323"
          },
          "compliance_quantity": null,
          "id": "9034a666-5b87-4abb-85bc-8e544a9c5363",
          "is_sample": false,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 90210, US",
            "company_id": "00000000-0000-0000-0000-00000000172b",
            "id": "00000000-0000-0000-0000-000000000817",
            "license_id": null,
            "name": "Place 222"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "e8874e72-be4c-44e5-af60-a653a95703a7",
            "name": "Product 310",
            "sku": "sku 311",
            "updated_datetime": "2026-08-17T21:24:27.960807Z"
          },
          "quantity": "5.000000000",
          "received_quantity": "0.000000000"
        },
        {
          "batch": {
            "batch_number": null,
            "id": "00000000-0000-0000-0000-0000000008a4",
            "name": "B324"
          },
          "compliance_quantity": null,
          "id": "5cf4f0db-3b47-4ae7-b1f8-4ac12a23e578",
          "is_sample": false,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 90210, US",
            "company_id": "00000000-0000-0000-0000-00000000172b",
            "id": "00000000-0000-0000-0000-000000000817",
            "license_id": null,
            "name": "Place 222"
          },
          "package": null,
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "24bacd74-ef7f-4ade-9e90-478ef46853d0",
            "name": "Product 319",
            "sku": "sku 320",
            "updated_datetime": "2026-08-17T21:24:27.971757Z"
          },
          "quantity": "2.000000000",
          "received_quantity": "0.000000000"
        }
      ],
      "location": {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-00000000172b",
        "id": "00000000-0000-0000-0000-000000000817",
        "license_id": null,
        "license_number": null,
        "name": "Place 222"
      },
      "metrc_transfer_id": null,
      "order_datetime": "2026-08-17T21:24:27.921390Z",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-887@example.com",
        "full_name": "FirstName1820 LastName1821",
        "id": "00000000-0000-0000-0000-000000001e26",
        "role": {
          "id": "00000000-0000-0000-0000-000000001e7c",
          "name": "Admin 840"
        }
      },
      "paid": "0",
      "payment_status": "NOT_PAID",
      "payments": [],
      "purchase_number": "Purchase #16",
      "qb_bill_id": null,
      "status": "PENDING",
      "supplier_location": null,
      "total": "32.00",
      "updated_datetime": "2026-08-17T21:24:27.922246Z"
    },
    {
      "billing_location": {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-00000000172b",
        "id": "00000000-0000-0000-0000-000000000814",
        "license_id": null,
        "license_number": null,
        "name": "Place 218"
      },
      "biotrack_id": null,
      "charges": [
        {
          "id": "ad584429-772f-4d62-8750-ebaf609f030b",
          "name": "C1",
          "percent": "10.0000",
          "price": "1.00",
          "tax": {
            "id": "00000000-0000-0000-0000-000000000029",
            "name": "T1"
          },
          "type": "CHARGE",
          "unit_type": "PERCENT"
        }
      ],
      "company": {
        "id": "00000000-0000-0000-0000-000000000e5e",
        "name": "Company 623",
        "updated_datetime": "2030-11-01T00:00:00.000000Z"
      },
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "purchase-owner@example.com",
        "full_name": "FirstName1658 LastName1659",
        "id": "00000000-0000-0000-0000-000000001ddb",
        "role": {
          "id": "00000000-0000-0000-0000-000000001e81",
          "name": "Admin 845"
        }
      },
      "custom_data": [
        {
          "id": 175,
          "name": "Custom Field 17",
          "value": "Custom Field Value 1"
        }
      ],
      "description": "A description of this purchase",
      "due_datetime": "2020-01-01T00:00:01.000000Z",
      "id": "00000000-0000-0000-0000-0000000000b8",
      "inserted_datetime": "2020-01-01T00:00:03.000000Z",
      "items": [
        {
          "batch": {
            "batch_number": "UID1",
            "id": "00000000-0000-0000-0000-000000000896",
            "name": "B1"
          },
          "compliance_quantity": "1.0000",
          "id": "32ca75c1-cf12-4569-b4a2-e2f87934c908",
          "is_sample": false,
          "location": {
            "address": "123 Fake Street, Beverly Hills, CA 90210, US",
            "company_id": "00000000-0000-0000-0000-00000000172b",
            "id": "00000000-0000-0000-0000-00000000080b",
            "license_id": "00000000-0000-0000-0000-000000000214",
            "name": "Place 209"
          },
          "package": {
            "batch_number": "B1",
            "compliance_label": "ABCDEF012345670000000021",
            "id": "00000000-0000-0000-0000-0000000000e3",
            "metrc_label": "ABCDEF012345670000000021",
            "status": "active"
          },
          "price": "10.000000000",
          "price_base": "10",
          "product": {
            "id": "00f7fa80-cfbf-4206-8743-aa5069a7b7f1",
            "name": "P1",
            "sku": "SKU1",
            "updated_datetime": "2023-11-02T00:00:00.000000Z"
          },
          "quantity": "1.000000000",
          "received_quantity": "1.000000000"
        }
      ],
      "location": {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-00000000172b",
        "id": "00000000-0000-0000-0000-000000000813",
        "license_id": null,
        "license_number": null,
        "name": "Place 217"
      },
      "metrc_transfer_id": null,
      "order_datetime": "2020-01-01T00:00:02.000000Z",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "purchase-owner@example.com",
        "full_name": "FirstName1658 LastName1659",
        "id": "00000000-0000-0000-0000-000000001ddb",
        "role": {
          "id": "00000000-0000-0000-0000-000000001e81",
          "name": "Admin 845"
        }
      },
      "paid": "0",
      "payment_status": "NOT_PAID",
      "payments": [],
      "purchase_number": "SO-123",
      "qb_bill_id": null,
      "status": "COMPLETED",
      "supplier_location": null,
      "total": "10.00",
      "updated_datetime": "2020-01-01T00:00:04.000000Z"
    }
  ],
  "next_page": null
}

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.

Required permission: purchases_permissions_view. Results are filtered to only include purchases the authenticated user can access under their team restrictions.

Request

GET /public/v1/purchases

Parameters

Parameter Description In Type Required Default 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 query number false ?page[number]=1
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-0000000000f6/payments
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NzMsImlhdCI6MTc4NzAwMTg3MywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMmYxODAyMDEtOTJiNS00NDNiLTg2ZWQtOTc2NThhOTI2ZmMzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODcyLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6OTY4NiIsInR5cCI6ImFjY2VzcyJ9.JNX5RA1Pwmv8uT4PoR-ajxO65qqU0xne6uh1XRJgODk

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

Response

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

{
  "data": {
    "amount": "100.01",
    "company": {
      "id": "00000000-0000-0000-0000-000000001255",
      "name": "Company 2097",
      "updated_datetime": "2026-08-17T21:24:33.953311Z"
    },
    "credit_uses": null,
    "description": "Payment for purchase",
    "fully_paid_with_credits": false,
    "id": "00000000-0000-0000-0000-000000000063",
    "inserted_datetime": "2026-08-17T21:24:33.965959Z",
    "invoice": null,
    "overpayment_credits": null,
    "payment_date": "2020-01-01T00:00:00.000000Z",
    "payment_method": {
      "active": true,
      "deleted_at": null,
      "id": "00000000-0000-0000-0000-000000000084",
      "inserted_datetime": "2026-08-17T21:24:33.959659Z",
      "name": "Payment Method 0",
      "qb_payment_method_id": null,
      "type": "CREDIT_CARD",
      "updated_datetime": "2026-08-17T21:24:33.959659Z"
    },
    "payment_number": "PYT-0000001",
    "payment_type": "PURCHASE",
    "purchase": {
      "id": "00000000-0000-0000-0000-0000000000f6",
      "purchase_number": "Purchase #72",
      "status": "PENDING",
      "total": "32.00"
    },
    "quickbooks_deposit_account_id": "QBD-123",
    "quickbooks_deposit_account_name": "QBD-NAME",
    "status": "POSTED",
    "updated_datetime": "2026-08-17T21:24:33.965959Z"
  }
}

Required permission: purchases_permissions_make_payments. The authenticated user must also be allowed to view purchases under their team restrictions.

Request

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

Parameters

Parameter Description In Type Required Default Example
amount Amount of the payment. Will round to 2 decimal places query decimal true
description Description of the payment query string true
payment_datetime Payment date query string true
payment_method_id Payment method ID 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 PaymentResponse

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NzEsImlhdCI6MTc4NzAwMTg3MSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNjY3Nzc0MjktYjNjZi00NGYyLWE1NTUtYWM1YjcxOTNhNTI5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODcwLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6OTE2NiIsInR5cCI6ImFjY2VzcyJ9.VIbJsaHfPJTYNhtNgZRe6-jORRGG74E_EWVvijeXTks

{
  "billing_location_id": "00000000-0000-0000-0000-000000000957",
  "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-000000001118",
  "custom_data": {
    "224": [
      "A",
      "B"
    ]
  },
  "description": "A description of this purchase",
  "due_datetime": "2020-01-30T00:00:00.000000Z",
  "items": [
    {
      "location_id": "00000000-0000-0000-0000-000000000955",
      "price": "10.000000000",
      "product_id": "fbb559da-23e9-4dd6-94e7-d229f6badfb9",
      "quantity": "1.000000000"
    }
  ],
  "location_id": "00000000-0000-0000-0000-000000000955",
  "order_datetime": "2020-01-01T00:00:00.000000Z",
  "owner_id": "00000000-0000-0000-0000-0000000023ce"
}

Response

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

{
  "data": {
    "billing_location": {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "company_id": "00000000-0000-0000-0000-000000001b95",
      "id": "00000000-0000-0000-0000-000000000957",
      "license_id": null,
      "license_number": null,
      "name": "Place 541"
    },
    "biotrack_id": null,
    "charges": [
      {
        "id": "a821f74a-8fca-40cd-b04c-cf442e050551",
        "name": "C1",
        "percent": "10.0000",
        "price": "1.00",
        "type": "CHARGE",
        "unit_type": "PERCENT"
      },
      {
        "id": "8de35284-d3dd-4a80-b9b1-3c035881ca2e",
        "name": "C2",
        "percent": null,
        "price": "-5.00",
        "type": "DISCOUNT",
        "unit_type": "PRICE"
      }
    ],
    "company": {
      "id": "00000000-0000-0000-0000-000000001118",
      "name": "Company 1715",
      "updated_datetime": "2026-08-17T21:24:31.889870Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-0000000023ce",
      "role": {
        "id": "00000000-0000-0000-0000-000000002496",
        "name": "Admin 2402"
      }
    },
    "custom_data": [
      {
        "id": 224,
        "name": "Custom Field 44",
        "value": "A,B"
      }
    ],
    "description": "A description of this purchase",
    "due_datetime": "2020-01-30T00:00:00.000000Z",
    "id": "00000000-0000-0000-0000-0000000000de",
    "inserted_datetime": "2026-08-17T21:24:31.954784Z",
    "items": [
      {
        "batch": {
          "batch_number": null,
          "id": "00000000-0000-0000-0000-000000000a61",
          "name": "B1"
        },
        "compliance_quantity": null,
        "id": "a268a3b8-a68f-42f5-ba1b-3959df1eb0bc",
        "is_sample": false,
        "location": {
          "address": "123 Fake Street, Beverly Hills, CA 90210, US",
          "company_id": "00000000-0000-0000-0000-000000001b95",
          "id": "00000000-0000-0000-0000-000000000955",
          "license_id": "00000000-0000-0000-0000-000000000276",
          "name": "Place 539"
        },
        "package": null,
        "price": "10.000000000",
        "price_base": "10.000000000",
        "product": {
          "id": "fbb559da-23e9-4dd6-94e7-d229f6badfb9",
          "name": "P1",
          "sku": "SKU1",
          "updated_datetime": "2026-08-17T21:24:31.932297Z"
        },
        "quantity": "1.000000000",
        "received_quantity": "0.000000000"
      }
    ],
    "location": {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "company_id": "00000000-0000-0000-0000-000000001b95",
      "id": "00000000-0000-0000-0000-000000000955",
      "license_id": "00000000-0000-0000-0000-000000000276",
      "license_number": "CDPH-00000122",
      "name": "Place 539"
    },
    "metrc_transfer_id": null,
    "order_datetime": "2020-01-01T00:00:00.000000Z",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "user1@a.com",
      "full_name": "John Foo",
      "id": "00000000-0000-0000-0000-0000000023ce",
      "role": {
        "id": "00000000-0000-0000-0000-000000002496",
        "name": "Admin 2402"
      }
    },
    "paid": "0",
    "payment_status": "NOT_PAID",
    "payments": [],
    "purchase_number": "PO-0000001",
    "qb_bill_id": null,
    "status": "PENDING",
    "supplier_location": null,
    "total": "6.00",
    "updated_datetime": "2026-08-17T21:24:31.962798Z"
  }
}

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. Required permission: purchases_permissions_create to create a new purchase order, purchases_permissions_edit (and access to the purchase under team restrictions) to update an existing purchase order.

Request

POST /public/v1/purchases

Parameters

Parameter Description In Type Required Default Example
billing_location_id The billing address for this purchase order query string true
charges The additional lines of Charge, Discount, or Tax added to this purchase order body PurchaseChargesRequest false
company_id The company that is the supplier for this purchase order query string true
custom_data A map of custom field IDs to their values. Use GET /public/v1/custom-fields?model_name=purchase to retrieve available custom fields and their IDs. body object false {"123":"Custom Value 1","456":"Custom Value 2"}
description A description of the purchase order query string false
due_datetime The datetime by which the purchase order should be paid query string true
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
items The items present on this purchase order body PurchaseItemsRequest true
location_id The location into which the inventory in this purchase will be received query string true
order_datetime The datetime on which the purchase order was placed query string true
owner_id The ID of the Distru user that owns this purchase order query string false

Responses

Status Description Schema
200 A single purchase orders PurchaseResponse

Reports

Get the Cost of Goods Sold report

GET /public/v1/reports/cogs returns one Final row per completed order line item as {data, meta}, narrowed by order date

GET /public/v1/reports/cogs?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNTE2ZmU2OTItMzM5Zi00YjQwLThjM2MtYjkyMGEwMjQ1NWE3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjgyNiIsInR5cCI6ImFjY2VzcyJ9.VVf35QAvXTQd3yjdcFiFD-nhkue99b14OHoe6DoMfRY

Response

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

{
  "data": [
    {
      "batch": "",
      "cost_origin": "",
      "final_input": "Final",
      "margin_actual": "",
      "margin_default": "",
      "metrc_production_batch_number": "",
      "order_number": "SO-1",
      "package": "",
      "product_brand": "",
      "product_category": "Some category 10",
      "product_name": "Alpha",
      "profit_unit_actual": "",
      "profit_unit_default": "",
      "quantity": 4,
      "sku": "SKU-A",
      "total_cost_actual": "",
      "total_cost_default": "",
      "total_price": 40,
      "total_profits_actual": "",
      "total_profits_default": "",
      "unit_cost_actual": "",
      "unit_cost_default": "",
      "unit_price": 10,
      "unit_type": "Gram"
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "order_number",
        "label": "Order Number"
      },
      {
        "key": "final_input",
        "label": "Final/Input"
      },
      {
        "key": "cost_origin",
        "label": "Cost Origin"
      },
      {
        "key": "product_name",
        "label": "Product Name"
      },
      {
        "key": "sku",
        "label": "SKU"
      },
      {
        "key": "product_brand",
        "label": "Product Brand"
      },
      {
        "key": "product_category",
        "label": "Product Category"
      },
      {
        "key": "package",
        "label": "Package"
      },
      {
        "key": "metrc_production_batch_number",
        "label": "Metrc Production Batch Number"
      },
      {
        "key": "batch",
        "label": "Batch"
      },
      {
        "key": "quantity",
        "label": "Quantity"
      },
      {
        "key": "unit_type",
        "label": "Unit Type"
      },
      {
        "key": "unit_price",
        "label": "Unit Price"
      },
      {
        "key": "total_price",
        "label": "Total Price"
      },
      {
        "key": "unit_cost_actual",
        "label": "Unit Cost (Actual)"
      },
      {
        "key": "unit_cost_default",
        "label": "Unit Cost (Default)"
      },
      {
        "key": "total_cost_actual",
        "label": "Total Cost (Actual)"
      },
      {
        "key": "total_cost_default",
        "label": "Total Cost (Default)"
      },
      {
        "key": "total_profits_actual",
        "label": "Total Profits (Actual)"
      },
      {
        "key": "total_profits_default",
        "label": "Total Profits (Default)"
      },
      {
        "key": "profit_unit_actual",
        "label": "Profit/Unit (Actual)"
      },
      {
        "key": "profit_unit_default",
        "label": "Profit/Unit (Default)"
      },
      {
        "key": "margin_actual",
        "label": "Margin (Actual)"
      },
      {
        "key": "margin_default",
        "label": "Margin (Default)"
      }
    ],
    "date_range": "Aug 17, 2026",
    "report": "cogs"
  }
}

Returns one row per completed sales order line item over the reported date range, with the product's descriptive attributes (name, SKU, brand, category), its package, batch, and Metrc production batch, plus the item's quantity, unit type, unit and total price, and both actual and default cost figures (unit cost, total cost, total profit, profit per unit, and margin). Only line items on Completed orders that have not been fully returned are included. When neither order_datetime nor delivery_datetime is provided, the report defaults to orders from the last 30 days (by order date) to avoid scanning your entire order history.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. Companies on the BioTrack compliance integration do not get the metrc_production_batch_number column. Report-level information (the resolved date and column definitions) is returned under meta.

Required permission: reports_permissions_cogs.

Request

GET /public/v1/reports/cogs

Parameters

Parameter Description In Type Required Default Example
delivery_datetime Filter by delivery date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
order_datetime Filter by order date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z

Responses

Status Description Schema
200 The Cost of Goods Sold report CogsReport

Get the Cultivation Transaction History report

GET /public/v1/reports/cultivation-transaction-history returns one row per cultivation transaction as {data, meta}, filtered by strain and type

GET /public/v1/reports/cultivation-transaction-history?datetime=2000-01-01T00%3A00%3A00Z%2C2999-01-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiM2FmNjBiNGQtYjVkZC00ZDA1LTk5NDYtOGE5NmQzMWE2YWIzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzIyOCIsInR5cCI6ImFjY2VzcyJ9.ZVCP-f4UcwPhYYzUuik62YnxFdBv1VabJWwX_Courzg

Response

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

{
  "data": [
    {
      "amount": 1,
      "batch_name": "Plant Group 3083",
      "date": "08/17/2026",
      "description": null,
      "package_label_s": null,
      "plant_tag_s": null,
      "product_name": null,
      "related_entity": null,
      "related_entity_status": null,
      "strain": "Blue Dream",
      "type": "Plant Batch Creation",
      "unit": "Unit"
    },
    {
      "amount": 1,
      "batch_name": "Plant Group 6596",
      "date": "08/17/2026",
      "description": null,
      "package_label_s": null,
      "plant_tag_s": null,
      "product_name": null,
      "related_entity": null,
      "related_entity_status": null,
      "strain": "OG Kush",
      "type": "Plant Batch Creation",
      "unit": "Unit"
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "date",
        "label": "Date"
      },
      {
        "key": "strain",
        "label": "Strain"
      },
      {
        "key": "batch_name",
        "label": "Batch Name"
      },
      {
        "key": "plant_tag_s",
        "label": "Plant Tag(s)"
      },
      {
        "key": "product_name",
        "label": "Product Name"
      },
      {
        "key": "package_label_s",
        "label": "Package Label(s)"
      },
      {
        "key": "type",
        "label": "Type"
      },
      {
        "key": "related_entity",
        "label": "Related Entity"
      },
      {
        "key": "related_entity_status",
        "label": "Related Entity Status"
      },
      {
        "key": "amount",
        "label": "Amount"
      },
      {
        "key": "unit",
        "label": "Unit"
      },
      {
        "key": "description",
        "label": "Description"
      }
    ],
    "date_range": "Dec 31, 1999 to Dec 31, 2998",
    "report": "cultivation_transaction_history"
  }
}

Returns one row per cultivation transaction over the reported date range, covering the full plant lifecycle: plant batch creations, adjustments and splits, growth phase changes, plant moves, destructions, additive applications, teardowns, harvests, waste, and packaging. Each row carries the transaction's date, strain, batch name, plant tag(s), product name, package label(s), type, the related entity (teardown or harvest) and its status, the signed amount and unit, and the transaction's description. When no date filter is provided, the report defaults to the last 30 days.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. The total_cost column is omitted for users without permission to view costs. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_cultivation_transaction_history.

Request

GET /public/v1/reports/cultivation-transaction-history

Parameters

Parameter Description In Type Required Default Example
datetime Filter by transaction date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
license_ids Filter by license IDs query array false
plant_batch_ids Filter by plant batch (plant group) IDs query array false
strain Filter by an exact strain name query string false
transaction_type Filter by a single transaction type query string false Move Plant(s)

Responses

Status Description Schema
200 The Cultivation Transaction History report CultivationTransactionHistoryReport

Get the Harvest Outputs report

GET /public/v1/reports/harvest-outputs returns one row per assembly line item as {data, meta}, filtered by status

GET /public/v1/reports/harvest-outputs
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMjZlN2MwMjctNzcyNC00MzVhLTgwNDAtZTQxM2YzYmE3Nzg5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njk1OCIsInR5cCI6ImFjY2VzcyJ9.fbdlV7NDy7snysSncDnIfpTySbnxV5V6TEDlyQOPbqk

Response

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

{
  "data": [
    {
      "cost_input_output": "Output",
      "distru_product": "Product 110",
      "harvest_assembly_date": "08/17/2026",
      "harvest_assembly_number": "HAS-0000001",
      "harvest_name": "Spring-Hill-Kush-#2-08/17/2026",
      "line_item_id": "b7ce0b3c-5008-4105-aba1-27b5f7269e4d",
      "location": "Place 122",
      "output_batch_number": null,
      "output_package_number": "1A4010200001234000000000",
      "output_reference_id": null,
      "product_category": "Some category 61",
      "quantity": 10,
      "status": "PENDING",
      "strain": "Spring Hill Kush #2",
      "unit_type": "Gram"
    },
    {
      "cost_input_output": "Input",
      "distru_product": "Spring-Hill-Kush-#2-08/17/2026",
      "harvest_assembly_date": "08/17/2026",
      "harvest_assembly_number": "HAS-0000001",
      "harvest_name": "Spring-Hill-Kush-#2-08/17/2026",
      "line_item_id": "6184216e-a5d9-4950-9dec-5b55780374aa",
      "location": "Place 77",
      "output_batch_number": null,
      "output_package_number": null,
      "output_reference_id": null,
      "product_category": null,
      "quantity": 10,
      "status": "PENDING",
      "strain": "Spring Hill Kush #2",
      "unit_type": "Gram"
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "harvest_assembly_date",
        "label": "Harvest Assembly Date"
      },
      {
        "key": "harvest_assembly_number",
        "label": "Harvest Assembly Number"
      },
      {
        "key": "status",
        "label": "Status"
      },
      {
        "key": "harvest_name",
        "label": "Harvest Name"
      },
      {
        "key": "output_batch_number",
        "label": "Output Batch Number"
      },
      {
        "key": "output_package_number",
        "label": "Output Package Number"
      },
      {
        "key": "strain",
        "label": "Strain"
      },
      {
        "key": "location",
        "label": "Location"
      },
      {
        "key": "cost_input_output",
        "label": "Cost/Input/Output"
      },
      {
        "key": "distru_product",
        "label": "Distru Product"
      },
      {
        "key": "product_category",
        "label": "Product Category"
      },
      {
        "key": "quantity",
        "label": "Quantity"
      },
      {
        "key": "unit_type",
        "label": "Unit Type"
      },
      {
        "key": "line_item_id",
        "label": "Line Item ID"
      },
      {
        "key": "output_reference_id",
        "label": "Output Reference ID"
      }
    ],
    "date_range": "Aug 10, 2026 to Aug 17, 2026",
    "report": "harvest_outputs"
  }
}

Returns one row per line item of every harvest assembly over the reported date range. Each assembly expands into its inputs (the harvested material consumed), its outputs (the products produced, with their batch and package numbers), and its cost line items — the cost_input_output column identifies which. Every row carries the assembly's date, number, and status, plus the harvest name, strain, location, product, product category, quantity, and unit type. When no date filter is provided, the report defaults to the last 7 days.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. The cost columns (unit_cost_actual, unit_cost_default, total_cost_actual, total_cost_default, cost_type, cost_type_description) are omitted for users without permission to view costs. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_harvest_outputs.

Request

GET /public/v1/reports/harvest-outputs

Parameters

Parameter Description In Type Required Default Example
datetime Filter by harvest harvest assembly date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
harvest_name Filter by harvest name (partial match) query string false
location_id Filter by a single input location ID query string false
output_product_category_id Filter by a single output product category ID query string false
output_product_name Filter by output product name (partial match) query string false
status Filter by harvest assembly status query string false COMPLETED
strain Filter by strain (partial match) query string false

Responses

Status Description Schema
200 The Harvest Outputs report HarvestOutputsReport

Get the Inventory Assets report

GET /public/v1/reports/inventory-assets returns one row per on-hand asset as {data, meta}, filtered by location

GET /public/v1/reports/inventory-assets
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOTMxOGU2MDItMzdjZi00ZDk1LWJjYjUtM2MzNzVkNjcxYjk2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njk1MiIsInR5cCI6ImFjY2VzcyJ9.c5AOzgXvIaf6Y_QFFuVSJqefQxnyrr4jxcyaScanGHE

Response

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

{
  "data": [
    {
      "active_quantity": 100,
      "assembling_quantity": 0,
      "batch_number": "B1",
      "category": "Some category 25",
      "expiration_date": null,
      "harvest_date": null,
      "license": null,
      "location": "L1",
      "owner": "FirstName262 LastName263",
      "package_number": null,
      "product": "Widget",
      "selling_quantity": 0,
      "sku": "sku 42",
      "subcategory": "Some subcategory 21",
      "tracking_method": "BATCH",
      "unit_price": 1.0,
      "unit_type": "Gram",
      "vendor": "Company 121"
    },
    {
      "active_quantity": 50,
      "assembling_quantity": 0,
      "batch_number": "B1",
      "category": "Some category 25",
      "expiration_date": null,
      "harvest_date": null,
      "license": null,
      "location": "L2",
      "owner": "FirstName262 LastName263",
      "package_number": null,
      "product": "Widget",
      "selling_quantity": 0,
      "sku": "sku 42",
      "subcategory": "Some subcategory 21",
      "tracking_method": "BATCH",
      "unit_price": 1.0,
      "unit_type": "Gram",
      "vendor": "Company 121"
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "product",
        "label": "Product"
      },
      {
        "key": "license",
        "label": "License"
      },
      {
        "key": "location",
        "label": "Location"
      },
      {
        "key": "package_number",
        "label": "Package Number"
      },
      {
        "key": "batch_number",
        "label": "Batch Number"
      },
      {
        "key": "sku",
        "label": "SKU"
      },
      {
        "key": "vendor",
        "label": "Vendor"
      },
      {
        "key": "owner",
        "label": "Owner"
      },
      {
        "key": "unit_type",
        "label": "Unit Type"
      },
      {
        "key": "active_quantity",
        "label": "Active Quantity"
      },
      {
        "key": "assembling_quantity",
        "label": "Assembling Quantity"
      },
      {
        "key": "selling_quantity",
        "label": "Selling Quantity"
      },
      {
        "key": "category",
        "label": "Category"
      },
      {
        "key": "subcategory",
        "label": "Subcategory"
      },
      {
        "key": "unit_price",
        "label": "Unit Price"
      },
      {
        "key": "expiration_date",
        "label": "Expiration Date"
      },
      {
        "key": "tracking_method",
        "label": "Tracking Method"
      },
      {
        "key": "harvest_date",
        "label": "Harvest Date"
      }
    ],
    "date_range": "Aug 17, 2026 - 2:24PM",
    "report": "inventory_assets"
  }
}

Returns one row per on-hand inventory asset (a product at a location, batch, or package) with its descriptive attributes (product, SKU, vendor, owner, unit type, category, subcategory, license, location, package number, batch number), its active, assembling, and selling quantities, its unit price, and its actual and default unit and total costs. Quantities and costs are point-in-time: pass datetime to snapshot the position at a past moment (defaults to now).

Pass style=granular to expand each asset into its underlying cost inputs — this adds the final_input, cost_origin, and cost_quantity columns and requires permission to view cost details. Cost columns are omitted for users without permission to view costs.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. Report-level information (the resolved date and column definitions) is returned under meta.

Required permission: reports_permissions_inventory_assets.

Request

GET /public/v1/reports/inventory-assets

Parameters

Parameter Description In Type Required Default Example
datetime Point-in-time snapshot as an ISO8601 datetime (defaults to now) query string false 2026-07-01T00:00:00Z
location_id Filter by a single location ID query string false
style Row granularity (defaults to collapsed) query string false granular

Responses

Status Description Schema
200 The Inventory Assets report InventoryAssetsReport

Get the Inventory Transaction History report

GET /public/v1/reports/inventory-transaction-history returns one row per inventory transaction as {data, meta}, honoring the date filter

GET /public/v1/reports/inventory-transaction-history
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMjVhYzcxMGUtM2EzMi00YTMxLWJkODItMzJmZDZiNjQzNWE2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzA5MCIsInR5cCI6ImFjY2VzcyJ9.b7rKn5YbA-8LDCdLajwVtkWBUq4m3xfpedYYF_d4i-Y

Response

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

{
  "data": [
    {
      "amount": 100,
      "batch_id": "00000000-0000-0000-0000-00000000085e",
      "batch_number": null,
      "cbd": null,
      "cbd_mg_g": null,
      "cbd_mg_ml": null,
      "company_relationship_id": null,
      "date": "2026-08-17T21:24:26.317078Z",
      "description": "FirstName572 LastName573 moved 100 g of Batch B1 of Widget from gain to active in Place 76 with reason 'revaluation'",
      "metrc_production_batch_number": null,
      "metrc_unit_name": null,
      "package_batch_number_or_batch_name": "B1",
      "package_label": null,
      "product": "Widget",
      "product_id": "ceab3e57-fc55-48b2-8134-9b8572357def",
      "related_entity": "Stock Adjustment",
      "related_entity_customer_vendor": null,
      "related_entity_status": null,
      "thc": null,
      "thc_mg_g": null,
      "thc_mg_ml": null,
      "total_cbd": null,
      "total_cbd_mg_g": null,
      "total_cbd_mg_ml": null,
      "total_cost": null,
      "total_thc": null,
      "total_thc_mg_g": null,
      "total_thc_mg_ml": null,
      "type": "adjustment",
      "unit_type": "Gram"
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "date",
        "label": "Date"
      },
      {
        "key": "product",
        "label": "Product"
      },
      {
        "key": "package_batch_number_or_batch_name",
        "label": "Package Batch Number or Batch Name"
      },
      {
        "key": "batch_number",
        "label": "Batch Number"
      },
      {
        "key": "package_label",
        "label": "Package Label"
      },
      {
        "key": "metrc_production_batch_number",
        "label": "Metrc Production Batch Number"
      },
      {
        "key": "type",
        "label": "Type"
      },
      {
        "key": "related_entity",
        "label": "Related Entity"
      },
      {
        "key": "related_entity_status",
        "label": "Related Entity Status"
      },
      {
        "key": "related_entity_customer_vendor",
        "label": "Related Entity Customer/Vendor"
      },
      {
        "key": "amount",
        "label": "Amount"
      },
      {
        "key": "unit_type",
        "label": "Unit Type"
      },
      {
        "key": "metrc_unit_name",
        "label": "Metrc Unit Name"
      },
      {
        "key": "product_id",
        "label": "Product Id"
      },
      {
        "key": "batch_id",
        "label": "Batch Id"
      },
      {
        "key": "company_relationship_id",
        "label": "Company Relationship Id"
      },
      {
        "key": "description",
        "label": "Description"
      },
      {
        "key": "thc",
        "label": "THC %"
      },
      {
        "key": "total_thc",
        "label": "Total THC %"
      },
      {
        "key": "thc_mg_g",
        "label": "THC mg/g"
      },
      {
        "key": "thc_mg_ml",
        "label": "THC mg/mL"
      },
      {
        "key": "total_thc_mg_g",
        "label": "Total THC mg/g"
      },
      {
        "key": "total_thc_mg_ml",
        "label": "Total THC mg/mL"
      },
      {
        "key": "cbd",
        "label": "CBD %"
      },
      {
        "key": "total_cbd",
        "label": "Total CBD %"
      },
      {
        "key": "cbd_mg_g",
        "label": "CBD mg/g"
      },
      {
        "key": "cbd_mg_ml",
        "label": "CBD mg/mL"
      },
      {
        "key": "total_cbd_mg_g",
        "label": "Total CBD mg/g"
      },
      {
        "key": "total_cbd_mg_ml",
        "label": "Total CBD mg/mL"
      },
      {
        "key": "total_cost",
        "label": "Total Cost"
      }
    ],
    "date_range": "Jul 18, 2026 to Aug 17, 2026",
    "report": "inventory_transaction_history"
  }
}

Returns one row per inventory transaction over the reported date range, with the transaction's date, product, package and batch identifiers, Metrc production batch number, type, related entity (order, return, assembly, stock adjustment, etc.) and its status and customer/vendor, the amount and unit type, package potency figures (THC/CBD), and the transaction's total cost. When no date filter is provided, the report defaults to the last 30 days.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. Companies on the BioTrack compliance integration do not get the metrc_unit_name and metrc_production_batch_number columns. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_inventory_transaction_history.

Request

GET /public/v1/reports/inventory-transaction-history

Parameters

Parameter Description In Type Required Default Example
batch_ids Filter by batch IDs query array false
datetime Filter by transaction date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
package_id Filter by a single package ID query string false
product_ids Filter by product IDs query array false

Responses

Status Description Schema
200 The Inventory Transaction History report InventoryTransactionHistoryReport

Get the Inventory Valuation report

GET /public/v1/reports/inventory-valuation returns one row per product as {data, meta}, valued and filtered per params

GET /public/v1/reports/inventory-valuation
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOWExMDcwNGUtOGEzYi00OGU1LThjMmUtMmExNWVhMjE2MzNlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzE4MyIsInR5cCI6ImFjY2VzcyJ9.tK0vgcs8xLKKBjeUcqwwdLG7s8IDCEfXpqRmxGGbF58

Response

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

{
  "data": [
    {
      "active_quantity": 5.0,
      "active_value_price": 50.0,
      "assembling_quantity": 0.0,
      "available_quantity": 5.0,
      "brand": null,
      "category": "Some category 51",
      "group": "Product Group 30",
      "image_url": null,
      "incoming_quantity": 0.0,
      "inventory_threshold_max": null,
      "inventory_threshold_min": null,
      "name": "Alpha",
      "owner": "FirstName736 LastName739",
      "pending_output_quantity": 0.0,
      "reserved_quantity": 0.0,
      "sku": "sku 84",
      "subcategory": "Some subcategory 44",
      "unit_cost": 4.0,
      "unit_price": 10.0,
      "unit_type": "Gram",
      "vendor": "Company 285"
    },
    {
      "active_quantity": 0.0,
      "active_value_price": 0.0,
      "assembling_quantity": 0.0,
      "available_quantity": 0.0,
      "brand": null,
      "category": "Some category 53",
      "group": "Product Group 33",
      "image_url": null,
      "incoming_quantity": 0.0,
      "inventory_threshold_max": null,
      "inventory_threshold_min": null,
      "name": "Beta",
      "owner": "FirstName736 LastName739",
      "pending_output_quantity": 0.0,
      "reserved_quantity": 0.0,
      "sku": "sku 91",
      "subcategory": "Some subcategory 47",
      "unit_cost": 4.0,
      "unit_price": 10.0,
      "unit_type": "Gram",
      "vendor": "Company 292"
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "name",
        "label": "Name"
      },
      {
        "key": "sku",
        "label": "SKU"
      },
      {
        "key": "vendor",
        "label": "Vendor"
      },
      {
        "key": "unit_type",
        "label": "Unit Type"
      },
      {
        "key": "category",
        "label": "Category"
      },
      {
        "key": "subcategory",
        "label": "Subcategory"
      },
      {
        "key": "group",
        "label": "Group"
      },
      {
        "key": "owner",
        "label": "Owner"
      },
      {
        "key": "active_quantity",
        "label": "Active Quantity"
      },
      {
        "key": "assembling_quantity",
        "label": "Assembling Quantity"
      },
      {
        "key": "reserved_quantity",
        "label": "Reserved Quantity"
      },
      {
        "key": "available_quantity",
        "label": "Available Quantity"
      },
      {
        "key": "incoming_quantity",
        "label": "Incoming Quantity"
      },
      {
        "key": "pending_output_quantity",
        "label": "Pending Output Quantity"
      },
      {
        "key": "unit_cost",
        "label": "Unit Cost"
      },
      {
        "key": "unit_price",
        "label": "Unit Price"
      },
      {
        "key": "inventory_threshold_max",
        "label": "Inventory Threshold Max"
      },
      {
        "key": "inventory_threshold_min",
        "label": "Inventory Threshold Min"
      },
      {
        "key": "active_value_price",
        "label": "Active Value (Price)"
      },
      {
        "key": "image_url",
        "label": "Image URL"
      },
      {
        "key": "brand",
        "label": "Brand"
      }
    ],
    "date_range": "Aug 17, 2026",
    "report": "inventory_valuation"
  }
}

Returns one row per product with its current on-hand position — active, assembling, reserved, available, incoming, and pending-output quantities — alongside the product's descriptive attributes (SKU, vendor, brand, unit type, category, subcategory, group, owner), its unit cost and price, its inventory alert thresholds, and its active inventory value. The active value is priced by unit price by default; pass calculation_method=cost to value it by unit cost instead, which also renames the value column (active_value_price becomes active_value_cost).

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. Any Product custom fields configured for the company are appended as extra columns. Report-level information (the resolved date and column definitions) is returned under meta.

Required permission: reports_permissions_inventory_valuation.

Request

GET /public/v1/reports/inventory-valuation

Parameters

Parameter Description In Type Required Default Example
brand_ids Filter by brand (company relationship) IDs query array false
calculation_method How to value active inventory (defaults to price) query string false cost
location_ids Filter by location IDs query array false
search Search by product name or SKU query string false
user_ids Filter by user IDs query array false
vendor_ids Filter by vendor (company relationship) IDs query array false

Responses

Status Description Schema
200 The Inventory Valuation report InventoryValuationReport

Get the Invoice History report

GET /public/v1/reports/invoice-history returns one row per invoice as {data, meta}, narrowed by the applied filters

GET /public/v1/reports/invoice-history?invoice_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMzc4MjJlZjEtN2Q3Ni00OGEzLTliN2UtNWZlOWMxZmQ5ODMxIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njk0OCIsInR5cCI6ImFjY2VzcyJ9.I6QBMN7LpTNeb8sZYk9iP-JhnwXGj_bOc1SuKVFbM88

Response

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

{
  "data": [
    {
      "charge_summary": null,
      "customer": "Company 124",
      "discount_summary": null,
      "due_date": "2026-08-17",
      "invoice_date": "2026-07-01",
      "invoice_number": "INV-2",
      "line_item_subtotal": 0.0,
      "outstanding": 500.0,
      "owner": "FirstName284 LastName285",
      "paid": 0.0,
      "sales_order": "SO-14",
      "status": "NOT_PAID",
      "tax_summary": null,
      "total": "500.00",
      "total_charges": 0.0,
      "total_discounts": 0.0,
      "total_taxes": 0.0
    },
    {
      "charge_summary": null,
      "customer": "Company 119",
      "discount_summary": null,
      "due_date": "2026-08-17",
      "invoice_date": "2026-07-01",
      "invoice_number": "INV-1",
      "line_item_subtotal": 0.0,
      "outstanding": 1.0e3,
      "owner": "FirstName248 LastName249",
      "paid": 0.0,
      "sales_order": "SO-13",
      "status": "FULLY_PAID",
      "tax_summary": null,
      "total": "1000.00",
      "total_charges": 0.0,
      "total_discounts": 0.0,
      "total_taxes": 0.0
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "invoice_date",
        "label": "Invoice Date"
      },
      {
        "key": "invoice_number",
        "label": "Invoice Number"
      },
      {
        "key": "due_date",
        "label": "Due Date"
      },
      {
        "key": "sales_order",
        "label": "Sales Order"
      },
      {
        "key": "customer",
        "label": "Customer"
      },
      {
        "key": "status",
        "label": "Status"
      },
      {
        "key": "paid",
        "label": "Paid"
      },
      {
        "key": "outstanding",
        "label": "Outstanding"
      },
      {
        "key": "line_item_subtotal",
        "label": "Line Item Subtotal"
      },
      {
        "key": "total_taxes",
        "label": "Total Taxes"
      },
      {
        "key": "tax_summary",
        "label": "Tax Summary"
      },
      {
        "key": "total_charges",
        "label": "Total Charges"
      },
      {
        "key": "charge_summary",
        "label": "Charge Summary"
      },
      {
        "key": "total_discounts",
        "label": "Total Discounts"
      },
      {
        "key": "discount_summary",
        "label": "Discount Summary"
      },
      {
        "key": "total",
        "label": "Total"
      },
      {
        "key": "owner",
        "label": "Owner"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "invoice_history"
  }
}

Returns one row per invoice with its dates, sales order, customer, status, and monetary totals (paid, outstanding, line item subtotal, taxes, charges, discounts, total) along with the tax, charge, and discount summaries. When no date filter is provided, the report defaults to the last 30 days.

Every value is returned as it appears in the report's CSV export, with numeric cells (monetary amounts) parsed into numbers. Companies on a compliance integration (Metrc or BioTrack) get additional manifest and shipped-from-license columns, and any Invoice custom fields configured for the company are appended as extra columns. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_invoice_history.

Request

GET /public/v1/reports/invoice-history

Parameters

Parameter Description In Type Required Default Example
batch_ids Filter by batch IDs query array false
company_relationship_ids Filter by customer (company relationship) IDs query array false
due_datetime Filter by due date range query string false
invoice_datetime Filter by invoice date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
order_status Filter by the invoice's sales order status query array false ["COMPLETED"]
paid Filter by paid amount range (comma-separated min,max) query string false
product_ids Filter by product IDs query array false
search Search by invoice number query string false
shipped_from_license_ids Filter by the shipped-from license IDs query array false
status Filter by invoice payment status query array false ["FULLY_PAID"]
total Filter by invoice total range (comma-separated min,max) query string false 100,500

Responses

Status Description Schema
200 The Invoice History report InvoiceHistoryReport

Get the Order Fulfillment report

GET /public/v1/reports/order-fulfillment returns one row per product pivoted across orders as {data, meta}, narrowed by filters

GET /public/v1/reports/order-fulfillment?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZDE3NzVjOGQtZmM0Zi00OWRkLWJjNzgtMjQ0MTliYmU4YzRjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjgzNCIsInR5cCI6ImFjY2VzcyJ9.uYASR5TgkEWq_Qc94H2GiZPo7fE-aFKkR0bgZoGaDn8

Response

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

{
  "data": [
    {
      "category": "Some category 8",
      "group": "Product Group 0",
      "product": "A1",
      "so_1": 3,
      "so_2": "",
      "subcategory": "Some subcategory 3",
      "total_units": 3,
      "total_value": 30.0,
      "unit_price": 10.0
    },
    {
      "category": "Some category 13",
      "group": "Product Group 4",
      "product": "B2",
      "so_1": 1,
      "so_2": 4,
      "subcategory": "Some subcategory 10",
      "total_units": 5,
      "total_value": 100.0,
      "unit_price": 20.0
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "product",
        "label": "Product"
      },
      {
        "key": "group",
        "label": "Group"
      },
      {
        "key": "category",
        "label": "Category"
      },
      {
        "key": "subcategory",
        "label": "Subcategory"
      },
      {
        "key": "so_1",
        "label": "SO-1"
      },
      {
        "key": "so_2",
        "label": "SO-2"
      },
      {
        "key": "total_units",
        "label": "Total Units"
      },
      {
        "key": "unit_price",
        "label": "Unit Price"
      },
      {
        "key": "total_value",
        "label": "Total Value"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "order_fulfillment"
  }
}

Returns one row per product sold over the reported date range, pivoted across the matching sales orders: alongside the product's group, category, and subcategory, each row carries one dynamic column per order (keyed by the slugified order number, e.g. so_1042) holding the quantity of that product on that order, plus the product's total units, unit price, and total value. When no date filter is provided, the report defaults to the last 30 days. Canceled and merged orders are always excluded.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. Because the per-order columns are dynamic, the exact set of keys on each row and in meta.columns depends on which orders match the filters. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_order_fulfillment.

Request

GET /public/v1/reports/order-fulfillment

Parameters

Parameter Description In Type Required Default Example
company_relationship_ids Filter by customer (company relationship) IDs query array false
location_ids Filter by the order item location IDs query array false
order_datetime Filter by order date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
owner_ids Filter by order owner (sales rep) IDs query array false
product_ids Filter by product IDs query array false
search Search by order number, customer name, or LeafLink short ID query string false
status Filter by sales order status query array false ["COMPLETED","DELIVERED"]
user_ids Filter by the order item user IDs query array false

Responses

Status Description Schema
200 The Order Fulfillment report OrderFulfillmentReport

Get the Plant Lifecycle report

GET /public/v1/reports/plant-lifecycle returns one row per plant batch as {data, meta}, filtered by strain

GET /public/v1/reports/plant-lifecycle?datetime=2000-01-01T00%3A00%3A00Z%2C2999-01-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZGMzODYyODAtYTU1My00MTM0LWE5MGItMDNiZWE3NDdjZDEyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzA0MiIsInR5cCI6ImFjY2VzcyJ9.aBfVP26XLGN7NwecdicgZOprQGlQuvuHprL0w222AD0

Response

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

{
  "data": [
    {
      "batch_creation_date": "08/17/2026",
      "days_as_batch": 0,
      "days_veg_to_last_harvest": null,
      "first_harvest_date": null,
      "harvest_name_s": null,
      "last_harvest_date": null,
      "plant_batch_name": "Plant Group 3784",
      "plants_destroyed": 0,
      "plants_harvested": 0,
      "plants_promoted_to_veg": 0,
      "plants_started": 2,
      "promoted_to_veg_date": null,
      "strain": "Blue Dream",
      "total_lifecycle_days": 0
    },
    {
      "batch_creation_date": "08/17/2026",
      "days_as_batch": 0,
      "days_veg_to_last_harvest": null,
      "first_harvest_date": null,
      "harvest_name_s": null,
      "last_harvest_date": null,
      "plant_batch_name": "Plant Group 6025",
      "plants_destroyed": 0,
      "plants_harvested": 0,
      "plants_promoted_to_veg": 0,
      "plants_started": 3,
      "promoted_to_veg_date": null,
      "strain": "OG Kush",
      "total_lifecycle_days": 0
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "plant_batch_name",
        "label": "Plant Batch Name"
      },
      {
        "key": "batch_creation_date",
        "label": "Batch Creation Date"
      },
      {
        "key": "strain",
        "label": "Strain"
      },
      {
        "key": "plants_started",
        "label": "Plants Started"
      },
      {
        "key": "plants_promoted_to_veg",
        "label": "Plants Promoted to Veg"
      },
      {
        "key": "plants_destroyed",
        "label": "Plants Destroyed"
      },
      {
        "key": "plants_harvested",
        "label": "Plants Harvested"
      },
      {
        "key": "promoted_to_veg_date",
        "label": "Promoted to Veg Date"
      },
      {
        "key": "first_harvest_date",
        "label": "First Harvest Date"
      },
      {
        "key": "last_harvest_date",
        "label": "Last Harvest Date"
      },
      {
        "key": "days_as_batch",
        "label": "Days as Batch"
      },
      {
        "key": "days_veg_to_last_harvest",
        "label": "Days Veg to Last Harvest"
      },
      {
        "key": "total_lifecycle_days",
        "label": "Total Lifecycle Days"
      },
      {
        "key": "harvest_name_s",
        "label": "Harvest Name(s)"
      }
    ],
    "date_range": "Dec 31, 1999 to Dec 31, 2998",
    "report": "plant_lifecycle"
  }
}

Returns one row per plant batch (plant group) whose creation date falls in the reported range, summarizing its lifecycle: the batch name, creation date, strain, and the counts of plants started, promoted to vegetative, destroyed, and harvested. Each row also carries the promotion-to-veg date, first and last harvest dates, the durations spent as a batch, from veg to last harvest, and over the total lifecycle (in days), and the names of the harvests the batch produced.

Only plant batches on active Metrc licenses that can track vegetative plants are included. When no date filter is provided, the report defaults to the last 30 days (by batch creation date). Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. The cost columns (total_cost_batch_stage, total_cost_veg_to_last_harvest, destroyed_plant_cost, total_lifecycle_cost) are omitted for users without permission to view costs. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_plant_lifecycle.

Request

GET /public/v1/reports/plant-lifecycle

Parameters

Parameter Description In Type Required Default Example
datetime Filter by plant batch creation date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
strain Filter by strain (partial match) query string false

Responses

Status Description Schema
200 The Plant Lifecycle report PlantLifecycleReport

Get the Purchase Order History report

GET /public/v1/reports/purchase-order-history returns one row per purchase as {data, meta}, narrowed by the applied filters

GET /public/v1/reports/purchase-order-history?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZTFlOTlkM2ItMGZjYy00YTRlLThlMWQtZDlkMmFlZDZiMjQ0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njk1OSIsInR5cCI6ImFjY2VzcyJ9.mhiyL3ZNRi2Oxw45-FS_NBptorHdhpabEvuband-7CE

Response

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

{
  "data": [
    {
      "amount": "500.00",
      "due_date": "2026-08-17T14:24:25.735451",
      "owner": "FirstName288 LastName289",
      "paid": "0.0",
      "purchase_date": "2026-07-01T05:00:00.000000",
      "purchase_number": "PO-2",
      "status": "PENDING",
      "vendor": "Company 126"
    },
    {
      "amount": "1000.00",
      "due_date": "2026-08-17T14:24:25.721192",
      "owner": "FirstName272 LastName273",
      "paid": "0.0",
      "purchase_date": "2026-07-01T05:00:00.000000",
      "purchase_number": "PO-1",
      "status": "COMPLETED",
      "vendor": "Company 123"
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "purchase_date",
        "label": "Purchase Date"
      },
      {
        "key": "due_date",
        "label": "Due Date"
      },
      {
        "key": "purchase_number",
        "label": "Purchase Number"
      },
      {
        "key": "vendor",
        "label": "Vendor"
      },
      {
        "key": "status",
        "label": "Status"
      },
      {
        "key": "paid",
        "label": "Paid"
      },
      {
        "key": "amount",
        "label": "Amount"
      },
      {
        "key": "owner",
        "label": "Owner"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "purchase_order_history"
  }
}

Returns one row per purchase with its dates, vendor, status, and monetary totals (paid, amount). When no date filter is provided, the report defaults to the last 30 days.

Every value is returned as it appears in the report's CSV export, with numeric cells (monetary amounts) parsed into numbers. Companies on a compliance integration (Metrc or BioTrack) get an additional manifest number column, and any Purchase custom fields configured for the company are appended as extra columns. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_purchase_order_history.

Request

GET /public/v1/reports/purchase-order-history

Parameters

Parameter Description In Type Required Default Example
batch_ids Filter by batch IDs query array false
company_relationship_ids Filter by vendor (company relationship) IDs query array false
created_datetime Filter by the datetime the purchase was created query string false
creator_ids Filter by purchase creator (user) IDs query array false
due_datetime Filter by due date range query string false
location_ids Filter by receiving warehouse (location) IDs query array false
order_datetime Filter by purchase date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
owner_ids Filter by purchase owner (user) IDs query array false
paid Filter by paid amount range (comma-separated min,max) query string false
product_ids Filter by product IDs query array false
search Search by purchase number query string false
status Filter by purchase status query array false ["COMPLETED","DELIVERING"]
total Filter by purchase total range (comma-separated min,max) query string false 100,500
updated_datetime Filter by the datetime the purchase was last modified query string false

Responses

Status Description Schema
200 The Purchase Order History report PurchaseOrderHistoryReport

Get the Purchases By Company report

GET /public/v1/reports/purchases-by-company returns one row per vendor as {data, meta}, narrowed by the applied filters

GET /public/v1/reports/purchases-by-company?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNWZlODk4YjItMmU4ZC00MTQ2LWFhNzctMWMyM2Y5MDU2YzQzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzA4MiIsInR5cCI6ImFjY2VzcyJ9.L9syM75oGy8cOJeOlN9L5jTBPyS_mUEC_yLdjm_3c3c

Response

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

{
  "data": [
    {
      "category": "Lab",
      "last_purchase_date": "7/15/2026",
      "name": "Alpha",
      "product_owner": "FirstName532 LastName533",
      "purchase_order_count": 2,
      "relationship_type": null,
      "total_purchases": 1.5e3
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "name",
        "label": "Name"
      },
      {
        "key": "last_purchase_date",
        "label": "Last Purchase Date"
      },
      {
        "key": "purchase_order_count",
        "label": "Purchase Order Count"
      },
      {
        "key": "total_purchases",
        "label": "Total Purchases"
      },
      {
        "key": "product_owner",
        "label": "Product Owner"
      },
      {
        "key": "category",
        "label": "Category"
      },
      {
        "key": "relationship_type",
        "label": "Relationship Type"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "purchases_by_company"
  }
}

Returns one row per vendor (company relationship) with its last purchase date, purchase order count, and total purchases over the reported date range. When no date filter is provided, the report defaults to the last 30 days. Draft purchases are excluded.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. Any CompanyRelationship custom fields configured for the company are appended as extra columns. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_purchases_by_company.

Request

GET /public/v1/reports/purchases-by-company

Parameters

Parameter Description In Type Required Default Example
company_relationship_group_ids Filter by vendor group IDs query array false
order_datetime Filter by purchase date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
owner_ids Filter by purchase owner (sales rep) IDs query array false
search Search by vendor (related company) name query string false

Responses

Status Description Schema
200 The Purchases By Company report PurchasesByCompanyReport

Get the Purchases By Product report

GET /public/v1/reports/purchases-by-product returns one row per purchased product as {data, meta}, narrowed by the applied filters

GET /public/v1/reports/purchases-by-product?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYTEzNjA1NzYtM2EyZS00NzNkLTk1YTctNzI5MDRkNThmMzBhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjkxNCIsInR5cCI6ImFjY2VzcyJ9.qiEfEeDmG1IzTGZy1N_A4bcogpzwTwVEjRco4ZVpqso

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 164c2df19344b7e154172826d5c54ab2-841680aeba914249-0

{
  "data": [
    {
      "category": "Some category 21",
      "group": "Product Group 11",
      "name": "Alpha",
      "owner": "FirstName200 LastName201",
      "quantity_purchased": 4,
      "sale_price": 1.0,
      "sku": "sku 36",
      "subcategory": "Some subcategory 17",
      "total_purchased": 40.0,
      "unit_cost": null,
      "unit_type": "Gram",
      "vendor": "Company 92",
      "wholesale_price": null
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "name",
        "label": "Name"
      },
      {
        "key": "sku",
        "label": "SKU"
      },
      {
        "key": "quantity_purchased",
        "label": "Quantity Purchased"
      },
      {
        "key": "total_purchased",
        "label": "Total Purchased"
      },
      {
        "key": "unit_type",
        "label": "Unit Type"
      },
      {
        "key": "category",
        "label": "Category"
      },
      {
        "key": "subcategory",
        "label": "Subcategory"
      },
      {
        "key": "group",
        "label": "Group"
      },
      {
        "key": "vendor",
        "label": "Vendor"
      },
      {
        "key": "owner",
        "label": "Owner"
      },
      {
        "key": "unit_cost",
        "label": "Unit Cost"
      },
      {
        "key": "sale_price",
        "label": "Sale Price"
      },
      {
        "key": "wholesale_price",
        "label": "Wholesale Price"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "purchases_by_product"
  }
}

Returns one row per purchased product with its quantity purchased and total purchased (purchase item quantities times price) over the reported date range, alongside the product's descriptive attributes (SKU, unit type, category, subcategory, group, vendor, owner, unit cost, sale price, and wholesale price). When no date filter is provided, the report defaults to the last 30 days. Draft purchases are excluded.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. Any Product custom fields configured for the company are appended as extra columns. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_purchases_by_product.

Request

GET /public/v1/reports/purchases-by-product

Parameters

Parameter Description In Type Required Default Example
location_ids Filter by the purchase location IDs query array false
order_datetime Filter by purchase date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
owner_ids Filter by purchase owner (sales rep) IDs query array false
search Search by product name or SKU query string false

Responses

Status Description Schema
200 The Purchases By Product report PurchasesByProductReport

Get the Sales By Company report

GET /public/v1/reports/sales-by-company returns one row per customer as {data, meta}, narrowed by the applied filters

GET /public/v1/reports/sales-by-company?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiN2UxMDA5MGItZjUyNC00YmRhLWE0NDgtNDdhMTk0YjQxMTNlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzEyMiIsInR5cCI6ImFjY2VzcyJ9.YPv9KswrPI-gEhkLuY5S-Hp1lJBs2wiZZqIwq-fzIpU

Response

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

{
  "data": [
    {
      "category": "Delivery",
      "last_order_date": "7/15/2026",
      "name": "Alpha",
      "order_count": 3,
      "owner": "FirstName640 LastName641",
      "relationship_type": null,
      "total_received": 0.0,
      "total_sales": 1.8e3
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "name",
        "label": "Name"
      },
      {
        "key": "last_order_date",
        "label": "Last Order Date"
      },
      {
        "key": "order_count",
        "label": "Order Count"
      },
      {
        "key": "total_received",
        "label": "Total Received"
      },
      {
        "key": "total_sales",
        "label": "Total Sales"
      },
      {
        "key": "owner",
        "label": "Owner"
      },
      {
        "key": "category",
        "label": "Category"
      },
      {
        "key": "relationship_type",
        "label": "Relationship Type"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "sales_by_company"
  }
}

Returns one row per customer (company relationship) with its last order date, order count, total received (payments), and total sales (order totals net of returns) over the reported date range. When no date filter is provided, the report defaults to the last 30 days. Canceled orders are excluded unless the status filter explicitly requests them.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. Any CompanyRelationship custom fields configured for the company are appended as extra columns. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_sales_by_company.

Request

GET /public/v1/reports/sales-by-company

Parameters

Parameter Description In Type Required Default Example
company_relationship_group_ids Filter by customer group IDs query array false
order_datetime Filter by order date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
owner_ids Filter by order owner (sales rep) IDs query array false
search Search by customer (related company) name query string false
status Filter by sales order status query array false ["COMPLETED","DELIVERED"]

Responses

Status Description Schema
200 The Sales By Company report SalesByCompanyReport

Get the Sales By Product report

GET /public/v1/reports/sales-by-product returns one row per product as {data, meta}, narrowed by the applied filters

GET /public/v1/reports/sales-by-product?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNjQ5NDJjZTQtYWFkOS00MzVkLTlmZDAtMTRjYTc2MTIyN2E0IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzAxOSIsInR5cCI6ImFjY2VzcyJ9.WJ9ThdlOtuXT6NUH3qkZxMVBJI45I1ya2yzxHqmKlMI

Response

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

{
  "data": [
    {
      "category": "Some category 32",
      "group": "Product Group 18",
      "name": "Beta",
      "product_owner": "FirstName408 LastName409",
      "quantity_sold": 3,
      "sale_price": 1.0,
      "shipped_from_license": null,
      "sku": "sku 53",
      "subcategory": "Some subcategory 28",
      "total_sales": 60.0,
      "unit_cost": null,
      "unit_type": "Gram",
      "upc": null,
      "vendor": "Company 173",
      "wholesale_price": null
    },
    {
      "category": "Some category 31",
      "group": "Product Group 17",
      "name": "Alpha",
      "product_owner": "FirstName398 LastName399",
      "quantity_sold": 4,
      "sale_price": 1.0,
      "shipped_from_license": null,
      "sku": "sku 51",
      "subcategory": "Some subcategory 27",
      "total_sales": 40.0,
      "unit_cost": null,
      "unit_type": "Gram",
      "upc": null,
      "vendor": "Company 165",
      "wholesale_price": null
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "name",
        "label": "Name"
      },
      {
        "key": "sku",
        "label": "SKU"
      },
      {
        "key": "quantity_sold",
        "label": "Quantity Sold"
      },
      {
        "key": "total_sales",
        "label": "Total Sales"
      },
      {
        "key": "unit_type",
        "label": "Unit Type"
      },
      {
        "key": "category",
        "label": "Category"
      },
      {
        "key": "subcategory",
        "label": "Subcategory"
      },
      {
        "key": "group",
        "label": "Group"
      },
      {
        "key": "vendor",
        "label": "Vendor"
      },
      {
        "key": "product_owner",
        "label": "Product Owner"
      },
      {
        "key": "unit_cost",
        "label": "Unit Cost"
      },
      {
        "key": "sale_price",
        "label": "Sale Price"
      },
      {
        "key": "wholesale_price",
        "label": "Wholesale Price"
      },
      {
        "key": "shipped_from_license",
        "label": "Shipped From License"
      },
      {
        "key": "upc",
        "label": "UPC"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "sales_by_product"
  }
}

Returns one row per product with its quantity sold and total sales (order item quantities times price, net of returns) over the reported date range, alongside the product's descriptive attributes (SKU, unit type, category, subcategory, group, vendor, owner, unit cost, sale price, wholesale price, shipped-from license, and UPC). When no date filter is provided, the report defaults to the last 30 days. Canceled orders are excluded unless the status filter explicitly requests them.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. Any Product custom fields configured for the company are appended as extra columns. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_sales_by_product.

Request

GET /public/v1/reports/sales-by-product

Parameters

Parameter Description In Type Required Default Example
customer_ids Filter by customer (company relationship) IDs query array false
exclude_customer_ids Exclude sales to these customer (company relationship) IDs query array false
location_ids Filter by the order item location IDs query array false
order_datetime Filter by order date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
owner_ids Filter by order owner (sales rep) IDs query array false
search Search by product name or SKU query string false
shipped_from_license_ids Filter by the shipped-from license IDs query array false
status Filter by sales order status query array false ["COMPLETED","DELIVERED"]
user_ids Filter by the order item user IDs query array false

Responses

Status Description Schema
200 The Sales By Product report SalesByProductReport

Get the Sales By User report

GET /public/v1/reports/sales-by-user returns one row per user as {data, meta}, ranked by sales and narrowed by filters

GET /public/v1/reports/sales-by-user?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z&user_ids[]=00000000-0000-0000-0000-000000001aba&user_ids[]=00000000-0000-0000-0000-000000001abf
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYjA4MGM4ZDYtOTI2NS00ZjI0LWFhMzEtODU0MGEwNDFiMmY4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjgzNyIsInR5cCI6ImFjY2VzcyJ9.EY943WZ9D_G0Dnx_S-rSrCb4zgIFWzrahkdz3DnC7BU

Response

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

{
  "data": [
    {
      "leaderboard_rank": 1,
      "order_count": 2,
      "sales_pre_tax": 50.0,
      "total_sales": 150.0,
      "user": "Alice Rep"
    },
    {
      "leaderboard_rank": 2,
      "order_count": 1,
      "sales_pre_tax": 30.0,
      "total_sales": 30.0,
      "user": "Bob Rep"
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "leaderboard_rank",
        "label": "Leaderboard Rank"
      },
      {
        "key": "user",
        "label": "User"
      },
      {
        "key": "order_count",
        "label": "Order Count"
      },
      {
        "key": "sales_pre_tax",
        "label": "Sales (Pre-Tax)"
      },
      {
        "key": "total_sales",
        "label": "Total Sales"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "sales_by_user"
  }
}

Returns one row per user (sales rep) with its leaderboard rank, order count, pre-tax sales, and total sales (order totals net of returns) over the reported date range. Users are ranked by total sales, with the top seller at rank 1. When no date filter is provided, the report defaults to the last 30 days. Canceled orders are excluded unless the status filter explicitly requests them.

Every value is returned as it appears in the report's CSV export, with numeric cells parsed into numbers. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_sales_by_user.

Request

GET /public/v1/reports/sales-by-user

Parameters

Parameter Description In Type Required Default Example
order_datetime Filter by order date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
search Search by order number or customer name query string false
status Filter by sales order status query array false ["COMPLETED","DELIVERED"]
user_ids Filter by user (sales rep) IDs query array false

Responses

Status Description Schema
200 The Sales By User report SalesByUserReport

Get the Sales Order History report

GET /public/v1/reports/sales-order-history returns one row per order as {data, meta}, narrowed by the applied filters

GET /public/v1/reports/sales-order-history?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiODFkMTEzM2QtNmY5Ni00YTdlLWE3MzEtYzhiYjUyNGEwMGE3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzI2NSIsInR5cCI6ImFjY2VzcyJ9.0L3MnDbFsvG9Q2hg-m0FLDajsyhhgIq5wKZunWaD9jo

Response

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

{
  "data": [
    {
      "charges_taxes_not_included": 0.0,
      "customer": "Company 350",
      "delivery_date": null,
      "delivery_date_utc": null,
      "discounts_taxes_not_included": 0.0,
      "due_date": "2026-08-17T14:24:26.811239",
      "due_date_utc": "2026-08-17T21:24:26.811239Z",
      "order_date": "2026-07-01T05:00:00.000000",
      "order_date_utc": "2026-07-01T12:00:00.000000Z",
      "order_number": "SO-1",
      "outstanding": 1.0e3,
      "owner": null,
      "paid": 0.0,
      "returns": 0.0,
      "status": "COMPLETED",
      "subtotal": 0.0,
      "taxes": 0.0,
      "total": 1.0e3
    },
    {
      "charges_taxes_not_included": 0.0,
      "customer": "Company 352",
      "delivery_date": null,
      "delivery_date_utc": null,
      "discounts_taxes_not_included": 0.0,
      "due_date": "2026-08-17T14:24:26.824643",
      "due_date_utc": "2026-08-17T21:24:26.824643Z",
      "order_date": "2026-07-01T05:00:00.000000",
      "order_date_utc": "2026-07-01T12:00:00.000000Z",
      "order_number": "SO-2",
      "outstanding": 500.0,
      "owner": null,
      "paid": 0.0,
      "returns": 0.0,
      "status": "PENDING",
      "subtotal": 0.0,
      "taxes": 0.0,
      "total": 500.0
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "order_date",
        "label": "Order Date"
      },
      {
        "key": "order_date_utc",
        "label": "Order Date (UTC)"
      },
      {
        "key": "delivery_date",
        "label": "Delivery Date"
      },
      {
        "key": "delivery_date_utc",
        "label": "Delivery Date (UTC)"
      },
      {
        "key": "due_date",
        "label": "Due Date"
      },
      {
        "key": "due_date_utc",
        "label": "Due Date (UTC)"
      },
      {
        "key": "order_number",
        "label": "Order Number"
      },
      {
        "key": "customer",
        "label": "Customer"
      },
      {
        "key": "status",
        "label": "Status"
      },
      {
        "key": "paid",
        "label": "Paid"
      },
      {
        "key": "outstanding",
        "label": "Outstanding"
      },
      {
        "key": "subtotal",
        "label": "Subtotal"
      },
      {
        "key": "taxes",
        "label": "Taxes"
      },
      {
        "key": "discounts_taxes_not_included",
        "label": "Discounts (taxes not included)"
      },
      {
        "key": "charges_taxes_not_included",
        "label": "Charges (taxes not included)"
      },
      {
        "key": "returns",
        "label": "Returns"
      },
      {
        "key": "total",
        "label": "Total"
      },
      {
        "key": "owner",
        "label": "Owner"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "sales_order_history"
  }
}

Returns one row per sales order with its dates, customer, status, and monetary totals (paid, outstanding, subtotal, taxes, discounts, charges, returns, total). When no date filter is provided, the report defaults to the last 30 days.

Every value is returned as it appears in the report's CSV export, with numeric cells (monetary amounts) parsed into numbers. Companies on a compliance integration (Metrc or BioTrack) get additional manifest and shipped-from-license columns, and any Order custom fields configured for the company are appended as extra columns. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_sales_order_history.

Request

GET /public/v1/reports/sales-order-history

Parameters

Parameter Description In Type Required Default Example
batch_ids Filter by batch IDs query array false
brand_ids Filter by brand IDs query array false
company_relationship_group_ids Filter by customer group IDs query array false
company_relationship_ids Filter by customer (company relationship) IDs query array false
created_datetime Filter by the datetime the order was created query string false
creator_ids Filter by order creator (user) IDs query array false
delivery_datetime Filter by delivery date range query string false
due_datetime Filter by due date range query string false
matched_with_compliance_transfer Filter by whether the order is matched with a compliance transfer query boolean false
menu_ids Filter by menu IDs query array false
order_datetime Filter by order date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
order_source Filter by the source that created the order query array false
owner_ids Filter by order owner (user) IDs query array false
payment_status Filter by payment status query array false ["FULLY_PAID"]
product_ids Filter by product IDs query array false
search Search by order number, customer name, or LeafLink short ID query string false
shipped_from_license_ids Filter by the shipped-from license IDs query array false
status Filter by sales order status query array false ["COMPLETED","DELIVERED"]
total Filter by order total range (comma-separated min,max) query string false 100,500
updated_datetime Filter by the datetime the order was last modified query string false

Responses

Status Description Schema
200 The Sales Order History report SalesOrderHistoryReport

Get the Sales Order Item History report

GET /public/v1/reports/sales-order-item-history returns one row per line item as {data, meta}, narrowed by the applied filters

GET /public/v1/reports/sales-order-item-history?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMzFiN2IyNjYtZmE0YS00NzA0LWI4MWItZmZlOTc0YWE0ZGViIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg2NSIsInR5cCI6ImFjY2VzcyJ9.cUdBaSqGyKpS14O77vrL2vJfgUxM1TrPvbvnHA72FPM

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 71f4e17b62989817d0340239dc3e5ec1-54c6224a24892813-0

{
  "data": [
    {
      "batch_number": null,
      "brand": null,
      "brand_id": null,
      "category": "Some category 14",
      "customer": "Company 52",
      "customer_id": "00000000-0000-0000-0000-000000001514",
      "default_unit_cost": null,
      "default_unit_price": 1.0,
      "default_wholesale_price": null,
      "delivery_date": null,
      "delivery_date_utc": null,
      "due_date": "2026-08-17T14:24:25.360163",
      "due_date_utc": "2026-08-17T21:24:25.360163Z",
      "group": "Product Group 5",
      "invoice_numbers": null,
      "line_item_id": "57713952-5daa-48d0-87d2-fda40adb82c4",
      "order_date": "2026-07-01T05:00:00.000000",
      "order_date_utc": "2026-07-01T12:00:00.000000Z",
      "order_id": "6f3dcf79-fe20-4af4-9af5-d28107327960",
      "order_item_price": 10.0,
      "order_number": "SO-1",
      "product": "P1",
      "product_id": "af707dc5-39e7-4941-b2fa-8fff349b8ce5",
      "product_sku": "sku 16",
      "quantity": 3,
      "returned_quantity": 0,
      "sales_rep": null,
      "status": "COMPLETED",
      "subcategory": "Some subcategory 11",
      "upc": null,
      "vendor": "Acme Vendor",
      "vendor_id": "00000000-0000-0000-0000-000000000d75"
    },
    {
      "batch_number": null,
      "brand": null,
      "brand_id": null,
      "category": "Some category 14",
      "customer": "Company 56",
      "customer_id": "00000000-0000-0000-0000-000000001517",
      "default_unit_cost": null,
      "default_unit_price": 1.0,
      "default_wholesale_price": null,
      "delivery_date": null,
      "delivery_date_utc": null,
      "due_date": "2026-08-17T14:24:25.391773",
      "due_date_utc": "2026-08-17T21:24:25.391773Z",
      "group": "Product Group 5",
      "invoice_numbers": null,
      "line_item_id": "3d7b868a-e513-4c5c-b3b3-6348e6647e3f",
      "order_date": "2026-07-01T05:00:00.000000",
      "order_date_utc": "2026-07-01T12:00:00.000000Z",
      "order_id": "0a39f249-2b36-4c92-9e0c-743c0e4713f8",
      "order_item_price": 10.0,
      "order_number": "SO-2",
      "product": "P1",
      "product_id": "af707dc5-39e7-4941-b2fa-8fff349b8ce5",
      "product_sku": "sku 16",
      "quantity": 2,
      "returned_quantity": 0,
      "sales_rep": null,
      "status": "PENDING",
      "subcategory": "Some subcategory 11",
      "upc": null,
      "vendor": "Acme Vendor",
      "vendor_id": "00000000-0000-0000-0000-000000000d75"
    },
    {
      "batch_number": null,
      "brand": null,
      "brand_id": null,
      "category": "Some category 15",
      "customer": "Company 52",
      "customer_id": "00000000-0000-0000-0000-000000001514",
      "default_unit_cost": null,
      "default_unit_price": 1.0,
      "default_wholesale_price": null,
      "delivery_date": null,
      "delivery_date_utc": null,
      "due_date": "2026-08-17T14:24:25.360163",
      "due_date_utc": "2026-08-17T21:24:25.360163Z",
      "group": "Product Group 6",
      "invoice_numbers": null,
      "line_item_id": "8e980d22-f789-49d5-bca0-2ce20031f38f",
      "order_date": "2026-07-01T05:00:00.000000",
      "order_date_utc": "2026-07-01T12:00:00.000000Z",
      "order_id": "6f3dcf79-fe20-4af4-9af5-d28107327960",
      "order_item_price": 10.0,
      "order_number": "SO-1",
      "product": "P2",
      "product_id": "531bf916-3662-4810-9cbb-dc9db2941dac",
      "product_sku": "sku 18",
      "quantity": 5,
      "returned_quantity": 0,
      "sales_rep": null,
      "status": "COMPLETED",
      "subcategory": "Some subcategory 12",
      "upc": null,
      "vendor": "Acme Vendor",
      "vendor_id": "00000000-0000-0000-0000-000000000d75"
    },
    {
      "batch_number": null,
      "brand": null,
      "brand_id": null,
      "category": "Some category 15",
      "customer": "Company 56",
      "customer_id": "00000000-0000-0000-0000-000000001517",
      "default_unit_cost": null,
      "default_unit_price": 1.0,
      "default_wholesale_price": null,
      "delivery_date": null,
      "delivery_date_utc": null,
      "due_date": "2026-08-17T14:24:25.391773",
      "due_date_utc": "2026-08-17T21:24:25.391773Z",
      "group": "Product Group 6",
      "invoice_numbers": null,
      "line_item_id": "e7d985dd-85ff-4f12-b45b-077036bbb469",
      "order_date": "2026-07-01T05:00:00.000000",
      "order_date_utc": "2026-07-01T12:00:00.000000Z",
      "order_id": "0a39f249-2b36-4c92-9e0c-743c0e4713f8",
      "order_item_price": 10.0,
      "order_number": "SO-2",
      "product": "P2",
      "product_id": "531bf916-3662-4810-9cbb-dc9db2941dac",
      "product_sku": "sku 18",
      "quantity": 1,
      "returned_quantity": 0,
      "sales_rep": null,
      "status": "PENDING",
      "subcategory": "Some subcategory 12",
      "upc": null,
      "vendor": "Acme Vendor",
      "vendor_id": "00000000-0000-0000-0000-000000000d75"
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "line_item_id",
        "label": "Line Item Id"
      },
      {
        "key": "order_id",
        "label": "Order Id"
      },
      {
        "key": "order_date",
        "label": "Order Date"
      },
      {
        "key": "order_date_utc",
        "label": "Order Date (UTC)"
      },
      {
        "key": "delivery_date",
        "label": "Delivery Date"
      },
      {
        "key": "delivery_date_utc",
        "label": "Delivery Date (UTC)"
      },
      {
        "key": "due_date",
        "label": "Due Date"
      },
      {
        "key": "due_date_utc",
        "label": "Due Date (UTC)"
      },
      {
        "key": "order_number",
        "label": "Order Number"
      },
      {
        "key": "status",
        "label": "Status"
      },
      {
        "key": "product",
        "label": "Product"
      },
      {
        "key": "product_id",
        "label": "Product Id"
      },
      {
        "key": "product_sku",
        "label": "Product SKU"
      },
      {
        "key": "default_unit_cost",
        "label": "Default Unit Cost"
      },
      {
        "key": "default_unit_price",
        "label": "Default Unit Price"
      },
      {
        "key": "default_wholesale_price",
        "label": "Default Wholesale Price"
      },
      {
        "key": "brand",
        "label": "Brand"
      },
      {
        "key": "brand_id",
        "label": "Brand Id"
      },
      {
        "key": "vendor",
        "label": "Vendor"
      },
      {
        "key": "vendor_id",
        "label": "Vendor Id"
      },
      {
        "key": "order_item_price",
        "label": "Order Item Price"
      },
      {
        "key": "returned_quantity",
        "label": "Returned Quantity"
      },
      {
        "key": "quantity",
        "label": "Quantity"
      },
      {
        "key": "category",
        "label": "Category"
      },
      {
        "key": "subcategory",
        "label": "Subcategory"
      },
      {
        "key": "group",
        "label": "Group"
      },
      {
        "key": "customer",
        "label": "Customer"
      },
      {
        "key": "customer_id",
        "label": "Customer Id"
      },
      {
        "key": "sales_rep",
        "label": "Sales Rep"
      },
      {
        "key": "invoice_numbers",
        "label": "Invoice Numbers"
      },
      {
        "key": "upc",
        "label": "UPC"
      },
      {
        "key": "batch_number",
        "label": "Batch Number"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "sales_order_item_history"
  }
}

Returns one row per sales order line item with its order dates, product, brand, vendor, customer, status, quantities, and prices. When no date filter is provided, the report defaults to the last 30 days.

Every value is returned as it appears in the report's CSV export, with numeric cells (quantities, prices) parsed into numbers. Companies on a compliance integration (Metrc or BioTrack) get additional package, potency, manifest, and shipped-from-license columns, and any Order custom fields configured for the company are appended as extra columns. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_sales_order_item_history.

Request

GET /public/v1/reports/sales-order-item-history

Parameters

Parameter Description In Type Required Default Example
batch_ids Filter by batch IDs query array false
brand_ids Filter by brand IDs query array false
company_relationship_group_ids Filter by customer group IDs query array false
company_relationship_ids Filter by customer (company relationship) IDs query array false
created_datetime Filter by the datetime the order was created query string false
creator_ids Filter by order creator (user) IDs query array false
delivery_datetime Filter by delivery date range query string false
due_datetime Filter by due date range query string false
matched_with_compliance_transfer Filter by whether the order is matched with a compliance transfer query boolean false
menu_ids Filter by menu IDs query array false
order_datetime Filter by order date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
order_source Filter by the source that created the order query array false
owner_ids Filter by order owner (user) IDs query array false
payment_status Filter by payment status query array false ["FULLY_PAID"]
product_group_ids Filter line items by product group IDs query array false
product_ids Filter by product IDs query array false
sample Filter line items by whether they are samples query string false
search Search by order number, customer name, or LeafLink short ID query string false
shipped_from_license_ids Filter by the shipped-from license IDs query array false
status Filter by sales order status query array false ["COMPLETED","DELIVERED"]
total Filter by order total range (comma-separated min,max) query string false 100,500
trade_sample_packages Filter line items by whether their package is a trade sample query string false
updated_datetime Filter by the datetime the order was last modified query string false

Responses

Status Description Schema
200 The Sales Order Item History report SalesOrderItemHistoryReport

Get the Sales Order Tax report

GET /public/v1/reports/sales-order-tax returns tax totals as {data, meta}, narrowed by the applied filters

GET /public/v1/reports/sales-order-tax?order_datetime=2026-06-01T00%3A00%3A00Z%2C2026-08-01T00%3A00%3A00Z
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZmYwYmU4ZTctODAwYi00Y2NkLWFjYTItNDNiNWYxZjM3NGM5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzAwOSIsInR5cCI6ImFjY2VzcyJ9.E-0jEJsnRAs5yYaFfk0xBeRcvQaQmMPiwA3tOhRF7G0

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 10841e25f7a25625c96bb551631d1ab0-9877dd366f5d9437-0

{
  "data": [
    {
      "tax_rate": 5.0,
      "tax_type": "City Tax",
      "total_tax": 20.0
    },
    {
      "tax_rate": 27.0,
      "tax_type": "Excise Tax",
      "total_tax": 1099.0
    }
  ],
  "meta": {
    "columns": [
      {
        "key": "tax_type",
        "label": "Tax Type"
      },
      {
        "key": "tax_rate",
        "label": "Tax Rate"
      },
      {
        "key": "total_tax",
        "label": "Total Tax"
      }
    ],
    "date_range": "May 31, 2026 to Jul 31, 2026",
    "report": "sales_order_tax"
  }
}

Returns total tax collected on sales orders, grouped by tax type and rate. When no date filter is provided, the report defaults to the last 30 days.

Every value is returned as it appears in the report's CSV export, with numeric cells (rates, amounts) parsed into numbers. Report-level information (the resolved date range and column definitions) is returned under meta.

Required permission: reports_permissions_sales_order_tax.

Request

GET /public/v1/reports/sales-order-tax

Parameters

Parameter Description In Type Required Default Example
batch_ids Filter by batch IDs query array false
brand_ids Filter by brand IDs query array false
company_relationship_group_ids Filter by customer group IDs query array false
company_relationship_ids Filter by customer (company relationship) IDs query array false
created_datetime Filter by the datetime the order was created query string false
creator_ids Filter by order creator (user) IDs query array false
delivery_datetime Filter by delivery date range query string false
due_datetime Filter by due date range query string false
matched_with_compliance_transfer Filter by whether the order is matched with a compliance transfer query boolean false
menu_ids Filter by menu IDs query array false
order_datetime Filter by order date range (comma-separated ISO8601 range) query string false 2026-01-01T00:00:00Z,2026-02-01T00:00:00Z
order_source Filter by the source that created the order query array false
owner_ids Filter by order owner (user) IDs query array false
payment_status Filter by payment status query array false ["FULLY_PAID"]
product_ids Filter by product IDs query array false
search Search by order number, customer name, or LeafLink short ID query string false
shipped_from_license_ids Filter by the shipped-from license IDs query array false
status Filter by sales order status query array false ["COMPLETED","DELIVERED"]
tax_ids Filter by tax IDs query array false
total Filter by order total range (comma-separated min,max) query string false 100,500
updated_datetime Filter by the datetime the order was last modified query string false

Responses

Status Description Schema
200 The Sales Order Tax report SalesOrderTaxReport

Returns

Get a return

GET /public/v1/returns/:id returns a single return

GET /public/v1/returns/00000000-0000-0000-0000-000000000052
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNmFmNGVkOTktOGY5NS00ZmJlLWFjMzEtMWI0MDM1YTgyNDE3IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzkxMCIsInR5cCI6ImFjY2VzcyJ9.EkoN7iBesdIEzxcgZ6bJSBB4aDn5IdjIbqFTGEg4Va0

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 820398d0624a8b793057cc1b00483bc6-4913bd0e4375ea1a-0

{
  "data": {
    "company": {
      "id": "00000000-0000-0000-0000-000000000ec3",
      "name": "Company 807",
      "updated_datetime": "2026-08-17T21:24:28.403670Z"
    },
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1080@example.com",
      "full_name": "FirstName2210 LastName2211",
      "id": "00000000-0000-0000-0000-000000001ee8",
      "role": {
        "id": "00000000-0000-0000-0000-000000001f99",
        "name": "Admin 1125"
      }
    },
    "credits": [
      {
        "amount": "100",
        "credit_number": "CRT-RET",
        "id": "c97dfe7d-f28d-4afc-990e-765781d9f0a5",
        "source": "RETURN"
      }
    ],
    "custom_data": {},
    "description": null,
    "id": "00000000-0000-0000-0000-000000000052",
    "inserted_datetime": "2026-08-17T21:24:28.446301Z",
    "invoice_numbers": [
      "INV-001",
      "INV-002"
    ],
    "items": [
      {
        "id": "00000000-0000-0000-0000-000000000050",
        "price": 30.1,
        "product": {
          "id": "823d876a-2555-497d-84a2-3fcae2415166",
          "name": "Product 436",
          "sku": "sku 437",
          "updated_datetime": "2026-08-17T21:24:28.396629Z"
        },
        "quantity": 5.0,
        "waste": false
      }
    ],
    "location": {
      "address": "123 Fake Street, Beverly Hills, CA 90210, US",
      "company_id": "00000000-0000-0000-0000-0000000017f9",
      "id": "00000000-0000-0000-0000-000000000842",
      "license_id": null,
      "name": "Place 264"
    },
    "order_id": "6d4237fc-8200-4f05-89e6-25376cc42de5",
    "order_number": "SO-100",
    "order_quantity": "5",
    "owner": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1080@example.com",
      "full_name": "FirstName2210 LastName2211",
      "id": "00000000-0000-0000-0000-000000001ee8",
      "role": {
        "id": "00000000-0000-0000-0000-000000001f99",
        "name": "Admin 1125"
      }
    },
    "qb_credit_memo_id": "QB-CM-1",
    "return_datetime": "2026-08-17T21:24:28.445896Z",
    "return_number": "RN-21",
    "return_quantity": "5",
    "return_type": "Full Return",
    "status": "PROCESSING",
    "total": 32.0,
    "updated_datetime": "2026-08-17T21:24:28.446301Z"
  }
}

Get a single return given the ID.

Required permission: returns_permissions_view.

Request

GET /public/v1/returns/{id}

Parameters

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

Responses

Status Description Schema
200 A single return ReturnResponse
404 Not Found

Get returns

GET /public/v1/returns renders invoice_numbers and credits for a return linked to an order

GET /public/v1/returns
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMGFhYzI2OWYtMzA0Ny00MGE0LWFlYWUtOGI0ZTkwNTQ5MzUxIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzE4MiIsInR5cCI6ImFjY2VzcyJ9.0Opoo8M3h9YkugjGhroUpVKHQu7y37cuWeJmyXN3Cls

Response

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

{
  "data": [
    {
      "company": {
        "id": "00000000-0000-0000-0000-000000000dc6",
        "name": "Company 296",
        "updated_datetime": "2026-08-17T21:24:26.597522Z"
      },
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-362@example.com",
        "full_name": "FirstName737 LastName738",
        "id": "00000000-0000-0000-0000-000000001c13",
        "role": {
          "id": "00000000-0000-0000-0000-000000001ca6",
          "name": "Admin 370"
        }
      },
      "credits": [
        {
          "amount": "100",
          "credit_number": "CRT-RET",
          "id": "d177540d-73ac-46cc-9980-0cb9e1c172b8",
          "source": "RETURN"
        }
      ],
      "custom_data": {},
      "description": null,
      "id": "00000000-0000-0000-0000-00000000003f",
      "inserted_datetime": "2026-08-17T21:24:26.649118Z",
      "invoice_numbers": [
        "INV-001",
        "INV-002"
      ],
      "items": [
        {
          "id": "00000000-0000-0000-0000-00000000003d",
          "price": 10.0,
          "product": {
            "id": "afcee992-a2d4-4a12-9af4-c18ead935d56",
            "name": "Product 87",
            "sku": "sku 88",
            "updated_datetime": "2026-08-17T21:24:26.589428Z"
          },
          "quantity": 10.0,
          "waste": false
        }
      ],
      "location": {
        "address": "123 Fake Street, Beverly Hills, CA 90210, US",
        "company_id": "00000000-0000-0000-0000-0000000015f3",
        "id": "00000000-0000-0000-0000-0000000007ad",
        "license_id": null,
        "name": "Place 115"
      },
      "order_id": "d149e4c9-562e-45c8-af3b-46cc125236f4",
      "order_number": "SO-100",
      "order_quantity": "10",
      "owner": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-362@example.com",
        "full_name": "FirstName737 LastName738",
        "id": "00000000-0000-0000-0000-000000001c13",
        "role": {
          "id": "00000000-0000-0000-0000-000000001ca6",
          "name": "Admin 370"
        }
      },
      "qb_credit_memo_id": null,
      "return_datetime": "2026-08-17T21:24:26.648726Z",
      "return_number": "RN-2",
      "return_quantity": "10",
      "return_type": "Full Return",
      "status": "PROCESSING",
      "total": 32.0,
      "updated_datetime": "2026-08-17T21:24:26.649118Z"
    }
  ],
  "next_page": null
}

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

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

Required permission: returns_permissions_view.

Request

GET /public/v1/returns

Parameters

Parameter Description In Type Required Default Example
inserted_datetime Filter returns by their creation datetime query string false 2022-07-10T00:00:00Z,
page Pagination information query number false ?page[number]=1
return_datetime Filter returns by their return datetime query string false 2022-07-10T00:00:00Z,
updated_datetime Filter returns by the datetime they were most recently modified query string false ,2022-07-10T00:00:00Z

Responses

Status Description Schema
200 A list of returns Returns

StockAdjustment

Get a stock adjustment

GET /public/v1/adjustments/:id returns a single stock adjustment

GET /public/v1/adjustments/00000000-0000-0000-0000-0000000001b6
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOTUzOWU2NGYtMmNlMC00MDVmLWE5ODEtZjc4ZjMyYzk4NGQzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Nzk1MiIsInR5cCI6ImFjY2VzcyJ9.hJ2j6jnqHsXwiMXpuZ6upHTDfIILE1gTKv2nec6SMq8

Response

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

{
  "data": {
    "batch_id": "00000000-0000-0000-0000-0000000008d0",
    "completion_datetime": "2026-08-17T21:24:28.510893Z",
    "compliance_quantity": null,
    "compliance_unit_type": null,
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-1138@example.com",
      "full_name": "FirstName2326 LastName2327",
      "id": "00000000-0000-0000-0000-000000001f23",
      "role": {
        "id": "00000000-0000-0000-0000-000000001fd4",
        "name": "Admin 1184"
      }
    },
    "description": null,
    "id": "00000000-0000-0000-0000-0000000001b6",
    "inserted_datetime": "2026-08-17T21:24:28.511925Z",
    "license_id": null,
    "location_id": "00000000-0000-0000-0000-000000000851",
    "owner_id": null,
    "package_id": null,
    "product_id": "31c9a6a3-d1ab-4094-9a69-50b1c662698d",
    "quantity": "10",
    "reason": "revaluation",
    "total_cost": null,
    "unit_cost": null,
    "unit_type": {
      "id": "00000000-0000-0000-0000-000000012f40",
      "name": "Gram"
    },
    "updated_datetime": "2026-08-17T21:24:28.511925Z"
  }
}

Get a single stock adjustment given the ID.

Required permission: products_permissions_view.

Request

GET /public/v1/adjustments/{id}

Parameters

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

Responses

Status Description Schema
200 A single stock adjustment StockAdjustmentResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGE0N2NiODEtOTIwZi00NzE4LWFkOWMtMzA4YWRiODFmNjRkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzMwNiIsInR5cCI6ImFjY2VzcyJ9.fjSgbOiZZC5QnOZTfYWitVQqgjGrYJ0zvCLCV_HWGm4

Response

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

{
  "data": [
    {
      "batch_id": null,
      "completion_datetime": "2026-08-17T21:24:26.978682Z",
      "compliance_quantity": null,
      "compliance_unit_type": null,
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-500@example.com",
        "full_name": "FirstName1016 LastName1017",
        "id": "00000000-0000-0000-0000-000000001c9d",
        "role": {
          "id": "00000000-0000-0000-0000-000000001d35",
          "name": "Admin 513"
        }
      },
      "description": null,
      "id": "00000000-0000-0000-0000-00000000019f",
      "inserted_datetime": "2026-08-17T21:24:26.979614Z",
      "license_id": null,
      "location_id": null,
      "owner_id": "00000000-0000-0000-0000-000000001c8a",
      "package_id": null,
      "product_id": "923967cb-49f1-49c4-aae0-45150616a3c8",
      "quantity": "10",
      "reason": "revaluation",
      "total_cost": "10000",
      "unit_cost": "1000",
      "unit_type": {
        "id": "00000000-0000-0000-0000-0000000118ba",
        "name": "Gram"
      },
      "updated_datetime": "2026-08-17T21:24:26.979614Z"
    },
    {
      "batch_id": null,
      "completion_datetime": "2026-08-17T21:24:27.191717Z",
      "compliance_quantity": "1",
      "compliance_unit_type": {
        "id": "00000000-0000-0000-0000-0000000118bc",
        "name": "Ounce"
      },
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-480@example.com",
        "full_name": "FirstName976 LastName977",
        "id": "00000000-0000-0000-0000-000000001c8a",
        "role": {
          "id": "00000000-0000-0000-0000-000000001d22",
          "name": "Admin 494"
        }
      },
      "description": "A default note describing this transaction",
      "id": "00000000-0000-0000-0000-0000000001a1",
      "inserted_datetime": "2026-08-17T21:24:27.206887Z",
      "license_id": "00000000-0000-0000-0000-00000000020a",
      "location_id": "00000000-0000-0000-0000-0000000007d2",
      "owner_id": null,
      "package_id": "00000000-0000-0000-0000-0000000000dc",
      "product_id": "883f9025-3569-496c-8274-e52eb0b16c47",
      "quantity": "1",
      "reason": "Voluntary Surrender",
      "total_cost": "900",
      "unit_cost": "900",
      "unit_type": {
        "id": "00000000-0000-0000-0000-0000000118bc",
        "name": "Ounce"
      },
      "updated_datetime": "2026-08-17T21:24:27.206887Z"
    },
    {
      "batch_id": "00000000-0000-0000-0000-000000000885",
      "completion_datetime": "2026-08-17T21:24:27.379214Z",
      "compliance_quantity": null,
      "compliance_unit_type": null,
      "creator": {
        "banned": false,
        "deleted_at": null,
        "email": "owner-663@example.com",
        "full_name": "FirstName1352 LastName1353",
        "id": "00000000-0000-0000-0000-000000001d42",
        "role": {
          "id": "00000000-0000-0000-0000-000000001de1",
          "name": "Admin 685"
        }
      },
      "description": null,
      "id": "00000000-0000-0000-0000-0000000001a3",
      "inserted_datetime": "2026-08-17T21:24:27.380108Z",
      "license_id": null,
      "location_id": "00000000-0000-0000-0000-0000000007cf",
      "owner_id": null,
      "package_id": null,
      "product_id": "7026bd86-7ab1-4547-a49f-34dd0c0ae0f1",
      "quantity": "1",
      "reason": "revaluation",
      "total_cost": "-800",
      "unit_cost": "-800",
      "unit_type": {
        "id": "00000000-0000-0000-0000-0000000118ba",
        "name": "Gram"
      },
      "updated_datetime": "2026-08-17T21:24:27.380108Z"
    }
  ],
  "next_page": null
}

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.

Required permission: products_permissions_view.

Request

GET /public/v1/adjustments

Parameters

Parameter Description In Type Required Default Example
completion_datetime Filter stock adjustments by their completion datetime (adjustment date) query string false 2022-07-10T00:00:00Z,
inserted_datetime Filter stock adjustments by their creation datetime query string false 2022-07-10T00:00:00Z,
page Pagination information query number false ?page[number]=1

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTg1N2YxMDItMTgwYi00YzMzLTg0YmEtYmYzMTNhMmY4MjJiIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzczMCIsInR5cCI6ImFjY2VzcyJ9.38-uqvxWKN-GVIJ8AuiPF2yGUUhDf5nv6tn_wfgVVQc

{
  "completion_datetime": "2020-01-03T12:20:00.000000Z",
  "description": "test",
  "location_id": "00000000-0000-0000-0000-000000000822",
  "product_id": "dc7bfed5-508c-4dbb-8e64-789de47818cc",
  "quantity": 10,
  "reason": "expired"
}

Response

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

{
  "data": {
    "batch_id": null,
    "completion_datetime": "2020-01-03T12:20:00.000000Z",
    "compliance_quantity": null,
    "compliance_unit_type": null,
    "creator": {
      "banned": false,
      "deleted_at": null,
      "email": "owner-898@example.com",
      "full_name": "FirstName1842 LastName1843",
      "id": "00000000-0000-0000-0000-000000001e32",
      "role": {
        "id": "00000000-0000-0000-0000-000000001eda",
        "name": "Admin 934"
      }
    },
    "description": "test",
    "id": "00000000-0000-0000-0000-0000000001ae",
    "inserted_datetime": "2026-08-17T21:24:27.994834Z",
    "license_id": null,
    "location_id": "00000000-0000-0000-0000-000000000822",
    "owner_id": null,
    "package_id": null,
    "product_id": "dc7bfed5-508c-4dbb-8e64-789de47818cc",
    "quantity": "10",
    "reason": "expired",
    "total_cost": null,
    "unit_cost": null,
    "unit_type": {
      "id": "00000000-0000-0000-0000-0000000126e6",
      "name": "Gram"
    },
    "updated_datetime": "2026-08-17T21:24:27.994834Z"
  }
}

Required permission: products_permissions_adjust_inventory.

Request

POST /public/v1/adjustments

Parameters

Parameter Description In Type Required Default Example
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
completion_datetime The datetime of the stock adjustment. Must only be provided for compliance adjustments. query string 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
location_id The ID of the source location of the stock adjustment. Must only be provided for non-compliance adjustments. 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
product_id The ID of the product to adjust. Must only be provided if the product is product-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
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
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

Responses

Status Description Schema
200 The stock adjustment was inserted successfully StockAdjustmentResponse

Strain

Create or update a strain

POST /public/v1/strains creates a strain

POST /public/v1/strains
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiM2JjMTJlNzQtMWI1Zi00NTg5LWFiNTAtMTVhMWU2NTRiYWYzIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzUzNCIsInR5cCI6ImFjY2VzcyJ9.A1LG_RXmotu_txfYlDhuVVc6SNKDt-gWTfVPpbWssZ0

{
  "name": "Blue Dream",
  "strain_type": "HYBRID"
}

Response

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

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000062",
    "inserted_datetime": "2026-08-17T21:24:27.489797Z",
    "name": "Blue Dream",
    "strain_type": "HYBRID",
    "updated_datetime": "2026-08-17T21:24:27.489797Z"
  }
}

Create or update a strain. Omit id to create a new strain (name is then required); pass the id of an existing strain to update it in place.

Required permission: settings_permissions_strains.

Request

POST /public/v1/strains

Parameters

Parameter Description In Type Required Default Example
id The ID of the strain to update. Omit to create a new strain. query string false
name Name of the strain. Required when creating. query string false
strain_type Type of strain query string false

Responses

Status Description Schema
200 The created or updated strain StrainResponse
400 Invalid parameters
404 Not Found

Get a strain

GET /public/v1/strains/:id returns a single strain

GET /public/v1/strains/00000000-0000-0000-0000-00000000006e
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMWU0M2RkMjctZTljZC00MDU5LWExZDktNTk5NDZiZWU2NDMyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Nzg5NiIsInR5cCI6ImFjY2VzcyJ9.zKNthJkZ2F9y0tBTG_fEsZSc-zYyIp87r9GeTqXIvAc

Response

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

{
  "data": {
    "id": "00000000-0000-0000-0000-00000000006e",
    "inserted_datetime": "2026-08-17T21:24:28.310955Z",
    "name": "Blue Dream",
    "strain_type": "HYBRID",
    "updated_datetime": "2026-08-17T21:24:28.310955Z"
  }
}

Get a single strain given the ID.

Required permission: settings_permissions_strains.

Request

GET /public/v1/strains/{id}

Parameters

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

Responses

Status Description Schema
200 A single strain StrainResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNjE3Y2Y0MWEtYmQwZi00Nzk1LWI0ZTEtMjFmMWJkNTE0M2Y1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzE4MSIsInR5cCI6ImFjY2VzcyJ9.io_OAzG0D6-7mnsfF5PzpNrnEwW7x4PT8cujCnbyEXQ

Response

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

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000053",
      "inserted_datetime": "2026-08-17T21:24:26.562584Z",
      "name": "Strain 0",
      "strain_type": "INDICA",
      "updated_datetime": "2026-08-17T21:24:26.562584Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000054",
      "inserted_datetime": "2026-08-17T21:24:26.563639Z",
      "name": "Strain 1",
      "strain_type": null,
      "updated_datetime": "2026-08-17T21:24:26.563639Z"
    }
  ],
  "next_page": null
}

Get strains filtered by various attributes

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

Required permission: settings_permissions_strains.

Request

GET /public/v1/strains

Parameters

Parameter Description In Type Required Default Example
inserted_datetime Filter strains by their creation datetime query string false 2022-07-10T00:00:00Z,
page Pagination information query number false ?page[number]=1
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

Tag

Delete a tag

DELETE /public/v1/tags/:id deletes a tag

DELETE /public/v1/tags/00000000-0000-0000-0000-000000000037
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiMDlhMTdjYWItY2FlOS00NjBlLThhOGYtYmFlOWMzZjIyYjI5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzA0NCIsInR5cCI6ImFjY2VzcyJ9.rtp8zbDlE9ZbP70-cwyvYXPF0JcGAw6-RQp6Y4BtndM

Response

204
cache-control: max-age=0, private, must-revalidate
b3: 2a582ac12157b31aff61c315e7a2fb0e-08011367d09f21a3-0

Permanently deletes the tag. This is a hard delete: the record is removed from the database and cannot be recovered.

Any authenticated API key for the company may manage tags; no additional settings permission is required.

Request

DELETE /public/v1/tags/{id}

Parameters

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

Responses

Status Description Schema
204 No Content
404 Not Found

Get a tag

GET /public/v1/tags/:id returns a single tag

GET /public/v1/tags/00000000-0000-0000-0000-000000000030
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNGMwZDI3ZTktMmYzZi00MmM4LTg5OTUtODFmNjhjMWJhMjJjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg5NiIsInR5cCI6ImFjY2VzcyJ9.H-ir-xQQ4CsBHiKappmvEMlQHa7SZyRfpAXic20OX1U

Response

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

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000030",
    "inserted_datetime": "2026-08-17T21:24:25.439565Z",
    "name": "Top Shelf",
    "updated_datetime": "2026-08-17T21:24:25.439565Z"
  }
}

Get a single tag given the ID.

Any authenticated API key for the company may manage tags; no additional settings permission is required.

Request

GET /public/v1/tags/{id}

Parameters

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

Responses

Status Description Schema
200 A single tag TagResponse
404 Not Found

Get tags

GET /public/v1/tags returns paginated tags for the company with next_page

GET /public/v1/tags
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjUxZGI3NDYtNjg0MS00M2M2LTg3ZjktMzQ1ZTk1YmIyYjYwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjgzMiIsInR5cCI6ImFjY2VzcyJ9.K4YWx9QFfPStwpPL9ALNm6wU-Ehz_9YTCVW6mP2AtVI

Response

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

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-00000000002b",
      "inserted_datetime": "2026-08-17T21:24:25.007176Z",
      "name": "T1",
      "updated_datetime": "2026-08-17T21:24:25.007176Z"
    },
    {
      "id": "00000000-0000-0000-0000-00000000002c",
      "inserted_datetime": "2026-08-17T21:24:25.009526Z",
      "name": "T2",
      "updated_datetime": "2026-08-17T21:24:25.009526Z"
    },
    {
      "id": "00000000-0000-0000-0000-00000000002d",
      "inserted_datetime": "2026-08-17T21:24:25.010525Z",
      "name": "T3",
      "updated_datetime": "2026-08-17T21:24:25.010525Z"
    }
  ],
  "next_page": "https://www.example.com/public/v1/tags?page[number]=2"
}

List tags for the authenticated company.

Any authenticated API key for the company may manage tags; no additional settings permission is required.

Request

GET /public/v1/tags

Parameters

Parameter Description In Type Required Default Example
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of tags Tags

Upsert a tag

POST /public/v1/tags creates a tag

POST /public/v1/tags
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjYsImlhdCI6MTc4NzAwMTg2NiwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOWVmY2QzMTctZTcxNS00ZTg2LTg4YmMtYjFmM2E0Y2IwNDFlIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY1LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzE3MCIsInR5cCI6ImFjY2VzcyJ9.nl9r8rljkSr9Dk4HL7iKIXabeeZRjBKgngfO2jrrc4E

{
  "name": "Top Shelf"
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
b3: 55ea7b5258ef1e041a125e9d05cff603-262acb1eddc827d2-0

{
  "data": {
    "id": "00000000-0000-0000-0000-00000000003a",
    "inserted_datetime": "2026-08-17T21:24:26.530743Z",
    "name": "Top Shelf",
    "updated_datetime": "2026-08-17T21:24:26.530743Z"
  }
}

Upsert a single tag. To update an existing tag, pass its ID in the id field. If you do not pass an ID, a new tag is created.

Any authenticated API key for the company may manage tags; no additional settings permission is required.

Request

POST /public/v1/tags

Parameters

Parameter Description In Type Required Default Example
id Tag ID. If given, the matching tag is updated; otherwise a new one is created. query string false
name The name of the tag query string true

Responses

Status Description Schema
200 The updated tag TagResponse
201 The created tag TagResponse
400 Invalid parameters
404 Not Found

Tax

Get a tax

GET /public/v1/taxes renders the full tax fields without michigan fields

GET /public/v1/taxes/00000000-0000-0000-0000-000000000023
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOWVjYjliOWYtOGViNC00MmIwLWJkNmMtY2NmZWM0MGNhMjE5IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njk4NyIsInR5cCI6ImFjY2VzcyJ9.YElDClpbnZOAt_yI7MNsmyYuandOO95eGIHRcyphoX8

Response

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

{
  "data": {
    "description": null,
    "id": "00000000-0000-0000-0000-000000000023",
    "inserted_datetime": "2026-08-17T21:24:25.786720Z",
    "name": "CA Excise",
    "qb_account_id": "84",
    "qb_product_id": "12",
    "tags": [
      {
        "id": "00000000-0000-0000-0000-000000000035",
        "name": "Cannabis"
      }
    ],
    "tax_applied_after_charges": true,
    "tax_applied_after_price_tiers": true,
    "tax_code": "EXCISE",
    "tax_rate_percent": 15.0,
    "updated_datetime": "2026-08-17T21:24:25.787593Z"
  }
}

Get a single tax given the ID.

Required permission: settings_permissions_taxes.

Request

GET /public/v1/taxes/{id}

Parameters

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

Responses

Status Description Schema
200 A single tax TaxResponse
404 Not Found

Get taxes

GET /public/v1/taxes returns paginated taxes for the company with tags and next_page

GET /public/v1/taxes
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiYzM1ZTYxYmMtOTMxYy00NTY2LTkwOWQtMGFjMWMwZGQxODQ2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg5OSIsInR5cCI6ImFjY2VzcyJ9.c5Ikg3ddV0WKStteTFW5M5WTQD7U5Sx92lEkOFnwEFI

Response

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

{
  "data": [
    {
      "description": null,
      "id": "00000000-0000-0000-0000-00000000001d",
      "inserted_datetime": "2026-08-17T21:24:25.503477Z",
      "name": "T1",
      "qb_account_id": null,
      "qb_product_id": null,
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000032",
          "name": "Cannabis"
        }
      ],
      "tax_applied_after_charges": false,
      "tax_applied_after_price_tiers": true,
      "tax_code": "Tax Code 1",
      "tax_rate_percent": 15.0,
      "updated_datetime": "2026-08-17T21:24:25.503477Z"
    },
    {
      "description": null,
      "id": "00000000-0000-0000-0000-00000000001e",
      "inserted_datetime": "2026-08-17T21:24:25.509662Z",
      "name": "T2",
      "qb_account_id": null,
      "qb_product_id": null,
      "tags": [],
      "tax_applied_after_charges": false,
      "tax_applied_after_price_tiers": true,
      "tax_code": "Tax Code 3",
      "tax_rate_percent": 15.0,
      "updated_datetime": "2026-08-17T21:24:25.509662Z"
    },
    {
      "description": null,
      "id": "00000000-0000-0000-0000-00000000001f",
      "inserted_datetime": "2026-08-17T21:24:25.513808Z",
      "name": "T3",
      "qb_account_id": null,
      "qb_product_id": null,
      "tags": [],
      "tax_applied_after_charges": false,
      "tax_applied_after_price_tiers": true,
      "tax_code": "Tax Code 5",
      "tax_rate_percent": 15.0,
      "updated_datetime": "2026-08-17T21:24:25.513808Z"
    }
  ],
  "next_page": "https://www.example.com/public/v1/taxes?page[number]=2"
}

List taxes for the authenticated company.

Required permission: settings_permissions_taxes.

Request

GET /public/v1/taxes

Parameters

Parameter Description In Type Required Default Example
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of taxes Taxes

TestResult

Get a test result

GET /public/v1/test-results/:id returns a single test result

GET /public/v1/test-results/00000000-0000-0000-0000-00000000005b
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjksImlhdCI6MTc4NzAwMTg2OSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiZjg3NTZkZjUtYjYxMy00MDgzLTk5NjctNTBmMzcwMTBjZDNkIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY4LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6ODM1MyIsInR5cCI6ImFjY2VzcyJ9.PLhjWGaXjpG6GKkQKfYVyekjFF0BzZ_PL3FpTplLXyk

Response

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

{
  "data": {
    "additional_test_results": {},
    "batch_id": "00000000-0000-0000-0000-00000000091c",
    "biotrack_id": null,
    "cbd_mg_per_unit": null,
    "cbd_percentage": null,
    "coa_url": null,
    "id": "00000000-0000-0000-0000-00000000005b",
    "inserted_datetime": "2026-08-17T21:24:29.443372Z",
    "is_primary": false,
    "lab_license_number": null,
    "lab_name": null,
    "metrc_id": null,
    "mg_per_unit_type": "mg/g",
    "name": "TR001",
    "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": "2026-08-17T21:24:29.443372Z"
  }
}

Get a single test result given the ID.

Required permission: products_permissions_view.

Request

GET /public/v1/test-results/{id}

Parameters

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

Responses

Status Description Schema
200 A single test result TestResultResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiOGM4ZjhmMzItNzhlYi00NjM1LWIxNTEtZGM1ZDhlNzBiZmQ2IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg1NiIsInR5cCI6ImFjY2VzcyJ9.KvCfoM_j2PHUyWK5h1EZI-rHqchGFa9qk_unRH7exQg

Response

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

{
  "data": [
    {
      "additional_test_results": {
        "thca_percentage": "12"
      },
      "batch_id": null,
      "biotrack_id": null,
      "cbd_mg_per_unit": "1.12345",
      "cbd_percentage": "60.1234",
      "coa_url": null,
      "id": "00000000-0000-0000-0000-000000000041",
      "inserted_datetime": "2026-08-17T21:24:26.458201Z",
      "is_primary": false,
      "lab_license_number": "1234567890",
      "lab_name": "Test Lab",
      "metrc_id": 1234567890,
      "mg_per_unit_type": "mg/g",
      "name": "Test result 1",
      "package_id": "00000000-0000-0000-0000-0000000000d9",
      "release_date": "2026-08-17",
      "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": "2026-08-17T21:24:26.458201Z"
    },
    {
      "additional_test_results": {
        "thca_percentage": "12"
      },
      "batch_id": "00000000-0000-0000-0000-000000000863",
      "biotrack_id": null,
      "cbd_mg_per_unit": null,
      "cbd_percentage": null,
      "coa_url": null,
      "id": "00000000-0000-0000-0000-000000000042",
      "inserted_datetime": "2026-08-17T21:24:26.507414Z",
      "is_primary": false,
      "lab_license_number": null,
      "lab_name": null,
      "metrc_id": 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": "2026-08-17T21:24:26.507414Z"
    },
    {
      "additional_test_results": {},
      "batch_id": null,
      "biotrack_id": null,
      "cbd_mg_per_unit": null,
      "cbd_percentage": null,
      "coa_url": null,
      "id": "00000000-0000-0000-0000-000000000043",
      "inserted_datetime": "2026-08-17T21:24:26.612773Z",
      "is_primary": false,
      "lab_license_number": null,
      "lab_name": null,
      "metrc_id": null,
      "mg_per_unit_type": "mg/g",
      "name": "File.pdf",
      "package_id": "00000000-0000-0000-0000-0000000000da",
      "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": "2026-08-17T21:24:26.612773Z"
    }
  ],
  "next_page": null
}

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.

Required permission: products_permissions_view.

Request

GET /public/v1/test-results

Parameters

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

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMmZmYTY5MjctMmUwOC00MDdmLTk5NmMtMjdlM2FmYjQzODVjIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzY2MiIsInR5cCI6ImFjY2VzcyJ9.V6bhX0SrR0wUB-0tV110QSP2PrzyNUJKU8RfTKCzLJ8

{
  "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-000000000897",
  "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: 276c6000207b2400442e95ff7df138c5-8fc9803a3d984ac3-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-000000000897",
    "biotrack_id": null,
    "cbd_mg_per_unit": "1.1",
    "cbd_percentage": "2.2",
    "coa_url": null,
    "id": "00000000-0000-0000-0000-00000000004d",
    "inserted_datetime": "2026-08-17T21:24:27.845019Z",
    "is_primary": true,
    "lab_license_number": "1234567890",
    "lab_name": "Test Lab",
    "metrc_id": null,
    "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": "2026-08-17T21:24:27.845019Z"
  }
}

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. Required permission: products_permissions_edit.

Request

POST /public/v1/test-results

Parameters

Parameter Description In Type Required Default Example
additional_test_results The additional tests results for this test result. Check here for the valid options. body object false
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
cbd_mg_per_unit The CBD 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
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
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
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
mg_per_unit_type The unit type for the mg per unit fields query string false mg/g
name The name of this test result query string false Test Result Name
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
release_date The release date for this test result query string false 2022-07-10
thc_mg_per_unit The THC mg per unit for this test result. query decimal false 1.5
thc_percentage The THC percentage for this test result. Max precision is 4 decimal places. 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
total_cbd_percentage The total CBD percentage for this test result. Max precision is 4 decimal places. 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
total_thc_percentage The total THC percentage for this test result. Max precision is 4 decimal places. query decimal false 1.5

Responses

Status Description Schema
200 A single test result TestResultResponse

UnitType

Get a unit type

GET /public/v1/unit-types/:id returns the full unit type fields

GET /public/v1/unit-types/00000000-0000-0000-0000-000000010aa3
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiY2UzYTA1NTEtY2RlYS00NDA2LWJjZTItMTFmZjM5ZTY0ZjkwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg5NCIsInR5cCI6ImFjY2VzcyJ9.YY-52tcMeov0r_gKehIuYmR_lPdDsR7m9hGhDUwL0xo

Response

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

{
  "data": {
    "active": true,
    "category": "WEIGHT",
    "id": "00000000-0000-0000-0000-000000010aa3",
    "inserted_datetime": "2026-08-17T21:24:25.433991Z",
    "locked": true,
    "name": "Big Bag",
    "qty_per_si_unit": "453.592",
    "updated_datetime": "2026-08-17T21:24:25.433991Z"
  }
}

Get a single unit type given the ID.

Request

GET /public/v1/unit-types/{id}

Parameters

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

Responses

Status Description Schema
200 A single unit type UnitTypeFullResponse
404 Not Found

Get unit types

GET /public/v1/unit-types returns paginated unit types with next_page

GET /public/v1/unit-types
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjQsImlhdCI6MTc4NzAwMTg2NCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNjk5OGRkYmEtZTBhNy00NWQxLWI0YTAtOGFmNWNjMzUyMzQyIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODYzLCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Njg0MCIsInR5cCI6ImFjY2VzcyJ9.K0NIZcRgWVqgDhS7tAtsHg7u2oRedsGRL4WJ2Ut8ZKg

Response

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

{
  "data": [
    {
      "active": false,
      "category": "WEIGHT",
      "id": "00000000-0000-0000-0000-000000010741",
      "inserted_datetime": "2026-08-17T21:24:24.749767Z",
      "locked": true,
      "name": "Kilogram",
      "qty_per_si_unit": "1",
      "updated_datetime": "2026-08-17T21:24:24.749767Z"
    },
    {
      "active": true,
      "category": "WEIGHT",
      "id": "00000000-0000-0000-0000-00000001075f",
      "inserted_datetime": "2026-08-17T21:24:24.749767Z",
      "locked": true,
      "name": "Gram",
      "qty_per_si_unit": "1000",
      "updated_datetime": "2026-08-17T21:24:24.749767Z"
    },
    {
      "active": false,
      "category": "WEIGHT",
      "id": "00000000-0000-0000-0000-000000010760",
      "inserted_datetime": "2026-08-17T21:24:24.749767Z",
      "locked": true,
      "name": "Milligram",
      "qty_per_si_unit": "1000000",
      "updated_datetime": "2026-08-17T21:24:24.749767Z"
    }
  ],
  "next_page": "https://www.example.com/public/v1/unit-types?page[number]=2"
}

List unit types for the authenticated company.

Request

GET /public/v1/unit-types

Parameters

Parameter Description In Type Required Default Example
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of unit types UnitTypes

User

Get a user

GET /public/v1/users/:id returns a single user

GET /public/v1/users/00000000-0000-0000-0000-000000001ccb
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMDUzZThhN2MtNjRlOS00ODRjLTllOWQtMDIwMzYwZjYyZjhiIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzM2OSIsInR5cCI6ImFjY2VzcyJ9.2-QwlZEXZFLyEK59M3CRchrWp3A3MyZw6m3NmSbEAnE

Response

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

{
  "data": {
    "banned": false,
    "deleted_at": null,
    "email": "owner-545@example.com",
    "full_name": "FirstName1106 LastName1107",
    "id": "00000000-0000-0000-0000-000000001ccb",
    "role": {
      "id": "00000000-0000-0000-0000-000000001d62",
      "name": "Admin 558"
    }
  }
}

Get a single user given the ID.

Required permission: settings_permissions_manage_team.

Request

GET /public/v1/users/{id}

Parameters

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

Responses

Status Description Schema
200 A single user UserResponse
404 Not Found

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.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjUsImlhdCI6MTc4NzAwMTg2NSwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNWUzNGZhZGQtODcyZS00MmM2LTlhYTQtZDVkNThiY2FlZGFhIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY0LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NjkyNyIsInR5cCI6ImFjY2VzcyJ9.Bzd9XBNcYwH5JUy9p6yDZndaK1hDfeigc9byYwUDkNk

Response

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

{
  "data": [
    {
      "banned": false,
      "deleted_at": null,
      "email": "owner-101@example.com",
      "full_name": "FirstName202 LastName203",
      "id": "00000000-0000-0000-0000-000000001b0f",
      "role": {
        "id": "00000000-0000-0000-0000-000000001ba1",
        "name": "Admin 109"
      }
    },
    {
      "banned": false,
      "deleted_at": null,
      "email": "owner-103@example.com",
      "full_name": "FirstName206 LastName207",
      "id": "00000000-0000-0000-0000-000000001b11",
      "role": {
        "id": "00000000-0000-0000-0000-000000001ba3",
        "name": "Admin 111"
      }
    }
  ],
  "next_page": null
}

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.

Required permission: settings_permissions_manage_team.

Request

GET /public/v1/users

Parameters

Parameter Description In Type Required Default Example
deleted Filter deleted users. no returns non-deleted, only returns deleted, include returns both. query string false no
inserted_datetime Filter users by their creation datetime query string false 2022-07-10T00:00:00Z,
page Pagination information query number false ?page[number]=1
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

Vehicle

Create or update a vehicle

POST /public/v1/vehicles creates a vehicle

POST /public/v1/vehicles
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiMTNlZWUyZTktOWRhNi00YTIzLWFkYTItYWFmNjllMGUxMDg4IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzcwOSIsInR5cCI6ImFjY2VzcyJ9.fO6pfroSd3U6aWNp6lbCFmCwWYrH-rpjWuNSqshE-44

{
  "color": "Red",
  "description": "Delivery truck",
  "license_plate_number": "XYZ789",
  "license_plate_state": "TX",
  "make": "Ford",
  "model": "F-150",
  "vin": "ABCDEFGHIJ1234567",
  "year": "2024"
}

Response

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

{
  "data": {
    "color": "Red",
    "description": "Delivery truck",
    "id": "00000000-0000-0000-0000-00000000002c",
    "inserted_datetime": "2026-08-17T21:24:27.914970Z",
    "license_plate_number": "XYZ789",
    "license_plate_state": "TX",
    "make": "Ford",
    "model": "F-150",
    "updated_datetime": "2026-08-17T21:24:27.914970Z",
    "vin": "ABCDEFGHIJ1234567",
    "year": "2024"
  }
}

Create or update a vehicle. Omit id to create a new vehicle (make, model and license_plate_number are then required); pass the id of an existing vehicle to update it in place.

Required permission: settings_permissions_vehicles.

Request

POST /public/v1/vehicles

Parameters

Parameter Description In Type Required Default Example
color The color of the vehicle query string false
description A description or name for the vehicle query string false
id The ID of the vehicle to update. Omit to create a new vehicle. query string false
license_plate_number The license plate number. Required when creating. query string false
license_plate_state The license plate state query string false
make The make of the vehicle. Required when creating. query string false
model The model of the vehicle. Required when creating. query string false
vin The vehicle identification number (VIN) query string false
year The year of the vehicle query string false

Responses

Status Description Schema
200 The created or updated vehicle VehicleResponse
400 Invalid parameters
404 Not Found

Get a vehicle

GET /public/v1/vehicles/:id returns a single vehicle

GET /public/v1/vehicles/00000000-0000-0000-0000-00000000002d
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjgsImlhdCI6MTc4NzAwMTg2OCwiaXNzIjoiRGlzdHJ1IiwianRpIjoiNTgyZDkwODMtNGNkMC00YTQ3LThmMzQtMDE2MThjOGU5MDQ1IiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY3LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6Nzc2MSIsInR5cCI6ImFjY2VzcyJ9.3Hc9aTb053N2u78CnN1DjweJRLZSSQIt7AeNjlQnHd0

Response

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

{
  "data": {
    "color": "Blue",
    "description": "Company car",
    "id": "00000000-0000-0000-0000-00000000002d",
    "inserted_datetime": "2026-08-17T21:24:28.029260Z",
    "license_plate_number": "ABC123",
    "license_plate_state": "CA",
    "make": "Toyota",
    "model": "Camry",
    "updated_datetime": "2026-08-17T21:24:28.029260Z",
    "vin": "1234567890",
    "year": "2023"
  }
}

Get a single vehicle given the ID.

Required permission: settings_permissions_vehicles.

Request

GET /public/v1/vehicles/{id}

Parameters

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

Responses

Status Description Schema
200 A single vehicle VehicleResponse
404 Not Found

Get vehicles

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

GET /public/v1/vehicles
content-type: application/json
accept: application/json
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJEaXN0cnUiLCJleHAiOjE4MTg0NTE0NjcsImlhdCI6MTc4NzAwMTg2NywiaXNzIjoiRGlzdHJ1IiwianRpIjoiYjZjMzBiODUtNzFjNC00MmI5LTgwN2MtNTJhYThkZWE1NjkwIiwibW9iaWxlIjpmYWxzZSwibmJmIjoxNzg3MDAxODY2LCJwbGF0Zm9ybSI6IkFQSSIsInN1YiI6IlVzZXI6NzM0NCIsInR5cCI6ImFjY2VzcyJ9.TPECvVHodF1C4qQ-JvBAbylIKjLbfP-zMugk9mdZW2k

Response

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

{
  "data": [
    {
      "color": "Red",
      "description": "Test Vehicle",
      "id": "00000000-0000-0000-0000-000000000023",
      "inserted_datetime": "2026-08-17T21:24:27.065135Z",
      "license_plate_number": "1234567890ABCDEFG",
      "license_plate_state": "CA",
      "make": "Toyota",
      "model": "Camry",
      "updated_datetime": "2026-08-17T21:24:27.065135Z",
      "vin": "1234567890ABCDEFG",
      "year": "2020"
    },
    {
      "color": "Red",
      "description": "Test Vehicle",
      "id": "00000000-0000-0000-0000-000000000024",
      "inserted_datetime": "2026-08-17T21:24:27.073520Z",
      "license_plate_number": "1234567890ABCDEFG",
      "license_plate_state": "CA",
      "make": "Honda",
      "model": "Civic",
      "updated_datetime": "2026-08-17T21:24:27.073520Z",
      "vin": "1234567890ABCDEFG",
      "year": "2020"
    }
  ],
  "next_page": null
}

List vehicles for the authenticated company.

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

Required permission: settings_permissions_vehicles.

Request

GET /public/v1/vehicles

Parameters

Parameter Description In Type Required Default Example
page Pagination information query number false ?page[number]=1

Responses

Status Description Schema
200 A list of vehicles Vehicles

Models

AddBatchCostsRequest

Property Description Type Required
batch_ids Non-empty list of batch UUIDs array(any) true
costs Non-empty list of costs to apply array(CostEntryInput) true
distribute_by_quantity Split each cost across the batches in proportion to their active quantity boolean false
location_ids Optional list of location UUIDs to scope the stock the cost applies to array(any) false

AddPackageCostsRequest

Property Description Type Required
costs Non-empty list of costs to apply array(CostEntryInput) true
distribute_by_quantity Split each cost across the packages in proportion to their active quantity boolean false
package_ids Non-empty list of package UUIDs array(any) true

AddProductCostsRequest

Property Description Type Required
costs Non-empty list of costs to apply array(CostEntryInput) true
distribute_by_quantity Split each cost across the products in proportion to their active quantity boolean false
location_ids Optional list of location UUIDs to scope the stock the cost applies to array(any) false
product_ids Non-empty list of product-tracked product UUIDs array(any) true

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
total_cost_actual The total actual cost of the additional cost number false
total_cost_default The total default cost (from the configured cost type) of the additional cost number false
unit_type A unit type as shown in Distru UnitType false

AdditionalTestResult

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

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

Assemblies

A collection of Assemblies

Property Description Type Required
data Assemblies array(Assembly) false
next_page URL for the next page of results; null when there is no next page string false

Assembly

An assembly as shown in Distru

Property Description Type Required
assembly_number The assembly number for this assembly string false
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
creator Information about a user in Distru User false
custom_data The custom data for this assembly array(CustomField) false
description The description for this assembly string false
estimated_start_date The datetime this assembly is expected to start 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
inserted_datetime The datetime this assembly was created at string false
is_metrc_processing_job True if this assembly is associated with a Metrc processing job, false otherwise boolean false
license A license as shown in Distru License false
metrc_processing_job_id The Metrc processing job ID for this assembly, or null integer false
metrc_processing_job_name The Metrc processing job name for this assembly, or null string false
metrc_processing_job_notes The Metrc processing job notes for this assembly, or null 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
updated_datetime The datetime this assembly was last updated at string false
waste_count_quantity The count-based waste recorded when finishing this assembly's Metrc processing job. Only set for assemblies that are Metrc processing jobs; null otherwise. Reported to Metrc as TotalCountWaste. string false
waste_count_unit_name The Metrc unit-of-measure name for waste_count_quantity (e.g. "Each"). Only set for Metrc processing jobs; null otherwise. string false
waste_volume_quantity The volume-based waste recorded when finishing this assembly's Metrc processing job. Only set for assemblies that are Metrc processing jobs; null otherwise. Reported to Metrc as TotalVolumeWaste. string false
waste_volume_unit_name The Metrc unit-of-measure name for waste_volume_quantity (e.g. "Milliliters"). Only set for Metrc processing jobs; null otherwise. string false
waste_weight_quantity The weight-based waste recorded when finishing this assembly's Metrc processing job. Only set for assemblies that are Metrc processing jobs; null otherwise. Reported to Metrc as TotalWeightWaste. string false
waste_weight_unit_name The Metrc unit-of-measure name for waste_weight_quantity (e.g. "Grams"). Only set for Metrc processing jobs; null otherwise. 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. string false
cost_per_unit The cost per unit of this input string false
cost_per_unit_default The default cost per unit (from the configured product unit cost) of this input string false
location A location as nested inside another entity in Distru LocationCompact 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 string false
total_cost_actual The total actual cost of this input string false
total_cost_default The total default cost (from the configured product unit cost) of this input string false

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. string false
cost_per_unit The cost per unit of this output string false
cost_per_unit_default The default cost per unit (from the configured product unit cost) of this output string false
expiration_datetime The expiration date for this assembly output string false
ingredients The ingredients for this assembly output array(AssemblyInput) false
is_finished_good Is this output a finished good? boolean false
is_production_batch Is this output a production batch? boolean false
location A location as nested inside another entity in Distru LocationCompact false
package A package as shown in Distru Package false
package_datetime 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 string false
total_cost_actual The total actual cost of this output string false
total_cost_default The total default cost (from the configured product unit cost) of this output string false

AssemblyResponse

A single assembly

Property Description Type Required
data An assembly as shown in Distru Assembly false

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

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
bins The bins this batch is stored in. Only present when bin inventory tracking is enabled for the company. array(BinCompact) false
cbd A free-form CBD value set directly on the batch record. This is a static label, independent of any lab result — the batch's primary_test_result may report different potency values (e.g. cbd_percentage). Null if unset. string false
cost_per_unit_actual The cost per unit of this batch string false
cost_per_unit_default The default cost per unit (from the configured product unit cost) of this batch string false
creator Information about a user in Distru User false
custom_data The custom data for this batch array(CustomField) false
deleted_at The date and time when this batch was deleted string false
description The description for this batch string false
expiration_date The expiration date for this batch string false
harvest_datetime The harvest datetime for this batch (ISO 8601 format) string false
id Unique ID for this batch string false
inserted_datetime The datetime this batch was created (ISO 8601) string false
manufactured_datetime The manufactured datetime for this batch (ISO 8601 format) string false
name Human readable name for this batch string false
owner_id The ID of the user that owns this batch string false
primary_test_result The compact primary test result nested on a package or batch PrimaryTestResult false
product_id The ID of the batch's product string false
thc A free-form THC value set directly on the batch record. This is a static label, independent of any lab result — the batch's primary_test_result may report different potency values (e.g. thc_percentage). Null if unset. string false
total_cost_actual The total actual cost of this batch string false
total_cost_default The total default cost (from the configured product unit cost) of this batch string false
updated_datetime The datetime this batch was last modified (ISO 8601) string false

BatchFullResponse

A single batch

Property Description Type Required
data Extended details about a batch for a product as shown in Distru BatchFull false

Batches

A collection of Batches

Property Description Type Required
data Batches array(BatchFull) false
next_page URL for the next page of results; null when there is no next page string false

BillOfMaterials

A product's bill of materials (recipe of inputs and additional costs)

Property Description Type Required
costs The additional costs applied by this bill of materials array(BillOfMaterialsCost) false
description The description of this bill of materials string false
id Unique ID for this bill of materials string false
inputs The inputs consumed by this bill of materials array(BillOfMaterialsInput) false
name Human readable name for this bill of materials string false

BillOfMaterialsCost

An additional cost applied by a bill of materials

Property Description Type Required
cost_type The cost type applied by a bill-of-materials cost BillOfMaterialsCostType false
description The description of this cost string false
id Unique ID for this cost string false
quantity The quantity of the cost type applied string false

BillOfMaterialsCostType

The cost type applied by a bill-of-materials cost

Property Description Type Required
cost_per_unit The cost per unit. Null unless the caller has the costs_permissions_view_cost_types_cost_per_unit permission. string false
id Unique ID for this cost type string false
name Human readable name for this cost type string false
unit_type A unit type as shown in Distru UnitType false

BillOfMaterialsFilter

A dynamic filter that selects products as a bill-of-materials input

Property Description Type Required
criteria The filter criteria, each a type (category, subcategory, group, strain, unit_type, tags) and its matched values (each an id and name) array(any) false
id Unique ID for this filter string false
name Human readable name for this filter string false

BillOfMaterialsInput

A single input of a bill of materials

Property Description Type Required
filter A dynamic filter that selects products as a bill-of-materials input BillOfMaterialsFilter false
id Unique ID for this input string false
product A product as shown in Distru Product false
quantity The quantity of this input required by the bill of materials string false
type The kind of input: product or filter string false

Bin

A bin used to track where inventory is physically stored

Property Description Type Required
id Unique ID for this bin string false
inserted_datetime When the bin was created (UTC ISO-8601) string false
name The name of the bin string false
updated_datetime When the bin was last updated (UTC ISO-8601) string false

BinCompact

Minimal details about a bin, as nested on other records

Property Description Type Required
id Unique ID for this bin string false
name The name of the bin string false

BinResponse

A single bin

Property Description Type Required
data A bin used to track where inventory is physically stored Bin false

Bins

A collection of bins

Property Description Type Required
data Bins array(Bin) false
next_page URL for the next page of results; null when there is no next page string false

CancelCredit

Options for canceling a credit

Property Description Type Required
should_delete_credit_uses When true, also removes this credit's applications to invoices (its credit uses), returning the used amounts to those invoices. Defaults to false. boolean false

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 string false
price The price of this line if it is a flat charge string false
tax.id Unique ID for this Tax string false
tax.name The name of this tax string false
type What type of additional line is this. Tax lines are returned as CHARGE with a populated tax object. array(any) false
unit_type Determines if this line is tracked as a percentage or a flat charge array(any) false

CogsReport

The Cost of Goods Sold report

Property Description Type Required
data The report rows array(CogsReportRow) true
meta Report-level metadata CogsReportMeta true

CogsReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

CogsReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(CogsReportColumn) false
date_range The human-readable date the report was generated string false
report The report identifier string true

CogsReportRow

A single row of the Cost of Goods Sold report (one sales order line item). Companies on the BioTrack compliance integration do not get the metrc_production_batch_number key.

Property Description Type Required
batch The Distru batch number string false
cost_origin The origin of the cost string false
final_input Whether the row is the sold item (Final) string false
margin_actual The actual margin number false
margin_default The default margin number false
metrc_production_batch_number The Metrc production batch number string false
order_number The sales order number string false
package The package compliance label string false
product_brand The product's brand string false
product_category The product's category string false
product_name The product name string false
profit_unit_actual The actual profit per unit number false
profit_unit_default The default profit per unit number false
quantity The quantity sold, net of returns number false
sku The product SKU string false
total_cost_actual The actual total cost number false
total_cost_default The default total cost number false
total_price The total price (unit price times quantity) number false
total_profits_actual The actual total profit number false
total_profits_default The default total profit number false
unit_cost_actual The actual cost per unit number false
unit_cost_default The default cost per unit number false
unit_price The price per unit number false
unit_type The item's unit type string false

CompactCredit

A compact representation of a credit

Property Description Type Required
amount The current amount of this credit string false
credit_number The credit number as shown in the Distru UI string false
id Unique ID for this credit string false
source How this credit was created string false

CompactInvoice

A compact view of an invoice as nested inside another entity in Distru

Property Description Type Required
id Unique ID for this invoice string false
invoice_number The invoice number as shown in the Distru UI string false
status The payment status of this invoice string false
total The total for this invoice string false

CompactMenu

A compact reference to a menu, nested inside another entity in Distru

Property Description Type Required
menu_id Public ID of the menu string false
menu_name Display name of the menu string false

CompactOrder

A compact view of an order as nested inside another entity in Distru

Property Description Type Required
id Unique ID for this order string false
order_number The order number as shown in the Distru UI string false
status The status of this order string false
total The total on this order string false

CompactReturn

A compact representation of a return

Property Description Type Required
company A company as nested inside another entity in Distru CompanyCompact false
id Unique ID for this return string false
return_datetime The datetime of this return string false
return_number The return number as shown in the Distru UI string false
status The status of this return string false
total The total value of this return number false

Companies

A collection of companies

Property Description Type Required
data Companies array(Company) false
next_page URL for the next page of results; null when there is no next page 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_payment_term A payment term as shown in Distru PaymentTerm 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
deleted_at The datetime this company relationship was deleted at string false
group A company group as shown in Distru CompanyGroup false
id Unique ID for this company string false
inserted_datetime The datetime this company was created at string false
invoice_email The email address where sales order invoices are delivered string false
leaflink_brand_id The LeafLink brand ID mapped to this company; only set on self-relationships, otherwise null integer false
leaflink_customer_id The LeafLink customer ID mapped to this company, or null integer 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(LocationCompact) 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 The current outstanding (unpaid) balance for this company, as a decimal string (e.g. "150.50"). "0" when nothing is outstanding. 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 Information about a user in Distru User 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
qb_customer_id The QuickBooks Online customer ID mapped to this company, or null string false
qb_vendor_id The QuickBooks Online vendor ID mapped to this company, or null 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

CompanyCompact

A company as nested inside another entity in Distru

Property Description Type Required
id Unique ID for this company string false
name Human readable name for this company string false
updated_datetime The datetime this company was last updated at string false

CompanyGroup

A company group as shown in Distru

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

CompanyGroupFull

A company group

Property Description Type Required
id Unique ID for this company group string false
inserted_datetime When the company group was created (UTC ISO-8601) string false
name The name of the company group string false
updated_datetime When the company group was last updated (UTC ISO-8601) string false

CompanyGroupFullResponse

A single company group

Property Description Type Required
data A company group CompanyGroupFull false

CompanyGroups

A collection of company groups

Property Description Type Required
data Company Groups array(CompanyGroupFull) false
next_page URL for the next page of results; null when there is no next page string false

CompanyResponse

A single company relationship

Property Description Type Required
data A company as shown in Distru Company false

Contact

Information about a contact in Distru's CRM

Property Description Type Required
company.id Unique ID for this company string false
custom_data The custom data for this contact array(CustomField) false
deleted_at The datetime of deletion if the contact was deleted string false
description The description of this contact string false
driver_license_issuing_state Driver license issuing state for shipping manifests string false
driver_license_number Driver license number for shipping manifests string false
email The email address of this contact string false
first_name The first name of this contact string false
full_name The full name of this contact string false
id Unique ID for this contact string false
inserted_datetime The datetime this contact was created at string false
last_name The last name of 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
updated_datetime The datetime this contact was last updated at string false
work_phone_number The work phone number of this contact string false

ContactResponse

A single contact

Property Description Type Required
data Information about a contact in Distru's CRM Contact false

Contacts

A collection of Contacts

Property Description Type Required
data Contacts array(Contact) false
next_page URL for the next page of results; null when there is no next page string false

CostEntryInput

A single cost to apply to a record

Property Description Type Required
cost_per_unit Per-unit amount. When omitted, the cost type's own cost per unit is used. Must be omitted for cost types with a locked cost per unit; only required when an inline-editable cost type has no cost per unit of its own number false
cost_type_id The cost type UUID from GET /public/v1/cost-types (required) string true
description Free-form text stored on the cost string false
quantity Units of the cost type to apply, must be > 0 (required) number true

CostType

A cost type

Property Description Type Required
active Whether the cost type is active boolean false
allow_inline_edits Controls whether the per-unit cost amount can be overridden when a cost of this type is applied to a record (a plant cost, an assembly or breakdown output cost, or an order/invoice cost line). When true, the user may enter or override cost_per_unit at apply time; when false, the applied amount is locked to this cost type's configured cost_per_unit and cannot be changed. boolean false
cost_per_unit The cost per unit as a decimal string string false
deleted_at When the cost type was soft-deleted (UTC ISO-8601), or null if it has not been deleted string false
description A description of the cost type string false
id Unique ID for this cost type string false
inserted_datetime When the cost type was created (UTC ISO-8601) string false
name The name of the cost type string false
unit_type A unit type as shown in Distru UnitType false
updated_datetime When the cost type was last updated (UTC ISO-8601) string false

CostTypeResponse

A single cost type

Property Description Type Required
data A cost type CostType false

CostTypes

A collection of cost types

Property Description Type Required
data Cost Types array(CostType) false
next_page URL for the next page of results; null when there is no next page string false

Credit

A credit as shown in Distru

Property Description Type Required
amount The current amount of this credit string false
canceled_datetime The datetime at which the credit was canceled. Only set for CANCELED credits. string false
company A company as nested inside another entity in Distru CompanyCompact false
creator Information about a user in Distru User false
credit_number The credit number as shown in the Distru UI string false
credit_uses This credit's applications to invoices. Each use has the applied amount, the compact credit, and the invoice payment it was applied to. array(CreditUse) false
deleted_in_qbo Whether this credit was pushed to QuickBooks and later deleted there. boolean false
external_note A note on this credit, visible to the customer string false
id Unique ID for this credit string false
inserted_datetime The datetime at which the credit was created in Distru string false
internal_note An internal note on this credit string false
original_amount The amount this credit was originally created with. Never changes. string false
owner Information about a user in Distru User false
payment A payment as shown in Distru Payment false
qb_credit_memo_id The id of the QuickBooks credit memo this credit maps to, when synced. string false
qb_payment_id The id of the QuickBooks payment this credit maps to, when synced. string false
qb_sync_status The credit's QuickBooks sync status. Only meaningful when the QuickBooks integration is enabled; null otherwise. Values: PENDING (the latest sync covering this credit is still in flight), ERROR (the latest sync covering this credit failed), DELETED_IN_QBO (pushed to QuickBooks once, then deleted there), NOT_SYNCED (never pushed to QuickBooks), PARTIALLY_SYNCED (the credit is in QuickBooks but at least one of its applications has not been synced yet), SYNCED (fully synced). string false
remaining_balance The unused balance still available on this credit string false
return A compact representation of a return CompactReturn false
source How this credit was created string false
status The status of this credit. ACTIVE has a remaining balance, REDEEMED is fully used, CANCELED was voided. string false
updated_datetime The datetime at which the credit was last updated in Distru string false

CreditResponse

A single credit wrapped in a data envelope

Property Description Type Required
data A credit as shown in Distru Credit false

CreditUse

An application of a credit to an invoice payment

Property Description Type Required
amount The amount of the credit applied to the invoice payment string false
credit A compact representation of a credit CompactCredit false
id Unique ID for this credit use string false
inserted_datetime The datetime at which this credit use was created in Distru string false
payment A payment as shown in Distru Payment false

Credits

A collection of Credits

Property Description Type Required
data Credits array(Credit) false
next_page URL for the next page of results; null when there is no next page string false

CultivationTransactionHistoryReport

The Cultivation Transaction History report

Property Description Type Required
data The report rows array(CultivationTransactionHistoryReportRow) true
meta Report-level metadata CultivationTransactionHistoryReportMeta true

CultivationTransactionHistoryReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

CultivationTransactionHistoryReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(CultivationTransactionHistoryReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

CultivationTransactionHistoryReportRow

A single row of the Cultivation Transaction History report (one cultivation transaction). The total_cost key is omitted for users without permission to view costs.

Property Description Type Required
amount The signed transaction amount number false
batch_name The plant batch name string false
date The transaction date, in the company's timezone string false
description The transaction description string false
package_label_s The package compliance label(s) string false
plant_tag_s The plant tag(s) involved string false
product_name The product name string false
related_entity The related entity (teardown or harvest) string false
related_entity_status The related entity's status string false
strain The strain name string false
total_cost The transaction's total cost number false
type The transaction type string false
unit The unit string false

CustomField

A custom field as shown in Distru

Property Description Type Required
id Unique ID for this custom field integer 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

CustomFieldDefinition

A custom field definition

Property Description Type Required
description Description of the custom field string false
disabled_field_options The subset of field_options that have been turned off. Applies only to dropdown and checkbox fields; always empty for text and date fields. A disabled option can no longer be selected on new or edited records, but it stays in field_options and is listed here so that historical records already holding the value continue to display it. Every value here also appears in field_options. Example: a dropdown with field_options ["Small", "Medium", "Large"] and disabled_field_options ["Medium"] keeps showing "Medium" on records saved with it, but "Medium" is no longer offered when picking a value. array(any) false
field_options Field options array(any) false
field_type Field type string false
filterable Whether the field is filterable boolean false
id Custom field ID integer false
name Name of the custom field string false
parent_object Parent object attached to the field string false
required Whether a value for the field is required when saving a record boolean false

CustomFieldDefinitionResponse

A single custom field definition wrapped in a data envelope

Property Description Type Required
data A custom field definition CustomFieldDefinition false

CustomFieldDefinitions

A collection of custom field definitions

Property Description Type Required
data CustomFieldDefinitions array(CustomFieldDefinition) false
next_page URL for the next page of results; null when there is no next page string false

Driver

A driver

Property Description Type Required
birth_date The driver's birth date (ISO-8601 date) string false
driver_license The driver's license number string false
email The driver's email string false
first_name The driver's first name string false
hire_date The driver's hire date (ISO-8601 date) string false
id Unique ID for this driver string false
inserted_datetime When the driver was created (UTC ISO-8601) string false
last_name The driver's last name string false
occupational_license_number The driver's occupational license number string false
phone_number The driver's phone number string false
updated_datetime When the driver was last updated (UTC ISO-8601) string false
us_state The driver's US state string false

DriverResponse

A single driver

Property Description Type Required
data A driver Driver false

Drivers

A collection of drivers

Property Description Type Required
data Drivers array(Driver) false
next_page URL for the next page of results; null when there is no next page string false

FileAttachment

A file attachment

Property Description Type Required
assembly_id ID of the assembly this file is attached to, if any string false
batch_id ID of the batch this file is attached to, if any string false
company_relationship_id ID of the company relationship this file is attached to, if any string false
contact_id ID of the contact this file is attached to, if any string false
id Unique ID for this file attachment string false
invoice_id ID of the invoice this file is attached to, if any string false
license_id ID of the license this file is attached to, if any string false
mime_type MIME type of the file; null when the file is missing string false
name The file name string false
order_id ID of the order this file is attached to, if any string false
order_shipment_id ID of the order shipment this file is attached to, if any string false
product_id ID of the product this file is attached to, if any string false
purchase_id ID of the purchase this file is attached to, if any string false
request_id ID of the request this file is attached to, if any string false
return_id ID of the return this file is attached to, if any string false
size_in_bytes Size of the file in bytes; null when the file is missing integer false
stock_transfer_id ID of the stock transfer this file is attached to, if any string false
task_id ID of the task this file is attached to, if any string false
upload_datetime When the file was uploaded (UTC ISO-8601) string false
uploader.id string false
uploader.name string false
url URL to download the file; null when the file is missing string false

FileAttachmentResponse

A single file attachment wrapped in a data envelope

Property Description Type Required
data A file attachment FileAttachment false

HarvestOutputsReport

The Harvest Outputs report

Property Description Type Required
data The report rows array(HarvestOutputsReportRow) true
meta Report-level metadata HarvestOutputsReportMeta true

HarvestOutputsReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

HarvestOutputsReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(HarvestOutputsReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

HarvestOutputsReportRow

A single row of the Harvest Outputs report (one input, output, or cost line item of a harvest assembly). The cost keys (unit_cost_actual, unit_cost_default, total_cost_actual, total_cost_default, cost_type, cost_type_description) are omitted for users without permission to view costs.

Property Description Type Required
cost_input_output The line item type (Input, Output, or Cost) string false
cost_type The cost type name string false
cost_type_description The cost type description string false
distru_product The Distru product name string false
harvest_assembly_date The harvest assembly date string false
harvest_assembly_number The harvest assembly number string false
harvest_name The harvest name string false
line_item_id The line item ID string false
location The location name string false
output_batch_number The output batch number string false
output_package_number The output package compliance label string false
output_reference_id The referenced output ID for cost line items string false
product_category The product category string false
quantity The line item quantity number false
status The assembly status string false
strain The strain name string false
total_cost_actual The actual total cost number false
total_cost_default The default total cost number false
unit_cost_actual The actual cost per unit number false
unit_cost_default The default cost per unit number false
unit_type The unit type string false

Image

An image as shown in Distru

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

Inventories

A list of active and available quantity for each group

Property Description Type Required
data Inventories array(Inventory) false
next_page URL for the next page of results; null when there is no next page string false

Inventory

Property Description Type Required
active Active quantity string true
available Available quantity (active - reserved) string true
batch_number The batch number of the batch or the package string false
cost_default_per_unit The cost per unit of the inventory. Note: This is calculated by dividing the total default cost by the active quantity. string false
cost_per_unit_actual The cost per unit of the inventory. Note: This is calculated by dividing the total cost by the active quantity. string false
location_id ID of the location string false
product_id ID of the product string true
reserved Reserved quantity string true
total_cost_actual The aggregated total cost of the inventory's active quantity string false
total_cost_default The aggregated total default cost of the inventory's active quantity string false
updated_datetime The datetime at which the inventory was last updated string false

InventoryAssetsReport

The Inventory Assets report

Property Description Type Required
data The report rows array(InventoryAssetsReportRow) true
meta Report-level metadata InventoryAssetsReportMeta true

InventoryAssetsReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

InventoryAssetsReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(InventoryAssetsReportColumn) false
date_range The human-readable date the report was generated string false
report The report identifier string true

InventoryAssetsReportRow

A single row of the Inventory Assets report. The final_input, cost_origin, and cost_quantity keys are present only when style=granular. Cost keys (unit_cost_actual, unit_cost_default, total_cost_actual, total_cost_default) are omitted for users without permission to view costs.

Property Description Type Required
active_quantity The active on-hand quantity number false
assembling_quantity The quantity being assembled number false
batch_number The batch number string false
category The product's category string false
cost_origin The origin of the cost input (granular) string false
cost_quantity The quantity attributed to the cost input (granular) number false
expiration_date The asset's expiration date string false
final_input Whether the row is the final asset or a cost input (granular) string false
harvest_date The package's harvest date string false
license The location's license number string false
location The location name string false
owner The product owner's name string false
package_number The package compliance label string false
product The product name string false
selling_quantity The quantity being sold number false
sku The product SKU string false
subcategory The product's subcategory string false
total_cost_actual The actual total cost number false
total_cost_default The default total cost number false
tracking_method The product's inventory tracking method string false
unit_cost_actual The actual cost per unit number false
unit_cost_default The default cost per unit number false
unit_price The product's unit price number false
unit_type The unit type string false
vendor The product's vendor string false

InventoryTransactionHistoryReport

The Inventory Transaction History report

Property Description Type Required
data The report rows array(InventoryTransactionHistoryReportRow) true
meta Report-level metadata InventoryTransactionHistoryReportMeta true

InventoryTransactionHistoryReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

InventoryTransactionHistoryReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(InventoryTransactionHistoryReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

InventoryTransactionHistoryReportRow

A single row of the Inventory Transaction History report (one inventory transaction). Companies on the BioTrack compliance integration do not get the metrc_unit_name and metrc_production_batch_number keys. Potency keys are only populated for package-based transactions.

Property Description Type Required
amount The transaction amount (signed quantity) number false
batch_id The batch ID string false
batch_number The Distru batch number string false
cbd The package CBD percentage number false
cbd_mg_g The package CBD in mg/g number false
cbd_mg_ml The package CBD in mg/mL number false
company_relationship_id The related company relationship ID string false
date The transaction date and time, in the company's timezone string false
description The transaction description string false
metrc_production_batch_number The Metrc production batch number string false
metrc_unit_name The Metrc unit name string false
package_batch_number_or_batch_name The package batch number or, for batch-tracked products, the batch name string false
package_label The package compliance label string false
product The product name string false
product_id The product ID string false
related_entity The related entity (order, return, assembly, adjustment...) string false
related_entity_customer_vendor The related entity's customer or vendor name string false
related_entity_status The related entity's status string false
thc The package THC percentage number false
thc_mg_g The package THC in mg/g number false
thc_mg_ml The package THC in mg/mL number false
total_cbd The package total CBD percentage number false
total_cbd_mg_g The package total CBD in mg/g number false
total_cbd_mg_ml The package total CBD in mg/mL number false
total_cost The transaction's total cost number false
total_thc The package total THC percentage number false
total_thc_mg_g The package total THC in mg/g number false
total_thc_mg_ml The package total THC in mg/mL number false
type The transaction type string false
unit_type The unit type string false

InventoryValuationReport

The Inventory Valuation report

Property Description Type Required
data The report rows array(InventoryValuationReportRow) true
meta Report-level metadata InventoryValuationReportMeta true

InventoryValuationReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

InventoryValuationReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(InventoryValuationReportColumn) false
date_range The human-readable date the report was generated string false
report The report identifier string true

InventoryValuationReportRow

A single row of the Inventory Valuation report (one product). Companies with Product custom fields will see additional keys. When calculation_method=cost, the active_value_price key is returned as active_value_cost instead.

Property Description Type Required
active_quantity The active on-hand quantity number false
active_value_price The active inventory value (priced by unit price) number false
assembling_quantity The quantity being assembled number false
available_quantity The available quantity (active minus reserved) number false
brand The product's brand string false
category The product's category string false
group The product's group string false
image_url The product's thumbnail image URL string false
incoming_quantity The incoming quantity from open purchases number false
inventory_threshold_max The product's inventory alert maximum number false
inventory_threshold_min The product's inventory alert minimum number false
name The product name string false
owner The product owner's name string false
pending_output_quantity The quantity pending output from open assemblies number false
reserved_quantity The reserved quantity number false
sku The product SKU string false
subcategory The product's subcategory string false
unit_cost The product's unit cost number false
unit_price The product's unit price number false
unit_type The product's unit type string false
vendor The product's vendor string false

Invoice

An invoice as shown in Distru. Ordered by invoice date

Property Description Type Required
billing_location A location with its license number inlined, as nested on orders/invoices/purchases LocationWithLicense false
charges A collection of Charges array(Charge) false
company A company as nested inside another entity in Distru CompanyCompact 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
external_notes Notes on this invoice that are visible to 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
internal_notes Notes on this invoice that are only visible internally 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
order A compact view of an order as nested inside another entity in Distru CompactOrder false
owner Information about a user in Distru User false
paid_amount The payment amount recorded against this invoice so far. string false
payment_term_name The name of the payment term applied to this invoice (e.g. "Net 30") string false
payments A collection of the invoice's payments array(Payment) false
remaining_amount The remaining amount for this invoice string false
status The status of this invoice string false
total The total for this invoice including taxes, discounts, and all line items string false
updated_datetime The datetime at which the invoice was last updated in Distru string false
voided_datetime The datetime the invoice was voided. An invoice is automatically voided when its sales order is canceled, and un-voided (cleared back to null) if that order later leaves the canceled status. Null for invoices that have never been voided. string false

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

InvoiceChargesRequest

A collection of Invoice charge params

Property Description Type Required

InvoiceHistoryReport

The Invoice History report

Property Description Type Required
data The report rows array(InvoiceHistoryReportRow) true
meta Report-level metadata InvoiceHistoryReportMeta true

InvoiceHistoryReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

InvoiceHistoryReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(InvoiceHistoryReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

InvoiceHistoryReportRow

A single row of the Invoice History report. Companies on a compliance integration and companies with Invoice custom fields will see additional keys.

Property Description Type Required
charge_summary A per-charge breakdown of the invoice charges string false
customer The customer name string false
discount_summary A per-discount breakdown of the invoice discounts string false
due_date The due date, in the company's timezone string false
invoice_date The invoice date, in the company's timezone string false
invoice_number The invoice number string false
line_item_subtotal The invoice line item subtotal number false
outstanding The outstanding (unpaid) amount on the invoice number false
owner The invoice owner's name string false
paid The amount paid on the invoice number false
sales_order The sales order number the invoice belongs to string false
status The invoice payment status string false
tax_summary A per-tax breakdown of the invoice taxes string false
total The invoice total number false
total_charges The total charges on the invoice number false
total_discounts The total discounts on the invoice number false
total_taxes The total taxes on the invoice number false

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
cost_per_unit The cost per unit of this invoice item. string false
cost_per_unit_default The default cost per unit (from the configured product unit cost) of this invoice item. string false
description A free-text description for this invoice line item string false
id Unique ID for this invoice item string false
order_item_id The ID of the order item this invoice item is associated with integer false
package A package as shown in Distru Package false
price Price per unit of this invoice item string false
product A product as shown in Distru Product false
quantity Quantity used on this invoice item string 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. |string|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. |string|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. |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

InvoiceItemsRequest

A collection of invoice item params

Property Description Type Required

InvoicePayment

An invoice payment as shown in Distru

Property Description Type Required
amount The amount of the payment number false
description 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
quickbooks_deposit_account_name The name of the Quickbooks deposit account used for this payment string false
quickbooks_sync_enqueued Whether a sync of this payment to QuickBooks was enqueued. False when the company isn't integrated with QuickBooks, or when the payment's invoice or credits aren't synced yet (those must be synced first). boolean false

InvoiceResponse

A single invoice wrapped in a data envelope

Property Description Type Required
data An invoice as shown in Distru. Ordered by invoice date Invoice false

Invoices

A collection of Invoices

Property Description Type Required
data Invoices array(Invoice) false
next_page URL for the next page of results; null when there is no next page string false

License

A license as shown in Distru

Property Description Type Required
active Whether this license is currently active boolean false
expiry_datetime The datetime this license expires string false
id Unique ID for this license string false
issue_datetime The datetime this license was issued string false
license_number License number string false
license_type The license type as configured in Distru. A state-specific free-form value, e.g. "Distributor" or "Type 11 Distributor-Transport" string false

Location

A location as shown in Distru

Property Description Type Required
address Human readable address for this location string false
apt The apartment/suite/unit of this location, or null string false
city The city of this location string false
company_id ID of the company that owns this location string false
country The country of this location string false
deleted_at The datetime of deletion if the location was deleted string false
id Unique ID for this location string false
inserted_datetime The datetime this location was created at string false
latitude The latitude of this location number 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
longitude The longitude of this location number false
metrc_id The Metrc location ID for this location, or null integer false
name Human readable name for this location string false
state The state of this location string false
street_address The street address of this location string false
updated_datetime The datetime this location was last updated at string false
zip The postal code of this location string false

LocationCompact

A location as nested inside another entity 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_id ID of the license this location is associated with, null if none string false
name Human readable name for this location string false

LocationResponse

A single location wrapped in a data envelope

Property Description Type Required
data A location as shown in Distru Location false

LocationWithLicense

A location with its license number inlined, as nested on orders/invoices/purchases

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_id ID of the license this location is associated with, null if none string false
license_number License number of the location's license, null if none string false
name Human readable name for this location string false

Locations

A collection of Locations

Property Description Type Required
data Locations array(Location) false
next_page URL for the next page of results; null when there is no next page string false
Property Description Type Required
active Whether the menu is active boolean false
available_delivery_days Days of the week available for delivery, e.g. MONDAY, TUESDAY, ..., SUNDAY array(any) false
default_order_status Status applied to orders placed through this menu string false
discoverable Whether the menu is listed on the DistruCommerce marketplace. Only possible when visibility is PUBLIC boolean false
external_name External menu name string false
id Unique ID for this menu string false
inserted_datetime Created at (UTC ISO-8601) string false
internal_name Internal menu name string false
minimum_order_lead_time_days Number of days from order placement that are unavailable for delivery integer false
minimum_order_subtotal Minimum order subtotal required to check out through this menu; null when unset string false
product_count Count of active products on the menu integer false
updated_datetime Updated at (UTC ISO-8601) string false
url The menu's primary public URL; null when the menu has no primary URL string false
visibility One of: PUBLIC, PRIVATE, PASSCODE_PROTECTED string false

A single menu wrapped in a data envelope

Property Description Type Required
data Menu false

A collection of menus

Property Description Type Required
data Menus array(Menu) false
next_page URL for the next page of results; null when there is no next page string false

OfficialProductCategories

A collection of official product categories

Property Description Type Required
data OfficialProductCategories array(OfficialProductCategory) false
next_page URL for the next page of results; null when there is no next page string false

OfficialProductCategory

An official product category

Property Description Type Required
id Unique ID for this official product category string false
name The name of the official product category string false

Order

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

Property Description Type Required
billing_location A location with its license number inlined, as nested on orders/invoices/purchases LocationWithLicense false
biotrack_id The ID of the BioTrack manifest associated with this order string false
blaze_payment_type The payment type for an order shipping to a Blaze-associated company. string false
buyer_company A company as nested inside another entity in Distru CompanyCompact false
buyer_note A note left by the buyer when the order was placed through a Distru menu, or null string false
charges A collection of Charges array(Charge) false
combined_order A compact view of an order as nested inside another entity in Distru CompactOrder false
company A company as nested inside another entity in Distru CompanyCompact false
creator Information about a user in Distru User false
custom_data A collection of CustomData array(CustomField) false
delivered_datetime The datetime the order was marked Delivered or Completed, or null if it never reached those statuses string 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
external_notes External notes for this order 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
inventory_source A location with its license number inlined, as nested on orders/invoices/purchases LocationWithLicense false
invoices A collection of the invoices on this order array(CompactInvoice) false
items A collection of SalesOrderItems array(SalesOrderItem) false
leaflink_id The LeafLink ID for this order string false
leaflink_order_number The LeafLink order number for this order string false
menu A compact reference to a menu, nested inside another entity in Distru CompactMenu false
metrc_transfer_id The ID of the Metrc transfer associated with this order integer 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
payment_term_name The name of the payment term applied to this order string false
returns A collection of the returns on this order array(CompactReturn) false
shipping_location A location with its license number inlined, as nested on orders/invoices/purchases LocationWithLicense false
status The status of this sales order string false
total The total for this order including taxes, discounts, and all line items string false
updated_datetime The datetime at which the order was last updated in Distru 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 name of this charge (e.g. "Delivery Fee") string false
percent The percentage applied for this charge. Used when type is PERCENT number false
price The flat amount for this charge. Used when type is PRICE 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

OrderChargesRequest

A collection of Order charge params

Property Description Type Required

OrderFulfillmentReport

The Order Fulfillment report

Property Description Type Required
data The report rows array(OrderFulfillmentReportRow) true
meta Report-level metadata OrderFulfillmentReportMeta true

OrderFulfillmentReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

OrderFulfillmentReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions, including one column per matching order array(OrderFulfillmentReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

OrderFulfillmentReportRow

A single row of the Order Fulfillment report (one product). In addition to the keys below, each row carries one dynamic key per matching order, named after the slugified order number (e.g. so_1042), whose value is the quantity of this product on that order.

Property Description Type Required
category The product's category string false
group The product's group string false
product The product name string false
subcategory The product's subcategory string false
total_units The total units of this product across the matching orders number false
total_value The total value of this product across the matching orders number false
unit_price The product's unit price number false

OrderItemRequest

Order item params

Property Description Type Required
batch_id The ID of the batch (if the product is batch-tracked) string false
compliance_quantity The Metrc (compliance) quantity for this item. For unit/each-based package-tracked products this must equal the package's full Metrc quantity, and quantity must equal it number 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
is_sample True if this order is a sample boolean false
location_id The ID of the location this order item is fulfilled from 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

OrderItemsRequest

A collection of Order item params

Property Description Type Required

OrderResponse

A single order wrapped in a data envelope

Property Description Type Required
data A sales order as shown in Distru. Ordered by order date Order 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
estimated_arrival_datetime The estimated arrival datetime (ISO 8601 format) string false
estimated_departure_datetime The estimated departure datetime (ISO 8601 format) 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

OrderTransferTemplateTransporterInfosRequest

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

Property Description Type Required

Orders

A collection of Orders

Property Description Type Required
data Orders array(Order) false
next_page URL for the next page of results; null when there is no next page 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

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
bins The bins this package is stored in. Only present when bin inventory tracking is enabled for the company. array(BinCompact) false
biotrack_id The BioTrack inventory ID for this package; null for non-BioTrack packages integer false
biotrack_inventory_type_id The BioTrack inventory type ID for this package integer false
biotrack_net_quantity_per_unit The BioTrack net quantity per unit for this package string false
biotrack_room_id The BioTrack room ID where this package is stored integer false
biotrack_status The package's BioTrack inventory status. Null for non-BioTrack packages. string false
biotrack_usable_weight The BioTrack usable weight for this package. For weighable (weight/volume) packages this is the package's weight at creation; for count-based packages it is the per-unit amount of cannabis. May be null for some inventory types (and is null for non-BioTrack packages). string false
compliance_label The compliance (e.g. Metrc) label for this package string false
compliance_product_name The product name reported by the compliance system (e.g. Metrc, BioTrack) string false
compliance_strain_name The strain name reported by the compliance system (e.g. Metrc, BioTrack) string false
compliance_transferred_datetime The datetime this package was transferred out in the compliance system (ISO 8601); null if not transferred out string false
compliance_type The compliance system tracking this package: METRC or BIOTRACK; null if not compliance-tracked string false
cost_per_unit_actual The cost per unit of this package string false
cost_per_unit_default The default cost per unit (from the configured product unit cost) of this package string false
creator Information about a user in Distru User false
custom_data The custom data for this package array(CustomField) false
description The description for this package string false
expiration_datetime The date and time this package expires (ISO 8601) string false
finished_datetime The datetime this package was finished in the compliance system (ISO 8601); null if not finished string false
harvest_date The harvest date for this package (ISO 8601) string false
id Unique ID for this package in Distru string false
inactivated_datetime The datetime this package was inactivated (ISO 8601); null while active string false
is_production_batch True if this package is a production batch boolean false
is_test_sample True if this package is a test sample boolean false
is_trade_sample True if this package is a Metrc trade sample boolean false
lab_testing_state Compliance lab testing state (e.g. Metrc); BioTrack uses analogous values string false
license A license as shown in Distru License false
location.id Unique ID for this Location string false
location.name The name of this Location string false
metrc_archived_date The date this package was archived in Metrc — i.e. the moment it was discontinued in Metrc (ISO 8601 date) string false
metrc_finished_date The date this package was finished in Metrc (ISO 8601 date) string false
metrc_id The Metrc package ID for this package; null for non-Metrc packages integer false
metrc_label The Metrc label for this package, null if not Metrc-tracked string false
metrc_production_batch_number The Metrc production batch number for this package string false
metrc_received_datetime The most recent datetime this package was received via a Metrc transfer (ISO 8601) string false
metrc_received_from_manifest_number The Metrc manifest number the package was most recently received from string false
metrc_source_harvest_names The Metrc source harvest names for this package string false
metrc_status The package's Metrc inventory status. Null for BioTrack-synced packages. string false
metrc_transfer_id The Metrc transfer ID this package is currently on; null if not in transit integer false
metrc_unit_name The Metrc unit of measure name for this package string false
owner Information about a user in Distru User false
packaged_date The compliance packaged date for this package (ISO 8601) string false
primary_test_result The compact primary test result nested on a package or batch PrimaryTestResult false
product_id The ID of this package's product string 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
total_cost_actual The total actual cost of this package string false
total_cost_default The total default cost (from the configured product unit cost) of this package string false
unit_type A unit type as shown in Distru UnitType false

PackageFullResponse

A single package wrapped in a data envelope

Property Description Type Required
data A package with extended details as shown in Distru PackageFull false

Packages

A collection of Packages

Property Description Type Required
data Packages array(PackageFull) false
next_page URL for the next page of results; null when there is no next page string false

Page

Pagination information for a request

Property Description Type Required
number Page number integer true

PageWithSize

Pagination information for a request

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

Payment

A payment as shown in Distru

Property Description Type Required
amount The amount of this payment string false
company A company as nested inside another entity in Distru CompanyCompact false
credit_uses Credits applied towards this invoice payment. Null for purchase payments. array(PaymentCreditUse) false
description Description of this payment string false
fully_paid_with_credits Whether this payment was fully paid using credits. When true, payment_method is null. boolean false
id Unique ID for this payment string false
inserted_datetime The datetime at which the payment was created in Distru string false
invoice A compact view of an invoice as nested inside another entity in Distru CompactInvoice false
overpayment_credits Credits created from overpaying this invoice payment. Null for purchase payments. array(PaymentCredit) false
payment_date The datetime of this payment string false
payment_method A payment method as shown in Distru PaymentMethod false
payment_number The payment number as shown in the Distru UI string false
payment_type Whether this payment belongs to an invoice (INVOICE) or a purchase (PURCHASE) string false
purchase A compact representation of the purchase a payment belongs to PaymentPurchase false
quickbooks_deposit_account_id The QuickBooks Online deposit account ID for this payment string false
quickbooks_deposit_account_name The QuickBooks Online deposit account name for this payment. Only present on the single-payment response. string false
quickbooks_sync_enqueued Whether a QuickBooks Online sync was enqueued for this payment. Only present on the payment creation response. boolean false
status The status of this payment. Either POSTED or VOIDED. string false
updated_datetime The datetime at which the payment was last updated in Distru string false

PaymentCredit

A compact representation of a credit related to a payment

Property Description Type Required
amount The current amount of this credit string false
credit_number The credit number as shown in the Distru UI string false
id Unique ID for this credit string false
source How this credit was created string false

PaymentCreditUse

A credit applied towards an invoice payment

Property Description Type Required
amount The amount of credit applied towards the payment string false
credit A compact representation of a credit related to a payment PaymentCredit false
id Unique ID for this credit use string false

PaymentMethod

A payment method as shown in Distru

Property Description Type Required
active Whether this payment method is active boolean false
deleted_at The datetime of deletion if the payment method was deleted string false
id Unique ID for this payment method string false
inserted_datetime The datetime this payment method was created at string false
name Name of the payment method string false
qb_payment_method_id The ID of the matching payment method in QuickBooks Online, if this payment method is synced string false
type The payment method type. One of CASH, CHECK, CREDIT_CARD, BANK_REMITTANCE, BANK_TRANSFER string false
updated_datetime The datetime this payment method was last updated at string false

PaymentMethodResponse

A single Payment Method

Property Description Type Required
data A payment method as shown in Distru PaymentMethod false

PaymentMethods

A collection of Payment Methods

Property Description Type Required
data Payment Methods array(PaymentMethod) false
next_page URL for the next page of results; null when there is no next page string false

PaymentPurchase

A compact representation of the purchase a payment belongs to

Property Description Type Required
id Unique ID for this purchase string false
purchase_number The purchase number as shown in the Distru UI string false
status The status of this purchase string false
total The total amount of this purchase string false

PaymentResponse

A single Payment

Property Description Type Required
data A payment as shown in Distru Payment false

PaymentTerm

A payment term as shown in Distru

Property Description Type Required
days Number of days until payment is due integer false
id Unique ID for this payment term string false
inserted_datetime The datetime this payment term was created at string false
locked Whether this payment term is a locked Distru default that cannot be edited boolean false
name Name of the payment term string false
time_of_day Time of day the payment is due string false
updated_datetime The datetime this payment term was last updated at string false

PaymentTerms

A collection of Payment Terms

Property Description Type Required
data Payment Terms array(PaymentTerm) false
next_page URL for the next page of results; null when there is no next page string false

Payments

A collection of Payments

Property Description Type Required
data Payments array(Payment) false
next_page URL for the next page of results; null when there is no next page string false

PdfDownloadUrl

The JSON envelope a PDF download endpoint returns when ?format=url is passed

Property Description Type Required
data.expires_datetime ISO 8601 datetime when the signed URL expires string false
data.url Temporary signed URL to download the PDF string false

PlantLifecycleReport

The Plant Lifecycle report

Property Description Type Required
data The report rows array(PlantLifecycleReportRow) true
meta Report-level metadata PlantLifecycleReportMeta true

PlantLifecycleReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

PlantLifecycleReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(PlantLifecycleReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

PlantLifecycleReportRow

A single row of the Plant Lifecycle report (one plant batch). The cost keys (total_cost_batch_stage, total_cost_veg_to_last_harvest, destroyed_plant_cost, total_lifecycle_cost) are omitted for users without permission to view costs.

Property Description Type Required
batch_creation_date The plant batch creation date string false
days_as_batch The number of days spent as a batch number false
days_veg_to_last_harvest The number of days from veg to the last harvest number false
destroyed_plant_cost The cost of destroyed plants number false
first_harvest_date The date of the batch's first harvest string false
harvest_name_s The names of the harvests the batch produced string false
last_harvest_date The date of the batch's last harvest string false
plant_batch_name The plant batch name string false
plants_destroyed The number of plants destroyed number false
plants_harvested The number of plants harvested number false
plants_promoted_to_veg The number of plants promoted to vegetative number false
plants_started The number of plants started number false
promoted_to_veg_date The date the batch was promoted to vegetative string false
strain The strain name string false
total_cost_batch_stage The total cost during the batch stage number false
total_cost_veg_to_last_harvest The total cost from veg to the last harvest number false
total_lifecycle_cost The total lifecycle cost number false
total_lifecycle_days The total number of lifecycle days number false

PrimaryTestResult

The compact primary test result nested on a package or batch

Property Description Type Required
cbd_mg_per_unit The CBD mg per unit for this test result string false
cbd_mg_per_unit_total The total CBD mg per unit for this test result string false
cbd_percentage The CBD percentage for this test result string false
cbd_percentage_total The total CBD percentage for this test result string false
coa_url Public URL to view/download this test result's Certificate of Analysis (COA), or null when no file is attached 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
thc_mg_per_unit The THC mg per unit for this test result string false
thc_mg_per_unit_total The total THC mg per unit for this test result string false
thc_percentage The THC percentage for this test result string false
thc_percentage_total The total THC percentage for this test result string false

Product

A product as shown in Distru

Property Description Type Required
bill_of_materials A product's bill of materials (recipe of inputs and additional costs) BillOfMaterials false
brand A company as nested inside another entity in Distru CompanyCompact false
category A product category as shown in Distru ProductCategoryCompact false
creator Information about a user in Distru User false
custom_data The custom data for this product array(CustomField) false
deleted_at The datetime of deletion if the product was deleted string false
description The description of this product string false
description_markdown The description of this product in markdown format string false
external_name Customer-facing name for DistruCommerce menus and Order Tracker string false
gross_weight The gross weight of the product string false
gross_weight_unit_type A unit type as shown in Distru UnitType false
id Unique ID for this product string false
images The images associated with the product array(Image) false
inventory_tracking_method How this product's inventory is tracked. One of: BATCH (grouped into batches sharing traits such as expiration dates and test results), PACKAGE (inventory is defined by packages), PRODUCT (ungrouped; inventory exists directly on the product). string false
is_active Is this product active? boolean false
is_featured Is this product featured? boolean false
leaflink_product_id The LeafLink product ID this product is synced to, or null if not synced integer false
menu_visibility Which menus this product is shown in. One of DO_NOT_INCLUDE, INCLUDE_IN_ALL, INCLUDE_IN_SELECT (same values accepted by the upsert endpoint), or null if unset. The menus field below lists the specific menus the product belongs to — this is how you see which menus when the value is INCLUDE_IN_SELECT. When the value is INCLUDE_IN_ALL, menus lists every menu (newly created menus are automatically added). string false
menus Menus this product is associated with, ordered by menu creation time then id (includes inactive menus). Reflects menu_visibility: empty for DO_NOT_INCLUDE, the selected subset for INCLUDE_IN_SELECT, and every menu for INCLUDE_IN_ALL. array(CompactMenu) false
msrp The MSRP of the product string false
name Human readable name for this product string false
owner Information about a user in Distru User false
product_group.id Unique ID for this product group string false
product_group.name The name of this product group string false
quantity_available_threshold_max The maximum available quantity before an over-stock alert is triggered string false
quantity_available_threshold_min The minimum available quantity before a low-stock alert is triggered 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 ProductSubcategoryCompact false
tags The tags associated with this product array(ProductTagRef) false
total_cannabinoid_unit The unit that total THC and CBD are measured in string false
total_cbd The total CBD of this product string false
total_thc The total THC of this product string false
treez_wholesale_price The Treez wholesale price of this product, or null string false
unit_cost The cost (or purchase price) of the product per unit. string false
unit_net_weight The net weight of the product per unit string false
unit_net_weight_serving_size_unit_type A unit type as shown in Distru UnitType false
unit_price The price of one unit of this product string false
unit_serving_size The serving size of the product per unit string 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 string false
upc The UPC of this product string false
updated_datetime The datetime this product was last updated at string false
vendor A company as nested inside another entity in Distru CompanyCompact false
wholesale_unit_price The wholesale unit price of this product number false

ProductCategories

A collection of product categories

Property Description Type Required
data Product Categories array(ProductCategory) false
next_page URL for the next page of results; null when there is no next page string false

ProductCategory

A product category

Property Description Type Required
id Unique ID for this product category string false
inserted_datetime When the product category was created (UTC ISO-8601) string false
name The name of the product category string false
official_product_category_id The official product category ID this category maps to string false
updated_datetime When the product category was last updated (UTC ISO-8601) string false

ProductCategoryCompact

A product category as shown in Distru

Property Description Type Required
id Unique ID for this category string false
name Human readable name for this category string false
official_product_category_id The official product category ID this category maps to string false

ProductCategoryResponse

A single product category

Property Description Type Required
data A product category ProductCategory false

ProductGroup

A product group

Property Description Type Required
id Unique ID for this product group string false
inserted_datetime When the product group was created (UTC ISO-8601) string false
name The name of the product group string false
updated_datetime When the product group was last updated (UTC ISO-8601) string false

ProductGroupResponse

A single product group

Property Description Type Required
data A product group ProductGroup false

ProductGroups

A collection of product groups

Property Description Type Required
data Product Groups array(ProductGroup) false
next_page URL for the next page of results; null when there is no next page string false

ProductPosMapping

A mapping between a Distru product and a POS product

Property Description Type Required
blaze_asset_id Blaze asset ID string false
blaze_product_id Blaze product ID string false
blaze_retailer_id Blaze retailer ID string false
dutchie_product_id Dutchie product ID integer false
dutchie_retailer_id Dutchie retailer ID string false
id Mapping ID string false
inserted_datetime Creation timestamp string false
pos_type POS type (BLAZE, DUTCHIE, or TREEZ) string false
product_id Distru product ID string false
treez_photo_url Treez photo URL string false
treez_product_id Treez product ID string false
treez_retailer_id Treez retailer ID integer false
updated_datetime Last update timestamp string false

ProductPosMappingResponse

Property Description Type Required
data A mapping between a Distru product and a POS product ProductPosMapping false

ProductPosMappingsResponse

Property Description Type Required
data List of POS mappings array(ProductPosMapping) false

ProductResponse

A single Product

Property Description Type Required
data A product as shown in Distru Product false

ProductSubcategories

A collection of product subcategories

Property Description Type Required
data Product Subcategories array(ProductSubcategory) false
next_page URL for the next page of results; null when there is no next page string false

ProductSubcategory

A product subcategory

Property Description Type Required
category A product category as shown in Distru ProductCategoryCompact false
id Unique ID for this product subcategory string false
inserted_datetime When the product subcategory was created (UTC ISO-8601) string false
name The name of the product subcategory string false
updated_datetime When the product subcategory was last updated (UTC ISO-8601) string false

ProductSubcategoryCompact

A product subcategory as shown in Distru

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

ProductSubcategoryResponse

A single product subcategory

Property Description Type Required
data A product subcategory ProductSubcategory false

ProductTagRef

A tag associated with a product

Property Description Type Required
id Unique ID for this tag string false
name The name of this tag string false

Products

A collection of Products

Property Description Type Required
data Products array(Product) false
next_page URL for the next page of results; null when there is no next page string false

Purchase

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

Property Description Type Required
billing_location A location with its license number inlined, as nested on orders/invoices/purchases LocationWithLicense false
biotrack_id The BioTrack transfer ID this purchase was matched with, if any string false
charges A collection of Charges array(Charge) false
company A company as nested inside another entity in Distru CompanyCompact false
creator Information about a user in Distru User false
custom_data The custom data for this purchase order array(CustomField) false
description A description of the purchase order 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
items A collection of PurchaseOrderItems array(PurchaseOrderItem) false
location A location with its license number inlined, as nested on orders/invoices/purchases LocationWithLicense false
metrc_transfer_id The Metrc transfer ID this purchase was matched with, if any integer false
order_datetime The datetime on which the order was placed string false
owner Information about a user in Distru User false
paid The total amount paid towards this purchase order across all payments string false
payment_status The payment status of this purchase order string false
payments A collection of the purchase's payments array(Payment) false
purchase_number The purchase order number as shown in the Distru UI string false
qb_bill_id The ID of the associated bill in QuickBooks Online, if synced string false
status The status of this purchase order string false
supplier_location A location as nested inside another entity in Distru LocationCompact false
total The total for this order including taxes, discounts, and all line items string false
updated_datetime The datetime at which the order was last updated in Distru string 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 true
percent The percent value for this charge. Required if unit_type is PERCENT number false
price The flat price for this charge. Required if unit_type is PRICE. Auto-calculated for percent-based charges number false
type Type of this line item. Note: Tax charges should be sent as CHARGE with a tax_id string true
unit_type Determines if this line is tracked as a percentage or a flat charge string true

PurchaseChargesRequest

A collection of Purchase charge params

Property Description Type Required

PurchaseItemRequest

Purchase item params. Must provide either batch_id or product_id. If batch_id is provided, product_id will be auto-filled. If product_id is provided for a product-tracked item, batch_id will be auto-filled.

Property Description Type Required
batch_id The ID of the batch 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 purchase order item record string false
price Price per unit of the inventory being received on this purchase item number true
product_id The ID of the product string false
quantity Quantity received in this purchase item number true

PurchaseItemsRequest

A collection of purchase item params

Property Description Type Required

PurchaseOrderHistoryReport

The Purchase Order History report

Property Description Type Required
data The report rows array(PurchaseOrderHistoryReportRow) true
meta Report-level metadata PurchaseOrderHistoryReportMeta true

PurchaseOrderHistoryReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

PurchaseOrderHistoryReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(PurchaseOrderHistoryReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

PurchaseOrderHistoryReportRow

A single row of the Purchase Order History report. Companies on a compliance integration and companies with Purchase custom fields will see additional keys.

Property Description Type Required
amount The purchase total number false
due_date The due date, in the company's timezone string false
owner The purchase owner's name string false
paid The amount paid on the purchase number false
purchase_date The purchase date, in the company's timezone string false
purchase_number The purchase number string false
status The purchase status string false
vendor The vendor name string false

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
compliance_quantity The quantity of this order item expressed in its package's unit type. Null if not package-tracked. string false
id Unique ID for this order item string false
is_sample True if this order item is a sample boolean false
location A location as nested inside another entity in Distru LocationCompact false
package A package as shown in Distru Package false
price Price per unit of this order item (with discounts applied) string false
price_base Price per unit of this order item string false
product A product as shown in Distru Product false
quantity Quantity purchased on this order item string false
received_quantity Quantity received on this order item. Less than or equal to the quantity field. Omitted when null. string false

PurchasePayment

A purchase payment as shown in Distru

Property Description Type Required
amount The amount of the payment number false
description 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
quickbooks_deposit_account_name The name of the Quickbooks deposit account used for this payment string false

PurchaseResponse

A single purchase order envelope

Property Description Type Required
data A purchase order as shown in Distru. Ordered by order date Purchase false

Purchases

A collection of Purchases

Property Description Type Required
data Purchases array(Purchase) false
next_page URL for the next page of results; null when there is no next page string false

PurchasesByCompanyReport

The Purchases By Company report

Property Description Type Required
data The report rows array(PurchasesByCompanyReportRow) true
meta Report-level metadata PurchasesByCompanyReportMeta true

PurchasesByCompanyReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

PurchasesByCompanyReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(PurchasesByCompanyReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

PurchasesByCompanyReportRow

A single row of the Purchases By Company report. Companies with CompanyRelationship custom fields will see additional keys.

Property Description Type Required
category The vendor's category string false
last_purchase_date The date of the vendor's most recent purchase string false
name The vendor (related company) name string false
product_owner The vendor's owner (sales rep) name string false
purchase_order_count The number of purchases in the reported date range number false
relationship_type The vendor's relationship type string false
total_purchases The total cost of the vendor's purchases number false

PurchasesByProductReport

The Purchases By Product report

Property Description Type Required
data The report rows array(PurchasesByProductReportRow) true
meta Report-level metadata PurchasesByProductReportMeta true

PurchasesByProductReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

PurchasesByProductReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(PurchasesByProductReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

PurchasesByProductReportRow

A single row of the Purchases By Product report. Companies with Product custom fields will see additional keys.

Property Description Type Required
category The product's category string false
group The product's group string false
name The product name string false
owner The product owner's name string false
quantity_purchased The quantity purchased number false
sale_price The product's sale price number false
sku The product SKU string false
subcategory The product's subcategory string false
total_purchased The total cost of the purchased quantity number false
unit_cost The product's unit cost number false
unit_type The product's unit type string false
vendor The product's vendor string false
wholesale_price The product's wholesale price number false

RelationshipType

A relationship type as shown in Distru

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

Return

A return as shown in Distru

Property Description Type Required
company A company as nested inside another entity in Distru CompanyCompact false
creator Information about a user in Distru User false
credits The credits generated from this return. array(CompactCredit) false
custom_data Custom data associated with this return map false
description Description of the return string false
id Unique ID for this return string false
inserted_datetime The datetime at which the return was created in Distru string false
invoice_numbers Invoice numbers associated with the order array(any) false
items The items on this return array(ReturnItem) false
location A location as nested inside another entity in Distru LocationCompact false
order_id The associated order ID (UUID) string false
order_number The order number from the associated order string false
order_quantity Total quantity of all items on the associated order string false
owner Information about a user in Distru User false
qb_credit_memo_id The id of the QuickBooks Online credit memo this return maps to, when synced. string false
return_datetime The datetime of the return string false
return_number The return number as shown in the Distru UI string false
return_quantity Total quantity of all items on this return string false
return_type Indicates if this is a Full Return or Partial Return. Full Return means ALL order items have been FULLY returned. Null if not associated with an order. string false
status The status of this return string false
total The total amount of this return number false
updated_datetime The datetime at which the return was last updated in Distru string false

ReturnItem

A return item as shown in Distru

Property Description Type Required
id Unique ID for this return item string false
price Price per unit number false
product A product as shown in Distru Product false
quantity Quantity returned number false
waste Whether this item was marked as waste boolean false

ReturnResponse

A single return envelope

Property Description Type Required
data A return as shown in Distru Return false

Returns

A collection of Returns

Property Description Type Required
data Returns array(Return) false
next_page URL for the next page of results; null when there is no next page string false

Role

A user role as shown in Distru

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

SalesByCompanyReport

The Sales By Company report

Property Description Type Required
data The report rows array(SalesByCompanyReportRow) true
meta Report-level metadata SalesByCompanyReportMeta true

SalesByCompanyReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

SalesByCompanyReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(SalesByCompanyReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

SalesByCompanyReportRow

A single row of the Sales By Company report. Companies with CompanyRelationship custom fields will see additional keys.

Property Description Type Required
category The customer's category string false
last_order_date The date of the customer's most recent order string false
name The customer (related company) name string false
order_count The number of orders in the reported date range number false
owner The customer's owner (sales rep) name string false
relationship_type The customer's relationship type string false
total_received The total payments received on the customer's orders number false
total_sales The total order sales, net of returns number false

SalesByProductReport

The Sales By Product report

Property Description Type Required
data The report rows array(SalesByProductReportRow) true
meta Report-level metadata SalesByProductReportMeta true

SalesByProductReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

SalesByProductReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(SalesByProductReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

SalesByProductReportRow

A single row of the Sales By Product report. Companies with Product custom fields will see additional keys.

Property Description Type Required
category The product's category string false
group The product's group string false
name The product name string false
product_owner The product owner's name string false
quantity_sold The quantity sold, net of returns number false
sale_price The product's sale price number false
shipped_from_license The license the sold items shipped from string false
sku The product SKU string false
subcategory The product's subcategory string false
total_sales The total sales, net of returns number false
unit_cost The product's unit cost number false
unit_type The product's unit type string false
upc The product's UPC string false
vendor The product's vendor string false
wholesale_price The product's wholesale price number false

SalesByUserReport

The Sales By User report

Property Description Type Required
data The report rows array(SalesByUserReportRow) true
meta Report-level metadata SalesByUserReportMeta true

SalesByUserReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

SalesByUserReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(SalesByUserReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

SalesByUserReportRow

A single row of the Sales By User report.

Property Description Type Required
leaderboard_rank The user's rank by total sales, with 1 as the top seller number false
order_count The number of orders in the reported date range number false
sales_pre_tax The pre-tax sales total, net of returns number false
total_sales The total sales, net of returns number false
user The user's (sales rep's) name string false

SalesOrderHistoryReport

The Sales Order History report

Property Description Type Required
data The report rows array(SalesOrderHistoryReportRow) true
meta Report-level metadata SalesOrderHistoryReportMeta true

SalesOrderHistoryReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

SalesOrderHistoryReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(SalesOrderHistoryReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

SalesOrderHistoryReportRow

A single row of the Sales Order History report. Companies on a compliance integration and companies with Order custom fields will see additional keys.

Property Description Type Required
charges_taxes_not_included The total charges on the order, taxes not included number false
customer The customer name string false
delivery_date The delivery date, in the company's timezone string false
delivery_date_utc The delivery date, in UTC string false
discounts_taxes_not_included The total discounts on the order, taxes not included number false
due_date The due date, in the company's timezone string false
due_date_utc The due date, in UTC string false
order_date The order date, in the company's timezone string false
order_date_utc The order date, in UTC string false
order_number The order number string false
outstanding The outstanding (unpaid) amount on the order number false
owner The order owner's name string false
paid The amount paid on the order number false
returns The total value of returns on the order number false
status The order status string false
subtotal The order subtotal number false
taxes The total taxes on the order number false
total The order total number false

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
compliance_quantity The quantity of this order item expressed in its package's unit type. Null if not package-tracked. string false
cost_per_unit The cost per unit of this order item string false
cost_per_unit_default The default cost per unit (from the configured product unit cost) of this order item string false
id Unique ID for this order item string false
is_sample True if this order item is a sample boolean false
leaflink_id The LeafLink ID for this order item, or null integer false
location A location as nested inside another entity in Distru LocationCompact false
note A note on this order item, or null string false
package A package as shown in Distru Package false
price Price per unit of this order item string false
price_base Price per unit before any discounts string false
product A product as shown in Distru Product false
quantity Quantity sold on this order item string false
received_quantity Quantity received on this order item. Omitted when null. string false
returned_quantity Quantity returned on this order item string false
thc_percentage_total The total THC % this order line is reserved at, used when the company sells by potency. Only meaningful for batch- or package-tracked products (always null for product-tracked items). Set from the order/menu selection when the line is created — it is not derived from or changed by the assigned package (a package can only fulfill the line if its primary test result's total THC matches this value). Null when not selling by potency. string 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. string 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. string false

SalesOrderItemHistoryReport

The Sales Order Item History report

Property Description Type Required
data The report rows array(SalesOrderItemHistoryReportRow) true
meta Report-level metadata SalesOrderItemHistoryReportMeta true

SalesOrderItemHistoryReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

SalesOrderItemHistoryReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(SalesOrderItemHistoryReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

SalesOrderItemHistoryReportRow

A single row of the Sales Order Item History report (one sales order line item). Companies on a compliance integration and companies with Order custom fields will see additional keys (package, potency, manifest, and custom field columns).

Property Description Type Required
batch_number The batch number string false
brand The brand name string false
brand_id The brand ID string false
category The product category string false
customer The customer name string false
customer_id The customer ID string false
default_unit_cost The product's default unit cost number false
default_unit_price The product's default unit price number false
default_wholesale_price The product's default wholesale price number false
delivery_date The delivery date, in the company's timezone string false
delivery_date_utc The delivery date, in UTC string false
due_date The due date, in the company's timezone string false
due_date_utc The due date, in UTC string false
group The product group string false
invoice_numbers The invoice numbers associated with the line item string false
line_item_id The line item ID string false
order_date The order date, in the company's timezone string false
order_date_utc The order date, in UTC string false
order_id The order ID string false
order_item_price The line item price number false
order_number The order number string false
product The product name string false
product_id The product ID string false
product_sku The product SKU string false
quantity The line item quantity number false
returned_quantity The returned quantity on the line item number false
sales_rep The sales rep's name string false
status The order status string false
subcategory The product subcategory string false
upc The product UPC string false
vendor The vendor name string false
vendor_id The vendor ID string false

SalesOrderTaxReport

The Sales Order Tax report

Property Description Type Required
data The report rows array(SalesOrderTaxReportRow) true
meta Report-level metadata SalesOrderTaxReportMeta true

SalesOrderTaxReportColumn

Property Description Type Required
key The key used for this column in each data row string true
label The human-readable label of the column string true

SalesOrderTaxReportMeta

Report-level metadata

Property Description Type Required
columns The report's column definitions array(SalesOrderTaxReportColumn) false
date_range The human-readable date range the report covers string false
report The report identifier string true

SalesOrderTaxReportRow

A single row of the Sales Order Tax report

Property Description Type Required
tax_rate The tax rate percentage number false
tax_type The name of the tax string false
total_tax The total tax collected for this tax type and rate number false

StockAdjustment

A stock adjustment as shown in Distru

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 string 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. string false
compliance_unit_type A unit type as shown in Distru UnitType false
creator Information about a user in Distru User false
description The description for this adjustment string false
id Unique ID for this stock adjustment string false
inserted_datetime The datetime this adjustment was created at 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 string false
reason The reason for this adjustment string false
total_cost The total cost of this adjustment string false
unit_cost The cost per unit of this adjustment string false
unit_type A unit type as shown in Distru UnitType false
updated_datetime The datetime this adjustment was last modified at string false

StockAdjustmentResponse

A single stock adjustment envelope

Property Description Type Required
data A stock adjustment as shown in Distru StockAdjustment false

StockAdjustments

A collection of Stock Adjustments

Property Description Type Required
data Stock Adjustments array(StockAdjustment) false
next_page URL for the next page of results; null when there is no next page string false

Strain

A strain as shown in Distru

Property Description Type Required
id Unique ID for this strain string false
inserted_datetime The datetime this strain was created at string false
name Name of the strain string false
strain_type The type of strain, or null if unset string false
updated_datetime The datetime this strain was last updated at string false

StrainResponse

A single Strain

Property Description Type Required
data A strain as shown in Distru Strain 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
data Strains array(Strain) false
next_page URL for the next page of results; null when there is no next page string false

Tag

A tag

Property Description Type Required
id Unique ID for this tag string false
name The name of the tag string false

TagResponse

A single tag envelope

Property Description Type Required
data A tag Tag false

Tags

A collection of tags

Property Description Type Required
data Tags array(Tag) false
next_page URL for the next page of results; null when there is no next page string false

Tax

A tax

Property Description Type Required
description The description of the tax string false
id Unique ID for this tax string false
inserted_datetime When the tax was created (UTC ISO-8601) string false
name The name of the tax string false
qb_account_id The associated QuickBooks Online account ID string false
qb_product_id The associated QuickBooks Online product ID string false
tags Tags associated with this tax array(Tag) false
tax_applied_after_charges Whether the tax is applied after charges boolean false
tax_applied_after_price_tiers Whether the tax is applied after price tiers boolean false
tax_code The tax code string false
tax_rate_percent The tax rate as a percentage number false
updated_datetime When the tax was last updated (UTC ISO-8601) string false

TaxResponse

A single tax envelope

Property Description Type Required
data A tax Tax false

Taxes

A collection of taxes

Property Description Type Required
data Taxes array(Tax) false
next_page URL for the next page of results; null when there is no next page 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
batch_id The ID of the batch this test result belongs to, or null string false
biotrack_id The BioTrack ID for this test result, or null string 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
coa_url Public URL to view/download this test result's Certificate of Analysis (COA), or null when no file is attached string false
id Unique ID for this test result string false
inserted_datetime The datetime this test result was created at 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
metrc_id The Metrc ID for this test result, or null integer 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
package_id The ID of the package this test result belongs to, or null 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

TestResultResponse

A single test result envelope

Property Description Type Required
data A test result as shown in Distru TestResult false

TestResults

A collection of Test Results

Property Description Type Required
data Test Results array(TestResult) false
next_page URL for the next page of results; null when there is no next page string false

UnitType

A unit type as shown in Distru

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

UnitTypeFull

A unit type

Property Description Type Required
active Whether the unit type is active boolean false
category The category of the unit type string false
id Unique ID for this unit type string false
inserted_datetime When the unit type was created (UTC ISO-8601) string false
locked Whether the unit type is locked boolean false
name The name of the unit type string false
qty_per_si_unit The number of this unit that make up one SI base unit of its category. For weight-based unit types the SI base unit is the kilogram (e.g. a Gram is 1000, a Pound is ~2.20462). For volume-based unit types the SI base unit is the liter (e.g. a Milliliter is 1000, a Gallon is ~0.264172). For count-based (discrete/each) unit types it is 1, since a count unit has no physical measure. string false
updated_datetime When the unit type was last updated (UTC ISO-8601) string false

UnitTypeFullResponse

A single unit type envelope

Property Description Type Required
data A unit type UnitTypeFull false

UnitTypes

A collection of unit types

Property Description Type Required
data Unit Types array(UnitTypeFull) false
next_page URL for the next page of results; null when there is no next page string false

UpsertCredit

Parameters for creating or updating a credit

Property Description Type Required
amount The credit amount. Must be greater than 0. Required when creating. number false
company_id ID of the customer (company) this credit applies to. Required when creating; cannot be changed on update. string false
external_note A note on this credit, visible to the customer string false
id ID of the credit to update. Omit to create a new credit. string false
internal_note An internal note on this credit string false
owner_id ID of the user who owns this credit. Defaults to the API user when creating. string false
quickbooks_sales_item_id Optional QuickBooks sales item this credit maps to, used only when QuickBooks credit sync is enabled. Omit or send null to use the default "Distru Sales" item. Never required. string false

UpsertProductPosMapping

Parameters for creating or updating a POS mapping

Property Description Type Required
blaze_product_id Blaze product ID string false
blaze_retailer_id Blaze retailer ID string false
dutchie_product_id Dutchie product ID integer false
dutchie_retailer_id Dutchie retailer ID string false
product_id Distru product ID string true
treez_product_id Treez product ID string false
treez_retailer_id Treez retailer ID string false

User

Information about a user in Distru

Property Description Type Required
banned Is this user banned by Distru? boolean false
deleted_at The datetime of deletion if the user was deleted string 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

UserResponse

A single user envelope

Property Description Type Required
data Information about a user in Distru User false

Users

A collection of Users

Property Description Type Required
data Users array(User) false
next_page URL for the next page of results; null when there is no next page string false

Vehicle

A vehicle

Property Description Type Required
color The color of the vehicle string false
description A description or name for the vehicle string false
id Unique ID for this vehicle string false
inserted_datetime When the vehicle was created (UTC ISO-8601) string false
license_plate_number The license plate number string false
license_plate_state The license plate state string false
make The make of the vehicle string false
model The model of the vehicle string false
updated_datetime When the vehicle was last updated (UTC ISO-8601) string false
vin The vehicle identification number (VIN) string false
year The year of the vehicle string false

VehicleResponse

A single vehicle envelope

Property Description Type Required
data A vehicle Vehicle false

Vehicles

A collection of vehicles

Property Description Type Required
data Vehicles array(Vehicle) false
next_page URL for the next page of results; null when there is no next page string false

Changelog

2026-08-17

2026-08-13

2026-08-12

2026-08-03

2026-07-30

2026-07-29

Read/write parity pass across the API — every field that can be set can now be read back, and related resources (owner, locations, notes, custom data, tags) are exposed consistently.

2026-07-27

2026-06-29

2026-06-23

2026-06-08

2026-05-28

2026-05-25

2026-05-17

2026-05-11

2026-05-06

2026-05-01

2026-03-27

2026-03-10

2026-02-13

2026-02-12

2026-02-10

2026-01-23

2026-01-21

2026-01-19

2025-10-24

2025-10-19

2025-10-15

2025-09-10

2025-08-21

2025-08-20

2025-08-19

2025-07-01

2025-06-12

2025-06-12

2025-06-09

2025-05-27

2025-05-22

2025-05-18

2025-05-16

2025-05-15

2025-05-14

2025-05-13

2025-05-06

2025-04-09

2025-03-18

2025-03-11

2025-03-05

2025-02-26

2025-01-31

2025-01-17

2025-01-15

2025-01-08

2024-12-26

2024-12-24

2024-11-06

2024-10-02