Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

GlassesLens

Information about the lens

Lens type

Lens material

Lens quality

color
String

Lens color

Lens edge finish

addons
String

Additional anti-reflective, anti-fog, anti-scratch, and other coatings

Lens focus

sphere
String

Sphere

cylinder
String

Cylinder

axis
String

Axis

addition
String

Addition

pupillaryDistance

Pupillary distance

segmentHeight
String

Segment height

Prism corrections

Sample
{ "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "__typename": "PupillaryDistance" }, "segmentHeight": "Example String", "prism": { "__typename": "GlassesLensPrism" } }

GlassesLenses

Information about both lenses

Lens type

Lens material

Lens quality

color
String

Lens color

Lens edge finish

addons
String

Additional anti-reflective, anti-fog, anti-scratch, and other coatings

Lens focus

sphere
String

Sphere

cylinder
String

Cylinder

axis
String

Axis

addition
String

Addition

pupillaryDistance

Pupillary distance

segmentHeight
String

Segment height

Prism corrections

Sample
{ "right": { "__typename": "GlassesLens" }, "left": { "__typename": "GlassesLens" }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "__typename": "PupillaryDistance" }, "segmentHeight": "Example String", "prism": { "__typename": "GlassesLensPrism" } }

GlassesFrame

Information about the frame

sku
String

Frame SKU

Sample
{ "sku": "Example String" }

GlassesPrescription

Information about the glasses prescription

fileId
String

File ID from uploadFile

prescriptionId
String

Prescription ID

doctor

Prescribing doctor details

patient

Patient details

corrections

Prescribed corrections for distance, near, or multifocal lenses

issueDate
String

Issue date for the prescription YYYY-MM-DD format

expirationDate
String

Expiration date for the prescription YYYY-MM-DD format

Sample
{ "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "__typename": "Doctor" }, "patient": { "__typename": "Patient" }, "corrections": [ { "__typename": "GlassesLenses" } ], "issueDate": "Example String", "expirationDate": "Example String" }

Glasses

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

GlassesPrescriptionVerificationJobOptions

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

GlassesPrescriptionIssuanceJobOptions

jobId
String
sendText
Boolean
sendEmail
Boolean
buyLink
Boolean
Sample
{ "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }

GlassesFulfillmentJobOptions

frameOnly
Boolean
lensReplacement
Boolean
lensProtection
Boolean
sendBox
Boolean
Sample
{ "frameOnly": true, "lensReplacement": true, "lensProtection": true, "sendBox": true }

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" }

Interfaces

Overview

Enums

Overview

Inputs

Overview