Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Enums

Overview

Inputs

Overview

FileUploadInput

Attributes of the file to be uploaded

name
String!,non-null

Full file name

type
FileType!,non-null

File type

category

Service where the file will be used (optional)

Sample
{ "name": "Example String", "type": "BMP", "category": "ORDERS" }

DoctorInput

Information about the doctor

doctorId

Doctor ID (conditionally required if doctor name, practice name, and phone number are not set)

doctorName

Doctor name (conditionally required if doctor ID is not set)

practiceName

Practice name (conditionally required if doctor ID is not set)

phoneNumber

Phone number (conditionally required if doctor ID is not set)

faxNumber

Fax number

email

Doctor email address

address

Street address #1

address2

Street address #2

city

City

state

State

zipCode

Zip code

Website URL

Sample
{ "doctorId": "Example String", "doctorName": "Example String", "practiceName": "Example String", "phoneNumber": "Example String", "faxNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "url": "Example String" }

DoctorMatchInput

Used by 'doctors' query to find doctors with matching fields

doctorName

Doctor name

practiceName

Practice name

phoneNumber

Phone number

faxNumber

Fax number

email

Doctor email address

address

Street address #1

address2

Street address #2

city

City

state

State

zipCode

Zip code

Website URL

Sample
{ "doctorName": "Example String", "practiceName": "Example String", "phoneNumber": "Example String", "faxNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "url": "Example String" }

ShippingAddressInput

Shipping address information

Name of the recipient if different than the Patient name

address
String!,non-null

Street address #1

address2

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!,non-null

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

diameter
String!,non-null

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

baseCurve
String!,non-null

Indication of the curvature of the inside of the lens

axis

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

cylinder

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

addition

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

dominance

Indication of dominant or non-dominant eye

color

Color of the lens

packageSize
Int!,non-null

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 }

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

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

diameter

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

baseCurve

Indication of the curvature of the inside of the lens

sphere

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

axis

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

cylinder

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

addition

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

dominance

Indication of dominant or non-dominant eye

color

Color of the lens

packageSize

Number of lenses per package

quantity

Number of packages

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

ContactsProductsInput

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

ContactsPrescriptionInput

fileId

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

prescriptionId

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

Sample
{ "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "__typename": "DoctorInput" }, "patient": { "__typename": "PatientInput" }, "products": { "__typename": "ContactsProductsInput" } }

ContactsInput

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

Scalars

Overview