Skip to content
Probatix API Documentation

Retrieves a DiagnosticOrder resource.

GET
/v1/diagnostic_orders/{id}
curl --request GET \
  --url 'http://api.probatix.localhost/v1/diagnostic_orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?XDEBUG_SESSION=PHPSTORM' \
  --header 'X-API-TOKEN: <X-API-TOKEN>' \
  --header 'accept-language: de'

Retrieves a DiagnosticOrder resource.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

DiagnosticOrder identifier

Header Parameters

Section titled “Header Parameters”
accept-language
string
Allowed values: de en fr

Language for Errors and Translatable properties

Example
de

Query Parameters

Section titled “Query Parameters”
XDEBUG_SESSION
string
default: PHPSTORM

Xdebug session for debugging

Example
?XDEBUG_SESSION=PHPSTORM

Responses

Section titled “Responses”

200

Section titled “200”

DiagnosticOrder resource

object
id
required
string format: uuid
diagnosticTests

IRIs of the diagnostic tests that belong to this order.

Array<string>
createdAt
required

Timestamp when the order was created.

string format: date-time
shippedAt

Timestamp when the outbound shipment was handed over for transportation.

string | null format: date-time
shipmentTracking
Any of:
object
provider
required
string
Allowed values: DHL Swiss Post OTHER
createdAt
required

Timestamp when the shipment was created.

string format: date-time
updatedAt
required

Timestamp when the shipment was last updated.

string format: date-time
trackingCode
string | null
url
string format: url
shipmentStatus

Normalized shipment status for informational purposes only.

string | null
Allowed values: confirmed in_transit out_for_delivery delivered failure undeliverable returned_to_sender available_for_collection
providerStatus

Shipment status from the provider please note some Providers are not 100% reliable and will occasionally deliver shipments without status updates.

string | null
shippingAddress
Any of:
object
address1
required
string
address2
string | null
zip
required
string
city
required
string
countryCode
string
default: DE
firstName
required
string
lastName
required
string
id
string format: uuid
phone
string | null
company
string | null
name
string | null
metadata

Optional partner-defined metadata. Up to 10 entries are supported and values must be JSON primitive values (string, number, or boolean).

Array<string | null> | null
Example
{
  "diagnosticTests": [
    "/v1/diagnostic_tests/00112233-4455-6677-8899-aabbccddeeff"
  ],
  "shippedAt": "2026-05-04T09:15:00+00:00",
  "shipmentTracking": {
    "provider": "DHL",
    "trackingCode": "123",
    "url": "https://www.dhl.de/en/privatkunden/dhl-sendungsverfolgung.html?piececode=123",
    "shipmentStatus": "confirmed",
    "providerStatus": {
      "terminalStatus": true,
      "name": "DELIVERED",
      "value": "delivered"
    }
  },
  "shippingAddress": {
    "address1": "Bismarckstraße 10-12",
    "address2": "6. OG",
    "zip": "10625",
    "city": "Berlin",
    "countryCode": "DE",
    "firstName": "Jane",
    "lastName": "Doe",
    "phone": "030 56838352",
    "company": "Probatix Health GmbH",
    "name": "Probatix Health GmbH"
  },
  "metadata": {
    "yourReference1": "abc",
    "yourReference2": 123,
    "yourFlag1": true
  }
}

401

Section titled “401”

Unauthorized

A representation of common errors.

object
@context
One of:
string
@id
required
string
@type
required
string
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string
description
string | null
Example
{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 400
}

403

Section titled “403”

Forbidden

A representation of common errors.

object
@context
One of:
string
@id
required
string
@type
required
string
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string
description
string | null
Example
{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 400
}

404

Section titled “404”

Not found

A representation of common errors.

object
@context
One of:
string
@id
required
string
@type
required
string
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string
description
string | null
Example
{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 400
}