Vital Order API is one of 20 APIs that Vital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 7 JSON Schema definitions.
Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.
This API exposes
33 operations
across 32 paths,
and defines 112 schemas.
It is described by OpenAPI 3.2.0, at version 0.4.497.
Requests are made against 4 base URLs: https://api.us.junction.com, https://api.eu.junction.com, https://api.sandbox.us.junction.com, https://api.sandbox.eu.junction.com.
The identity and technical contract details declared by the specification.
Billing
string
ℹ️ This enum is non-exhaustive.
ResultType
string
ℹ️ This enum is non-exhaustive.
ParentBiomarkerData
object
4 properties
3 required
ClientFacingPatientDetailsCompatible
object
11 properties
2 required
LabResultsRaw
object
5 properties
2 required
MarkerType
string
ℹ️ This enum is non-exhaustive.
OrderStatusDetail
string
A descriptive-only additional field to be used in combination with OrderStatus. Exposed in the API. ℹ️ This enum is non-exhaustive.
Interpretation
string
ℹ️ This enum is non-exhaustive.
FailureType
string
ℹ️ This enum is non-exhaustive.
ClientFacingShipment
object
Schema for a Shipment in the client facing API. To be used as part of a ClientFacingTestkitOrder.
8 properties
8 required
AppointmentServiceType
string
ℹ️ This enum is non-exhaustive.
ClientFacingWalkInTestOrder
object
Schema for a walk-in test order in the client facing API. To be used as part of a ClientFacingOrder.
4 properties
3 required
ClientFacingAtHomePhlebotomyOrder
object
Schema for a at-home-phlebotomy test order in the client facing API. To be used as part of a ClientFacingOrder.
4 properties
3 required
HealthInsuranceCreateRequest
object
10 properties
AreaInfo
object
3 properties
3 required
ClientFacingAppointmentCancellationReason
object
3 properties
3 required
ClientFacingAppointment
object
19 properties
14 required
OrderSetRequest
object
3 properties
Gender
string
ℹ️ This enum is non-exhaustive.
LabLocationMetadata
object
9 properties
5 required
AppointmentPSCLabs
string
ℹ️ This enum is non-exhaustive.
GuarantorDetails
object
7 properties
4 required
Labs
string
ℹ️ This enum is non-exhaustive.
LabTestSampleType
string
The type of sample used to perform a lab test. ℹ️ This enum is non-exhaustive.
HTTPValidationError
object
1 property
RegisterTestkitRequest
object
7 properties
3 required
Address
object
7 properties
5 required
LabTestStatus
string
ℹ️ This enum is non-exhaustive.
SampleData
object
7 properties
AppointmentType
string
ℹ️ This enum is non-exhaustive.
api__api_v1__endpoints__vital_api__lab_testing__orders__helpers__AppointmentCancelRequest
object
2 properties
1 required
PatientAddressCompatible
object
9 properties
5 required
AoE
object
1 property
1 required
PhysicianCreateRequestBase
object
5 properties
3 required
ClientFacingOrderEvent
object
4 properties
3 required
ClientFacingWalkInOrderDetails
object
2 properties
1 required
ClientFacingAtHomePhlebotomyOrderDetails
object
2 properties
1 required
AppointmentBookingRequest
object
5 properties
1 required
DaySlots
object
3 properties
2 required
ResponsibleRelationship
string
ℹ️ This enum is non-exhaustive.
AppointmentLocation
object
6 properties
4 required
LabResultsMetadata
object
14 properties
5 required
MissingBiomarkerResult
object
8 properties
3 required
vital_core__clients__lab_test__getlabs__schema__AppointmentCancelRequest
object
2 properties
1 required
ClientFacingOnSiteCollectionOrderDetails
object
2 properties
1 required
ClientFacingLab
object
8 properties
8 required
OrderTransactionStatus
string
ℹ️ This enum is non-exhaustive.
AoEAnswer
object
3 properties
3 required
AppointmentRescheduleRequest
object
2 properties
1 required
UTCTimestampWithTimezoneOffset
object
2 properties
2 required
ClientFacingLabTest
object
16 properties
10 required
SexualOrientation
string
ℹ️ This enum is non-exhaustive.
AppointmentAvailabilitySlots
object
2 properties
1 required
PhlebotomyAreaInfo
object
2 properties
2 required
ResendWebhookBody
object
3 properties
Answer
object
3 properties
3 required
ShippingAddress
object
8 properties
7 required
PostOrderResponse
object
3 properties
3 required
RequestAppointmentRequest
object
3 properties
2 required
OrderLowLevelStatus
string
ℹ️ This enum is non-exhaustive.
ClientFacingOnSiteCollectionOrder
object
Schema for an on-site collection order in the client facing API. To be used as part of a ClientFacingOrder.
3 properties
3 required
Png
object
2 properties
2 required
AppointmentEventStatus
string
ℹ️ This enum is non-exhaustive.
OrderStatus
string
Used in combination with OrderStatusDetail to represent the current order state. OrderStatus is driven by a FSM whereas OrderStatusDetail is descriptive only.…
ShippingAddressWithValidation
object
8 properties
7 required
ClientFacingTestkitOrder
object
Schema for a testkit order in the client facing API. To be used as part of a ClientFacingOrder.
4 properties
4 required
QuestionType
string
ℹ️ This enum is non-exhaustive.
Question
object
9 properties
7 required
USAddress
object
7 properties
4 required
LngLat
object
2 properties
2 required
vital_core__schemas__db_schemas__lab_test__health_insurance__PersonDetails
object
5 properties
4 required
ClientFacingOrderTransaction
object
Order transaction info.
3 properties
3 required
LabLocationCapability
string
ℹ️ This enum is non-exhaustive.
PatientAddress
object
8 properties
6 required
PSCAreaInfoDetails
object
4 properties
3 required
PatientAddressWithValidation
object
9 properties
5 required
ClientFacingMarker
object
14 properties
3 required
PhysicianCreateRequest
object
6 properties
3 required
ClientFacingOrderInTransaction
object
Minimal order info for embedding in ordertransaction payload.
7 properties
3 required
UpdateOrderBody
object
Patch body for updating a modifiable order's scheduled activation date.
1 property
1 required
PSCInfo
object
3 properties
3 required
TimeSlot
object
7 properties
5 required
ClientFacingLabLocation
object
6 properties
6 required
AppointmentStatus
string
ℹ️ This enum is non-exhaustive.
ResendWebhookResponse
object
1 property
1 required
Consent
object
3 properties
1 required
Race
string
ℹ️ This enum is non-exhaustive.
PatientDetailsWithValidation
object
Patient details with validation for firstname, lastname, email, and dob.
13 properties
6 required
ClientFacingOrder
object
31 properties
17 required
PerformingLaboratory
object
4 properties
1 required
AllowedRadius
string
ℹ️ This enum is non-exhaustive.
ClientFacingPhysician
object
3 properties
3 required
PSCAreaInfo
object
3 properties
3 required
ClientFacingTestKitOrderDetails
object
2 properties
1 required
PhlebotomyProviderInfo
object
2 properties
2 required
ClientFacingLabs
string
ℹ️ This enum is non-exhaustive.
ClinicalInformation
object
4 properties
AppointmentProvider
string
ℹ️ This enum is non-exhaustive.
Ethnicity
string
ℹ️ This enum is non-exhaustive.
AddOnOrder
object
2 properties
OrderOrigin
string
ℹ️ This enum is non-exhaustive.
ConsentType
string
ℹ️ This enum is non-exhaustive.
CreateRegistrableTestkitOrderRequest
object
5 properties
3 required
Jpeg
object
2 properties
2 required
ClientFacingAppointmentEvent
object
3 properties
2 required
LabTestCollectionMethod
string
The method used to perform a lab test. ℹ️ This enum is non-exhaustive.
SimulationFlags
object
3 properties
GenderIdentity
string
ℹ️ This enum is non-exhaustive.
BiomarkerResult
object
Represent the schema for an individual biomarker result.
20 properties
3 required
OrderTopLevelStatus
string
ℹ️ This enum is non-exhaustive.
CreateOrderRequestCompatible
object
Schema for the create Order endpoint.
18 properties
3 required
ImportOrderBody
object
9 properties
7 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Vital publishes across the network.
