Search products

curl --request GET \
  --url https://api.byblend.com/api/v1/search/products \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "rank": 0.7,
      "result_type": "prescription",
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "sku": "1234567890",
      "name": "Mupirocin",
      "description": "A topical cream that is used to treat skin infections.",
      "product_code": "SUPERSPRAY15",
      "category": "topicals",
      "form": "cream",
      "is_active": true,
      "label_orientation": "portrait",
      "strength": "1%"
    }
  ]
}

GET

api

products

Search products

curl --request GET \
  --url https://api.byblend.com/api/v1/search/products \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "rank": 0.7,
      "result_type": "prescription",
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "sku": "1234567890",
      "name": "Mupirocin",
      "description": "A topical cream that is used to treat skin infections.",
      "product_code": "SUPERSPRAY15",
      "category": "topicals",
      "form": "cream",
      "is_active": true,
      "label_orientation": "portrait",
      "strength": "1%"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

string

required

Search query

Example:

"rapamycin"

limit

integer

Optional limit on the number of results to return. Max is 100, default is 50.

Example:

10

Response

200 - application/json

Successful response with array of products

results

(Prescription product · object | Non-prescription product · object | Order material · object)[]

Prescription product
Non-prescription product
Order material

Show child attributes

results.rank

number

Ranking score of the search result, from 0 to 1, indicating relevance to the search query

Example:

0.7

results.result_type

enum<string>

Available options:

prescription

results.id

string<uuid>

Unique identifier

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

results.created_at

string<date-time>

Date and time of creation

Example:

"2025-03-15T12:00:00Z"

results.updated_at

string<date-time>

Date and time of last update

Example:

"2025-03-15T12:00:00Z"

results.sku

string

Unique inventory identifier for the product

Example:

"1234567890"

results.name

string

Example:

"Mupirocin"

results.description

string

Example:

"A topical cream that is used to treat skin infections."

results.product_code

string

Customer reference for the product for use in electronic prescriptions.

Example:

"SUPERSPRAY15"

results.category

string

Optional category of the product for customer use, if desired.

Example:

"topicals"

results.form

string

Optional form of the product for customer use, if desired.

Example:

"cream"

results.is_active

boolean

Whether the product is currently active for purchase or prescription

Example:

true

results.label_orientation

string

Orientation of the printed product label, either portrait or landscape.

Example:

"portrait"

results.strength

string

Optional strength of the product for customer use, if desired.

Example:

"1%"

Search prescribers Search tasks

⌘I

Authentication

Composite Creation

Electronic Prescriptions

Notifications

Orders

Patients

Prescribers

Products and Materials

Reports

Search

Search products

Authorizations

Query Parameters

Response