Delivery

Create Delivery

Create a delivery under the delivery capable license_number provided.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

state

required

string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Request Body schema: application/json

required

object

license_number

required

string

Reference (entity_ID) for the license. This is the business license number issued by the state.

estimated_departure

required

string <date-time>

The estimated departure date and time of the delivery.

required

object

The type of delivery.

required

string

The ID of the delivery type.

required

object

The transporter details for the delivery.

required

object

license_number

required

string

Reference (entity_ID) for the license. This is the business license number issued by the state.

required

object

The vehicle details of the transporter.

make required	string The make of the vehicle.
model required	string The model of the vehicle.
plate_number required	string The license plate number of the vehicle.

required

Array of objects

The personnel involved in the transportation.

Array

first_name required	string The first name of the personnel.
last_name required	string The last name of the personnel.
phone_number required	string The phone number of the personnel.
driver_license_number required	string The driver's license number of the personnel.
employee_license_number required	string The state/metrc issued license number of the employee.

required

Array of objects

The orders included in the delivery.

Array

required

object

The type of order.

required

string

The ID of the order type.

stop_number

required

integer

The stop number of the order in the delivery sequence.

required

object

The delivery information for the order.

consumer_id required	string The unique identifier for the customer that can be used to identify them.
customer_name required	string The name of the customer receiving the delivery.
customer_address_1 required	string The primary address line for the customer's delivery location.
customer_address_2	string The secondary address line for the customer's delivery location (if applicable).
customer_city required	string The city of the customer's delivery location.
customer_state required	string The state of the customer's delivery location.
customer_zip required	string The ZIP code of the customer's delivery location.
customer_county	string The county of the customer's delivery location.
estimated_departure_time required	string <date-time> The estimated departure time for the order to the customer.
estimated_arrival_time required	string <date-time> The estimated arrival time for the order to the customer.
route_info required	string Directions to the customer's delivery location.

required

object

The type of customer receiving the delivery.

required

string

The ID of the customer type.

terminal

string

The terminal used for the order.

external_id

required

string

Idempotency key for the order, unique to the system creating the order.

required

object

The creation timestamp of the order.

date required	string <date-time> The date and time when the order was created.
local_time required	string The local date and time when the order was created without timezone.

required

Array of objects

Identifications associated with the order.

Array

required	object The type of identification.
id required	string The identification value.

required

object

Employee associated with registering order.

required

string

The Trace ID of the employee."

required

Array of objects

The line items included in the order.

Array

required	object The lot identifier for the line item.
discount	string The discount applied to the line item.
quantity required	string The quantity of the item in the line item.
unit_price required	string The unit price of the item in the line item.
	Array of objects The taxes applied to the line item.
total required	string The total amount for the line item; calculated as unit_price * quantity - discount + sum(taxes).

required

object

The currency used for the order.

required

string

The ID of the sales/currency_types.

required

object

The totals for the order.

quantity required	string The total quantity of items in the order.
subtotal required	string The subtotal amount for the order before taxes and discounts.
total required	string The total amount for the order after taxes and discounts.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

license_number

required

string

Reference (entity_ID) for the license. This is the business license number issued by the state.

estimated_departure

string <date-time>

The estimated departure date and time of the delivery.

object

The type of delivery.

id	string The ID of the delivery type.

object

The transporter details for the delivery.

object

license_number

required

string

Reference (entity_ID) for the license. This is the business license number issued by the state.

object

The vehicle details of the transporter.

make	string The make of the vehicle.
model	string The model of the vehicle.
plate_number	string The license plate number of the vehicle.

Array of objects

The personnel involved in the transportation.

Array

first_name	string The first name of the personnel.
last_name	string The last name of the personnel.
phone_number	string The phone number of the personnel.
driver_license_number	string The driver's license number of the personnel.

Array of objects

The orders included in the delivery.

Array

	object The type of order.
stop_number	integer The stop number of the order in the delivery sequence.
	object The delivery information for the order.
	object The type of customer receiving the delivery.
terminal	string The terminal used for the order.
external_id	string Idempotency key for the order, unique to the system creating the order.
	object The creation timestamp of the order.
	Array of objects Identifications associated with the order.
	object Employee associated with registering order.
	Array of objects The line items included in the order.
	object The currency used for the order.
	object The totals for the order.

Array of objects

Array

type	string
detail	string

400

Bad Request

post/{state}/v1/deliveries

Request samples

Payload

application/json

