Get orders

Retrieve all orders. This endpoint returns paginated responses.

Details on pagination are returned in response headers.

• X-Total-Count: total number of items available
• X-Page: current page number
• X-Page-Size: number of items per page
• X-Total-Pages: total number of pages available
• X-Remaining-Count: number of items remaining after the current page

GET /api/v1/orders

Get orders

cURL

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

200

[
  {
    "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",
    "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": "[e-mail]",
      "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": "[e-mail]",
      "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"
      }
    },
    "prescription_count": 1,
    "priority_requested": false,
    "cancellation_requested": false,
    "replacement_order_ids": [
      "0227d1e5-ba9a-42b5-8fe2-38882aa65708"
    ],
    "replacement_reason": "Product arrived damaged",
    "replacement_requested": false,
    "replacement_request_status": "pending",
    "replacement_requested_at": "2025-01-01T00:00:00Z",
    "replacement_requested_reason": "Product arrived damaged",
    "shipments": [
      {
        "carrier": "USPS",
        "created_at": "2026-04-17T18:31:05.175498",
        "delivered_at": "2026-04-17T18:31:05.175498",
        "id": "0239CA06-9A71-4FFE-8A8D-5403540A19E7",
        "service_level": "Ground Advantage",
        "status": "shipped",
        "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

has_unmatched_prescriptions · boolean

Filter orders by whether they have prescription products that are not (yet) associated with a prescription. The has_unmatched_prescriptions=true will return only orders with un-prescribed products.

Example:

true

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.

id · 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

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

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"

patient · object

Show child attributes

prescription_count · integer

Number of prescriptions associated with the order (expected to be the same as the number of prescription products in the products object)

Example:

1

priority_requested · boolean

Whether the order has a priority request

Example:

false

cancellation_requested · boolean

Whether the customer has requested cancellation for an order in picked or verified status

Example:

false

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"

replacement_requested · boolean

Whether the order has a replacement request. This field is deprecated and will be removed in a future version. Please use replacement_request_status instead.

Example:

false

replacement_request_status · enum<string>

Status of the replacement request

Available options: pending, fulfilled, declined, cancelled

Example:

"pending"

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

shipping · object

Show child attributes

status · string

Example:

"received"