Get orders

Get orders

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

[
  {
    "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
    "created_at": "2025-03-15T12:00:00Z",
    "updated_at": "2025-03-15T12:00:00Z",
    "address": {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "address_1": "140 Lindgren Streets",
      "address_2": "Apt 227",
      "city": "North Consueloburgh",
      "state": "CA",
      "country": "US",
      "type": "shipping",
      "zip_code": "02108"
    },
    "custom_shipping": {
      "label_url": "https://example.com/label.pdf",
      "tracking_number": "TEST123456",
      "tracking_url": "https://example.com/track/TEST123456",
      "carrier": "UPS"
    },
    "customer_id": "b658f16f-819c-4503-aede-bd555fc4ebfb",
    "external_id": "my-system-128318AA2",
    "is_replacement": false,
    "order_number": "ORD250312003548IAU4",
    "original_order_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
    "replacement_order_ids": [
      "0227d1e5-ba9a-42b5-8fe2-38882aa65708"
    ],
    "replacement_reason": "Product arrived damaged",
    "patient": {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "first_name": "Willard",
      "middle_name": "Moises",
      "last_name": "Donnelly",
      "gender": "male",
      "email": "[email protected]",
      "phone": "6417383445",
      "date_of_birth": "1990-01-01",
      "driver_license_number": "B49188319",
      "driver_license_state": "CA",
      "ssn": "123456789",
      "primary_language": "en",
      "guardian_name": "John Guardian",
      "guardian_phone": "6417383445",
      "guardian_email": "[email protected]",
      "guardian_relationship": "parent",
      "height_inches": 72,
      "weight_pounds": 180,
      "external_id": "1234567890",
      "is_smoker": false,
      "is_diabetic": false,
      "is_pregnant": false,
      "receive_sms": true,
      "receive_email": true,
      "address": {
        "address_1": "140 Lindgren Streets",
        "city": "North Consueloburgh",
        "state": "CA",
        "zip_code": "02108",
        "address_2": "Apt 227",
        "country": "US"
      }
    },
    "priority_requested": false,
    "products": {
      "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%",
          "quantity": 2,
          "reasons": [
            {
              "id": "00000000-0000-0000-0000-000000000201",
              "name": "Palatability",
              "description": "Commercial formulation has an unpleasant taste, texture, or odor."
            }
          ]
        }
      ],
      "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,
          "quantity": 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,
          "quantity": 1
        }
      ]
    },
    "replacement_requested": false,
    "replacement_requested_at": "2025-01-01T00:00:00Z",
    "replacement_requested_reason": "Product arrived damaged",
    "shipments": [
      {
        "carrier": "USPS",
        "id": "0239CA06-9A71-4FFE-8A8D-5403540A19E7",
        "service_level": "Ground Advantage",
        "shipped_at": "2025-01-01T00:00:00Z",
        "tracking_number": "9200190347375200467807",
        "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9200190347375200467807"
      }
    ],
    "shipping": {
      "carrier": "usps",
      "service_level": "usps_ground_advantage"
    },
    "status": "received"
  }
]

GET

api

orders

Get orders

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