[{"license": {"license_number": "1231235123"
},
"estimated_departure": "2025-09-12T09:09:50Z"
},
{"delivery_type": {"id": "KOMDT0001"
},
"transporter": [{"license": null,
"license_number": "1231235123",
"vehicle": {"make": "Dodge",
"model": "Ram",
"year": null,
"color": null,
"vin": null,
"plate_number": "deliveryemp123plt"
},
"personnel": [{"first_name": "Terry",
"last_name": "Cruz",
"phone_number": "1234567890",
"driver_license_number": "dlem321dl",
"employee_license_number": "12345663"
}
]
}
],
"orders": [{"order_type": {"id": "TRCOT0001"
},
"stop_number": 1
},
{"delivery_information": null,
"consumer_id": "456_consumer",
"customer_name": "Nick",
"customer_address_1": "124 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_state": "CO",
"customer_zip": "90210",
"estimated_departure_time": "2025-09-12T10:09:50Z",
"estimated_arrival_time": "2025-09-12T13:09:50Z",
"route_info": "right next door"
},
{"customer_types": {"id": "DMKOMCT0002"
},
"terminal": null,
"external_id": "testing1"
},
{"created_at": {"date": "2025-09-12T19:45:00Z",
"local_time": "2025-09-12T12:45:00"
},
"identifications": [{"types": {"id": "DMKOMIT0001"
},
"id": "CADLC12356",
"birthday": "2002-02-06T00:00:01Z"
},
{"types": {"id": "DMKOMIT0002"
},
"id": "123123",
"birthday": "2000-01-01T00:00:00Z"
}
]
},
{"employees": {"id": "ef37ae8a088548b3a11cebd3d52de999"
},
"line_items": [{"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"discount": "1.00",
"quantity": "1.00",
"unit_price": "10.00",
"taxes": [{"type": {"id": "KOMTAX0001"
},
"name": "MJ Sales Tax",
"rate": null,
"total": "1.00"
},
{"type": {"id": "KOMTAX0006"
},
"name": "MJ Municipal Tax",
"rate": null,
"total": "1.00"
}
],
"total": "11.00"
}
]
},
{"currency": {"id": "KOMCURT0001"
}
},
{"totals": {"quantity": "1.00",
"subtotal": "9.00",
"total": "11.00"
}
}
]
}
]

Response samples

application/json

{"results": {"data": {"delivery_type": {"id": "KOMDT0001"
},
"estimated_departure": "2025-09-12T09:09:50",
"license": {"license_number": "S0028"
},
"orders": [{"created_at": {"date": "2025-09-12T19:45:00",
"local_time": "2025-09-12T12:45:00"
},
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"customer_types": {"id": "DMKOMCT0002"
},
"delivery_information": {"consumer_id": "456_consumer",
"customer_address_1": "124 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_name": "Nick",
"customer_state": "CO",
"customer_zip": "90210",
"estimated_arrival_time": "2025-09-12T13:09:50",
"estimated_departure_time": "2025-09-12T10:09:50",
"route_info": "right next door"
},
"employees": {"id": "ef37ae8a088548b3a11cebd3d52de999"
},
"external_id": "testing1",
"id": "197f316d7fd041429b70c48915e788da",
"identifications": [{"birthday": "2002-02-06T00:00:01+00:00",
"id": "CADLC12356",
"types": {"id": "DMKOMIT0001"
}
},
{"birthday": "2000-01-01T00:00:00+00:00",
"id": "123123",
"types": {"id": "DMKOMIT0002"
}
}
],
"line_items": [{"discount": "1.00",
"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"quantity": 1,
"taxes": [{"name": "MJ Sales Tax",
"rate": null,
"total": "1.00",
"type": {"id": "KOMTAX0001"
}
},
{"name": "MJ Municipal Tax",
"rate": null,
"total": "1.00",
"type": {"id": "KOMTAX0006"
}
}
],
"total": "11.00",
"unit_price": "10.00"
}
],
"order_number": "0000004901",
"order_type": {"id": "TRCOT0001"
},
"stop_number": 1,
"terminal": null,
"totals": {"quantity": 1,
"subtotal": "9.00",
"taxes": [{"total": 1,
"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
}
},
{"total": 1,
"type": {"id": "KOMTAX0006",
"name": "Municipal Tax"
}
}
],
"total": "11.00"
}
}
],
"total_orders": 1,
"transporter": {"license": {"license_number": "S0028"
},
"personnel": [{"driver_license_number": "dlem321dl",
"first_name": "Terry",
"last_name": "Cruz",
"phone_number": "1234567890",
"employee_license_number": "12345663"
}
],
"vehicle": {"color": null,
"make": "Dodge",
"model": "Ram",
"plate_number": "deliveryemp123plt",
"vin": null,
"year": null
}
}
},
"type": "object"
},
"warnings": [ ]
}

Get Deliveries

