Create an order

post

https://api.sandbox.hurdle.bio/orders/v2

Body Params

productCode

string

Product code - recommended product identifier to use. See your account manager for valid product codes. Required if no product SKU is provided.

product

string

Product SKU - product identifier to use if no product code is available. See your account manager for valid SKUs. Required if no product code is provided.

quantity

integer

required

≥ 1

Quantity of the product to add to the order.

firstName

string

required

First name of the end user.

lastName

string

required

Last name of the end user.

deliveryAddress1

string

required

First line of the end user's address.

deliveryAddress2

string

Second line of the end user's address.

deliveryCity

string

required

City portion of the end user's address.

deliveryPostcode

string

required

Postcode of the end user's address.

deliveryCounty

string

County of the end user's address. This field is allowed when the value for 'deliveryCountryCode' is different from 'US'.

deliveryState

string

State of the end user's address. This field is mandatory when the value for 'deliveryCountryCode' is 'US' and is not allowed when the value for 'deliveryCountryCode' is different from 'US'.

deliveryCountryCode

string

required

ISO Alpha-2 country code of the end user's address.

string

required

End user's email address.

mobileCountryCode

string

End user's mobile country code.

mobileNumber

string

required

End user's mobile number.

notes

string

Order notes.

physicianDetails

object

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

Headers

X-API-Key

string

required

API Key

Responses

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Order created

400Bad request