[
  {
    "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
    "created_at": "2025-03-15T12:00:00Z",
    "updated_at": "2025-03-15T12:00:00Z",
    "address": {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "address_1": "140 Lindgren Streets",
      "address_2": "Apt 227",
      "city": "North Consueloburgh",
      "state": "CA",
      "country": "US",
      "type": "shipping",
      "zip_code": "02108"
    },
    "custom_shipping": {
      "label_url": "https://example.com/label.pdf",
      "tracking_number": "TEST123456",
      "tracking_url": "https://example.com/track/TEST123456",
      "carrier": "UPS"
    },
    "customer_id": "b658f16f-819c-4503-aede-bd555fc4ebfb",
    "external_id": "my-system-128318AA2",
    "is_replacement": false,
    "order_number": "ORD250312003548IAU4",
    "original_order_id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
    "replacement_order_ids": [
      "0227d1e5-ba9a-42b5-8fe2-38882aa65708"
    ],
    "replacement_reason": "Product arrived damaged",
    "patient": {
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "first_name": "Willard",
      "middle_name": "Moises",
      "last_name": "Donnelly",
      "gender": "male",
      "email": "[email protected]",
      "phone": "6417383445",
      "date_of_birth": "1990-01-01",
      "driver_license_number": "B49188319",
      "driver_license_state": "CA",
      "ssn": "123456789",
      "primary_language": "en",
      "guardian_name": "John Guardian",
      "guardian_phone": "6417383445",
      "guardian_email": "[email protected]",
      "guardian_relationship": "parent",
      "height_inches": 72,
      "weight_pounds": 180,
      "external_id": "1234567890",
      "is_smoker": false,
      "is_diabetic": false,
      "is_pregnant": false,
      "receive_sms": true,
      "receive_email": true,
      "address": {
        "address_1": "140 Lindgren Streets",
        "city": "North Consueloburgh",
        "state": "CA",
        "zip_code": "02108",
        "address_2": "Apt 227",
        "country": "US"
      }
    },
    "priority_requested": false,
    "products": {
      "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%",
          "quantity": 2,
          "reasons": [
            {
              "id": "00000000-0000-0000-0000-000000000201",
              "name": "Palatability",
              "description": "Commercial formulation has an unpleasant taste, texture, or odor."
            }
          ]
        }
      ],
      "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,
          "quantity": 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,
          "quantity": 1
        }
      ]
    },
    "replacement_requested": false,
    "replacement_requested_at": "2025-01-01T00:00:00Z",
    "replacement_requested_reason": "Product arrived damaged",
    "shipments": [
      {
        "carrier": "USPS",
        "id": "0239CA06-9A71-4FFE-8A8D-5403540A19E7",
        "service_level": "Ground Advantage",
        "shipped_at": "2025-01-01T00:00:00Z",
        "tracking_number": "9200190347375200467807",
        "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9200190347375200467807"
      }
    ],
    "shipping": {
      "carrier": "usps",
      "service_level": "usps_ground_advantage"
    },
    "status": "received"
  }
]

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

Page number for pagination

Example:

1

page_size

integer

Number of items per page; defaults to 25, max of 200

Example:

25

status

string

Filter orders by status; comma-separate multiple values to return orders of various statuses

Example:

"picked,verified"

Response

200 - application/json

Successful response with an array of orders. Details on pagination are returned in response headers.

string<uuid>

Unique identifier

Example:

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

created_at

string<date-time>

Date and time of creation

Example:

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

updated_at

string<date-time>

Date and time of last update

Example:

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

address

object

Show child attributes

address.id

string<uuid>

Unique identifier

Example:

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

address.address_1

string

Example:

"140 Lindgren Streets"

address.address_2

string

Example:

"Apt 227"

address.city

string

Example:

"North Consueloburgh"

address.state

string

Two-letter state abbreviation

Example:

"CA"

address.country

string

Two-letter country code

Example:

"US"

address.type

string

Type of address, if applicable

Example:

"shipping"

address.zip_code

string

5-digit ZIP code or ZIP+4 code, e.g. 02108 or 02108-1234

Example:

"02108"

custom_shipping

object

Custom shipping details for the order if your account has custom shipping enabled, and you have provided prepaid label details.

Show child attributes

custom_shipping.label_url

string

URL of the printable (4x6) custom shipping label

Example:

"https://example.com/label.pdf"

custom_shipping.tracking_number

string

Tracking number from the custom shipping label

Example:

"TEST123456"

custom_shipping.tracking_url

string

Tracking URL of the custom shipping label

Example:

"https://example.com/track/TEST123456"

custom_shipping.carrier

string

Carrier of the custom shipping label

Example:

"UPS"

customer_id

string<uuid>

Example:

"b658f16f-819c-4503-aede-bd555fc4ebfb"

external_id

string

