Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

FileUpload

Attributes of the file to be uploaded

id
String!,non-null

Unique File ID

name
String!,non-null

Full file name provided by the user

type
FileType!,non-null

File type corresponds directly with the MIME type (and often the file extension)

uploadUrl
String!,non-null

Signed URL enabling file upload via HTTP PUT with 15-minute expiration

Sample
{ "id": "Example String", "name": "Example String", "type": "BMP", "uploadUrl": "Example String" }

ContactPrescriptionVerificationRequest

Contact prescription verification request information

id
String!,non-null

Unique ID for this request

Current request status

expirationDate
String

Prescription expiration date if it is available

comments
String

Comments entered by Doctor and/or Visibly

updatedAt
String!,non-null

Last date and time this request was updated

Sample
{ "id": "Example String", "status": "NEW", "expirationDate": "Example String", "comments": "Example String", "updatedAt": "Example String" }

ContactPrescriptionVerificationJob

Contact prescription verification request information

jobId
String

Unique ID for this job

status
String

Current job status

reason
String

Current job reason, if applicable

notes
String

Notes entered by Doctor and/or Visibly

issueDate
String

Prescription issue date, if available

expirationDate
String

Prescription expiration date, if available

Prescriptions pertinent to the ordered products (inclusive of changes required)

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Sample
{ "jobId": "Example String", "status": "Example String", "reason": "Example String", "notes": "Example String", "issueDate": "Example String", "expirationDate": "Example String", "prescriptions": [ { "__typename": "ContactPrescription" } ], "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

PrescriptionRenewal

Prescription renewal information

workflowId
String

Workflow ID associated with this prescription renewal

status
String

Current status

reason
String

Current reason, if applicable

issueDate
String

Prescription issue date, if available

expirationDate
String

Prescription expiration date, if available

Prescriptions pertinent to the ordered products (inclusive of changes required)

tags

List of tags used to correlate this renewal with other systems

updatedAt
String

Last date and time this renewal was updated

Sample
{ "workflowId": "Example String", "status": "Example String", "reason": "Example String", "issueDate": "Example String", "expirationDate": "Example String", "prescriptions": [ { "__typename": "ContactPrescription" } ], "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

Workflow

Start Workflow Request information

workflowId
String!,non-null

Unique ID for this workflow

launchUrl
String

If applicable, the launch URL for the first step in this workflow

requestId
String

Unique ID for a prescription verification request if applicable

Current request status

jobId
String

Unique ID for a prescription verification job (conditionally available)

status
String

Current prescription verification job status (conditionally available)

updatedAt
String

Last date and time this request was updated

Sample
{ "workflowId": "Example String", "launchUrl": "Example String", "requestId": "Example String", "requestStatus": "NEW", "jobId": "Example String", "status": "Example String", "updatedAt": "Example String" }

Order

Order details

orderId
String

Unique ID for this order

status
String

Current order status

Sample
{ "orderId": "Example String", "status": "Example String" }

Session

Start vision test response

launchUrl
String!,non-null

The launch URL for the vision test

jobId
String

The job ID for the vision-test job (if applicable, simulation support only)

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

ContactProductMappingResponse

Contacts Product Mapping Response

ok
String!,non-null
Sample
{ "ok": "Example String" }

Tag

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

ContactsProduct

productId
String

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

manufacturer
String

Manufacturer name

brand
String

Brand name

schedule
String

Schedule name

type
String

Type name (Toric, Multi-Focal, etc.)

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 measured in millimeters

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", "manufacturer": "Example String", "brand": "Example String", "schedule": "Example String", "type": "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 }

ContactsProducts

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

Interfaces

Overview

Enums

Overview

Inputs

Overview