Barcoding
Notifications
Orders
Patients
- GETGet patients
- POSTCreate a patient
- GETGet a patient's details
- PUTUpdate a patient's details
- GETGet guardian relationship types
- GETGet a patient's orders
- GETGet a patient's risk factors
- POSTCreate risk factors
- POSTCreate a single risk factor
- PATCHConfirm risk factor match
- DELDeactivate a risk factor
- POSTAdd freeform risk factor text
Prescribers
Prescriptions
Products and Materials
Products and Materials Inventory
- GETGet inventory
- POSTCreate product inventory
- GETGet inventory lot details
- PUTUpdate inventory lot
- GETGet a prescription product inventory
- POSTCreate prescription product inventory
- GETGet a non-prescription product inventory
- POSTCreate non-prescription product inventory
- GETGet order material inventory
- POSTCreate order material product inventory
- PATCHAdjust inventory quantity
- GETGet inventory associations
- POSTCreate inventory association
- DELRemove inventory association
Reports
Search
Tasks
Webhooks
Products and Materials Inventory
Get inventory lot details
Retrieve details for a specific inventory lot by its unique ID.
GET
/
api
/
v1
/
products
/
inventory
/
{lot_id}
Copy
curl --request GET \
--url https://api.byblend.com/api/v1/products/inventory/{lot_id} \
--header 'Authorization: Bearer <token>'
Copy
{
"id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"created_at": "2025-03-15T12:00:00Z",
"updated_at": "2025-03-15T12:00:00Z",
"batch_number": "1234567890",
"cost_per_unit": 2.49,
"current_quantity": 80,
"expiration_date": "2025-01-01T00:00:00",
"is_active": true,
"manufacturer": "Krill Farms",
"mpn": "KF1234567890",
"notes": "This batch was received as a replacement to batch 817",
"received_date": "2025-01-01T18:21:45.371623",
"unit_type": "mg",
"upc": "7-12345-67890-4",
"type": "prescription",
"initial_quantity": 100,
"associations": {
"prescription": [
{
"customer": "Health First Telemedicine Clinic",
"customer_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"name": "Special Blend Product",
"product_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"units_per_product": 100
}
],
"non_prescription": [
{
"customer": "Health First Telemedicine Clinic",
"customer_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"name": "Special Blend Product",
"product_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"units_per_product": 100
}
],
"order_material": [
{
"customer": "Health First Telemedicine Clinic",
"customer_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"name": "Special Blend Product",
"product_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"units_per_product": 100
}
]
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique (UUID) identifier for the inventory lot
Example:
"98cae3a3-996c-4bf5-9143-0ab6d98bc1d0"
Response
200 - application/json
Successful response with inventory lot details
The response is of type object
.
Copy
curl --request GET \
--url https://api.byblend.com/api/v1/products/inventory/{lot_id} \
--header 'Authorization: Bearer <token>'
Copy
{
"id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"created_at": "2025-03-15T12:00:00Z",
"updated_at": "2025-03-15T12:00:00Z",
"batch_number": "1234567890",
"cost_per_unit": 2.49,
"current_quantity": 80,
"expiration_date": "2025-01-01T00:00:00",
"is_active": true,
"manufacturer": "Krill Farms",
"mpn": "KF1234567890",
"notes": "This batch was received as a replacement to batch 817",
"received_date": "2025-01-01T18:21:45.371623",
"unit_type": "mg",
"upc": "7-12345-67890-4",
"type": "prescription",
"initial_quantity": 100,
"associations": {
"prescription": [
{
"customer": "Health First Telemedicine Clinic",
"customer_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"name": "Special Blend Product",
"product_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"units_per_product": 100
}
],
"non_prescription": [
{
"customer": "Health First Telemedicine Clinic",
"customer_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"name": "Special Blend Product",
"product_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"units_per_product": 100
}
],
"order_material": [
{
"customer": "Health First Telemedicine Clinic",
"customer_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"name": "Special Blend Product",
"product_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
"units_per_product": 100
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.