Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

ContactsPrescription

fileId
String

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

prescriptionId
String

Prescription ID

issueDate
String

Prescription issue date, if available

expirationDate
String

Prescription expiration date, if available

doctor

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

patient

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

Details about the prescribed contacts

comments
String

Doctor-entered comments

Sample
{ "fileId": "Example String", "prescriptionId": "Example String", "issueDate": "Example String", "expirationDate": "Example String", "doctor": { "__typename": "Doctor" }, "patient": { "__typename": "Patient" }, "products": { "__typename": "ContactsProducts" }, "comments": "Example String" }

Contacts

Sample
{ "products": [ { "__typename": "ContactsProducts" } ], "prescription": { "__typename": "ContactsPrescription" } }

ContactsSuggestionJobOptions

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

ContactsPrescriptionVerificationJobOptions

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

ContactsPrescriptionIssuanceJobOptions

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

ContactsFulfillmentJobOptions

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

ContactsJobOptions

contactsPrescriptionVerification
contactsPrescriptionIssuance
wait
Int

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

Sample
{ "contactsSuggestion": { "__typename": "ContactsSuggestionJobOptions" }, "contactsPrescriptionVerification": { "__typename": "ContactsPrescriptionVerificationJobOptions" }, "contactsPrescriptionIssuance": { "__typename": "ContactsPrescriptionIssuanceJobOptions" }, "contactsFulfillment": { "__typename": "ContactsFulfillmentJobOptions" }, "wait": 40 }

ContactsPrescriptionVerificationJob

Contacts prescription verification job details

jobId
String

Unique ID for this job

status
String

Current job status

reason
String

Current job reason, if applicable

contacts

Contacts details

Contacts options

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Implements interfaces

ContactsJob

Contacts job interface

Sample
{ "jobId": "Example String", "status": "Example String", "reason": "Example String", "contacts": { "__typename": "Contacts" }, "options": { "__typename": "ContactsJobOptions" }, "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

ContactsSuggestionJob

Contacts suggestion job details

jobId
String

Unique ID for this job

status
String

Current job status

reason
String

Current job reason, if applicable

contacts

Contacts details

Contacts options

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Implements interfaces

ContactsJob

Contacts job interface

Sample
{ "jobId": "Example String", "status": "Example String", "reason": "Example String", "contacts": { "__typename": "Contacts" }, "options": { "__typename": "ContactsJobOptions" }, "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

ContactsPrescriptionIssuanceJob

Contacts prescription issuance job details

jobId
String

Unique ID for this job

status
String

Current job status

reason
String

Current job reason, if applicable

contacts

Contacts details

Contacts options

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Implements interfaces

ContactsJob

Contacts job interface

Sample
{ "jobId": "Example String", "status": "Example String", "reason": "Example String", "contacts": { "__typename": "Contacts" }, "options": { "__typename": "ContactsJobOptions" }, "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

PupillaryDistance

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 }

Interfaces

Overview

Enums

Overview

Inputs

Overview