External (your own system's) ID associated with the order.

Example:

"my-system-128318AA2"

is_replacement

boolean

Whether the order is a replacement order

Example:

false

order_number

string

Friendlier identifier for the order. Auto-generated.

Example:

"ORD250312003548IAU4"

original_order_id

string<uuid>

ID of the original order, if this is a replacement order

Example:

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

replacement_order_ids

string<uuid>[]

IDs of any replacement orders, if they have been created from this order

replacement_reason

string

If this is a replacement order, reason for the replacement

Example:

"Product arrived damaged"

patient

object

Show child attributes

patient.id

string<uuid>

Unique identifier

Example:

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

patient.created_at

string<date-time>

Date and time of creation

Example:

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

patient.updated_at

string<date-time>

Date and time of last update

Example:

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

patient.first_name

string

Example:

"Willard"

patient.middle_name

string

Example:

"Moises"

patient.last_name

string

Example:

"Donnelly"

patient.gender

enum<string>

Gender of the patient

Available options:

male,

female

Example:

"male"

patient.email

string

Example:

"[email protected]"

patient.phone

string

10-digit phone number without formatting, e.g. 6417383445

Example:

"6417383445"

patient.date_of_birth

string<date>

Example:

"1990-01-01"

patient.driver_license_number

string

Example:

"B49188319"

patient.driver_license_state

string

Example:

"CA"

patient.ssn

string

Social Security number. Can be provided with or without hyphens.

Example:

"123456789"

patient.primary_language

string

ISO 639-1 language code

Example:

"en"

patient.guardian_name

string

Name of the patient's guardian. Required if patient is a minor.

Example:

"John Guardian"

patient.guardian_phone

string

Example:

"6417383445"

patient.guardian_email

string

Example:

"[email protected]"

patient.guardian_relationship

string

Relationship of the guardian to the patient. See relationship types lookup for available values; most common are parent and legal_guardian; and other can be used.

Example:

"parent"

patient.height_inches

integer

Height of the patient in inches

Example:

72

patient.weight_pounds

integer

Weight of the patient in pounds

Example:

180

patient.external_id

string

External (your own) ID for the patient, to be used for prescription matching

Example:

"1234567890"

patient.is_smoker

boolean

Whether the patient is a smoker

Example:

false

patient.is_diabetic

boolean

Whether the patient is diabetic

Example:

false

patient.is_pregnant

boolean

Whether the patient is pregnant

Example:

false

patient.receive_sms

boolean

Whether the patient should receive SMS notifications for shipments. This is only applicable if you have authorized Blend to send patient communications on your behalf.

Example:

true

patient.receive_email

boolean

Whether the patient should receive email notifications for shipments. This is only applicable if you have authorized Blend to send patient communications on your behalf.

Example:

true

patient.address

object

Show child attributes

patient.address.address_1

string

required

Example:

"140 Lindgren Streets"

patient.address.city

string

required

Example:

"North Consueloburgh"

patient.address.state

string

required

Two-letter state abbreviation

Example:

"CA"

patient.address.zip_code

string

required

5-digit ZIP code or 9-digit ZIP+4 code, e.g. 02108 or 02108-1234.

Example:

"02108"

patient.address.address_2

string

Example:

"Apt 227"

patient.address.country

string

Two-letter country code, defaults to US

Example:

"US"

priority_requested

boolean

Whether the order has a priority request

Example:

false

products

object

Show child attributes

products.prescription

object[]

Show child attributes

products.prescription.id

string<uuid>

Unique identifier

Example:

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

products.prescription.created_at

string<date-time>

Date and time of creation

Example:

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

products.prescription.updated_at

string<date-time>

Date and time of last update

Example:

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

products.prescription.sku

string

Unique inventory identifier for the product

Example:

"1234567890"

products.prescription.name

string

Example:

"Mupirocin"

products.prescription.description

string

Example:

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

products.prescription.product_code

string

Customer reference for the product for use in electronic prescriptions.

Example:

"SUPERSPRAY15"

products.prescription.category

string

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

Example:

"topicals"

products.prescription.form

string

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

Example:

"cream"

products.prescription.is_active

boolean

Whether the product is currently active for purchase or prescription

Example:

true

products.prescription.label_orientation

string

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

Example:

"portrait"

products.prescription.strength

string

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

Example:

"1%"

products.prescription.quantity

integer

Quantity of product in this specific order

Example:

2

products.prescription.reasons

object[]

Show child attributes

products.prescription.reasons.id

string<uuid>

Example:

"00000000-0000-0000-0000-000000000201"

products.prescription.reasons.name

string

Example:

"Palatability"

products.prescription.reasons.description

string

Example:

"Commercial formulation has an unpleasant taste, texture, or odor."

products.non_prescription

object[]

Show child attributes

products.non_prescription.id

string<uuid>

Unique identifier

Example:

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

products.non_prescription.created_at

string<date-time>

Date and time of creation

Example:

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

products.non_prescription.updated_at

string<date-time>

Date and time of last update

Example:

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

products.non_prescription.sku

string

Unique inventory identifier for the product

Example:

"1234567890"

products.non_prescription.name

string

Example:

"Krill Farms Fish Oil"

products.non_prescription.description

string

Example:

"A fish oil supplement complementary to prescribed products."

products.non_prescription.category

string

Optional category of the product

Example:

"nutrition"

products.non_prescription.form

string

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

Example:

"liquid"

products.non_prescription.is_active

boolean

Whether the product is currently active for purchase

Example:

true

products.non_prescription.quantity

integer

Quantity in this specific order

Example:

1

products.order_material

object[]

Show child attributes

products.order_material.id

string<uuid>

Unique identifier

Example:

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

products.order_material.created_at

string<date-time>

Date and time of creation

Example:

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

products.order_material.updated_at

string<date-time>

Date and time of last update

Example:

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

products.order_material.sku

string

Unique inventory identifier for the product

Example:

"1234567890"

products.order_material.name

string

Example:

"Referral Brochure"

products.order_material.description

string

Example:

"Customer brochure included in every shipment."

products.order_material.category

string

Example:

"marketing"

products.order_material.current_stock

integer

Example:

927

products.order_material.reorder_threshold

integer

Example:

100

products.order_material.has_inventory

boolean

Whether the product has any inventory associated with it

Example:

true

products.order_material.is_global

boolean

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

Example:

false

products.order_material.quantity

integer

Quantity of the material in this specific order

Example:

1

replacement_requested

boolean

Whether the order has a replacement request

Example:

false

replacement_requested_at

string

Date and time a replacement request was made

Example:

"2025-01-01T00:00:00Z"

replacement_requested_reason

string

Reason for the replacement request

Example:

"Product arrived damaged"

shipments

object[]

Show child attributes

shipments.carrier

string

Shipment carrier.

Example:

"USPS"

shipments.id

string<uuid>

Blend internal shipment ID.

Example:

"0239CA06-9A71-4FFE-8A8D-5403540A19E7"

shipments.service_level

string

Shipment service level.

Example:

"Ground Advantage"

shipments.shipped_at

string

Date and time the package label was purchased and the item marked shipped.

Example:

"2025-01-01T00:00:00Z"

shipments.tracking_number

string

Tracking number for the shipment.

Example:

"9200190347375200467807"

shipments.tracking_url

string

Tracking URL for the shipment.

Example:

"https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9200190347375200467807"

shipping

object

Show child attributes

shipping.carrier

string

Desired shipment carrier.

Example:

"usps"

shipping.service_level

string

Desired shipment service level.

Example:

"usps_ground_advantage"

status

string

Example:

"received"

DEP: Deactivate a subscription Create an order

⌘I

Authentication

Composite Creation

Electronic Prescriptions

Notifications

Orders

Patients

Prescribers

Products and Materials

Reports

Search

Authorizations

Query Parameters

Response