Probatix Documentation
Probatix Diagnostics API v1

Create or update outbound shipment tracking for a diagnostic order

Creates or updates shipment tracking for the FulfillmentCenter -> Customer shipment of the DiagnosticOrder.

POST
/v1/diagnostic_orders/{id}/shipment_tracking

Creates or updates shipment tracking for the FulfillmentCenter -> Customer shipment of the DiagnosticOrder.

Authorization

apiKey
X-API-TOKEN<token>

In: header

Path Parameters

id*string (uuid)

ShipmentTrackingInput identifier

Header Parameters

accept-language?string

Language for Errors and Translatable properties

Allowed values: "de", "en", "fr"

Request Body

The new ShipmentTrackingInput resource

TypeScript Definitions

Use the request body type in TypeScript.

body*ShipmentTrackingInput
id?string (uuid)
provider*string

Shipment provider responsible for the parcel.

Allowed values: "DHL", "Swiss Post", "OTHER"

trackingCode?string | null

Optional carrier tracking code for the shipment.

url?string (url)

Optional tracking URL. If omitted, the system generates one for supported providers when a tracking code is provided.

shipmentStatus?string | null

Optional shipment status to expose together with the tracking data.

Allowed values: "confirmed", "in_transit", "out_for_delivery", "delivered", "failure", "undeliverable", "returned_to_sender", "available_for_collection", null

Response Body

curl -X POST "https://example.com/v1/diagnostic_orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/shipment_tracking" \  -H "accept-language: de" \  -H "Content-Type: application/json" \  -d '{    "provider": "DHL"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "diagnosticTests": [    "/entity/1"  ],  "createdAt": "2019-08-24T14:15:22Z",  "fulfilledAt": "2019-08-24T14:15:22Z",  "shipmentTracking": {    "provider": "DHL",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "trackingCode": "string",    "url": "string",    "shipmentStatus": "confirmed",    "providerStatus": "string",    "rawProviderHistory": [      "string"    ]  },  "shippingAddress": {    "address1": "string",    "address2": "string",    "zip": "string",    "city": "string",    "countryCode": "DE",    "firstName": "string",    "lastName": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "phone": "string",    "company": "string",    "name": "string"  },  "metadata": [    "string"  ]}

Activate a diagnostic test POST

Activates the DiagnosticTest for the provided specimen code. If the specimen already exists on the test it is updated, otherwise it is created during activation.

Create or update inbound shipment tracking for a diagnostic test POST

Creates or updates shipment tracking for the Customer -> Lab shipment of the DiagnosticTest.