OpenTHC API
OpenTHC Data Model and JSON-API reference
Version: 420.20.050
BasePath:/YOUR/PATH
MIT
https://mit-license.org/
Access
[ Jump to Models ]
Table of Contents
Authenticate to the System (authOpen)
Authenticates to the system with a username & password or other credentials, responds with a cookie and a session identifer
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
cre (required)
Form Parameter —
service-key (required)
Form Parameter —
company (required)
Form Parameter —
license (required)
Form Parameter —
license-key (required)
Form Parameter —
username (required)
Form Parameter —
password (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"data" : "data",
"meta" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success! Responds with a Set-Cookie and also provides the session token via data
inline_response_200
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
Validate a Session Token (authPing)
Verify a Session Token is still valid, provide one of the following parameters
Request headers
Return type
Example data
Content-Type: application/json
{
"meta" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success!
inline_response_200_1
403
Failure!
Close the Session (authShut)
Terminates the session, cleans up any lingering cache data, not required
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
No Content
403
General Failure Response
inline_response_400
Get Export or Import B2B Transaction List (b2bGet)
Query parameters
type (optional)
Query Parameter — Type of B2B Transaction
q (optional)
Query Parameter — Generic Search Operator
dt0 (optional)
Query Parameter — format: dateTime
dt1 (optional)
Query Parameter — format: dateTime
Return type
Example data
Content-Type: application/json
[ {
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
}, {
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Get Export B2B Transaction List (b2bIncomingGet)
Return type
Example data
Content-Type: application/json
[ {
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
}, {
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
post /b2b/incoming/{id}/commit
Commit a B2B Transaction (b2bIncomingIdCommitPost)
Path parameters
id (required)
Path Parameter — Unique ULID value for this B2B Transaction
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Up
delete /b2b/incoming/{id}
Void the B2B Transaction (b2bIncomingIdDelete)
Path parameters
id (required)
Path Parameter — Unique ULID value for this B2B Transaction
Responses
202
Delete Requested
204
Delete Confirmed
Up
get /b2b/incoming/{id}
Get Specific B2B Transaction (b2bIncomingIdGet)
Path parameters
id (required)
Path Parameter — Unique ULID value for this B2B Transaction
Return type
Example data
Content-Type: application/json
{
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
B2B_Sale
Up
post /b2b/incoming/{id}
Update a B2B Transaction (b2bIncomingIdPost)
Path parameters
id (required)
Path Parameter — Unique ULID value for this B2B Transaction
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
contact (required)
Form Parameter —
vehicle (required)
Form Parameter —
depart_at (required)
Form Parameter — format: dateTime
arrive_at (required)
Form Parameter — format: dateTime
Responses
200
Success
Get Export B2B Transaction List (b2bOutgoingGet)
Return type
Example data
Content-Type: application/json
[ {
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
}, {
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
post /b2b/outgoing/{id}/commit
Commit a B2B Transaction (b2bOutgoingIdCommitPost)
Path parameters
id (required)
Path Parameter — Unique ULID value for this B2B Transaction
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Up
delete /b2b/outgoing/{id}
Void the B2B Transaction (b2bOutgoingIdDelete)
Path parameters
id (required)
Path Parameter — Unique ULID value for this B2B Transaction
Responses
202
Delete Requested
204
Delete Confirmed
Up
get /b2b/outgoing/{id}/file/{fid}
Get File Attachments (b2bOutgoingIdFileFidGet)
Path parameters
id (required)
Path Parameter — The B2B Transaction ID
fid (required)
Path Parameter — The File ID
Return type
Example data
Content-Type: application/json
[ {
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
}, {
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
post /b2b/outgoing/{id}/file
Create B2B Transaction File Attachment (b2bOutgoingIdFilePost)
Create a B2B Transaction File Attachment
Path parameters
id (required)
Path Parameter — The B2B Transaction ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
type (required)
Form Parameter —
origin (required)
Form Parameter —
target (required)
Form Parameter —
depart (required)
Form Parameter — format: dateTime
arrive (required)
Form Parameter — format: dateTime
Return type
Example data
Content-Type: application/json
{
"data" : "",
"b2b_outgoing_id" : "b2b_outgoing_id",
"link" : "link",
"id" : "id",
"b2b_incoming_id" : "b2b_incoming_id",
"type" : "type"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Success
B2B_File
Up
get /b2b/outgoing/{id}
Get Specific B2B Transaction (b2bOutgoingIdGet)
Path parameters
id (required)
Path Parameter — Unique ULID value for this B2B Transaction
Return type
Example data
Content-Type: application/json
{
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
B2B_Sale
Up
get /b2b/outgoing/{id}/item/{iid}
Get a single B2B Transaction Item (b2bOutgoingIdItemIidGet)
Path parameters
iid (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
[ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
post /b2b/outgoing/{id}/item
Create a B2B Transaction Item (b2bOutgoingIdItemPost)
Path parameters
id (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
[ {
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
}, {
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
post /b2b/outgoing/{id}
Update a B2B Transaction (b2bOutgoingIdPost)
Path parameters
id (required)
Path Parameter — Unique ULID value for this B2B Transaction
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
contact (required)
Form Parameter —
vehicle (required)
Form Parameter —
depart_at (required)
Form Parameter — format: dateTime
arrive_at (required)
Form Parameter — format: dateTime
Responses
200
Success
Create B2B Transaction (b2bPost)
Create a B2B Transaction
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
type (required)
Form Parameter —
origin (required)
Form Parameter —
target (required)
Form Parameter —
depart (required)
Form Parameter — format: dateTime
arrive (required)
Form Parameter — format: dateTime
Return type
Example data
Content-Type: application/json
{
"depart_at" : "depart_at",
"item_list" : [ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"id" : "id",
"type" : "type",
"inventory" : { },
"unit_price" : 6.027456183070403,
"unit_count" : 0.8008281904610115
} ],
"id" : "id",
"source" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"type" : "incoming",
"arrive_at" : "arrive_at"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Success
B2B_Sale
Get Sale Data (b2cGet)
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "created_at",
"id" : "id"
}, {
"created_at" : "created_at",
"id" : "id"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of Transactions
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Void a B2C Transaction (b2cIdDelete)
Path parameters
id (required)
Path Parameter — Unique ID value for this B2C Transaction
Return type
Example data
Content-Type: application/json
{
"created_at" : "created_at",
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
B2C_Sale
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Get B2C Transaction Details (b2cIdGet)
Path parameters
id (required)
Path Parameter — Unique ID value for this B2C Transaction
Return type
Example data
Content-Type: application/json
{
"created_at" : "created_at",
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Transaction Details
B2C_Sale
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Get B2C Transaction Item List (b2cIdItemGet)
Path parameters
id (required)
Path Parameter — Unique ID value for this B2C Transaction
Return type
Example data
Content-Type: application/json
{
"id" : "id",
"inventory" : "inventory",
"unit_price" : "unit_price",
"unit_count" : "unit_count"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Transaction Item List
B2C_Sale_Item
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Create a B2C Transaction Item (b2cIdItemPost)
Path parameters
id (required)
Path Parameter — Transaction ID
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencodedapplication/json
Request body
Body Parameter — B2C Line Item
Form parameters
id (required)
Form Parameter —
inventory (required)
Form Parameter —
unit_count (required)
Form Parameter —
unit_price (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"id" : "id",
"inventory" : "inventory",
"unit_price" : "unit_price",
"unit_count" : "unit_count"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Item Details
B2C_Sale_Item
Post a Sale (b2cPost)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
inventory_id (required)
Form Parameter —
unit_count (required)
Form Parameter —
unit_price (required)
Form Parameter —
patient_id (required)
Form Parameter —
caregiver_id (required)
Form Parameter —
contact (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"created_at" : "created_at",
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
B2C_Sale
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Search Product Data (productGet)
Product, a Container for one or more Lot objects.
Query parameters
q (optional)
Query Parameter — Search Term.
Return type
Example data
Content-Type: application/json
[ {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
}, {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of Product objects
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Get Specific Product Data (productIdGet)
Product defines attributes of an Inventory Lot such as Weight/Volume, Package Size
Path parameters
id (required)
Path Parameter — Unique ULID value for this Product
Return type
Example data
Content-Type: application/json
{
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Product Object
Product
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Update a Product (productIdPost)
Product defines attributes of an Inventory Lot such as Weight/Volume, Package Size
Path parameters
id (required)
Path Parameter — Unique ULID value for this Product
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
name (required)
Form Parameter —
type (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Product Object
Product
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Create a Product (productPost)
Product defines attributes of an Inventory Lot such as Weight/Volume, Package Size
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
name (required)
Form Parameter —
type (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Product Object
Product
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Get List of Product Types (productTypeGet)
Return type
Example data
Content-Type: application/json
[ {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
}, {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
delete /product/type/{id}
Delete Product Type (productTypeIdDelete)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Product Type
Return type
Example data
Content-Type: application/json
{
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Product_Type
405
Not Allowed
Up
post /product/type/{id}
Modify Product Type (productTypeIdPost)
Update a product type
Path parameters
id (required)
Path Parameter — Unique ULID value for this Product Type
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
id (optional)
Form Parameter —
name (optional)
Form Parameter —
unit (optional)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Product_Type
405
Not Allowed
Create Product Type (productTypePost)
Create a new product type
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
id (required)
Form Parameter —
name (required)
Form Parameter —
unit (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Product_Type
Get a LIst of all the Sections (sectionGet)
Return type
Example data
Content-Type: application/json
[ {
"name" : "name",
"id" : "id",
"type" : "crop"
}, {
"name" : "name",
"id" : "id",
"type" : "crop"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Delete a Section (aka Archive) (sectionIdDelete)
Path parameters
id (required)
Path Parameter — Unique ID for this Section
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"id" : "id",
"type" : "crop"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Section
Get Section Data (sectionIdGet)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Section
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"id" : "id",
"type" : "crop"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Section
Update a Section (aka: Area or Room) (sectionIdPost)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Section
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
id (required)
Form Parameter —
name (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"id" : "id",
"type" : "crop"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Section
Create a Section (aka: Area or Room) (sectionPost)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
id (required)
Form Parameter —
name (required)
Form Parameter —
type (required)
Form Parameter —
flag_quarantine (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"id" : "id",
"type" : "crop"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Section
Search Variety Data (varietyGet)
Variety defines the Cultivar, Flavor or Strain of a Crop or Product
Query parameters
q (optional)
Query Parameter — Search Term.
Return type
Example data
Content-Type: application/json
[ {
"name" : "name",
"id" : "id",
"type" : "Hemp"
}, {
"name" : "name",
"id" : "id",
"type" : "Hemp"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of Variety objects
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Delete Variety Type (varietyIdDelete)
Delete Variety Type
Path parameters
id (required)
Path Parameter — Unique ULID value for this Section
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"id" : "id",
"type" : "Hemp"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Variety
Get a Variety (varietyIdGet)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Section
Return type
Example data
Content-Type: application/json
[ {
"name" : "name",
"id" : "id",
"type" : "Hemp"
}, {
"name" : "name",
"id" : "id",
"type" : "Hemp"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Update Variety (varietyIdPost)
Update Variety
Path parameters
id (required)
Path Parameter — Unique ULID value for this Section
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
id (required)
Form Parameter —
name (required)
Form Parameter —
type (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"id" : "id",
"type" : "Hemp"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated
Variety
Create a Variety (varietyPost)
Variety defines the Cultivar, Flavor or Strain of a Crop or Product
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
name (required)
Form Parameter —
type (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"id" : "id",
"type" : "Hemp"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Variety Object
Variety
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Search Vehicle Data (vehicleGet)
Search vehicles regsitered under this company/license
Query parameters
q (optional)
Query Parameter — Search Term.
Return type
Example data
Content-Type: application/json
[ {
"vrn" : "vrn",
"color" : "color",
"name" : "name",
"model" : "model",
"vin" : "vin",
"id" : "id",
"make" : "make"
}, {
"vrn" : "vrn",
"color" : "color",
"name" : "name",
"model" : "model",
"vin" : "vin",
"id" : "id",
"make" : "make"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of Vehicle objects
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Get Specific Vehcile Data (vehicleIdGet)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Vehicle
Return type
Example data
Content-Type: application/json
{
"vrn" : "vrn",
"color" : "color",
"name" : "name",
"model" : "model",
"vin" : "vin",
"id" : "id",
"make" : "make"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Vehicle Object
Vehicle
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Update a Vehicle (vehicleIdPost)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Vehicle
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
name (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Product Object
Product
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Create a Vehicle (vehiclePost)
Create a Vehicle to transport material
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
id (required)
Form Parameter —
name (required)
Form Parameter —
make (required)
Form Parameter —
model (required)
Form Parameter —
color (required)
Form Parameter —
vin (required)
Form Parameter —
vrn (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Product Object
Product
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Up
post /plant-collect/{id}/commit
Commit this Plant Collect group into Inventory Lot (plantCollectIdCommitPost)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Plant
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
plant_id (required)
Form Parameter —
date (required)
Form Parameter — format: dateTime
type (required)
Form Parameter —
qty (required)
Form Parameter —
uom (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"uom" : "g",
"plant" : {
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"name" : "name",
"id" : "id"
},
"qty" : 0.8008281904610115,
"id" : "id",
"type" : "raw"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Plant_Collect
Up
get /plant-collect/{id}
Commit this Plant Collect group into Inventory Lot (plantCollectIdGet)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Plant
Return type
Example data
Content-Type: application/json
{
"uom" : "g",
"plant" : {
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"name" : "name",
"id" : "id"
},
"qty" : 0.8008281904610115,
"id" : "id",
"type" : "raw"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Plant_Collect
Get a List of Plants (plantGet)
Query parameters
q (optional)
Query Parameter — Generic Search
Return type
Example data
Content-Type: application/json
[ {
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"name" : "name",
"id" : "id"
}, {
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"name" : "name",
"id" : "id"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Array of Plants
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Up
post /plant/{id}/collect
Collect Materials from a Plant (plantIdCollectPost)
Path parameters
id (required)
Path Parameter — Tracking Identifier of Plant
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
collect_id (required)
Form Parameter —
date (required)
Form Parameter — format: dateTime
type (required)
Form Parameter —
qty (required)
Form Parameter —
uom (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"uom" : "g",
"plant" : {
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"name" : "name",
"id" : "id"
},
"qty" : 0.8008281904610115,
"id" : "id",
"type" : "raw"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Plant_Collect
400
Request Error
500
Server Error
Delete the Plants (plantIdDelete)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Plant
Return type
Example data
Content-Type: application/json
{
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"name" : "name",
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
202
Marked for Deletion
Plant
204
Success, Delete Confirmed, No Content
Modify Plant Data (plantIdPost)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Plant
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
variety (required)
Form Parameter —
section (required)
Form Parameter —
propagation_source (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"name" : "name",
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Plant
Create a Plant (plantPost)
Create a New Plant from Seeds, Clones
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
source (required)
Form Parameter —
variety (required)
Form Parameter —
section (required)
Form Parameter —
qty (required)
Form Parameter — format: integer
Return type
Example data
Content-Type: application/json
[ {
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"name" : "name",
"id" : "id"
}, {
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"name" : "name",
"id" : "id"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Get a list of Inventory Objects (inventoryGet)
Return type
Example data
Content-Type: application/json
[ {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"qty" : 0.8008282,
"name" : "name",
"qty_initial" : 6.0274563,
"section" : {
"name" : "name",
"id" : "id",
"type" : "crop"
},
"id" : "id"
}, {
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"qty" : 0.8008282,
"name" : "name",
"qty_initial" : 6.0274563,
"section" : {
"name" : "name",
"id" : "id",
"type" : "crop"
},
"id" : "id"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
post /inventory/{id}/adjust
Adjust Inventory (inventoryIdAdjustPost)
Path parameters
id (required)
Path Parameter — Unique ID value for this Inventory
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
qty (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"qty" : 0.8008282,
"name" : "name",
"qty_initial" : 6.0274563,
"section" : {
"name" : "name",
"id" : "id",
"type" : "crop"
},
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Inventory
Up
delete /inventory/{id}
Delete the Inventory Inventory (inventoryIdDelete)
Path parameters
id (required)
Path Parameter — Unique ID value for this Inventory
Return type
Example data
Content-Type: application/json
{
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"qty" : 0.8008282,
"name" : "name",
"qty_initial" : 6.0274563,
"section" : {
"name" : "name",
"id" : "id",
"type" : "crop"
},
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
202
Marked for Deletion
Inventory
204
Success, Delete Confirmed, No Content
Up
post /inventory/{id}/destroy
Destroy Inventory (inventoryIdDestroyPost)
Path parameters
id (required)
Path Parameter — Unique ID value for this Inventory
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
reason_code (required)
Form Parameter —
reason_text (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"qty" : 0.8008282,
"name" : "name",
"qty_initial" : 6.0274563,
"section" : {
"name" : "name",
"id" : "id",
"type" : "crop"
},
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Inventory
View Inventory Inventory (inventoryIdGet)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Inventory
Return type
Example data
Content-Type: application/json
{
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"qty" : 0.8008282,
"name" : "name",
"qty_initial" : 6.0274563,
"section" : {
"name" : "name",
"id" : "id",
"type" : "crop"
},
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Inventory
Update Inventory Inventory (inventoryIdPatch)
Path parameters
id (required)
Path Parameter — Unique ID value for this Inventory
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Optional Inventory Details
Return type
Example data
Content-Type: application/json
{
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"qty" : 0.8008282,
"name" : "name",
"qty_initial" : 6.0274563,
"section" : {
"name" : "name",
"id" : "id",
"type" : "crop"
},
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Inventory
Create, Convert or Split an Inventory object (inventoryPost)
Consumes
This API call consumes the following media types via the request header:
application/jsonapplication/x-www-form-urlencoded
Form parameters
source (required)
Form Parameter —
output_product_id (required)
Form Parameter —
output_qty (required)
Form Parameter — format: float
Return type
Example data
Content-Type: application/json
{
"product" : {
"package" : {
"id" : "id",
"net" : { },
"net_volume" : 0.8008281904610115,
"net_weight" : 6.027456183070403,
"unit_count" : 1.4658129805029452
},
"name" : "name",
"id" : "id",
"type" : {
"unit" : {
"uom" : "ea",
"qty" : 0.8008281904610115,
"type" : "bulk"
},
"name" : "name",
"id" : "id"
},
"serving" : {
"qty" : 5.962133916683182,
"portion" : {
"uom" : "uom",
"qty" : 5.637376656633329
}
}
},
"variety" : {
"name" : "name",
"id" : "id",
"type" : "Hemp"
},
"qty" : 0.8008282,
"name" : "name",
"qty_initial" : 6.0274563,
"section" : {
"name" : "name",
"id" : "id",
"type" : "crop"
},
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Success
Inventory
400
Bad Request
Get a List of Supported Lab Metrics (labMetricGet)
Return type
Example data
Content-Type: application/json
[ {
"name" : "name",
"id" : "id",
"type" : "General"
}, {
"name" : "name",
"id" : "id",
"type" : "General"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of Lab Metric objects
Get just the Lab Report Details for this specific Lab Sample (labReportIdGet)
Lab Reports are ....
Path parameters
id (required)
Path Parameter — Unique ULID value for this Lab Report
Return type
Example data
Content-Type: application/json
{
"metric_list" : [ {
"lod" : "lod",
"uom" : "mg/g",
"lab_result_id" : "lab_result_id",
"lab_metric_id" : "lab_metric_id",
"limit" : "",
"qom" : "qom",
"loq" : "loq",
"status" : "fail"
}, {
"lod" : "lod",
"uom" : "mg/g",
"lab_result_id" : "lab_result_id",
"lab_metric_id" : "lab_metric_id",
"limit" : "",
"qom" : "qom",
"loq" : "loq",
"status" : "fail"
} ],
"license" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"image" : "image",
"contact" : { },
"lab_sample" : {
"stat" : 0,
"updated_at" : "updated_at",
"license_origin" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"created_at" : "created_at",
"id" : "id",
"deleted_at" : "deleted_at"
},
"certificate" : "certificate",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success!
Lab_Report
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Void the Lab Reports (labReportIdPost)
Void a Lab Report
Path parameters
id (required)
Path Parameter — Unique ULID value for this Lab Report
Return type
Example data
Content-Type: application/json
{
"data" : "",
"meta" : ""
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A General Response
inline_response_200_2
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Search the Lab Result (labResultGet)
Lab Result links a Lab Sample to one or more Lab Metrics
Query parameters
q (optional)
Query Parameter — Search Term.
Return type
Example data
Content-Type: application/json
[ {
"metric_list" : [ {
"lod" : "lod",
"uom" : "mg/g",
"lab_result_id" : "lab_result_id",
"lab_metric_id" : "lab_metric_id",
"limit" : "",
"qom" : "qom",
"loq" : "loq",
"status" : "fail"
}, {
"lod" : "lod",
"uom" : "mg/g",
"lab_result_id" : "lab_result_id",
"lab_metric_id" : "lab_metric_id",
"limit" : "",
"qom" : "qom",
"loq" : "loq",
"status" : "fail"
} ],
"license" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"image" : "image",
"contact" : { },
"lab_sample" : {
"stat" : 0,
"updated_at" : "updated_at",
"license_origin" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"created_at" : "created_at",
"id" : "id",
"deleted_at" : "deleted_at"
},
"certificate" : "certificate",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id"
}, {
"metric_list" : [ {
"lod" : "lod",
"uom" : "mg/g",
"lab_result_id" : "lab_result_id",
"lab_metric_id" : "lab_metric_id",
"limit" : "",
"qom" : "qom",
"loq" : "loq",
"status" : "fail"
}, {
"lod" : "lod",
"uom" : "mg/g",
"lab_result_id" : "lab_result_id",
"lab_metric_id" : "lab_metric_id",
"limit" : "",
"qom" : "qom",
"loq" : "loq",
"status" : "fail"
} ],
"license" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"image" : "image",
"contact" : { },
"lab_sample" : {
"stat" : 0,
"updated_at" : "updated_at",
"license_origin" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"created_at" : "created_at",
"id" : "id",
"deleted_at" : "deleted_at"
},
"certificate" : "certificate",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of Lab Result objects
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Get just the Lab Result Details for this specific Lab Sample (labResultIdGet)
Lab Results are ....
Path parameters
id (required)
Path Parameter — Unique ULID value for this Lab Result
Return type
Example data
Content-Type: application/json
{
"metric_list" : [ {
"lod" : "lod",
"uom" : "mg/g",
"lab_result_id" : "lab_result_id",
"lab_metric_id" : "lab_metric_id",
"limit" : "",
"qom" : "qom",
"loq" : "loq",
"status" : "fail"
}, {
"lod" : "lod",
"uom" : "mg/g",
"lab_result_id" : "lab_result_id",
"lab_metric_id" : "lab_metric_id",
"limit" : "",
"qom" : "qom",
"loq" : "loq",
"status" : "fail"
} ],
"license" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"image" : "image",
"contact" : { },
"lab_sample" : {
"stat" : 0,
"updated_at" : "updated_at",
"license_origin" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"created_at" : "created_at",
"id" : "id",
"deleted_at" : "deleted_at"
},
"certificate" : "certificate",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success!
Lab_Result
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Modify/Update the Lab Results (labResultIdPost)
Modify one or more metrics for a specific Lab result
Path parameters
id (required)
Path Parameter — Unique ULID value for this Lab Result
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Result and Metrics to update
Return type
Example data
Content-Type: application/json
{
"data" : "",
"meta" : ""
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A General Response
inline_response_200_2
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Get a list of Lab Samples (labSampleGet)
Search/List All Lab Items the Session has access to, for an Operator it's all the Lab Samples they have sent, for a Laboratory its the Samples that have been sent to them
Query parameters
q (optional)
Query Parameter — Generic Search
company (optional)
Query Parameter — The Company who has supplied the Inventory
inventory (optional)
Query Parameter —
dt0 (optional)
Query Parameter —
dt1 (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"stat" : 0,
"updated_at" : "updated_at",
"license_origin" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"created_at" : "created_at",
"id" : "id",
"deleted_at" : "deleted_at"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Sample Data
Lab_Sample
Up
delete /lab/sample/{id}
Void a Lab Sample (labSampleIdDelete)
Path parameters
id (required)
Path Parameter — Unique ID value for this Lab Result
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
202
Pending Delete Successful, One More Time to Confirm
400
General Failure Response
inline_response_400
404
General Failure Response
inline_response_400
409
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Get a Specific Sample (labSampleIdGet)
Path parameters
id (required)
Path Parameter — Unique ULID value for this Lab Result
Return type
Example data
Content-Type: application/json
{
"stat" : 0,
"updated_at" : "updated_at",
"license_origin" : {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"created_at" : "created_at",
"id" : "id",
"deleted_at" : "deleted_at"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Sample Data
Lab_Sample
Search Company Data (companyGet)
Company, top level grouping of a business
Query parameters
q (optional)
Query Parameter — Search Term.
Return type
Example data
Content-Type: application/json
[ {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
}, {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of Company objects
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Company (companyIdGet)
A Company contains one or more License objects and one or more Contact objects
Path parameters
id (required)
Path Parameter — The ID of the Company
Return type
Example data
Content-Type: application/json
{
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Company
Company
400
General Failure Response
inline_response_400
404
General Failure Response
inline_response_400
409
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Create a Company (companyPost)
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
name (required)
Form Parameter —
type (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
Company
Search Contacts (contactGet)
Contacts are members of a Company
Query parameters
email (required)
Query Parameter — The Email
phone (required)
Query Parameter — The Email
Return type
Example data
Content-Type: application/json
[ {
"phone" : "phone",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"name" : "Caregiver",
"id" : "id"
},
"email" : "email"
}, {
"phone" : "phone",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"name" : "Caregiver",
"id" : "id"
},
"email" : "email"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of Contacts
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
Select Contact (contactIdGet)
Contacts are members of a Company
Path parameters
id (required)
Path Parameter — The ID of the Contact
Return type
Example data
Content-Type: application/json
{
"phone" : "phone",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"name" : "Caregiver",
"id" : "id"
},
"email" : "email"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Contact
Contact
500
General Failure Response
inline_response_400
Update Contact (contactIdPost)
Post to Update a Contact
Path parameters
id (required)
Path Parameter — The ID of the Contact
Return type
Example data
Content-Type: application/json
{
"phone" : "phone",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"name" : "Caregiver",
"id" : "id"
},
"email" : "email"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Contact
Contact
500
General Failure Response
inline_response_400
Create Contact (contactPost)
Create a Contact
Return type
Example data
Content-Type: application/json
{
"phone" : "phone",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"name" : "Caregiver",
"id" : "id"
},
"email" : "email"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Contact
Contact
500
General Failure Response
inline_response_400
Search the License Data (licenseGet)
License, attached to a Company
Return type
Example data
Content-Type: application/json
[ {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
}, {
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An array of License objects
400
General Failure Response
inline_response_400
403
General Failure Response
inline_response_400
500
General Failure Response
inline_response_400
License (licenseIdGet)
A Company contains one or more License objects
Path parameters
id (required)
Path Parameter — The ID of the License
Return type
Example data
Content-Type: application/json
{
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A License
License
500
General Failure Response
inline_response_400
Update a License (licenseIdPost)
Path parameters
id (required)
Path Parameter — The ID of the License
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
id (required)
Form Parameter —
name (required)
Form Parameter —
code (required)
Form Parameter —
type (required)
Form Parameter —
company (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
License
Create a License (licensePost)
Create a new license
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
id (required)
Form Parameter —
name (required)
Form Parameter —
code (required)
Form Parameter —
type (required)
Form Parameter —
company (required)
Form Parameter —
Return type
Example data
Content-Type: application/json
{
"code" : "code",
"name" : "name",
"company" : {
"code" : "code",
"name" : "name",
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
},
"id" : "id",
"type" : {
"code" : "code",
"name" : "name",
"id" : "id"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created
License
[ Jump to Methods ]
Table of Contents
B2B_FileB2B_IncomingB2B_OutgoingB2B_SaleB2B_Sale_ItemB2C_SaleB2C_Sale_ItemCompanyCompany_TypeContactContact_TypeGeneric_ObjectInventoryLab_MetricLab_ReportLab_ResultLab_Result_MetricLab_SampleLicenseLicense_TypePlantPlant_CollectProductProduct_TypeProduct_Type_unitProduct_packageProduct_servingProduct_serving_portionSectionVarietyVehicleauth_open_bodyb2b_bodyb2c_bodycompany_bodyid_adjust_bodyid_collect_bodyid_commit_bodyid_destroy_bodyid_file_bodyincoming_id_bodyinline_response_200inline_response_200_1inline_response_200_2inline_response_400inventory_bodyinventory_id_bodyoutgoing_id_bodyplant_bodyplant_id_bodyproduct_bodyproduct_id_bodysection_bodysection_id_bodyvariety_bodyvehicle_id_body
A file attachment for a B2B Transaction
id
type
b2b_incoming_id (optional)
b2b_outgoing_id (optional)
data
link (optional)
String A Link to the File Contents
The Incoming transaction record (aka: Purchase Order, Receipt) of business to business type of transaction, contains one or more line items.
id
type
incoming
source
target
depart_at (optional)
String Estimate of Departure Time format: dateTime
arrive_at (optional)
String Estimate of Arrival Time format: dateTime
item_list
The Outgoing transaction record (aka: Manifest, Transfer) business to business type of transaction, contains one or more line items.
id
type
outgoing
source
target
depart_at (optional)
String Estimate of Departure Time format: dateTime
arrive_at (optional)
String Estimate of Arrival Time format: dateTime
item_list
A business to business type of transaction, contains one or more line items.
id
type
incoming
outgoing
source
target
depart_at (optional)
String Estimate of Departure Time format: dateTime
arrive_at (optional)
String Estimate of Arrival Time format: dateTime
item_list
Line item of a B2B Transaction
id (optional)
type (optional)
String The Type of transfer such as SAMPLE or FOR_PROCESSING; values are determined by the CRE provider
inventory (optional)
Object Inventory as String ID or Object
product (optional)
variety (optional)
unit_count (optional)
Double Quantity of Items Being Transferred format: double
unit_price (optional)
Double The All-In price of the line item, inclusive of all taxes, fees and other charges format: double
A business to consumer type transaction with one or more line items
id (optional)
String The Universal Identifier
created_at (optional)
String Timestamp of when the Transaction was created, which may be different than when the record was created format: dateTime
Line item of a B2C Transaction
id (optional)
String Global/Unique Identifier
inventory (optional)
String Inventory as String ID or Object
unit_count (optional)
unit_price (optional)
String Pre-Tax Price per Unit <em>NOT</em> the full price
A Company is a container for License and Contact models
id
String Global/Universal Unique Identifier
name
code (optional)
String A Unique Identifier Code; typically a Government issued ID
type (optional)
Designations for the a Type of a company
id
String Unique ID value for this Company Type from the well-known published set
code
String A single character descriptor of the Company Type
name
String A Friendly Name for this Company Type
A Contact represents a natural person
id
String Global/Universal Unique Identifier
type
name
email (optional)
String Contacts primary email address.
phone (optional)
String Contacts primary phone number
company
Well-known Types of Contacts
id (optional)
String well-known Contact Type ULID
name (optional)
String Human readable Name for this Contact Type
Caregiver
Client
Driver
Employee
Manager
Owner
Patient
User
Vendor
@context (optional)
String The Context of the Current Object, generally the OpenTHC namespace
@version (optional)
String The Version Serial Number, like 2018
An Inventory of some Product and Variety
id
String The Inventory Unique Identifier
name (optional)
String Freeform name of the Inventory, if desired
section (optional)
variety (optional)
product
qty (optional)
Float Current Quantity of the Product on Hand format: float
qty_initial (optional)
Float Initial Quantity of the Product format: float
Mapping for all of the individual metrics that would be recorded with a Lab Result to Universal IDs
id
String ID of this specific metric from the well-known published set
name
String Human readable name of this metric
type
String Human readable type of this metric
General
Cannabinoid
Terpene
Microbe
Metal
Solvent
Issued by a Laboratory as container for a collection of test results and their metrics
id (optional)
company (optional)
license (optional)
lab_sample (optional)
contact (optional)
Object The Contact Object of the Laboratory Technician Submitting Report
certificate (optional)
String URL of the Certificate in PDF format, either a public link on the internet, or a base64 encoded data URL.
image (optional)
String URL of the Product Image in a image/png or image/jpeg format, either a public link on the internet, or a base64 encoded data URL.
metric_list (optional)
Issued by a Laboratory as container for individual test result metrics
id (optional)
company (optional)
license (optional)
lab_sample (optional)
contact (optional)
Object The Contact Object of the Laboratory Technician Submitting Results
certificate (optional)
String URL of the Certificate in PDF format, either a public link on the internet, or a base64 encoded data URL.
image (optional)
String URL of the Product Image in a image/png or image/jpeg format, either a public link on the internet, or a base64 encoded data URL.
metric_list (optional)
A Lab Metric Result for any test
lab_result_id (optional)
lab_metric_id (optional)
String The Well Known Identifier of this Metric, may be null
qom (optional)
String Quantity of Measure, the value measured
uom (optional)
mg/g
percent
ppb
ppm
lod (optional)
loq (optional)
limit (optional)
Upper limit of detected stuff in the sample, below which the sample has passed
status (optional)
String The status of this Lab Metric on this Lab Result
fail
na
nd
nr
nt
pass
A Special type of Inventory Lot that becomes a Laboratory Sample
id
String ID of this specific Lab Sample
stat (optional)
200
410
created_at (optional)
String DateTime format: dateTime
updated_at (optional)
String DateTime format: dateTime
deleted_at (optional)
String DateTime when deleted -- null indicates NOT deleted format: dateTime
license_origin (optional)
A License is part of a Company and is a container for Inventory, Products, Variety, Section, B2B and B2C Transactions
id
String Global/Universal Unique Identifier
name
code (optional)
String A Unique Identifier Code; typically a Government issued ID
type
company
Designations for the a Type of a company
id
String Global/Universal Unique Identifier from the well-known published set
code
String A single character descriptor of the License Type
name
String Name of the License Type like Grower, or G1 or Lab or something
id (optional)
String Unique Plant Identifier
name (optional)
String Free-form Name of the plant, many times just the Variety
variety (optional)
id (optional)
String Unique Identifier of the Plant Collect operation
plant (optional)
type (optional)
String Material Type: Flower/Wet, Flower/Dry, Trim/Wet|Dry, Waste/Wet|Dry
raw
net
wet-plant
wet-waste
dry-buds
dry-trim
dry-waste
qty (optional)
Double Quantity of Material Collected format: double
uom (optional)
g
kg
oz
lb
id (optional)
String The Product Unique Identifer from the CRE
name (optional)
String Free-form name of the Product
type (optional)
package (optional)
serving (optional)
Designations for the a Type of a product
id
String ULID or An Internal SKU or Lot ID
name
unit
type (optional)
bulk
pack
each
qty (optional)
uom (optional)
ea
g
mg
ml
id (optional)
String Well-known ID of Package Descriptor
net (optional)
Object Net weight details as object
net_volume (optional)
net_weight (optional)
unit_count (optional)
qty (optional)
portion (optional)
qty (optional)
uom (optional)
A logical or physical organizational container aka Area, Room, Zone
id (optional)
String The Universal Identifier
name (optional)
type (optional)
crop
inventory
inventory-quarantine
The Variety is sometimes called the Cultivar or Strain. Not all products have a Variety
id
String Global/Universal Unique Identifier
name
String Free-form name of Variety
type (optional)
Hemp
Hybrid
Indica
Sativa
Ruderalis
The Vehicle is any equipment that transports cannabis
id
String Global/Universal Unique Identifier
name (optional)
String Free-form, auto-generated name of Vehicle
make
String Manufacturer / Make of vehicle
model
color
vin (optional)
String The Vehicle Identification Number
vrn (optional)
String The Vehicle Registration Number (License Plate/Number Plate)
cre (optional)
String The Regulatory Compliance Engine code
service-key (optional)
String The Software Pre-Shared Key, if the CRE provides this
company (optional)
String The Company Identifier, if the CRE has one
license (optional)
String The License Identifier, if the CRE has one (eg: METRC, LeafData)
license-key (optional)
String The License Pre-Shared Key, if the CRE has one (eg: LeafData)
username (optional)
String A Username, for the CREs that use this method (eg: BioTrack)
password (optional)
String A Password, for the CREs that use this method (eg: BioTrack)
type
incoming
outgoing
origin
target
depart (optional)
arrive (optional)
inventory_id (optional)
unit_count (optional)
unit_price (optional)
patient_id (optional)
String Deprecated, use the contact array
caregiver_id (optional)
String Deprecated, use the contact array
contact (optional)
name (optional)
type (optional)
qty
BigDecimal The new Quantity of the specified Inventory
collect_id (optional)
Identifier of the Batch, if one is not provided a new one will be assigned
date (optional)
String Date and Time of Collection format: dateTime
type (optional)
qty (optional)
Full Weight of Material in Integer value
uom (optional)
plant_id (optional)
array[String] Array of Plant IDs to factor for this net collection operation
date (optional)
String Date and Time of Collection format: dateTime
type (optional)
qty (optional)
Full Weight of Material in Integer value
uom (optional)
reason_code (optional)
reason_text (optional)
type
incoming
outgoing
origin
target
depart (optional)
arrive (optional)
contact (optional)
vehicle (optional)
depart_at (optional)
arrive_at (optional)
meta (optional)
data (optional)
meta (optional)
Object A data-array of information, CRE implementation specific
data (optional)
Some kind of data, an array of objects or a single object
meta (optional)
Additional Helpful info, generally an object or array of objects
data (optional)
Some kind of data, an array of objects or a single object
meta (optional)
Object Additional Helpful info, generally an object or array of objects
source (optional)
array[String] Null, String of Single Source, or Array of Source Inventory Items
output_product_id (optional)
String The Output Product Type
output_qty (optional)
Float Quantity in Product Type UOMs of the Output format: float
product
variety
name
String User defined Inventory name
contact (optional)
vehicle (optional)
depart_at (optional)
arrive_at (optional)
source (optional)
String The ID of the Source Item for creating this Plant
variety (optional)
String An Updated Variety ID, use Inventory.Variety.Name if not present
section (optional)
String Which Section the Plant should be created in
qty (optional)
BigDecimal Count of Plants to Create from Inventory format: integer
variety (optional)
section (optional)
String Indicate the Section the Plant is in
propagation_source (optional)
Boolean Designate the Plant as a Propagation Source (aka: Mother)
name (optional)
type (optional)
name (optional)
type (optional)
id (optional)
String Unique ULID value for this Section
name (optional)
String The Name for this Section
type (optional)
String The Type of Room: Plant or Inventory
flag_quarantine (optional)
String If the Section is a designated quarantine area
id (optional)
String Unique ULID value for this Section
name (optional)
String The Name for this Section
name (optional)
type (optional)