Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Enums

Overview

Role

NONE

NotificationSubscriptionType

Supported notification subscription types

HTTPS

HTTP POST notifications (webhooks) over TLS with support for Basic and Digest Access Authentication

EMAIL

Receive notifications at the specified email address

FileType

Supported file types and MIME type correlations

BMP

Correlates with image/bmp MIME type

DOC

Correlates with application/msword MIME type

DOCX

Correlates with application/vnd.openxmlformats-officedocument.wordprocessingml.document MIME type

GIF

Correlates with image/gif MIME type

HEIC

Correlates with image/heic MIME type

HEIF

Correlates with image/heif MIME type

JPEG

Correlates with image/jpeg MIME type

JPG

Correlates with image/jpeg MIME type

ODS

Correlates with application/vnd.oasis.opendocument.spreadsheet MIME type

ODT

Correlates with application/vnd.oasis.opendocument.text MIME type

PDF

Correlates with application/pdf MIME type

PNG

Correlates with image/png MIME type

RTF

Correlates with application/rtf MIME type

TIF

Correlates with image/tiff MIME type

TIFF

Correlates with image/tiff MIME type

WEBP

Correlates with image/webp MIME type

XLS

Correlates with application/vnd.ms-excel MIME type

XLSX

Correlates with application/vnd.openxmlformats-officedocument.spreadsheetml.sheet MIME type

XPS

Correlates with application/vnd.ms-xpsdocument MIME type

Category

ORDERS

Correlates with order management

GLASSES_PRESCRIPTION
CONTACTS_PRESCRIPTION

Eye

Indication of "left" or "right" eye

RIGHT

Right eye (OD)

LEFT

Left eye (OS)

ContactPrescriptionVerificationRequestStatus

Possible contact prescription verification request statuses

NEW

Initial state of a new request

UNDER_REVIEW

Manual review underway

REVIEW_FINISHED

Manual review finished, preparing verification email, fax, or call

PENDING_EMAIL

Email-based verification pending

PENDING_FAX

Fax-based verification pending

PENDING_CALL

Call-based verification pending

PENDING_DOCTOR_REPLY

Waiting for a reply from the doctor

PENDING_MANUAL_REVIEW

Manual review required; Automatic verification could not be completed

ON_HOLD

Request is on hold

APPROVED

Verification successful

APPROVED_WITH_CONDITIONS

Verification conditionally successful with product/prescription changes

APPROVED_ONE_TIME_ORDER

Special case one-time verification (e.g., doctor approved with expired prescription)

REJECTED_OTHER

Verification failed for unknown reasons; retrying may succeed

REJECTED_INVALID_PRESCRIPTION_FILE

Verification failed due to invalid prescription file

REJECTED_BLURRY_PRESCRIPTION_IMAGE

Verification failed due to illiegible or blurry prescription file

REJECTED_PARTIAL_PRESCRIPTION_IMAGE

Verification failed due to partial prescription file

REJECTED_NON_PRESCRIPTION_IMAGE

Verification failed due to non-prescription image file

REJECTED_FOREIGN_PROVIDER_INFO

Verification failed due to a prescription from a foreign provider

REJECTED_INVALID_PROVIDER_INFO

Verification failed due to invalid provider information

DENIED_OTHER

Doctor denied the request for some other reason

DENIED_PRESCRIPTION_EXPIRED

Doctor denied the request due to an expired prescription

DENIED_PRESCRIPTION_NOT_FINALIZED

Doctor denied the request due to a prescription being not finalized

DENIED_PRESCRIPTION_NOT_FOUND

Doctor denied the request due to prescription information being unavailable

DENIED_UNKNOWN_PATIENT

Doctor denied the request due to not fount doctor-patient relationship

CLOSED

The request has been manually closed without being completed

CANCELED

The request was canceled

PrismHorizontalDirection

IN
OUT

PrismVerticalDirection

UP
DOWN

GlassesLensType

DEMO
PLANO
PRESCRIPTION
READING

GlassesLensMaterial

CR39
POLYCARBONATE
HIGHINDEX167
HIGHINDEX174
TRIVEX

GlassesLensQuality

STANDARD
PREMIUM

Inputs

Overview

Scalars

Overview