GET
/
api
/
v1
/
search
/
orders
curl --request GET \
  --url https://api.byblend.com/api/v1/search/orders \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "rank": 0.7,
      "is_patient_order": true,
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "status_code": "N01",
      "status_name": "Received",
      "order_number": "ORD250312003548IAU4",
      "status": "Received",
      "customer_id": "b658f16f-819c-4503-aede-bd555fc4ebfb",
      "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": "Harmon43@gmail.com",
        "phone": "6417383445",
        "date_of_birth": "1990-01-01",
        "driver_license_number": "B49188319",
        "driver_license_state": "CA",
        "primary_language": "en",
        "guardian_name": "John Guardian",
        "guardian_phone": "6417383445",
        "guardian_email": "parent@example.com",
        "guardian_relationship": "parent",
        "height_inches": 72,
        "weight_pounds": 180,
        "external_id": "1234567890",
        "is_smoker": false,
        "is_diabetic": false,
        "is_pregnant": false,
        "address": {
          "address_1": "140 Lindgren Streets",
          "address_2": "Apt 227",
          "city": "North Consueloburgh",
          "state": "CA",
          "country": "US",
          "zip_code": "02108"
        }
      },
      "products": {
        "prescription": [
          {
            "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
            "created_at": "2025-03-15T12:00:00Z",
            "updated_at": "2025-03-15T12:00:00Z",
            "current_stock": 927,
            "reorder_threshold": 100,
            "has_inventory": true,
            "sku": "1234567890",
            "name": "Mupirocin",
            "description": "A topical cream that is used to treat skin infections.",
            "product_code": "SUPERSPRAY15",
            "category": "topicals",
            "form": "cream",
            "formula_id": 826271167,
            "is_active": true,
            "is_controlled_substance": false,
            "price": 120,
            "strength": "1%",
            "unit_count": 100,
            "unit_type": "mg",
            "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",
            "current_stock": 927,
            "reorder_threshold": 100,
            "has_inventory": true,
            "sku": "1234567890",
            "name": "Krill Farms Fish Oil",
            "description": "A fish oil supplement complementary to prescribed products.",
            "category": "nutrition",
            "form": "liquid",
            "is_active": true,
            "price": 39.99,
            "unit_count": 1000,
            "unit_type": "ml",
            "quantity": 1
          }
        ],
        "order_material": [
          {
            "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
            "created_at": "2025-03-15T12:00:00Z",
            "updated_at": "2025-03-15T12:00:00Z",
            "current_stock": 927,
            "reorder_threshold": 100,
            "has_inventory": true,
            "sku": "1234567890",
            "name": "Referral Brochure",
            "description": "Customer brochure included in every shipment.",
            "category": "marketing",
            "is_global": false,
            "quantity": 1
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

q
string
required

Search query

Example:

"ORD8272"

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 orders

The response is of type object.