Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Enums

Overview

Inputs

Overview

GlassesVerificationOptionsInput

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

GlassesPrescriptionOptionsInput

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

GlassesInput

Sample
{ "lenses": { "__typename": "GlassesLensesInput" }, "frame": { "__typename": "GlassesFrameInput" }, "prescription": { "__typename": "GlassesPrescriptionInput" } }

GlassesFulfillmentOptionsInput

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

GlassesOptionsInput

Sample
{ "verification": { "__typename": "GlassesVerificationOptionsInput" }, "prescription": { "__typename": "GlassesPrescriptionOptionsInput" }, "fulfillment": { "__typename": "GlassesFulfillmentOptionsInput" } }

PatientInput

Information about the patient

patientId

Patient ID

firstName

First name

middleName

Middle name

lastName

Last name

dateOfBirth

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

phoneNumber

Phone number

email

Email address

address

Street address #1

address2

Street address #2

city

City

state

State

zipCode

Zip code

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

LensInput

Information about the lens

type
LensType!,non-null

Lens type

Lens focus

material

Lens material

Lens quality

color

Lens color

Lens edge type

addons

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

prescription

Optionally provided prescription details, applicable to CORRECTIVE lenses only

corrections

Optionally provided correction details, applicable to CORRECTIVE lenses only

Sample
{ "type": "DEMO", "focus": "BIFOCAL", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "prescription": { "__typename": "PrescriptionInput" }, "corrections": { "__typename": "CorrectionsInput" } }

PrescriptionInput

Prescription details

fileId
String!,non-null

File ID

Sample
{ "fileId": "Example String" }
Referenced in

ItemInput

type
ItemType!,non-null
itemId
description
comment
lensReplacement
Deprecation reason

Use glasses property

Sample
{ "type": "GLASSES", "itemId": "Example String", "description": "Example String", "comment": "Example String", "glasses": { "__typename": "GlassesItemInput" }, "lensReplacement": { "__typename": "LensReplacementItemInput" }, "contacts": { "__typename": "ContactsItemInput" } }
Referenced in

GlassesItemInput

Glasses lens and frame details, used for frame-only, lens replacement, and frame + glasses orders

lens
LensInputdeprecated
Deprecation reason

Use glasses.lenses property

frame
FrameInputdeprecated
Deprecation reason

Use glasses.frame property

protection
Booleandeprecated
Deprecation reason

Use options.fulfillment.protection item

comment
Stringdeprecated
Deprecation reason

Use item.comment item

quantity
Sample
{ "lens": { "__typename": "LensInput" }, "frame": { "__typename": "FrameInput" }, "protection": true, "comment": "Example String", "glasses": { "__typename": "GlassesInput" }, "options": { "__typename": "GlassesOptionsInput" }, "tags": [ { "__typename": "TagInput" } ], "quantity": 40 }
Referenced in

LensReplacementItemInput

box
Boolean!,non-null
lens
LensInput!,non-null
protection
quantity
Int!,non-null
comment
Sample
{ "box": true, "lens": { "__typename": "LensInput" }, "protection": true, "quantity": 40, "comment": "Example String" }

Scalars

Overview