Skip to content
Probatix API Documentation

Retrieves the collection of SpecimenCollectionKitOrder resources.

GET
/sck/v1/orders
curl --request GET \
  --url 'http://api.probatix.localhost/sck/v1/orders?page=1&json_exact%5Bmetadata.id%5D=%5B%22externalId%22%2C%22anotherId%22%5D&json_exists%5Bmetadata.id%5D=true&json_search%5Bmetadata.id%5D=%5B%22externalId%22%2C%22anotherId%22%5D&sort%5BcreatedAt%5D=asc&sort%5Bid%5D=asc&XDEBUG_SESSION=PHPSTORM' \
  --header 'X-API-TOKEN: <X-API-TOKEN>' \
  --header 'accept-language: de'

Retrieves the collection of SpecimenCollectionKitOrder resources.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

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”
page
integer
default: 1 >= 1

The collection page number

createdAt[gt]
string

Return resources with createdAt greater than the given timestamp.

createdAt[gte]
string

Return resources with createdAt greater than or equal to the given timestamp.

createdAt[lt]
string

Return resources with createdAt less than the given timestamp.

createdAt[lte]
string

Return resources with createdAt less than or equal to the given timestamp.

exists[shipmentTracking]
boolean

Filter by whether the shipment tracking exists.

json_exact

Exact match on one or more JSON values addressed by dotted JSON paths such as metadata.id.

object
key
additional properties
Array<string>
Example
?json_exact[metadata.id]=externalId,anotherId
json_exists

Checks whether a dotted JSON path exists and resolves to a non-null value.

object
key
additional properties
boolean
Example
?json_exists[metadata.id]=true
json_search

Case-insensitive partial match on one or more JSON values addressed by dotted JSON paths such as metadata.id.

object
key
additional properties
Array<string>
Example
?json_search[metadata.id]=externalId,anotherId
kit[]
Array<string>

Filter by identifier, IRI, or canonical identifier.

order[]
Array<string>

Filter by identifier, IRI, or canonical identifier.

product[]
Array<string>

Filter by identifier, IRI, or canonical identifier.

sort[createdAt]
string
Allowed values: asc desc ASC DESC

SpecimenCollectionKitOrder sort[createdAt]

sort[id]
string
Allowed values: asc desc ASC DESC

SpecimenCollectionKitOrder sort[id]

XDEBUG_SESSION
string
default: PHPSTORM

Xdebug session for debugging

Example
?XDEBUG_SESSION=PHPSTORM

Responses

Section titled “Responses”

200

Section titled “200”

SpecimenCollectionKitOrder collection

Array<object>
object
id
required
string format: uuid
kits

IRIs of the specimen collection kits that belong to this order.

Array<string>
contact
object
firstName
required
string
lastName
required
string
email
required
string format: email
phone
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. Values must be JSON primitive values.

object | null
status
required

Current SCK order status.

string
Allowed values: new fulfilled canceled
createdAt
string | null format: date-time
shippedAt
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
Example
[
  {
    "kits": [
      "/sck/v1/kits/00112233-4455-6677-8899-aabbccddeeff"
    ],
    "contact": {
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "meron.nagy@probatix.de",
      "phone": "030 56838352"
    },
    "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,
      "priority": true
    },
    "status": "new",
    "createdAt": "2026-06-29T10:30:00+00:00",
    "shippedAt": "2026-06-30T09: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"
      }
    }
  }
]

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
}