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
Barcoding
Create a barcode
Create a new barcode
POST
/
api
/
v1
/
barcodes
/
{entity_type}
/
{entity_id}
Copy
curl --request POST \
--url https://api.byblend.com/api/v1/barcodes/{entity_type}/{entity_id} \
--header 'Authorization: Bearer <token>'
Copy
{
"barcode_value": "USER-3da03bd9-26cd-487c-9619-d4e1b0c26f24-7172173f",
"created_at": "2025-04-29T02:47:19.835090",
"entity_id": "3da03bd9-26cd-487c-9619-d4e1b0c26f24",
"entity_type": "user",
"expires_at": "2025-04-29T03:47:19.834495",
"image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADYAAAA2AQAAAACkPldwAAAAzklEQVR4nE2QQUpEMRBE609mIwSy8ApuhUAEEQLtkTyKRwpkG+k5gOAJhAwZmE1/WgSn2+weVUlVBTUIoeUD/k6iWgYNY4ZQ73LjrcXnl2v8MH1NjkNNx+TYJzkjpVEajHtKibS5H8iZo/vzr8nzg7Cy1Bsfcb9fxpO9d3j8huDL7m+6n3C98z1Fh3Ay/zZfPy8tep+aWVmNj6eH8wbx/C46xfMhhEzF9SQVYXmertpq+befZUr0fSEPYprWh96xh/3N88Isy/8bOhkL1vcH/sNf4bXmnzwAAAAASUVORK5CYII=",
"is_active": true,
"id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The type of entity the barcode is for
Available options:
user
, order
, patient
, prescription
, prescription_product
, non_prescription_product
, order_material
, inventory
The ID of the entity
Query Parameters
The number of hours until the barcode expires. If not provided, the barcode will not expire.
Example:
12
Response
201 - application/json
Successful response with barcode details
The response is of type object
.
Copy
curl --request POST \
--url https://api.byblend.com/api/v1/barcodes/{entity_type}/{entity_id} \
--header 'Authorization: Bearer <token>'
Copy
{
"barcode_value": "USER-3da03bd9-26cd-487c-9619-d4e1b0c26f24-7172173f",
"created_at": "2025-04-29T02:47:19.835090",
"entity_id": "3da03bd9-26cd-487c-9619-d4e1b0c26f24",
"entity_type": "user",
"expires_at": "2025-04-29T03:47:19.834495",
"image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADYAAAA2AQAAAACkPldwAAAAzklEQVR4nE2QQUpEMRBE609mIwSy8ApuhUAEEQLtkTyKRwpkG+k5gOAJhAwZmE1/WgSn2+weVUlVBTUIoeUD/k6iWgYNY4ZQ73LjrcXnl2v8MH1NjkNNx+TYJzkjpVEajHtKibS5H8iZo/vzr8nzg7Cy1Bsfcb9fxpO9d3j8huDL7m+6n3C98z1Fh3Ay/zZfPy8tep+aWVmNj6eH8wbx/C46xfMhhEzF9SQVYXmertpq+befZUr0fSEPYprWh96xh/3N88Isy/8bOhkL1vcH/sNf4bXmnzwAAAAASUVORK5CYII=",
"is_active": true,
"id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708"
}
Assistant
Responses are generated using AI and may contain mistakes.