Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Workflow

Start Workflow Request information

workflowId
String!,non-null

Unique ID for this workflow

launchUrl
String

If applicable, the launch URL for the first step in this workflow

requestId
String

Unique ID for a prescription verification request if applicable

Current request status

jobId
String

Unique ID for a prescription verification job (conditionally available)

status
String

Current prescription verification job status (conditionally available)

updatedAt
String

Last date and time this request was updated

Sample
{ "workflowId": "Example String", "launchUrl": "Example String", "requestId": "Example String", "requestStatus": "NEW", "jobId": "Example String", "status": "Example String", "updatedAt": "Example String" }

Order

Order details

orderId
String

Unique ID for this order

status
String

Current order status

Sample
{ "orderId": "Example String", "status": "Example String" }

Session

Start vision test response

launchUrl
String!,non-null

The launch URL for the vision test

jobId
String

The job ID for the vision-test job (if applicable, simulation support only)

Sample
{ "launchUrl": "Example String", "jobId": "Example String" }

ContactProductMappingResponse

Contacts Product Mapping Response

ok
String!,non-null
Sample
{ "ok": "Example String" }

Tag

Custom tags containing references to other systems

name
String!,non-null

The name of the tag

value
String!,non-null

The value of the tag

Sample
{ "name": "Example String", "value": "Example String" }

ContactsProduct

productId
String

ID that uniquely maps to a manufacturer, brand, and model combination

manufacturer
String

Manufacturer name

brand
String

Brand name

schedule
String

Schedule name

type
String

Type name (Toric, Multi-Focal, etc.)

diameter
String

The width of the contact lens from edge to edge measured by millimeters

baseCurve
String

Indication of the curvature of the inside of the lens measured in millimeters

sphere
String

The amount of lens power measured in diopters (D), minus sign (–) for nearsighted, plus sign (+) for farsighted

axis
String

The lens meridian with no cylinder power, indicated by a value between 1 and 180 degrees

cylinder
String

The amount of lens power for astigmatism measured in diopters (D), minus sign (–) for nearsighted, plus sign (+) for farsighted

addition
String

The additional magnifying power that applies to the bottom portion of multifocal lenses to fix presbyopia

dominance
String

Indication of dominant or non-dominant eye

color
String

Color of the lens

packageSize
Int

Number of lenses per package

quantity
Int

Number of packages

Sample
{ "productId": "Example String", "manufacturer": "Example String", "brand": "Example String", "schedule": "Example String", "type": "Example String", "diameter": "Example String", "baseCurve": "Example String", "sphere": "Example String", "axis": "Example String", "cylinder": "Example String", "addition": "Example String", "dominance": "Example String", "color": "Example String", "packageSize": 40, "quantity": 40 }

ContactsProducts

Sample
{ "right": { "__typename": "ContactsProduct" }, "left": { "__typename": "ContactsProduct" } }

ContactsPrescription

fileId
String

File ID from uploadFile (conditionally required if doctor and patient are not set)

prescriptionId
String

Prescription ID

issueDate
String

Prescription issue date, if available

expirationDate
String

Prescription expiration date, if available

doctor

Doctor details (conditionally required if prescription file ID is not set)

patient

Patient details (conditionally required if prescription file ID is not set)

Details about the prescribed contacts

comments
String

Doctor-entered comments

Sample
{ "fileId": "Example String", "prescriptionId": "Example String", "issueDate": "Example String", "expirationDate": "Example String", "doctor": { "__typename": "Doctor" }, "patient": { "__typename": "Patient" }, "products": { "__typename": "ContactsProducts" }, "comments": "Example String" }

Contacts

Sample
{ "products": [ { "__typename": "ContactsProducts" } ], "prescription": { "__typename": "ContactsPrescription" } }

ContactsSuggestionJobOptions

jobId
String
Sample
{ "jobId": "Example String" }

ContactsPrescriptionVerificationJobOptions

jobId
String
Sample
{ "jobId": "Example String" }

Interfaces

Overview

Enums

Overview

Inputs

Overview