Update an order

curl --request PATCH \
  --url https://api.stage.origin.one/api/v2/orders/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '
{
  "settings": {
    "changeReason": "misspelling",
    "otherChangeReason": "Participant moved",
    "clinicSelectionMode": "closestToParticipant",
    "reIssueDocuments": true,
    "resendNotifications": true
  }
}
'

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/merge-patch+json'
  },
  body: JSON.stringify({
    settings: {
      changeReason: 'misspelling',
      otherChangeReason: 'Participant moved',
      clinicSelectionMode: 'closestToParticipant',
      reIssueDocuments: true,
      resendNotifications: true
    }
  })
};

fetch('https://api.stage.origin.one/api/v2/orders/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stage.origin.one/api/v2/orders/{id}"

payload = { "settings": {
        "changeReason": "misspelling",
        "otherChangeReason": "Participant moved",
        "clinicSelectionMode": "closestToParticipant",
        "reIssueDocuments": True,
        "resendNotifications": True
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/merge-patch+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "object": "order",
  "code": "CPmJ6QbYMo",
  "agency": {
    "code": "FAA",
    "id": "3",
    "object": "agency",
    "url": "/api/v2/agencies/3"
  },
  "clinic": {
    "address": {
      "city": "Seattle",
      "country": "US",
      "line1": "123 Main St",
      "line2": "Suite 400",
      "object": "address",
      "postalCode": "98101",
      "state": "WA"
    },
    "id": "42",
    "name": "Austin Downtown Clinic",
    "object": "clinic",
    "phone": "+1-512-555-0100",
    "url": "/api/v2/clinics/42"
  },
  "clinicSelectionUrl": "https://acme.originone.ai/collection-site/CPmJ6QbYMo",
  "company": {
    "id": "123",
    "name": "Acme Inc",
    "object": "company",
    "url": "/api/v2/companies/123"
  },
  "createdAt": "2026-09-24T09:00:00.000Z",
  "expiresAt": "2026-09-24T15:15:00.000Z",
  "isFinal": false,
  "jobCategory": {
    "id": "3987402f-e963-45a9-8799-b9ea6621adae",
    "name": "Flight Crewmember",
    "object": "jobCategory",
    "url": "/api/v2/agencies/3/jobCategories/3987402f-e963-45a9-8799-b9ea6621adae"
  },
  "location": {
    "id": "456",
    "name": "Acme Downtown",
    "object": "location",
    "url": "/api/v2/locations/456"
  },
  "otherTestReason": "courtOrdered",
  "packages": [
    {
      "id": "789",
      "name": "DOT Pre-Employment Drug Test",
      "object": "package",
      "url": "/api/v2/packages/789"
    }
  ],
  "participant": {
    "address": {
      "city": "Seattle",
      "country": "US",
      "line1": "123 Main St",
      "line2": "Suite 400",
      "object": "address",
      "postalCode": "98101",
      "state": "WA"
    },
    "birthDate": "1980-11-11",
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "middleName": "Q",
    "phone": "+13033232323",
    "identifiers": [
      {
        "issuingCountry": "US",
        "issuingState": "WA",
        "object": "participantIdentifier",
        "type": "driverLicense",
        "value": "D1234567"
      }
    ]
  },
  "schedulingUrl": "https://acme.originone.ai/schedule/CPmJ6QbYMo",
  "services": [
    {
      "attributes": {
        "category": "standardPanels",
        "type": "urine"
      },
      "courierServiceName": "FedEx",
      "id": "<string>",
      "isDot": false,
      "isFinal": false,
      "lab": {
        "id": "64cba816-3c52-4a63-9d0e-0f2b5d1a7e11",
        "name": "CRL",
        "object": "vendor",
        "type": "lab"
      },
      "name": "5 Panel Urine",
      "object": "orderService",
      "screenHistory": [
        {
          "object": "orderServiceScreenHistory",
          "occurredAt": "2026-09-24T15:15:00.000Z",
          "type": "specimenCollected"
        }
      ],
      "specimenId": "SP-1",
      "status": "pending_collectionCompleted",
      "statusHistory": [
        {
          "groupType": "specimenCollected",
          "object": "orderServiceStatusHistory",
          "occurredAt": "2026-09-24T15:15:00.000Z",
          "status": "pending_collectionCompleted"
        }
      ],
      "statusUpdatedAt": "2026-09-24T15:15:00.000Z",
      "trackingNumber": "1Z999AA10123456784"
    }
  ],
  "status": "pending",
  "statusUpdatedAt": "2026-09-24T15:15:00.000Z",
  "testReason": "preEmployment",
  "updatedAt": "2026-09-24T15:20:00.000Z",
  "url": "/api/v2/orders/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "matched": {
    "originalSource": "app",
    "score": 100
  }
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

Orders

Update an order

Changes an order placed at a location under a company linked to the API token and returns it. The body is a JSON Merge Patch (RFC 7396): a member left out keeps its value, null clears it, and an array replaces the whole list, except participant.identifiers, which is merged by type. settings says why the order changes and is required; a body with only settings changes nothing and returns the order. Every change is checked before any is saved. The participant’s identifiers are included only for tokens that also carry order.participant.read. Returns 400 at the member at fault, 422 when the order’s status or history no longer allows the change or no collection site can take it, 404 for any order the token cannot see, and 409 when If-Match names an older version. Requires the order.update scope.

PATCH

api

orders

{id}

Update an order

curl --request PATCH \
  --url https://api.stage.origin.one/api/v2/orders/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '
{
  "settings": {
    "changeReason": "misspelling",
    "otherChangeReason": "Participant moved",
    "clinicSelectionMode": "closestToParticipant",
    "reIssueDocuments": true,
    "resendNotifications": true
  }
}
'

const options = {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/merge-patch+json'
  },
  body: JSON.stringify({
    settings: {
      changeReason: 'misspelling',
      otherChangeReason: 'Participant moved',
      clinicSelectionMode: 'closestToParticipant',
      reIssueDocuments: true,
      resendNotifications: true
    }
  })
};

fetch('https://api.stage.origin.one/api/v2/orders/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stage.origin.one/api/v2/orders/{id}"

payload = { "settings": {
        "changeReason": "misspelling",
        "otherChangeReason": "Participant moved",
        "clinicSelectionMode": "closestToParticipant",
        "reIssueDocuments": True,
        "resendNotifications": True
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/merge-patch+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "object": "order",
  "code": "CPmJ6QbYMo",
  "agency": {
    "code": "FAA",
    "id": "3",
    "object": "agency",
    "url": "/api/v2/agencies/3"
  },
  "clinic": {
    "address": {
      "city": "Seattle",
      "country": "US",
      "line1": "123 Main St",
      "line2": "Suite 400",
      "object": "address",
      "postalCode": "98101",
      "state": "WA"
    },
    "id": "42",
    "name": "Austin Downtown Clinic",
    "object": "clinic",
    "phone": "+1-512-555-0100",
    "url": "/api/v2/clinics/42"
  },
  "clinicSelectionUrl": "https://acme.originone.ai/collection-site/CPmJ6QbYMo",
  "company": {
    "id": "123",
    "name": "Acme Inc",
    "object": "company",
    "url": "/api/v2/companies/123"
  },
  "createdAt": "2026-09-24T09:00:00.000Z",
  "expiresAt": "2026-09-24T15:15:00.000Z",
  "isFinal": false,
  "jobCategory": {
    "id": "3987402f-e963-45a9-8799-b9ea6621adae",
    "name": "Flight Crewmember",
    "object": "jobCategory",
    "url": "/api/v2/agencies/3/jobCategories/3987402f-e963-45a9-8799-b9ea6621adae"
  },
  "location": {
    "id": "456",
    "name": "Acme Downtown",
    "object": "location",
    "url": "/api/v2/locations/456"
  },
  "otherTestReason": "courtOrdered",
  "packages": [
    {
      "id": "789",
      "name": "DOT Pre-Employment Drug Test",
      "object": "package",
      "url": "/api/v2/packages/789"
    }
  ],
  "participant": {
    "address": {
      "city": "Seattle",
      "country": "US",
      "line1": "123 Main St",
      "line2": "Suite 400",
      "object": "address",
      "postalCode": "98101",
      "state": "WA"
    },
    "birthDate": "1980-11-11",
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "middleName": "Q",
    "phone": "+13033232323",
    "identifiers": [
      {
        "issuingCountry": "US",
        "issuingState": "WA",
        "object": "participantIdentifier",
        "type": "driverLicense",
        "value": "D1234567"
      }
    ]
  },
  "schedulingUrl": "https://acme.originone.ai/schedule/CPmJ6QbYMo",
  "services": [
    {
      "attributes": {
        "category": "standardPanels",
        "type": "urine"
      },
      "courierServiceName": "FedEx",
      "id": "<string>",
      "isDot": false,
      "isFinal": false,
      "lab": {
        "id": "64cba816-3c52-4a63-9d0e-0f2b5d1a7e11",
        "name": "CRL",
        "object": "vendor",
        "type": "lab"
      },
      "name": "5 Panel Urine",
      "object": "orderService",
      "screenHistory": [
        {
          "object": "orderServiceScreenHistory",
          "occurredAt": "2026-09-24T15:15:00.000Z",
          "type": "specimenCollected"
        }
      ],
      "specimenId": "SP-1",
      "status": "pending_collectionCompleted",
      "statusHistory": [
        {
          "groupType": "specimenCollected",
          "object": "orderServiceStatusHistory",
          "occurredAt": "2026-09-24T15:15:00.000Z",
          "status": "pending_collectionCompleted"
        }
      ],
      "statusUpdatedAt": "2026-09-24T15:15:00.000Z",
      "trackingNumber": "1Z999AA10123456784"
    }
  ],
  "status": "pending",
  "statusUpdatedAt": "2026-09-24T15:15:00.000Z",
  "testReason": "preEmployment",
  "updatedAt": "2026-09-24T15:20:00.000Z",
  "url": "/api/v2/orders/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "matched": {
    "originalSource": "app",
    "score": 100
  }
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

{
  "error": "Bad Request",
  "errors": [
    {
      "code": "tooSmall",
      "detail": "Too small: expected number to be >=1",
      "meta": {},
      "source": {
        "pointer": "/page"
      }
    }
  ],
  "statusCode": 400
}

Editing orders explains how the merge patch applies, the settings every request needs, and what to do when a request fails partway.

Authorizations

Authorization

string

header

required

Origin One API token. Pass it in the Authorization header: Authorization: Bearer <token>.

Headers

If-Match

string

The ETag of the version this change is based on, from GET /orders/{id}. It is checked before anything is saved: when the order has changed since, the response is 409.

Path Parameters

string

required

Unique identifier of the resource.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

Body

settings

object

required

Why the order is changing and what to send afterwards. Not part of the order; never returned.

Show child attributes

agency

object | null

Regulatory agency, one of GET /agencies; null removes it. Required while the order has a DOT service, and not allowed otherwise.

Show child attributes

clinic

object

Collection site to move the order to, such as one from GET /orders/{id}/clinics; any clinic GET /clinics/{id} serves, offering every service on the order. Schedules an ordered order. Allowed until collection starts; for an expired or noShow order, only when its lab is Quest, LabCorp, CRL or Origin.

Show child attributes

expiresAt

string<date-time>

When the order expires (ISO 8601 date-time with offset), at least one hour from now. An expired or no-show order becomes active again.

Example:

"2026-10-30T17:00:00Z"

jobCategory

object

DOT job category of the participant, one of those the order’s agency publishes (see GET /agencies). Required when agency changes to one that publishes more than one job category on an order with a DOT service; a sole category is assigned automatically.

Show child attributes

location

object

Location to move the order to; must be under a company linked to the API token, and offer the order’s package.

Show child attributes

otherTestReason

string | null

Detail for a testReason of other, up to 30 characters; null clears it. Cleared automatically when testReason changes to another value.

Required string length: 1 - 30

Example:

"Court order"

packages

object[]

The package to order instead, as a one-item list. Must be available at the location; allowed only until collection starts.

Required array length: 1 element

Show child attributes

participant

object

Changes to the person being tested; only the members given change.

Show child attributes

testReason

enum<string>

Reason for the test.

Available options:

blindSample,

fitnessForDuty,

followUp,

jobTransfer,

notIndicated,

other,

periodic,

periodicMedical,

postAccident,

preEmployment,

preSiteAccess,

probation,

promotion,

random,

reasonableSuspicion,

returnToDuty,

splitSpecimen,

sweep,

unauthorizedTest,

unknown,

injury

Example:

"preEmployment"

Response

Success.

string

required

Unique identifier of the order.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

object

enum<string>

required

Object type; always order.

Available options:

order

Example:

"order"

code

string

required

Human-readable order code.

Example:

"CPmJ6QbYMo"

agency

object | null

required

Regulatory agency the order was placed under; null for a non-regulated order.

Show child attributes

clinic

object | null

required

Collection site; null until one is assigned.

Show child attributes

clinicSelectionUrl

string<uri> | null

required

Web page where someone picks the collection site, without signing in; null unless the order is ordered with no clinic and isn’t a link order. Anyone with it can see the participant’s address and choose the site.

Example:

"https://acme.originone.ai/collection-site/CPmJ6QbYMo"

company

object | null

required

Company the order was placed for.

Show child attributes

createdAt

string<date-time>

required

When the order was created.

Example:

"2026-09-24T09:00:00.000Z"

expiresAt

string<date-time> | null

required

When the order expires; null when it does not.

Example:

"2026-09-24T15:15:00.000Z"

isFinal

boolean

required

Whether the order has reached an outcome. Cancelled, expired and no-show orders report false; check status for those.

Example:

false

jobCategory

object | null

required

DOT job category of the participant; null when the order has none.

Show child attributes

location

object | null

required

Location the order was placed at.

Show child attributes

otherTestReason

string | null

required

Detail for a testReason of other; null when none was given.

Example:

"courtOrdered"

packages

object[]

required

Packages the order was created from.

Show child attributes

participant

object

required

The person being tested.

Show child attributes

schedulingUrl

string<uri> | null

required

Web page where the participant completes a link order, the one the link they receive opens; null unless a link order is ordered.

Example:

"https://acme.originone.ai/schedule/CPmJ6QbYMo"

services

object[]

required

Services on the order, in creation order.

Show child attributes

status

required

Current order status; new values may appear.

Available options:

adulterated,

cancelled,

complete,

expired,

fail,

fitForDuty,

incomplete,

integrationError,

negative,

lostInTransit,

nonNegative,

noShow,

notFitForDuty,

ordered,

pass,

pending,

positive,

released,

scheduled,

substituted,

testCancelled,

testNotPerformed,

unobtainable

Example:

"pending"

statusUpdatedAt

string<date-time>

required

When the order status last changed; the creation time until the first change.

Example:

"2026-09-24T15:15:00.000Z"

testReason

required

Reason for the test.

Available options:

blindSample,

fitnessForDuty,

followUp,

jobTransfer,

notIndicated,

other,

periodic,

periodicMedical,

postAccident,

preEmployment,

preSiteAccess,

probation,

promotion,

random,

reasonableSuspicion,

returnToDuty,

splitSpecimen,

sweep,

unauthorizedTest,

unknown,

injury

Example:

"preEmployment"

updatedAt

string<date-time>

required

When the order was last updated.

Example:

"2026-09-24T15:20:00.000Z"

url

string<uri-reference>

required

Canonical path of this resource, relative to the API origin.

Example:

"/api/v2/orders/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

matched

object

Present on a create response when an equivalent existing order was returned instead.

Show child attributes

Orders

Agencies

Job categories

Clinics

Companies

Locations

Packages

Services

Tenants

Webhooks

Update an order

Authorizations

Headers

Path Parameters

Body

Response