Create an order

Create a new order together with its samples. Many fields are optional
depending on state and regulatory requirements or seed-to-sale tracking.

Send the order as a single order form field containing the JSON-encoded
object described below. Every sample on the order must belong to the same
industry.

Order fields

  • client_id (int) — identifier for the client placing this order.
  • client_license_id (int) — identifier for the client license under which
    this order should be placed (the ID, not the license number).
  • lab_license_id (int) — identifier for the lab license under which this
    order should be placed (the ID, not the license number).
  • address_id (int) — lab address ID for drop-off orders, client address ID
    for pickup orders.
  • pickup (boolean, optional) — true if this order should be picked up at
    the client location. Defaults to false.
  • price_adjustment (float, optional) — dollar amount to change the order by;
    negative for a discount, positive for additional fees.
  • send_client_email (boolean, optional) — if true the client receives email
    notifications for the order being placed. Defaults to true.
  • lims_id (string, optional) — internal tracking ID for this order.
  • status_id (int, optional) — status in which to create the order. Defaults
    to 'placed'.

Secondary client

  • secondary_client_name (string, optional) — company name for the secondary
    client.
  • secondary_client_type (int, optional) — 1 for producer, 2 for
    distributor.
  • secondary_client_address (string, optional) — full address string for the
    secondary client.
  • secondary_client_license (string, optional) — license used by the secondary
    client for the order transaction.

Samples

samples is a list of objects, each accepting:

  • name (string) — product name for this sample.
  • strain_name (string) — name of the sample strain. Optional for
    non-cannabis samples.
  • type_id (int) — ID from the sample type enumeration.
  • production_method_id (int) — ID from the production method enumeration.
    Use 99 to submit a blank value.
  • classification_id (int) — ID from the sample classification enumeration.
    Use 1 to submit a blank value.
  • test_package_ids (list of int) — IDs of the test packages ordered for this
    sample.
  • notes (string, optional) — additional notes about this sample.
  • lims_id (string, optional) — internal tracking ID for this sample.
  • production_date (date, optional) — date the sample or product was
    harvested or created.
  • date_samples_collected (date, optional) — date the sample was collected.
  • batch_id (string, optional) — batch identifier.
  • batch_size (float, optional) — batch size.
  • batch_size_unit (string, optional) — g for grams, units for units, or
    lb for pounds. Defaults to g.
  • lot_id (string, optional) — lot identifier.
  • lot_size (float, optional) — lot size.
  • lot_size_unit (string, optional) — g for grams, units for units, or
    lb for pounds. Defaults to g.
  • production_run_id (string, optional) — production run identifier.
  • production_run_size (float, optional) — production run size.
  • production_run_size_unit (string, optional) — g for grams, units for
    units, or lb for pounds. Defaults to g.
  • manifest_id (string, optional) — manifest identifier, often for
    seed-to-sale systems.
  • harvest_id (string, optional) — harvest identifier, often for seed-to-sale
    systems.
  • regulator_sample_id (string, optional) — seed-to-sale tracking ID for this
    sample.
  • regulator_batch_id (string, optional) — seed-to-sale batch ID for this
    sample.
  • regulator_lot_id (string, optional) — seed-to-sale lot ID for this sample.

The following fields are required to calculate mg/container values for
edibles:

  • unit_description (string, optional) — describes the serving unit of the
    sample.
  • unit_weight (float, optional) — weight of an individual unit.
  • units_per_serving (float, optional) — how many units make up one serving.
  • servings_per_container (float, optional) — how many servings are in a
    container.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

JSON-encoded order object — see the field reference below.

Headers
string

HMAC-SHA256 request signature. Required only when request signing is enabled for your API key — see the Request Signing guide.

string

Unix timestamp (seconds) of the request, required only when request signing is enabled for your API key. Requests older than 30 seconds are rejected.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json