Retrieve deliveries details for all active delivery records.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

state

required

string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

query Parameters

license_number required	string Reference (entity_ID) for the license. This is the business license number issued by the state. Example: license_number=ABC-1234
limit	number Optional parameter that allows you to specify a number to limit the results in the response. Default limit is 100. Example: limit=100
offset	number Optional parameter that allows you to offset records if the max number for the filter exceeds the limit. Example: offset=0

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Responses

200

Response Schema: application/json

object

type

string

Value: "array"

object

count	string A string representing what records you are receiving out of the total for the filter criteria.
total	number The total number of records returned based upon filter criteria.
previous	string or null URL that when executed will return you to the last page set.
next	string or null URL that when executed will take you to the next set of paginated records.

object

type

string

Value: "array"

Array of objects

Array

type	string Value: "object"
	object

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/deliveries

Response samples

application/json

{"results": {"type": "array",
"records": {"count": "0 - 3",
"total": 3,
"previous": null,
"next": null
},
"data": [{"license": {"license_number": "S0028"
},
"id": "cbabf0b1ca4c4880810b984c19ca69a1",
"estimated_departure": null,
"actual_departure": "2025-09-12T17:28:55Z",
"total_orders": 2,
"orders_completed": 0,
"delivery_type": {"id": "KOMDT0001",
"name": "in_house"
},
"transporter": {"license": {"license_number": "S0028"
},
"vehicle": {"id": "48fbdc23cb394734945cc135ab4bf512",
"make": "Dodge",
"model": "Ram",
"year": null,
"color": null,
"vin": null,
"plate_number": "deliveryemp123plt"
},
"personnel": [{"employee_id": "27721bbc23434cb0b4fa1838d6c2d588",
"first_name": "Terry",
"last_name": "Cruz",
"phone_number": "123-456-7890",
"identification": [{"type": {"id": "CAKOMIT001",
"name": "valid_state_id"
},
"id": "dlem321dl"
}
]
}
]
},
"orders": [{"id": "7164f85b8ebc4c5ba62ff3ae9373f478",
"order_number": "0000004903",
"license": {"license_number": "S0028"
},
"order_type": {"id": "TRCOT0001",
"name": "delivery"
},
"stop_number": null,
"delivery_information": {"ext_consumer_id": "9a21182dd12b41389068ea5e049e0e2b",
"consumer_id": "40636c51c7c24d7aa4242447e0c4c5dd",
"customer_name": "test name",
"customer_address_1": "123 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_state": "CO",
"customer_zip": "90210",
"delivery_fee": null,
"estimated_departure_time": "2025-09-11T09:09:50Z",
"estimated_arrival_time": "2025-09-11T12:09:50Z",
"actual_arrival_time": null,
"notes": null,
"planned_route": "drive down the street, turn left at the light.  Go 3 blocks, turn left at down st."
},
"order_information": {"customer_types": {"id": "DMKOMCT0001",
"name": "consumer"
},
"terminal": null,
"external_id": "0020",
"created_at": null,
"identifications": [{"type": {"id": "DMKOMIT0001"
},
"id": "CADLC12356",
"birthday": "2002-02-06T00:00:01Z"
},
{"type": {"id": "DMKOMIT0002"
},
"id": "123123123123",
"birthday": "2002-02-06T00:00:01Z"
}
],
"employees": {"id": null
},
"line_items": [{"lot": {"id": "d435ab19f3264c629dd48e816f88722f"
},
"discount": null,
"quantity": "1.00",
"unit_price": "12.00",
"taxes": [{"type": {"id": "KOMTAX0001"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
},
{"type": {"id": "KOMTAX0002"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
},
{"type": {"id": "KOMTAX0005"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
}
],
"total": "15.00"
},
{"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"discount": "1.00",
"quantity": "1.00",
"unit_price": "10.00",
"taxes": [ ],
"total": "9.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"quantity": "2.00",
"subtotal": "21.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"total": "1.0"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"total": "1.0"
},
{"type": {"id": "KOMTAX0005",
"name": "County Tax"
},
"total": "1.0"
}
],
"total": "24.00"
},
"payments": [ ]
},
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:55Z",
"reason": "Order Created",
"actioned_by": "user_generated"
}
]
},
{"id": "eb77b1d620bb46e69a4942b691af1b90",
"order_number": "0000004904",
"license": {"license_number": "S0028"
},
"order_type": {"id": "TRCOT0001",
"name": "delivery"
},
"stop_number": null,
"delivery_information": {"ext_consumer_id": "751e419e0f7043c290051aa436fe2cf3",
"consumer_id": "f2dff397f80842f2b8bdbc765fed7f16",
"customer_name": "Nick",
"customer_address_1": "124 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_state": "CO",
"customer_zip": "90210",
"delivery_fee": null,
"estimated_departure_time": "2025-09-11T10:09:50Z",
"estimated_arrival_time": "2025-09-11T13:09:50Z",
"actual_arrival_time": null,
"notes": null,
"planned_route": "right next door"
},
"order_information": {"customer_types": {"id": "DMKOMCT0001",
"name": "consumer"
},
"terminal": null,
"external_id": "0021",
"created_at": null,
"identifications": [{"type": {"id": "DMKOMIT0001"
},
"id": "CADLC12356",
"birthday": "2002-02-06T00:00:01Z"
},
{"type": {"id": "DMKOMIT0002"
},
"id": "123123123123",
"birthday": "2002-02-06T00:00:01Z"
}
],
"employees": {"id": null
},
"line_items": [{"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"discount": "1.00",
"quantity": "1.00",
"unit_price": "10.00",
"taxes": [ ],
"total": "9.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"quantity": "1.00",
"subtotal": "9.00",
"taxes": [ ],
"total": "9.00"
},
"payments": [ ]
},
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:56Z",
"reason": "Order Created",
"actioned_by": "user_generated"
}
]
}
],
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:55Z",
"reason": "Delivery Created",
"actioned_by": "user_generated"
}
]
},
{"license": {"license_number": "S0028"
},
"id": "0145504d791343dc9d849b8f9b872a20",
"estimated_departure": null,
"actual_departure": "2025-09-12T15:31:39Z",
"total_orders": 1,
"orders_completed": 0,
"delivery_type": {"id": "KOMDT0001",
"name": "in_house"
},
"transporter": {"license": {"license_number": "S0028"
},
"vehicle": {"id": "4c630eb2b59844aa9b838205264b51f3",
"make": "Dodge",
"model": "Ram",
"year": null,
"color": null,
"vin": null,
"plate_number": "deliveryemp123plt"
},
"personnel": [{"employee_id": "c240268dde4548298b4be4f73e3f7377",
"first_name": "Terry",
"last_name": "Cruz",
"phone_number": "1234567890",
"identification": [{"type": {"id": "CAKOMIT001",
"name": "valid_state_id"
},
"id": "dlem321dl"
}
]
}
]
},
"orders": [{"id": "9b04e8b0250040fbaa975d0b77e4f7ec",
"order_number": "0000004894",
"license": {"license_number": "S0028"
},
"order_type": {"id": "TRCOT0001",
"name": "delivery"
},
"stop_number": null,
"delivery_information": {"ext_consumer_id": "e46a0408e51c4d649d11589cfdc6465a",
"consumer_id": "223dec5ee00b4f0b9fbbb8bdb9e43739",
"customer_name": "Nick",
"customer_address_1": "124 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_state": "CO",
"customer_zip": "90210",
"delivery_fee": null,
"estimated_departure_time": "2025-09-12T10:09:50Z",
"estimated_arrival_time": "2025-09-12T13:09:50Z",
"actual_arrival_time": null,
"notes": null,
"planned_route": "right next door"
},
"order_information": {"customer_types": {"id": "DMKOMCT0002",
"name": "patient"
},
"terminal": null,
"external_id": "testing1",
"created_at": null,
"identifications": [{"type": {"id": "DMKOMIT0001"
},
"id": "CADLC12356",
"birthday": "2002-02-06T00:00:01Z"
},
{"type": {"id": "DMKOMIT0002"
},
"id": "123123",
"birthday": "2000-01-01T00:00:00Z"
}
],
"employees": {"id": null
},
"line_items": [{"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"discount": "1.00",
"quantity": "1.00",
"unit_price": "10.00",
"taxes": [{"type": {"id": "KOMTAX0001"
},
"name": "MJ Sales Tax",
"rate": null,
"total": "1.00"
},
{"type": {"id": "KOMTAX0006"
},
"name": "MJ Municipal Tax",
"rate": null,
"total": "1.00"
}
],
"total": "11.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"quantity": "1.00",
"subtotal": "9.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"total": "1.0"
},
{"type": {"id": "KOMTAX0006",
"name": "Municipal Tax"
},
"total": "1.0"
}
],
"total": "11.00"
},
"payments": [ ]
},
"entity_state": [{"state": "active",
"date": "2025-09-12T15:31:39Z",
"reason": "Order Created",
"actioned_by": "user_generated"
}
]
}
],
"entity_state": [{"state": "active",
"date": "2025-09-12T15:31:39Z",
"reason": "Delivery Created",
"actioned_by": "user_generated"
}
]
},
{"license": {"license_number": "S0028"
},
"id": "81bba7e72e1049d19bcf68584ff881b6",
"estimated_departure": "2025-09-12T08:50:29Z",
"actual_departure": null,
"total_orders": 1,
"orders_completed": 0,
"delivery_type": {"id": "KOMDT0001",
"name": "in_house"
},
"transporter": {"license": {"license_number": "S0028"
},
"vehicle": {"id": "8bbdd024dcf742198bbacca0af994d9d",
"make": "John Deere",
"model": "Golf Cart",
"year": null,
"color": null,
"vin": null,
"plate_number": "123puttputt"
},
"personnel": [{"employee_id": "f5914f9333a14906a6217a1ec7665920",
"first_name": "batter up",
"last_name": "batter up",
"phone_number": null,
"identification": [{"type": {"id": "CAKOMIT001",
"name": "valid_state_id"
},
"id": "12373d"
}
]
}
]
},
"orders": [{"id": "74d4f17cbc2d4fbbba65f7aac6826cd5",
"order_number": "0000004896",
"license": {"license_number": "S0028"
},
"order_type": {"id": "TRCOT0001",
"name": "delivery"
},
"stop_number": null,
"delivery_information": {"ext_consumer_id": "123testconsumer_id",
"consumer_id": "b397a98c6b1e45aba2373a0a16b25ab2",
"customer_name": "barry bonds",
"customer_address_1": "123 easy st",
"customer_address_2": "",
"customer_city": "",
"customer_county": "strikeland",
"customer_state": "CO",
"customer_zip": "12345",
"delivery_fee": null,
"estimated_departure_time": "2025-09-12T08:50:29Z",
"estimated_arrival_time": "2025-09-12T08:50:29Z",
"actual_arrival_time": null,
"notes": null,
"planned_route": "drive down the diamond. Stop at first, turn left and head to second..."
},
"order_information": {"customer_types": {"id": "DMKOMCT0001",
"name": "consumer"
},
"terminal": null,
"external_id": null,
"created_at": null,
"identifications": [ ],
"employees": {"id": null
},
"line_items": [ ],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"quantity": "2.00",
"subtotal": "0.00",
"taxes": [ ],
"total": "72.00"
},
"payments": [ ]
},
"entity_state": [{"state": "active",
"date": "2025-09-12T15:04:14Z",
"reason": "Order Created",
"actioned_by": "system_generated"
},
{"state": "updated",
"date": "2025-09-12T15:04:14Z",
"reason": "Order Created",
"actioned_by": "system_generated"
}
]
}
],
"entity_state": [{"state": "active",
"date": "2025-09-12T14:52:37Z",
"reason": "Delivery Created",
"actioned_by": "system_generated"
},
{"state": "updated",
"date": "2025-09-12T14:52:37Z",
"reason": "Delivery Updated",
"actioned_by": "system_generated"
}
]
}
]
},
"warnings": [ ]
}

