Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Enums

Overview

Inputs

Overview

ContactsFulfillmentJobOptionsInput

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

ContactsJobOptionsInput

contactsPrescriptionVerification
wait
Int

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

Sample
{ "contactsSuggestion": { "__typename": "ContactsSuggestionJobOptionsInput" }, "contactsPrescriptionVerification": { "__typename": "ContactsPrescriptionVerificationJobOptionsInput" }, "contactsPrescriptionIssuance": { "__typename": "ContactsPrescriptionIssuanceJobOptionsInput" }, "contactsFulfillment": { "__typename": "ContactsFulfillmentJobOptionsInput" }, "wait": 40 }

PrismHorizontalInput

Horizontal prism details

power
String!,non-null

Power of the prism in diopters

direction

Direction of the prism from the base

Sample
{ "power": "Example String", "direction": "IN" }
Referenced in

PrismVerticalInput

Vertical prism details

power
String!,non-null

Power of the prism in diopters

direction

Direction of the prism from the base

Sample
{ "power": "Example String", "direction": "UP" }
Referenced in

PrismInput

Prism correction details

Horizontal prism power and direction

Vertical prism power and direction

Sample
{ "horizontal": { "__typename": "PrismHorizontalInput" }, "vertical": { "__typename": "PrismVerticalInput" } }
Referenced in

CorrectionInput

sphere
String!,non-null
cylinder
String
axis
String
addition
String
pupillaryDistance
Float
segmentHeight
Float
Sample
{ "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "__typename": "PrismInput" } }

CorrectionsInput

Sample
{ "right": { "__typename": "CorrectionInput" }, "left": { "__typename": "CorrectionInput" } }
Referenced in

CustomerInput

Information about the customer

firstName
String!,non-null

First name

middleName
String

Middle name

lastName
String!,non-null

Last name

dateOfBirth
String

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

phoneNumber
String

Phone number

email
String!,non-null

Email address

address
String!,non-null

Street address #1

address2
String

Street address #2

city
String!,non-null

City

state
String!,non-null

State

zipCode
String!,non-null

Zip code

Sample
{ "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" }
Referenced in

FrameInput

Information about the frame

sku
String

Frame SKU

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

PupillaryDistanceInput

Pupillary distance

intermediate
Float

Used to indicate single pupillary distance value in millimeters; Conditionally required if near and distance values are not provided

near
Float

Used to indicate pupillary distance for near vision in millimeters; Conditionally required if intermediate value is not provided

distance
Float

Used to indicate pupillary distance for distance vision in millimeters; Conditionally required if intermediate value is not provided

Sample
{ "intermediate": 40, "near": 40, "distance": 40 }

GlassesLenPrismHorizontalInput

Horizontal prism details

power
String!,non-null

Prism strength diopters

Prism base direction

Sample
{ "power": "Example String", "direction": "IN" }