v71

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-032076961.5 MB

order

Update Order

Update a modifiable order's scheduled activation date.

The order must be in ordered or awaiting_registration status. Setting activate_by to a future date reschedules dispatch; setting it to null clears the schedule and enqueues immediate dispatch for ordered orders.

Returns 400 when:

the order is not in a modifiable status,
the order was created for immediate processing (cannot be scheduled after the fact),
activate_by is in the past.

patch/v3/order/{order_id}

Path parameters

order_idstring uuid required

Your Order ID.

Request body

activate_bystring date nullable required

The date on which the order should be activated (dispatched to the lab). Must be today or a future date. Set to null to clear an existing scheduled date and dispatch the order immediately. Note: an order originally created for immediate processing (no activate_by at creation time) cannot be rescheduled — only orders that were created with an activate_by can have it changed or cleared.

Response

Successful Response

statusstring required

messagestring required

Example response

{
  "order": {
    "activate_by": "2020-01-01",
    "created_at": "2020-01-01T00:00:00Z",
    "details": {
      "data": {
        "created_at": "2020-01-01T00:00:00Z",
        "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
        "shipment": {
          "created_at": "2020-01-01T00:00:00.000Z",
          "id": "d55210cc-3d9f-4115-8262-5013f700c7be",
          "inbound_courier": "usps",
          "inbound_tracking_number": "<inbound_tracking_number>",
          "inbound_tracking_url": "<inbound_tracking_url>",
          "notes": "<notes>",
          "outbound_courier": "usps",
          "outbound_tracking_number": "<outbound_tracking_number>",
          "outbound_tracking_url": "<outbound_tracking_url>",
          "updated_at": "2020-01-01T00:00:00.000Z"
        },
        "updated_at": "2020-01-01T00:00:00Z"
      },
      "type": "testkit"
    },
    "events": [
      {
        "created_at": "2022-01-01T00:00:00Z",
        "id": 1,
        "status": "received.testkit.ordered"
      },
      {
        "created_at": "2022-01-02T00:00:00Z",
        "id": 2,
        "status": "received.testkit.requisition_created"
      },
      {
        "created_at": "2022-01-03T00:00:00Z",
        "id": 3,
        "status": "collecting_sample.testkit.transit_customer"
      }
    ],
    "has_abn": false,
    "health_insurace_id": "cf36a74f-c24e-474b-ba6a-683dba898745",
    "id": "e80b8ddb-04f5-40a8-921c-3f81ec936ed6",
    "lab_test": {
      "description": "Cholesterol test",
      "method": "testkit",
      "name": "Lipids Panel"
    },
    "last_event": {
      "created_at": "2022-01-03T00:00:00Z",
      "id": 3,
      "status": "collecting_sample.testkit.transit_customer"
    },
    "notes": "This is a note",
    "order_transaction": {
      "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
      "orders": [
        {
          "created_at": "2020-01-01T00:00:00Z",
          "id": "d55210cc-3d9f-4115-8262-5013f700c7be",
          "low_level_status": "transit_customer",
          "low_level_status_created_at": "2020-01-05T00:00:00Z",
          "origin": "initial",
          "updated_at": "2020-01-05T00:00:00Z"
        },
        {
          "created_at": "2020-01-05T01:00:00Z",
          "id": "e66321dd-4e0g-5226-9373-6124g811d8cf",
          "low_level_status": "requisition_created",
          "low_level_status_created_at": "2020-01-05T01:00:00Z",
          "origin": "redraw",
          "updated_at": "2020-01-05T01:00:00Z"
        }
      ],
      "status": "active"
    },
    "origin": "initial",
    "patient_address": {
      "city": "San Francisco",
      "country": "United States",
      "first_line": "123 Main St.",
      "phone_number": "+11234567890",
      "receiver_name": "John Doe",
      "second_line": "Apt. 208",
      "state": "CA",
      "zip": "91189"
    },
    "patient_details": {
      "dob": "2020-01-01",
      "gender": "male"
    },
    "requisition_form_url": "https://www.example.com",
    "sample_id": "123456789",
    "status": "collecting_sample",
    "team_id": "89f5d2ab-507a-423a-bb51-9b2b58c6eba2",
    "updated_at": "2020-01-01T00:00:00Z",
    "user_id": "47f6af56-da87-4b1d-bf95-023c970e3769"
  }
}