Get Delivery by ID

Get delivery details by delivery ID.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

state required	string Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating. Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"
id required	string Trace delivery id. Example: 11il9b62fe1c47e4970c55ec6c7ff8jj

query Parameters

license_number

required

string

Reference (entity_ID) for the license. This is the business license number issued by the state.

Example: license_number=ABC-1234

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

type

string

Value: "object"

object

license_number

required

string

Reference (entity_ID) for the license. This is the business license number issued by the state.

string

The unique identifier for the delivery.

estimated_departure

string <date-time>

The estimated departure date and time of the delivery.

actual_departure

string <date-time>

The actual departure date and time of the delivery.

total_orders

integer

The total number of orders in the delivery.

orders_completed

integer

The number of orders that have been completed in the delivery.

object

The type of delivery.

id	string The ID of the delivery type.
name	string The name of the delivery type.

object

The transporter details for the delivery.

	object
	object The vehicle details of the transporter.
	Array of objects The personnel involved in the transportation.

Array of objects

The orders included in the delivery.

Array

id	string The unique identifier for the order.
order_number	string The order number mapped to Metrc delivery license_number.
	object
	object The type of order.
stop_number	integer The stop number of the order in the delivery sequence.
	object The delivery information for the order.
	object Additional order information.
	Array of objects list of state changes made to the entity. Entity states for sales [active,inactive,voided,refunded].

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/deliveries/{id}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "S0028"
},
"id": "cbabf0b1ca4c4880810b984c19ca69a1",
"estimated_departure": null,
"actual_departure": "2025-09-12T17:28:55Z",
"total_orders": 2,
"orders_completed": 0,
"delivery_type": {"id": "KOMDT0001",
"name": "in_house"
},
"transporter": {"license": {"license_number": "S0028"
},
"vehicle": {"id": "48fbdc23cb394734945cc135ab4bf512",
"make": "Dodge",
"model": "Ram",
"year": null,
"color": null,
"vin": null,
"plate_number": "deliveryemp123plt"
},
"personnel": [{"employee_id": "27721bbc23434cb0b4fa1838d6c2d588",
"first_name": "Terry",
"last_name": "Cruz",
"phone_number": "123-456-7890",
"identification": [{"type": {"id": "CAKOMIT001",
"name": "valid_state_id"
},
"id": "dlem321dl"
}
]
}
]
},
"orders": [{"id": "7164f85b8ebc4c5ba62ff3ae9373f478",
"order_number": "0000004903",
"license": {"license_number": "S0028"
},
"order_type": {"id": "TRCOT0001",
"name": "delivery"
},
"stop_number": null,
"delivery_information": {"ext_consumer_id": "9a21182dd12b41389068ea5e049e0e2b",
"consumer_id": "40636c51c7c24d7aa4242447e0c4c5dd",
"customer_name": "test name",
"customer_address_1": "123 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_state": "CO",
"customer_zip": "90210",
"delivery_fee": null,
"estimated_departure_time": "2025-09-11T09:09:50Z",
"estimated_arrival_time": "2025-09-11T12:09:50Z",
"actual_arrival_time": null,
"notes": null,
"planned_route": "drive down the street, turn left at the light.  Go 3 blocks, turn left at down st."
},
"order_information": {"customer_types": {"id": "DMKOMCT0001",
"name": "consumer"
},
"terminal": null,
"external_id": "0020",
"created_at": null,
"identifications": [{"type": {"id": "DMKOMIT0001"
},
"id": "CADLC12356",
"birthday": "2002-02-06T00:00:01Z"
},
{"type": {"id": "DMKOMIT0002"
},
"id": "123123123123",
"birthday": "2002-02-06T00:00:01Z"
}
],
"employees": {"id": null
},
"line_items": [{"lot": {"id": "d435ab19f3264c629dd48e816f88722f"
},
"discount": null,
"quantity": "1.00",
"unit_price": "12.00",
"taxes": [{"type": {"id": "KOMTAX0001"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
},
{"type": {"id": "KOMTAX0002"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
},
{"type": {"id": "KOMTAX0005"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
}
],
"total": "15.00"
},
{"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"discount": "1.00",
"quantity": "1.00",
"unit_price": "10.00",
"taxes": [ ],
"total": "9.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"quantity": "2.00",
"subtotal": "21.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"total": "1.0"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"total": "1.0"
},
{"type": {"id": "KOMTAX0005",
"name": "County Tax"
},
"total": "1.0"
}
],
"total": "24.00"
},
"payments": [ ]
},
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:55Z",
"reason": "Order Created",
"actioned_by": "user_generated"
}
]
},
{"id": "eb77b1d620bb46e69a4942b691af1b90",
"order_number": "0000004904",
"license": {"license_number": "S0028"
},
"order_type": {"id": "TRCOT0001",
"name": "delivery"
},
"stop_number": null,
"delivery_information": {"ext_consumer_id": "751e419e0f7043c290051aa436fe2cf3",
"consumer_id": "f2dff397f80842f2b8bdbc765fed7f16",
"customer_name": "Nick",
"customer_address_1": "124 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_state": "CO",
"customer_zip": "90210",
"delivery_fee": null,
"estimated_departure_time": "2025-09-11T10:09:50Z",
"estimated_arrival_time": "2025-09-11T13:09:50Z",
"actual_arrival_time": null,
"notes": null,
"planned_route": "right next door"
},
"order_information": {"customer_types": {"id": "DMKOMCT0001",
"name": "consumer"
},
"terminal": null,
"external_id": "0021",
"created_at": null,
"identifications": [{"type": {"id": "DMKOMIT0001"
},
"id": "CADLC12356",
"birthday": "2002-02-06T00:00:01Z"
},
{"type": {"id": "DMKOMIT0002"
},
"id": "123123123123",
"birthday": "2002-02-06T00:00:01Z"
}
],
"employees": {"id": null
},
"line_items": [{"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"discount": "1.00",
"quantity": "1.00",
"unit_price": "10.00",
"taxes": [ ],
"total": "9.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"quantity": "1.00",
"subtotal": "9.00",
"taxes": [ ],
"total": "9.00"
},
"payments": [ ]
},
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:56Z",
"reason": "Order Created",
"actioned_by": "user_generated"
}
]
}
],
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:55Z",
"reason": "Delivery Created",
"actioned_by": "user_generated"
}
]
}
},
"warnings": [ ]
}

