Vital order API is one of 18 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.1.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.
OrderOrigin
string
ℹ️ This enum is non-exhaustive.
GuarantorDetails
object
7 properties
4 required
FailureType
string
ℹ️ This enum is non-exhaustive.
ClientFacingWalkInOrderDetails
object
2 properties
1 required
ConsentType
string
ℹ️ This enum is non-exhaustive.
ClientFacingLabs
string
ℹ️ This enum is non-exhaustive.
MarkerType
string
ℹ️ This enum is non-exhaustive.
PatientAddressCompatible
object
9 properties
5 required
ClientFacingOrderTransaction
object
Order transaction info.
3 properties
3 required
Billing
string
ℹ️ This enum is non-exhaustive.
AllowedRadius
string
ℹ️ This enum is non-exhaustive.
api__api_v1__endpoints__vital_api__lab_testing__orders__helpers__AppointmentCancelRequest
object
2 properties
1 required
OrderStatus
string
Used in combination with OrderStatusDetail to represent the current order state. OrderStatus is driven by a FSM whereas OrderStatusDetail is descriptive only.…
ClientFacingOrderEvent
object
4 properties
3 required
Ethnicity
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
ClientFacingOrder
object
31 properties
17 required
LngLat
object
2 properties
2 required
OrderStatusDetail
string
A descriptive-only additional field to be used in combination with OrderStatus. Exposed in the API. ℹ️ This enum is non-exhaustive.
PostOrderResponse
object
3 properties
3 required
ClientFacingMarker
object
14 properties
3 required
USAddress
object
7 properties
4 required
AppointmentProvider
string
ℹ️ This enum is non-exhaustive.
MissingBiomarkerResult
object
8 properties
3 required
ResponsibleRelationship
string
ℹ️ This enum is non-exhaustive.
QuestionType
string
ℹ️ This enum is non-exhaustive.
PatientAddressWithValidation
object
9 properties
5 required
ClientFacingAppointment
object
19 properties
14 required
ClientFacingAppointmentCancellationReason
object
3 properties
3 required
SimulationFlags
object
3 properties
ResendWebhookBody
object
3 properties
SampleData
object
7 properties
ClientFacingOrderInTransaction
object
Minimal order info for embedding in ordertransaction payload.
7 properties
3 required
ClinicalInformation
object
4 properties
PSCInfo
object
3 properties
3 required
LabResultsMetadata
object
14 properties
5 required
OrderLowLevelStatus
string
ℹ️ This enum is non-exhaustive.
ClientFacingPatientDetailsCompatible
object
11 properties
2 required
Race
string
ℹ️ This enum is non-exhaustive.
ClientFacingPhysician
object
3 properties
3 required
HealthInsuranceCreateRequest
object
10 properties
HTTPValidationError
object
1 property
AppointmentEventStatus
string
ℹ️ This enum is non-exhaustive.
OrderTopLevelStatus
string
ℹ️ This enum is non-exhaustive.
ClientFacingLabTest
object
16 properties
10 required
CreateRegistrableTestkitOrderRequest
object
5 properties
3 required
TimeSlot
object
7 properties
5 required
PatientAddress
object
8 properties
6 required
AoEAnswer
object
3 properties
3 required
AoE
object
1 property
1 required
DaySlots
object
3 properties
2 required
LabTestSampleType
string
The type of sample used to perform a lab test. ℹ️ This enum is non-exhaustive.
AppointmentLocation
object
6 properties
4 required
ClientFacingLabLocation
object
6 properties
6 required
AddOnOrder
object
2 properties
AppointmentStatus
string
ℹ️ This enum is non-exhaustive.
AppointmentRescheduleRequest
object
2 properties
1 required
Interpretation
string
ℹ️ This enum is non-exhaustive.
ClientFacingAtHomePhlebotomyOrderDetails
object
2 properties
1 required
Question
object
9 properties
7 required
UpdateOrderBody
object
Patch body for updating a modifiable order's scheduled activation date.
1 property
1 required
Gender
string
ℹ️ This enum is non-exhaustive.
Address
object
7 properties
5 required
Labs
string
ℹ️ This enum is non-exhaustive.
ShippingAddress
object
8 properties
7 required
UTCTimestampWithTimezoneOffset
object
2 properties
2 required
SexualOrientation
string
ℹ️ This enum is non-exhaustive.
Consent
object
3 properties
1 required
PSCAreaInfo
object
3 properties
3 required
LabLocationMetadata
object
9 properties
5 required
RequestAppointmentRequest
object
3 properties
2 required
ClientFacingOnSiteCollectionOrderDetails
object
2 properties
1 required
AppointmentBookingRequest
object
5 properties
1 required
CreateOrderRequestCompatible
object
Schema for the create Order endpoint.
18 properties
3 required
ClientFacingAppointmentEvent
object
3 properties
2 required
GenderIdentity
string
ℹ️ This enum is non-exhaustive.
Jpeg
object
2 properties
2 required
ImportOrderBody
object
9 properties
7 required
AppointmentServiceType
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
PSCAreaInfoDetails
object
4 properties
3 required
LabTestCollectionMethod
string
The method used to perform a lab test. ℹ️ This enum is non-exhaustive.
PhysicianCreateRequestBase
object
5 properties
3 required
PerformingLaboratory
object
4 properties
1 required
Answer
object
3 properties
3 required
ClientFacingTestKitOrderDetails
object
2 properties
1 required
AppointmentType
string
ℹ️ This enum is non-exhaustive.
ParentBiomarkerData
object
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
LabResultsRaw
object
5 properties
2 required
BiomarkerResult
object
Represent the schema for an individual biomarker result.
20 properties
3 required
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
PatientDetailsWithValidation
object
Patient details with validation for firstname, lastname, email, and dob.
13 properties
6 required
LabTestStatus
string
ℹ️ This enum is non-exhaustive.
ResendWebhookResponse
object
1 property
1 required
PhlebotomyProviderInfo
object
2 properties
2 required
vital_core__clients__lab_test__getlabs__schema__AppointmentCancelRequest
object
2 properties
1 required
PhysicianCreateRequest
object
6 properties
3 required
AppointmentAvailabilitySlots
object
2 properties
1 required
ClientFacingLab
object
8 properties
8 required
vital_core__schemas__db_schemas__lab_test__health_insurance__PersonDetails
object
5 properties
4 required
AreaInfo
object
3 properties
3 required
LabLocationCapability
string
ℹ️ This enum is non-exhaustive.
RegisterTestkitRequest
object
7 properties
3 required
Png
object
2 properties
2 required
ResultType
string
ℹ️ This enum is non-exhaustive.
ShippingAddressWithValidation
object
8 properties
7 required
OrderSetRequest
object
3 properties
PhlebotomyAreaInfo
object
2 properties
2 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
AppointmentPSCLabs
string
ℹ️ This enum is non-exhaustive.
OrderTransactionStatus
string
ℹ️ This enum is non-exhaustive.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Vital publishes across the network.
