API Reference

Create an order

post
https://api.sandbox.hurdle.bio/orders/v3

You must pass one of productCode or biomarkerCodes to select the panel to create an order

Body Params
string
required

Product code

integer
required
≥ 1

Quantity of the product to add to the order.

delivery
object
required

address.postcode is required for all products. In addition, firstName, lastName, address.addressLine1, address.city, address.countryCode are required for mobile phlebotomy products.

user
object

User details of the person who will be taking the actual test. This field is mandatory for pathways, phlebotomy, and auto-registration products requiring user info. It should be omitted for products that require manual user registration.

string

The ID of the preferred phlebotomy appointment slot that you want to book with the order. Required when using the Hurdle clinic network.

physician
object

Physician details. This field is mandatory when the value for 'deliveryCountryCode' is 'US'.

Headers
string
required

API key

string

Request ID used to enforce idempotence.

Responses

Updated 7 months ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago