Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Enums

Overview

Inputs

Overview

ShippingAddressInput

Shipping address information

to
String

Name of the recipient if different than the Patient name

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
{ "to": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" }
Referenced in

ContactProductInput

Information about a product/prescription. Use 'products' query to find possible values for product-specific prescription parameters.

productId
String!,non-null

ID that uniquely maps to a manufacturer, brand, and model combination

eye
Eye!,non-null

Indication of left (OS) or right (OD) eye

sphere
String

The amount of lens power measured in diopters (D), minus sign (–) for nearsighted, plus sign (+) for farsighted

diameter
String

The width of the contact lens from edge to edge measured by millimeters

baseCurve
String

Indication of the curvature of the inside of the lens

axis
String

The lens meridian with no cylinder power, indicated by a value between 1 and 180 degrees

cylinder
String

The amount of lens power for astigmatism measured in diopters (D), minus sign (–) for nearsighted, plus sign (+) for farsighted

addition
String

The additional magnifying power that applies to the bottom portion of multifocal lenses to fix presbyopia

dominance
String

Indication of dominant or non-dominant eye

color
String

Color of the lens

packageSize
Int

Number of lenses per package

quantity
Int!,non-null

Number of packages

Sample
{ "productId": "Example String", "eye": "RIGHT", "sphere": "Example String", "diameter": "Example String", "baseCurve": "Example String", "axis": "Example String", "cylinder": "Example String", "addition": "Example String", "dominance": "Example String", "color": "Example String", "packageSize": 40, "quantity": 40 }

ContactProductMappingInput

Product information

baseId
String

Base 4-letter ID for the product mapping

productKey
String

Base/Product Key for the product mapping

productId
String!,non-null

partner product ID for the product mapping

manufacturer
String!,non-null

Manufacturer name

brand
String!,non-null

Brand name

sphere
[String]

Possible sphere values

diameter
[String]

Possible diameter values

baseCurve
[String]

Possible baseCurve values

axis
[String]

Possible axis values

cylinder
[String]

Possible cylinder values

addition
[String]

Possible addition values

dominance
[String]

Possible dominance values

color
[String]

Possible color values

packageSize
[String]

Number of lenses per package

Sample
{ "baseId": "Example String", "productKey": "Example String", "productId": "Example String", "manufacturer": "Example String", "brand": "Example String", "sphere": [ "Example String" ], "diameter": [ "Example String" ], "baseCurve": [ "Example String" ], "axis": [ "Example String" ], "cylinder": [ "Example String" ], "addition": [ "Example String" ], "dominance": [ "Example String" ], "color": [ "Example String" ], "packageSize": [ "Example String" ] }

TagInput

Custom tags containing references to other systems

name
String!,non-null

The name of the tag

value
String!,non-null

The value of the tag

Sample
{ "name": "Example String", "value": "Example String" }

ContactsProductInput

productId
String

ID that uniquely maps to a manufacturer, brand, and potentially other parameters

diameter
String

The width of the contact lens from edge to edge measured by millimeters

baseCurve
String

Indication of the curvature of the inside of the lens

sphere
String

The amount of lens power measured in diopters (D), minus sign (–) for nearsighted, plus sign (+) for farsighted

axis
String

The lens meridian with no cylinder power, indicated by a value between 1 and 180 degrees

cylinder
String

The amount of lens power for astigmatism measured in diopters (D), minus sign (–) for nearsighted, plus sign (+) for farsighted

addition
String

The additional magnifying power that applies to the bottom portion of multifocal lenses to fix presbyopia

dominance
String

Indication of dominant or non-dominant eye

color
String

Color of the lens

packageSize
Int

Number of lenses per package

quantity
Int

Number of packages

Sample
{ "productId": "Example String", "diameter": "Example String", "baseCurve": "Example String", "sphere": "Example String", "axis": "Example String", "cylinder": "Example String", "addition": "Example String", "dominance": "Example String", "color": "Example String", "packageSize": 40, "quantity": 40 }

ContactsProductsInput

Sample
{ "right": { "__typename": "ContactsProductInput" }, "left": { "__typename": "ContactsProductInput" } }

ContactsPrescriptionInput

fileId
String

File ID from uploadFile (conditionally required if doctor and patient are not set)

prescriptionId
String

Prescription ID

Doctor details (conditionally required if prescription file ID is not set)

Patient details (conditionally required if prescription file ID is not set)

Details about the prescribed contact 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": "DoctorInput" }, "patient": { "__typename": "PatientInput" }, "products": { "__typename": "ContactsProductsInput" }, "issueDate": "Example String", "expirationDate": "Example String" }

ContactsInput

Sample
{ "products": { "__typename": "ContactsProductsInput" }, "prescription": { "__typename": "ContactsPrescriptionInput" } }

ContactsSuggestionJobOptionsInput

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

ContactsPrescriptionVerificationJobOptionsInput

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

ContactsPrescriptionIssuanceJobOptionsInput

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