Update Delivery

Update the delivery registered under the license_number provided.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the delivery you are updating. Example: 80d15c7713a74feeb4c1c5f533697644
state required	string Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating. Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Request Body schema: application/json

required

object

license_number

required

string

Reference (entity_ID) for the license. This is the business license number issued by the state.

required

object

The action to be performed on the delivery.

id	string The ID of the delivery action. (e.g., start, complete, cancel)

order_id

string

The order ID associated with the action, required for certain actions like voiding an order.

payment_method

string

The payment method used for the delivery, required for completing a delivery.

accepted_packages

Array of strings

List of accepted Lot IDs for the delivery, required for completing a delivery.

update_date

required

string <date-time>

The date and time when the action is performed in ISO 8601 format.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

type

string

Value: "object"

object

license_number

required

string

Reference (entity_ID) for the license. This is the business license number issued by the state.

string

The unique identifier for the delivery.

estimated_departure

string <date-time>

The estimated departure date and time of the delivery.

actual_departure

string <date-time>

The actual departure date and time of the delivery.

total_orders

integer

The total number of orders in the delivery.

orders_completed

integer

The number of orders that have been completed in the delivery.

object

The type of delivery.

id	string The ID of the delivery type.
name	string The name of the delivery type.

object

The transporter details for the delivery.

	object
	object The vehicle details of the transporter.
	Array of objects The personnel involved in the transportation.

