Specimen collection kit order created

Sent when a specimen collection kit order is created.

All webhook requests include the shared webhook headers.

Request Body

application/json

Webhook payload.

TypeScript Definitions

Use the request body type in TypeScript.

body*SpecimenCollectionKitOrder

id*string (uuid)

kits?array<string (iri-reference)>

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

contact?ShipmentContact

firstName*string

lastName*string

email*string (email)

phone?string | null

shippingAddress?FullAddressInput | null

address1*string

address2?string | null

zip*string

city*string

countryCode?string

firstName*string

lastName*string

id?string (uuid)

phone?string | null

company?string | null

name?string | null

metadata?object | null

Optional partner-defined metadata. Values must be JSON primitive values.

status*string

Current SCK order status.

Allowed values: "new", "fulfilled", "canceled"

createdAt?string | null

fulfilledAt?string | null

outboundShipment?ShipmentTracking | null

provider*string

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

createdAt*string (date-time)

Timestamp when the shipment was created.

updatedAt*string (date-time)

Timestamp when the shipment was last updated.

trackingCode?string | null

url?string (url)

shipmentStatus?string | null

Normalized shipment status for informational purposes only.

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

providerStatus?string | null

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

rawProviderHistory?array | null

Raw shipment history from the provider.

returnShipment?ShipmentTracking | null