Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

GlassesJobOptions

glassesPrescriptionVerification
glassesPrescriptionIssuance
wait
Int

The number of seconds between 0 and 20 to wait for completion; Default: 0 (no wait)

Sample
{ "glassesPrescriptionVerification": { "__typename": "GlassesPrescriptionVerificationJobOptions" }, "glassesPrescriptionIssuance": { "__typename": "GlassesPrescriptionIssuanceJobOptions" }, "glassesFulfillment": { "__typename": "GlassesFulfillmentJobOptions" }, "wait": 40 }

GlassesPrescriptionVerificationJob

Glasses prescription verification job details

jobId
String

Unique ID for this job

status
String

Current job status

reason
String

Current job reason, if applicable

glasses

Glasses details

Glasses options

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Implements interfaces

GlassesJob

Glasses job interface

Sample
{ "jobId": "Example String", "status": "Example String", "reason": "Example String", "glasses": { "__typename": "Glasses" }, "options": { "__typename": "GlassesJobOptions" }, "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

Patient

Information about the patient

patientId
String

Patient ID

firstName
String

First name

middleName
String

Middle name

lastName
String

Last name

dateOfBirth
String

Date of birth in ISO 8601 format, i.e., YYYY-MM-DD

phoneNumber
String

Phone number

email
String

Email address

address
String

Street address #1

address2
String

Street address #2

city
String

City

state
String

State

zipCode
String

Zip code

schedulerLink
String

Scheduler link

Sample
{ "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }

ContactsOutput

Contacts output with prescription arrays

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

GlassesOutput

Glasses output with prescription arrays

Sample
{ "lenses": { "__typename": "GlassesLenses" }, "frame": { "__typename": "GlassesFrame" }, "prescription": { "__typename": "GlassesPrescription" }, "prescriptions": [ { "__typename": "GlassesPrescription" } ] }

VisionTestJob

Vision Test Job details

accountKey
String

Account key

siteKey
String

Site key

jobId
String

Unique ID for this job

status
String

Current job status

reason
String

Current job reason, if applicable

patient

Patient details

Contacts details

Glasses details

tags

List of tags used to correlate this job with other systems

updatedAt
String!,non-null

Last date and time this job was updated

createdAt
String!,non-null

Date and time this job was created

Sample
{ "accountKey": "Example String", "siteKey": "Example String", "jobId": "Example String", "status": "Example String", "reason": "Example String", "patient": { "__typename": "Patient" }, "contacts": { "__typename": "ContactsOutput" }, "glasses": { "__typename": "GlassesOutput" }, "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String", "createdAt": "Example String" }

StartVisionTestJob

Start Vision Test Job details

accountKey
String

Account key

siteKey
String

Site key

jobId
String

Unique ID for this job

status
String

Current job status

reason
String

Current job reason, if applicable

patient

Patient details

Contacts details

Glasses details

tags

List of tags used to correlate this job with other systems

updatedAt
String!,non-null

Last date and time this job was updated

createdAt
String!,non-null

Date and time this job was created

Sample
{ "accountKey": "Example String", "siteKey": "Example String", "jobId": "Example String", "status": "Example String", "reason": "Example String", "patient": { "__typename": "Patient" }, "contacts": { "__typename": "ContactsOutput" }, "glasses": { "__typename": "GlassesOutput" }, "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String", "createdAt": "Example String" }

Interfaces

Overview

Enums

Overview

Inputs

Overview