Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Enums

Overview

Inputs

Overview

GlassesInput

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

GlassesPrescriptionVerificationJobOptionsInput

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

GlassesPrescriptionIssuanceJobOptionsInput

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

GlassesFulfillmentJobOptionsInput

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

GlassesJobOptionsInput

glassesPrescriptionVerification
wait
Int

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

Sample
{ "glassesPrescriptionVerification": { "__typename": "GlassesPrescriptionVerificationJobOptionsInput" }, "glassesPrescriptionIssuance": { "__typename": "GlassesPrescriptionIssuanceJobOptionsInput" }, "glassesFulfillment": { "__typename": "GlassesFulfillmentJobOptionsInput" }, "wait": 40 }

PatientInput

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

LensInput

Information about the lens

type
LensType!,non-null

Lens type

Lens focus

material

Lens material

Lens quality

color
String

Lens color

Lens edge type

addons
String

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
String
description
String
comment
String
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
Int
Sample
{ "lens": { "__typename": "LensInput" }, "frame": { "__typename": "FrameInput" }, "protection": true, "comment": "Example String", "glasses": { "__typename": "GlassesInput" }, "options": { "__typename": "GlassesJobOptionsInput" }, "tags": [ { "__typename": "TagInput" } ], "quantity": 40 }
Referenced in

LensReplacementItemInput

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