Get products

Get products

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

{
  "non_prescription": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "sku": "1234567890",
      "name": "Krill Farms Fish Oil",
      "description": "A fish oil supplement complementary to prescribed products.",
      "category": "nutrition",
      "form": "liquid",
      "is_active": true
    }
  ],
  "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%"
    }
  ],
  "order_material": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "sku": "1234567890",
      "name": "Referral Brochure",
      "description": "Customer brochure included in every shipment.",
      "category": "marketing",
      "current_stock": 927,
      "reorder_threshold": 100,
      "has_inventory": true,
      "is_global": false
    }
  ]
}

GET

api

products

Get products

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

{
  "non_prescription": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "sku": "1234567890",
      "name": "Krill Farms Fish Oil",
      "description": "A fish oil supplement complementary to prescribed products.",
      "category": "nutrition",
      "form": "liquid",
      "is_active": true
    }
  ],
  "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%"
    }
  ],
  "order_material": [
    {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "sku": "1234567890",
      "name": "Referral Brochure",
      "description": "Customer brochure included in every shipment.",
      "category": "marketing",
      "current_stock": 927,
      "reorder_threshold": 100,
      "has_inventory": true,
      "is_global": false
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

type

string

Optional type of product to retrieve, either 'prescription', 'non_prescription', or 'order_material'

Example:

"prescription"

Response

200 - application/json

Successful response with all products, or specific type of products.

All Types · object
Prescription Products · object[]
Non-Prescription Products · object[]
Order Materials · object[]

non_prescription

object[]

Show child attributes

non_prescription.id

string<uuid>

Unique identifier

Example:

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

non_prescription.created_at

string<date-time>

Date and time of creation

Example:

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

non_prescription.updated_at

string<date-time>

Date and time of last update

Example:

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

non_prescription.sku

string

Unique inventory identifier for the product

Example:

"1234567890"

non_prescription.name

string

Example:

"Krill Farms Fish Oil"

non_prescription.description

string

Example:

"A fish oil supplement complementary to prescribed products."

non_prescription.category

string

Optional category of the product

Example:

"nutrition"

non_prescription.form

string

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

Example:

"liquid"

non_prescription.is_active

boolean

Whether the product is currently active for purchase

Example:

true

prescription

object[]

Show child attributes

prescription.id

string<uuid>

Unique identifier

Example:

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

prescription.created_at

string<date-time>

Date and time of creation

Example:

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

prescription.updated_at

string<date-time>

Date and time of last update

Example:

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

prescription.sku

string

Unique inventory identifier for the product

Example:

"1234567890"

prescription.name

string

Example:

"Mupirocin"

prescription.description

string

Example:

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

prescription.product_code

string

Customer reference for the product for use in electronic prescriptions.

Example:

"SUPERSPRAY15"

prescription.category

string

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

Example:

"topicals"

prescription.form

string

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

Example:

"cream"

prescription.is_active

boolean

Whether the product is currently active for purchase or prescription

Example:

true

prescription.label_orientation

string

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

Example:

"portrait"

prescription.strength

string

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

Example:

"1%"

order_material

object[]

Show child attributes

order_material.id

string<uuid>

Unique identifier

Example:

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

order_material.created_at

string<date-time>

Date and time of creation

Example:

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

order_material.updated_at

string<date-time>

Date and time of last update

Example:

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

order_material.sku

string

Unique inventory identifier for the product

Example:

"1234567890"

order_material.name

string

Example:

"Referral Brochure"

order_material.description

string

Example:

"Customer brochure included in every shipment."

order_material.category

string

Example:

"marketing"

order_material.current_stock

integer

Example:

927

order_material.reorder_threshold

integer

Example:

100

order_material.has_inventory

boolean

Whether the product has any inventory associated with it

Example:

true

order_material.is_global

boolean

Whether the material is customer-specific or Blend-wide (e.g. regulatory inserts)

Example:

false

Get a prescriber's supervisees Get prescription products

⌘I

Authentication

Composite Creation

Electronic Prescriptions

Notifications

Orders

Patients

Prescribers

Products and Materials

Reports

Search

Authorizations

Query Parameters

Response