reference
/- saveContactsPrescription
createNotificationSubscription
deleteNotificationSubscription
uploadFile
suggestContacts
verifyContactsPrescription
issueContactsPrescription
verifyGlassesPrescription
submitOrder
saveOrder
savePatient
saveGlassesPrescription
startWorkflow
fulfillOrder
submitContactPrescriptionVerificationRequest
startVisionTest
mapProducts
saveContactsPrescription
Download GraphQL schema
Start a contacts prescription issuance job
Arguments
contacts
Contacts details
options
Contacts job options
tags
List of tags
Return type
Contactsjob
String
Unique ID for this job
status
String
Current job status
reason
String
Current job reason, if applicable
contacts
Contacts details
options
Contacts options
tags
List of tags used to correlate this workflow with other systems
updated
String!,non-null
Last date and time this job was updated
Mutation sample
mutation issueContactsPrescription(
$contacts: ContactsInput!
$options: ContactsJobOptionsInput
$tags: [TagInput]
) {
issueContactsPrescription(
contacts: $contacts
options: $options
tags: $tags
) {
jobId
status
reason
contacts {
products {
right {
productId
manufacturer
brand
schedule
type
diameter
baseCurve
sphere
axis
cylinder
addition
dominance
color
packageSize
quantity
}
left {
productId
manufacturer
brand
schedule
type
diameter
baseCurve
sphere
axis
cylinder
addition
dominance
color
packageSize
quantity
}
}
prescription {
fileId
prescriptionId
issueDate
expirationDate
doctor {
id
doctorName
practiceName
address
city
state
zipCode
}
patient {
patientId
firstName
middleName
lastName
dateOfBirth
phoneNumber
email
address
address2
city
state
zipCode
schedulerLink
}
products {
right {
productId
manufacturer
brand
schedule
type
diameter
baseCurve
sphere
axis
cylinder
addition
dominance
color
packageSize
quantity
}
left {
productId
manufacturer
brand
schedule
type
diameter
baseCurve
sphere
axis
cylinder
addition
dominance
color
packageSize
quantity
}
}
comments
}
}
options {
contactsSuggestion {
jobId
}
contactsPrescriptionVerification {
jobId
}
contactsPrescriptionIssuance {
jobId
sendText
sendEmail
buyLink
}
contactsFulfillment {
jobId
}
wait
}
tags {
name
value
}
updatedAt
}
}Variables
{ "contacts": { "products": { "right": { "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 }, "left": { "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 } }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "products": { "right": { "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 }, "left": { "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 } }, "issueDate": "Example String", "expirationDate": "Example String" } }, "options": { "contactsSuggestion": { "jobId": "Example String" }, "contactsPrescriptionVerification": { "jobId": "Example String" }, "contactsPrescriptionIssuance": { "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }, "contactsFulfillment": { "jobId": "Example String" }, "wait": 40 }, "tags": [ { "name": "Example String", "value": "Example String" } ] }
Response sample
{ "data": { "jobId": "Example String", "status": "Example String", "reason": "Example String", "contacts": { "products": [ { "right": { "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 }, "left": { "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 } } ], "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "issueDate": "Example String", "expirationDate": "Example String", "doctor": { "id": "Example String", "doctorName": "Example String", "practiceName": "Example String", "address": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "products": { "right": { "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 }, "left": { "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 } }, "comments": "Example String" } }, "options": { "contactsSuggestion": { "jobId": "Example String" }, "contactsPrescriptionVerification": { "jobId": "Example String" }, "contactsPrescriptionIssuance": { "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }, "contactsFulfillment": { "jobId": "Example String" }, "wait": 40 }, "tags": [ { "name": "Example String", "value": "Example String" } ], "updatedAt": "Example String" } }
Start a glasses prescription verification job
Arguments
glasses
Glasses details
options
Job options
tags
List of tags
Return type
Glassesjob
String
Unique ID for this job
status
String
Current job status
reason
String
Current job reason, if applicable
glasses
Glasses details
options
Glasses options
tags
List of tags used to correlate this workflow with other systems
updated
String!,non-null
Last date and time this job was updated
Mutation sample
mutation verifyGlassesPrescription(
$glasses: GlassesInput!
$options: GlassesJobOptionsInput
$tags: [TagInput]
) {
verifyGlassesPrescription(
glasses: $glasses
options: $options
tags: $tags
) {
jobId
status
reason
glasses {
lenses {
right {
type
material
quality
color
edge
addons
focus
sphere
cylinder
axis
addition
pupillaryDistance {
intermediate
near
distance
}
segmentHeight
prism {
horizontal {
power
direction
}
vertical {
power
direction
}
}
}
left {
type
material
quality
color
edge
addons
focus
sphere
cylinder
axis
addition
pupillaryDistance {
intermediate
near
distance
}
segmentHeight
prism {
horizontal {
power
direction
}
vertical {
power
direction
}
}
}
type
material
quality
color
edge
addons
focus
sphere
cylinder
axis
addition
pupillaryDistance {
intermediate
near
distance
}
segmentHeight
prism {
horizontal {
power
direction
}
vertical {
power
direction
}
}
}
frame {
sku
}
prescription {
fileId
prescriptionId
doctor {
id
doctorName
practiceName
address
city
state
zipCode
}
patient {
patientId
firstName
middleName
lastName
dateOfBirth
phoneNumber
email
address
address2
city
state
zipCode
schedulerLink
}
corrections {
right {
type
material
quality
color
edge
addons
focus
sphere
cylinder
axis
addition
pupillaryDistance {
intermediate
near
distance
}
segmentHeight
prism {
horizontal {
power
direction
}
vertical {
power
direction
}
}
}
left {
type
material
quality
color
edge
addons
focus
sphere
cylinder
axis
addition
pupillaryDistance {
intermediate
near
distance
}
segmentHeight
prism {
horizontal {
power
direction
}
vertical {
power
direction
}
}
}
type
material
quality
color
edge
addons
focus
sphere
cylinder
axis
addition
pupillaryDistance {
intermediate
near
distance
}
segmentHeight
prism {
horizontal {
power
direction
}
vertical {
power
direction
}
}
}
issueDate
expirationDate
}
}
options {
glassesPrescriptionVerification {
jobId
}
glassesPrescriptionIssuance {
jobId
sendText
sendEmail
buyLink
}
glassesFulfillment {
frameOnly
lensReplacement
lensProtection
sendBox
}
wait
}
tags {
name
value
}
updatedAt
}
}Variables
{ "glasses": { "lenses": { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "frame": { "sku": "Example String" }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "corrections": [ { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } ], "issueDate": "Example String", "expirationDate": "Example String" } }, "options": { "glassesPrescriptionVerification": { "jobId": "Example String" }, "glassesPrescriptionIssuance": { "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }, "glassesFulfillment": { "frameOnly": true, "lensReplacement": true, "lensProtection": true, "sendBox": true }, "wait": 40 }, "tags": [ { "name": "Example String", "value": "Example String" } ] }
Response sample
{ "data": { "jobId": "Example String", "status": "Example String", "reason": "Example String", "glasses": { "lenses": { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "frame": { "sku": "Example String" }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "id": "Example String", "doctorName": "Example String", "practiceName": "Example String", "address": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "corrections": [ { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } ], "issueDate": "Example String", "expirationDate": "Example String" } }, "options": { "glassesPrescriptionVerification": { "jobId": "Example String" }, "glassesPrescriptionIssuance": { "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }, "glassesFulfillment": { "frameOnly": true, "lensReplacement": true, "lensProtection": true, "sendBox": true }, "wait": 40 }, "tags": [ { "name": "Example String", "value": "Example String" } ], "updatedAt": "Example String" } }
Submit order
Arguments
order
Order details
Return type
[Boolean]The Boolean scalar type represents true or false.
Mutation sample
mutation submitOrder($order: OrderInput) {
submitOrder(order: $order)
}Variables
{ "order": { "orderId": "Example String", "orderedAt": "Example String", "total": 40, "customer": { "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" }, "shipping": { "method": "Example String", "address": { "to": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" } }, "items": [ { "type": "GLASSES", "itemId": "Example String", "description": "Example String", "comment": "Example String", "glasses": { "lens": { "type": "DEMO", "focus": "BIFOCAL", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "prescription": { "fileId": "Example String" }, "corrections": { "right": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } } }, "frame": { "sku": "Example String" }, "protection": true, "comment": "Example String", "glasses": { "lenses": { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "frame": { "sku": "Example String" }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "corrections": [ { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } ], "issueDate": "Example String", "expirationDate": "Example String" } }, "options": { "glassesPrescriptionVerification": { "jobId": "Example String" }, "glassesPrescriptionIssuance": { "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }, "glassesFulfillment": { "frameOnly": true, "lensReplacement": true, "lensProtection": true, "sendBox": true }, "wait": 40 }, "tags": [ { "name": "Example String", "value": "Example String" } ], "quantity": 40 }, "lensReplacement": { "box": true, "lens": { "type": "DEMO", "focus": "BIFOCAL", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "prescription": { "fileId": "Example String" }, "corrections": { "right": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } } }, "protection": true, "quantity": 40, "comment": "Example String" }, "contacts": { "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "doctorId": "Example String", "doctor": { "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" }, "products": [ { "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 } ], "prescriptions": [ { "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 } ], "fileIds": [ "Example String" ], "quantity": 40, "comment": "Example String", "contacts": { "products": { "right": { "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 }, "left": { "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 } }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "products": { "right": { "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 }, "left": { "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 } }, "issueDate": "Example String", "expirationDate": "Example String" } }, "options": { "contactsSuggestion": { "jobId": "Example String" }, "contactsPrescriptionVerification": { "jobId": "Example String" }, "contactsPrescriptionIssuance": { "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }, "contactsFulfillment": { "jobId": "Example String" }, "wait": 40 }, "tags": [ { "name": "Example String", "value": "Example String" } ] } } ] } }
Response sample
{ "data": [ true ] }
Save order details
Arguments
order
Order details
Return type
BooleanThe Boolean scalar type represents true or false.
Mutation sample
mutation saveOrder($order: OrderInput) {
saveOrder(order: $order)
}Variables
{ "order": { "orderId": "Example String", "orderedAt": "Example String", "total": 40, "customer": { "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" }, "shipping": { "method": "Example String", "address": { "to": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" } }, "items": [ { "type": "GLASSES", "itemId": "Example String", "description": "Example String", "comment": "Example String", "glasses": { "lens": { "type": "DEMO", "focus": "BIFOCAL", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "prescription": { "fileId": "Example String" }, "corrections": { "right": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } } }, "frame": { "sku": "Example String" }, "protection": true, "comment": "Example String", "glasses": { "lenses": { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "frame": { "sku": "Example String" }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "corrections": [ { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } ], "issueDate": "Example String", "expirationDate": "Example String" } }, "options": { "glassesPrescriptionVerification": { "jobId": "Example String" }, "glassesPrescriptionIssuance": { "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }, "glassesFulfillment": { "frameOnly": true, "lensReplacement": true, "lensProtection": true, "sendBox": true }, "wait": 40 }, "tags": [ { "name": "Example String", "value": "Example String" } ], "quantity": 40 }, "lensReplacement": { "box": true, "lens": { "type": "DEMO", "focus": "BIFOCAL", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "prescription": { "fileId": "Example String" }, "corrections": { "right": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } } }, "protection": true, "quantity": 40, "comment": "Example String" }, "contacts": { "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "doctorId": "Example String", "doctor": { "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" }, "products": [ { "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 } ], "prescriptions": [ { "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 } ], "fileIds": [ "Example String" ], "quantity": 40, "comment": "Example String", "contacts": { "products": { "right": { "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 }, "left": { "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 } }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "products": { "right": { "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 }, "left": { "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 } }, "issueDate": "Example String", "expirationDate": "Example String" } }, "options": { "contactsSuggestion": { "jobId": "Example String" }, "contactsPrescriptionVerification": { "jobId": "Example String" }, "contactsPrescriptionIssuance": { "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }, "contactsFulfillment": { "jobId": "Example String" }, "wait": 40 }, "tags": [ { "name": "Example String", "value": "Example String" } ] } } ] } }
Response sample
{ "data": true }
Save patient detailst
Arguments
patient
Patient details
Return type
BooleanThe Boolean scalar type represents true or false.
Mutation sample
mutation savePatient($patient: PatientInput!) {
savePatient(patient: $patient)
}Variables
{ "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" } }
Response sample
{ "data": true }
Save contacts prescription details
Arguments
prescription
Contacts prescription details
Return type
BooleanThe Boolean scalar type represents true or false.
Mutation sample
mutation saveContactsPrescription($prescription: ContactsPrescriptionInput!) {
saveContactsPrescription(prescription: $prescription)
}Variables
{ "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "products": { "right": { "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 }, "left": { "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 } }, "issueDate": "Example String", "expirationDate": "Example String" } }
Response sample
{ "data": true }
Save glasses prescription details
Arguments
prescription
Glasses prescription details
Return type
BooleanThe Boolean scalar type represents true or false.
Mutation sample
mutation saveGlassesPrescription($prescription: GlassesPrescriptionInput!) {
saveGlassesPrescription(prescription: $prescription)
}Variables
{ "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "corrections": [ { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } ], "issueDate": "Example String", "expirationDate": "Example String" } }
Response sample
{ "data": true }
Deprecation reason
Use startVisionTest.
Start a workflow utilizing one or more Visibly services
Arguments
name
String!,non-nullrequired
The name of the workflow to run
patient
Optional patient information
doctor
String
Optional doctor Id
doctor
Optional doctor information
products
Optional ordered products
prescriptions
Prescriptions pertinent to the ordered products
file
[String]
File IDs from uploadFile for flat files containing prescription information
tags
List of tags used to correlate this workflow with other systems
Return type
Workflowworkflow
String!,non-null
Unique ID for this workflow
launch
String
If applicable, the launch URL for the first step in this workflow
request
String
Unique ID for a prescription verification request if applicable
request
Current request status
job
String
Unique ID for a prescription verification job (conditionally available)
status
String
Current prescription verification job status (conditionally available)
updated
String
Last date and time this request was updated
Mutation sample
mutation startWorkflow(
$name: String!
$patient: PatientInput
$doctorId: String
$doctor: DoctorInput
$products: [ContactProductInput]
$prescriptions: [ContactProductInput]
$fileIds: [String]
$tags: [TagInput]
) {
startWorkflow(
name: $name
patient: $patient
doctorId: $doctorId
doctor: $doctor
products: $products
prescriptions: $prescriptions
fileIds: $fileIds
tags: $tags
) {
workflowId
launchUrl
requestId
requestStatus
jobId
status
updatedAt
}
}Variables
{ "name": "Example String", "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "doctorId": "Example String", "doctor": { "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" }, "products": [ { "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 } ], "prescriptions": [ { "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 } ], "fileIds": [ "Example String" ], "tags": [ { "name": "Example String", "value": "Example String" } ] }
Response sample
{ "data": { "workflowId": "Example String", "launchUrl": "Example String", "requestId": "Example String", "requestStatus": "NEW", "jobId": "Example String", "status": "Example String", "updatedAt": "Example String" } }
Deprecation reason
Use submitOrder
Fulfill order
Arguments
ordered
String!,non-nullrequired
Date and time when the order was placed in ISO 8601 format
customer
Customer information
shipping
Shipping details
items
Items in the order
tags
List of tags
Return type
Orderorder
String
Unique ID for this order
status
String
Current order status
Mutation sample
mutation fulfillOrder(
$orderedAt: String!
$customer: CustomerInput!
$shipping: ShippingInput!
$items: [ItemInput]
$tags: [TagInput]
) {
fulfillOrder(
orderedAt: $orderedAt
customer: $customer
shipping: $shipping
items: $items
tags: $tags
) {
orderId
status
}
}Variables
{ "orderedAt": "Example String", "customer": { "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" }, "shipping": { "method": "Example String", "address": { "to": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" } }, "items": [ { "type": "GLASSES", "itemId": "Example String", "description": "Example String", "comment": "Example String", "glasses": { "lens": { "type": "DEMO", "focus": "BIFOCAL", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "prescription": { "fileId": "Example String" }, "corrections": { "right": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } } }, "frame": { "sku": "Example String" }, "protection": true, "comment": "Example String", "glasses": { "lenses": { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "frame": { "sku": "Example String" }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "corrections": [ { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } ], "issueDate": "Example String", "expirationDate": "Example String" } }, "options": { "glassesPrescriptionVerification": { "jobId": "Example String" }, "glassesPrescriptionIssuance": { "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }, "glassesFulfillment": { "frameOnly": true, "lensReplacement": true, "lensProtection": true, "sendBox": true }, "wait": 40 }, "tags": [ { "name": "Example String", "value": "Example String" } ], "quantity": 40 }, "lensReplacement": { "box": true, "lens": { "type": "DEMO", "focus": "BIFOCAL", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "prescription": { "fileId": "Example String" }, "corrections": { "right": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": 40, "segmentHeight": 40, "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } } }, "protection": true, "quantity": 40, "comment": "Example String" }, "contacts": { "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "doctorId": "Example String", "doctor": { "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" }, "products": [ { "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 } ], "prescriptions": [ { "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 } ], "fileIds": [ "Example String" ], "quantity": 40, "comment": "Example String", "contacts": { "products": { "right": { "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 }, "left": { "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 } }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "products": { "right": { "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 }, "left": { "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 } }, "issueDate": "Example String", "expirationDate": "Example String" } }, "options": { "contactsSuggestion": { "jobId": "Example String" }, "contactsPrescriptionVerification": { "jobId": "Example String" }, "contactsPrescriptionIssuance": { "jobId": "Example String", "sendText": true, "sendEmail": true, "buyLink": true }, "contactsFulfillment": { "jobId": "Example String" }, "wait": 40 }, "tags": [ { "name": "Example String", "value": "Example String" } ] } } ], "tags": [ { "name": "Example String", "value": "Example String" } ] }
Response sample
{ "data": { "orderId": "Example String", "status": "Example String" } }
Deprecation reason
Use verifyContactsPrescription.
Submit a contact prescription verification request
Arguments
patient
Patient information
doctor
String
The doctor ID from the doctors query (conditionally required if doctor is not set)
doctor
Doctor details (conditionally required if doctorId is not set)
products
Ordered products
prescriptions
Prescriptions pertinent to the ordered products (conditionally required if fileIds is not set)
file
[String]
File IDs from uploadFile for flat files containing prescription information (conditionally required if prescriptions is not set)
tags
[String]
Optional list of tags used to correlate this request with other systems
Return type
Contactid
String!,non-null
Unique ID for this request
status
Current request status
expiration
String
Prescription expiration date if it is available
comments
String
Comments entered by Doctor and/or Visibly
updated
String!,non-null
Last date and time this request was updated
Mutation sample
mutation submitContactPrescriptionVerificationRequest(
$patient: PatientInput!
$doctorId: String
$doctor: DoctorInput
$products: [ContactProductInput]!
$prescriptions: [ContactProductInput]
$fileIds: [String]
$tags: [String]
) {
submitContactPrescriptionVerificationRequest(
patient: $patient
doctorId: $doctorId
doctor: $doctor
products: $products
prescriptions: $prescriptions
fileIds: $fileIds
tags: $tags
) {
id
status
expirationDate
comments
updatedAt
}
}Variables
{ "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "doctorId": "Example String", "doctor": { "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" }, "products": [ { "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 } ], "prescriptions": [ { "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 } ], "fileIds": [ "Example String" ], "tags": [ "Example String" ] }
Response sample
{ "data": { "id": "Example String", "status": "NEW", "expirationDate": "Example String", "comments": "Example String", "updatedAt": "Example String" } }
Start a workflow utilizing one or more Visibly services
Arguments
contacts
Optional prescribed and ordered contacts
glasses
Optional prescribed and ordered glasses
patient
Optional patient information
tags
Optional List of tags used to correlate this vision test with other systems
Return type
Sessionlaunch
String!,non-null
The launch URL for the vision test
job
String
The job ID for the vision-test job (if applicable, simulation support only)
Mutation sample
mutation startVisionTest(
$contacts: ContactsInput
$glasses: GlassesInput
$patient: PatientInput
$tags: [TagInput]
) {
startVisionTest(
contacts: $contacts
glasses: $glasses
patient: $patient
tags: $tags
) {
launchUrl
jobId
}
}Variables
{ "contacts": { "products": { "right": { "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 }, "left": { "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 } }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "products": { "right": { "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 }, "left": { "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 } }, "issueDate": "Example String", "expirationDate": "Example String" } }, "glasses": { "lenses": { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "frame": { "sku": "Example String" }, "prescription": { "fileId": "Example String", "prescriptionId": "Example String", "doctor": { "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" }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "corrections": [ { "right": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "left": { "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } }, "type": "DEMO", "material": "CR39", "quality": "STANDARD", "color": "Example String", "edge": "POLISH", "addons": "Example String", "focus": "BIFOCAL", "sphere": "Example String", "cylinder": "Example String", "axis": "Example String", "addition": "Example String", "pupillaryDistance": { "intermediate": 40, "near": 40, "distance": 40 }, "segmentHeight": "Example String", "prism": { "horizontal": { "power": "Example String", "direction": "IN" }, "vertical": { "power": "Example String", "direction": "UP" } } } ], "issueDate": "Example String", "expirationDate": "Example String" } }, "patient": { "patientId": "Example String", "firstName": "Example String", "middleName": "Example String", "lastName": "Example String", "dateOfBirth": "Example String", "phoneNumber": "Example String", "email": "Example String", "address": "Example String", "address2": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String", "schedulerLink": "Example String" }, "tags": [ { "name": "Example String", "value": "Example String" } ] }
Response sample
{ "data": { "launchUrl": "Example String", "jobId": "Example String" } }