Array of objects

The orders included in the delivery.

Array

id	string The unique identifier for the order.
order_number	string The order number mapped to Metrc delivery license_number.
	object
	object The type of order.
stop_number	integer The stop number of the order in the delivery sequence.
	object The delivery information for the order.
	object Additional order information.
	Array of objects list of state changes made to the entity. Entity states for sales [active,inactive,voided,refunded].

Array of objects

Array

type	string
detail	string

400

Bad Request

put/{state}/v1/deliveries/{id}

Request samples

Payload

application/json

{"license": {"license_number": "1231235123"
},
"actions": {"id": "TRCDA001"
},
"update_date": "2025-09-12T09:09:50Z"
}

Response samples

application/json

{"results": {"type": "object",
"data": {"license": {"license_number": "S0028"
},
"id": "cbabf0b1ca4c4880810b984c19ca69a1",
"estimated_departure": null,
"actual_departure": "2025-09-12T17:28:55Z",
"total_orders": 2,
"orders_completed": 0,
"delivery_type": {"id": "KOMDT0001",
"name": "in_house"
},
"transporter": {"license": {"license_number": "S0028"
},
"vehicle": {"id": "48fbdc23cb394734945cc135ab4bf512",
"make": "Dodge",
"model": "Ram",
"year": null,
"color": null,
"vin": null,
"plate_number": "deliveryemp123plt"
},
"personnel": [{"employee_id": "27721bbc23434cb0b4fa1838d6c2d588",
"first_name": "Terry",
"last_name": "Cruz",
"phone_number": "123-456-7890",
"identification": [{"type": {"id": "CAKOMIT001",
"name": "valid_state_id"
},
"id": "dlem321dl"
}
]
}
]
},
"orders": [{"id": "7164f85b8ebc4c5ba62ff3ae9373f478",
"order_number": "0000004903",
"license": {"license_number": "S0028"
},
"order_type": {"id": "TRCOT0001",
"name": "delivery"
},
"stop_number": null,
"delivery_information": {"ext_consumer_id": "9a21182dd12b41389068ea5e049e0e2b",
"consumer_id": "40636c51c7c24d7aa4242447e0c4c5dd",
"customer_name": "test name",
"customer_address_1": "123 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_state": "CO",
"customer_zip": "90210",
"delivery_fee": null,
"estimated_departure_time": "2025-09-11T09:09:50Z",
"estimated_arrival_time": "2025-09-11T12:09:50Z",
"actual_arrival_time": null,
"notes": null,
"planned_route": "drive down the street, turn left at the light.  Go 3 blocks, turn left at down st."
},
"order_information": {"customer_types": {"id": "DMKOMCT0001",
"name": "consumer"
},
"terminal": null,
"external_id": "0020",
"created_at": null,
"identifications": [{"type": {"id": "DMKOMIT0001"
},
"id": "CADLC12356",
"birthday": "2002-02-06T00:00:01Z"
},
{"type": {"id": "DMKOMIT0002"
},
"id": "123123123123",
"birthday": "2002-02-06T00:00:01Z"
}
],
"employees": {"id": null
},
"line_items": [{"lot": {"id": "d435ab19f3264c629dd48e816f88722f"
},
"discount": null,
"quantity": "1.00",
"unit_price": "12.00",
"taxes": [{"type": {"id": "KOMTAX0001"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
},
{"type": {"id": "KOMTAX0002"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
},
{"type": {"id": "KOMTAX0005"
},
"name": "Imported Record",
"rate": null,
"total": "1.00"
}
],
"total": "15.00"
},
{"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"discount": "1.00",
"quantity": "1.00",
"unit_price": "10.00",
"taxes": [ ],
"total": "9.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"quantity": "2.00",
"subtotal": "21.00",
"taxes": [{"type": {"id": "KOMTAX0001",
"name": "Sales Tax"
},
"total": "1.0"
},
{"type": {"id": "KOMTAX0002",
"name": "Excise Tax"
},
"total": "1.0"
},
{"type": {"id": "KOMTAX0005",
"name": "County Tax"
},
"total": "1.0"
}
],
"total": "24.00"
},
"payments": [ ]
},
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:56Z",
"reason": "Order Created",
"actioned_by": "user_generated"
},
{"state": "updated",
"date": "2025-09-15T13:35:58Z",
"reason": "Order Updated",
"actioned_by": "user_generated"
},
{"state": "started_delivery",
"date": "2025-09-15T13:34:07Z",
"reason": "start delivery",
"actioned_by": "system_generated"
}
]
},
{"id": "eb77b1d620bb46e69a4942b691af1b90",
"order_number": "0000004904",
"license": {"license_number": "S0028"
},
"order_type": {"id": "TRCOT0001",
"name": "delivery"
},
"stop_number": null,
"delivery_information": {"ext_consumer_id": "751e419e0f7043c290051aa436fe2cf3",
"consumer_id": "f2dff397f80842f2b8bdbc765fed7f16",
"customer_name": "Nick",
"customer_address_1": "124 easy st",
"customer_address_2": "none",
"customer_city": "somewhereville",
"customer_county": "Larimer",
"customer_state": "CO",
"customer_zip": "90210",
"delivery_fee": null,
"estimated_departure_time": "2025-09-11T10:09:50Z",
"estimated_arrival_time": "2025-09-11T13:09:50Z",
"actual_arrival_time": null,
"notes": null,
"planned_route": "right next door"
},
"order_information": {"customer_types": {"id": "DMKOMCT0001",
"name": "consumer"
},
"terminal": null,
"external_id": "0021",
"created_at": null,
"identifications": [{"type": {"id": "DMKOMIT0001"
},
"id": "CADLC12356",
"birthday": "2002-02-06T00:00:01Z"
},
{"type": {"id": "DMKOMIT0002"
},
"id": "123123123123",
"birthday": "2002-02-06T00:00:01Z"
}
],
"employees": {"id": null
},
"line_items": [{"lot": {"id": "1e9ab37c5f604f30a57762c2b84a8088"
},
"discount": "1.00",
"quantity": "1.00",
"unit_price": "10.00",
"taxes": [ ],
"total": "9.00"
}
],
"currency": {"id": "KOMCURT0001",
"name": "USD"
},
"totals": {"quantity": "1.00",
"subtotal": "9.00",
"taxes": [ ],
"total": "9.00"
},
"payments": [ ]
},
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:56Z",
"reason": "Order Created",
"actioned_by": "user_generated"
},
{"state": "updated",
"date": "2025-09-15T13:35:58Z",
"reason": "Order Updated",
"actioned_by": "user_generated"
},
{"state": "started_delivery",
"date": "2025-09-15T13:34:07Z",
"reason": "start delivery",
"actioned_by": "system_generated"
}
]
}
],
"entity_state": [{"state": "active",
"date": "2025-09-12T17:28:55Z",
"reason": "Delivery Created",
"actioned_by": "user_generated"
},
{"state": "started_delivery",
"date": "2025-09-15T13:34:07Z",
"reason": "start delivery",
"actioned_by": "system_generated"
},
{"state": "updated",
"date": "2025-09-15T13:35:58Z",
"reason": "Delivery Updated",
"actioned_by": "user_generated"
}
]
}
},
"warnings": [ ]
}

Retrieve delivery actions

Retrieve a list of sales actions for updating a sale

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

state

required

string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Responses

200

Response Schema: application/json

object

type

string

Value: "array"

Array of objects

Array

id	string The ID of the delivery action. (e.g., start, complete, void)
name	string The name of the delivery action.
description	string A brief description of the delivery action.

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/deliveries/actions

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "TRCDA001",
"name": "start delivery",
"description": null
},
{"id": "TRCDA002",
"name": "end delivery order",
"description": null
},
{"id": "TRCDA003",
"name": "void delivery order",
"description": null
}
]
},
"warnings": [ ]
}