Cancel an order

patch https://api.sandbox.hurdle.bio/orders/v3/{orderNumber}/cancel

Cancels an order for an at-home test. Only possible when the order has not been dispatched or processed.

Responses

Response body

object

productCode

string

Product code

quantity

integer

≥ 1

Quantity of the product associated with the order.

delivery

object

firstName

string

First name of the end user.

lastName

string

Last name of the end user.

address

object

string

End user's email address.

mobileNumber

string

End user's mobile number.

notes

string

Order notes.

status

string

Status of the order.

CREATED CONFIRMED CANCELLED PROCESSING DISPATCHED REFUNDED

paymentConfirmed

boolean

This field is used to flag order as paid.

orderNumber

string

Unique identifier for the order.

kits

array of objects

List of all the kits associated to this order. Only available once the order has been dispatched (or straight away in certain phlebotomy use cases where no physical kit is dispatched to the user).

kits

object

kitId

string

Unique identifier of the test kit. Needed to register the kit later.

createdAt

string

Date the order object was created.

updatedAt

string

Date the order object was last updated.

dispatchedAt

string

Date the order object was dispatched.

stripeInvoiceId

string

Stripe identifier for an invoice.

Language

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.sandbox.hurdle.bio/orders/v3/orderNumber/cancel \
3
     --header 'accept: application/json'


xxxxxxxxxx
32
}
1
{
2
  "productCode": "C1BLP03200",
3
  "quantity": 2,
4
  "delivery": {
5
    "firstName": "Bob",
6
    "lastName": "Jones",
7
    "address": {
8
      "addressLine1": "130 Plumstead Road",
9
      "addressLine2": "Plumstead",
10
      "city": "London",
11
      "postcode": "SE18 7DW",
12
      "county": "Greater London",
13
      "state": "California",
14
      "countryCode": "GB"
15
    },
16
    "email": "bob@mycompany.com",
17
    "mobileNumber": 77777777777
18
  },
19
  "notes": "Leave in the garden.",
20
  "status": "DISPATCHED",
21
  "paymentConfirmed": true,
22
  "orderNumber": "AD234",
23
  "kits": [
24
    {
25
      "kitId": "TSAB1001"

200Order cancelled

404Order not found

409Cannot update or cancel order that has been dispatched/cancelled/started processing