Retrieve lot(s) details

Retrieve the lot details. If the id: is not provided, the details of all active lots for the license_number are obtained, filtered by the query parameter(s) criteria.

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" "il" "wa" "ma" "md" "mi" "wv" "co" "ok" "oh"
id
required
string

Lot ID

Example: a521f55de4394f4f99c282be687e63aa
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
entity_state
string

Queryable entity states for lots.

Enum: "active" "inactive" "finished" "unfinished" "onhold" "discontinued" "lab_testing_not_submitted" "lab_testing_submitted" "lab_testing_in_progress" "lab_testing_awaiting_confirmation" "lab_testing_passed" "lab_testing_failed" "lab_retesting_in_progress" "lab_retest_passed" "lab_retest_failed" "used" "in_transit" "scheduled_for_transfer" "accepted" "rejected" "returned" "received" "partial_rejected" "partial_returned" "scheduled_for_destruction" "lot_not_in_inventory"
start_date
string

start date value for query operations

Example: start_date=2021-08-12T00:00:00z
end_date
string

end date value for query operations

Example: end_date=2021-08-13T00:00:00z
barcode
string

Lot's tag that uniquely identifies it for tracking purposes.

Example: barcode=1KMP00000000099000015442
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

OK

400

Bad Request

get/{state}/v1/lots/{id}
Response samples
application/json
{
  • "results": {
    },
  • "warnings": [ ]
}