Authentication This endpoint requires bearer token authentication.
Your bearer token in the format Bearer <token>.
The email address of the user creating the order. Must exactly match the email address used to log in to the SpecCheck Dashboard.
Body Controls whether the order is saved as a draft or submitted to the lab. Possible enum values:
draft — Saves the order as a draft for review and finalization in the SpecCheck Dashboard.submit — Submits the order to the lab for fulfillment. The type of submission for this order. Possible enum values:
new — A new order.redo — A redo of a previous order.multi_pair — An additional pair submitted as part of a multi-pair order. The type of order. Must be one of the values in order_types returned by Retrieve Order Settings . Order type rx is always available; other order types vary by lab. The ID of the lab for this order.
The lab account number for this order.
The patient’s first name. The maximum length is 50 characters.
The patient’s last name. The maximum length is 50 characters.
The patient’s email address.
The patient’s phone number. The maximum length is 20 characters.
Mounting option for the order. Must be one of the values in mounting_options returned by Retrieve Order Settings . Required when order_type is rx. Lens configuration. Required when order_type is rx and mode is submit.
The ID of the lens style. Must be an id from the data array returned by List Lens Styles . The ID of the lens material. Must be an id from the data array returned by List Lens Materials . The ID of the lens color. Must be an id from the colors array returned by List Lens Addons . A list of coat IDs. Each value must be an id from the coats array returned by List Lens Addons . The lens tint for this order. Must be one of the values in tints returned by List Lens Addons . Instructions for the lens tint. Required when tint is provided. The maximum length is 250 characters.
The frame handling option. Must be one of the values in frame_handling_options returned by Retrieve Order Settings . The frame manufacturer. The maximum length is 50 characters.
The frame model. The maximum length is 50 characters.
The frame color. The maximum length is 50 characters.
Eye size, in millimeters. The value must be between 10 and 100.
Bridge size, in millimeters. The value must be between 10 and 100.
Temple length, in millimeters. The value must be between 100 and 200.
A measurement, in millimeters. The value must be between 10 and 100.
B measurement, in millimeters. The value must be between 10 and 100.
Lens effective diameter (ED), in millimeters. The value must be between 10 and 100.
Vertex distance, in millimeters. The value must be between 1 and 30.
Pantoscopic tilt, in degrees. The value must be between -20 and 20.
Wrap angle, in degrees. The value must be between 0 and 40.
The frame SKU. The maximum length is 50 characters.
Prescription details. Required when order_type is rx.
Left-eye prescription. When order_type is rx, at least one of left_eye or right_eye must be provided.
Right-eye prescription. When order_type is rx, at least one of left_eye or right_eye must be provided.
Show left_eye / right_eye
Sphere power, in diopters. The value must be between -30 and 30.
Interpupillary distance (IPD) for this eye, in millimeters. Must be provided as a monocular value (per eye), not a combined value. The value must be between 20 and 50.
Near (reading) interpupillary distance (IPD) for this eye, in millimeters. Must be provided as a monocular value (per eye), not a combined value. The value must be between 20 and 50.
Cylinder power, in diopters. The value must be between -20 and 20. Required when axis is provided.
Axis, in degrees. The value must be an integer from 1 to 180. Required when cylinder is provided.
Add power, in diopters. The value must be between 0.5 and 5. Required when seg_height is provided.
Segment height, in millimeters. The value must be between 0.5 and 50. Required when add is provided.
Optical center height, in millimeters. The value must be between 0.5 and 50.
Prism power, in prism diopters. The value must be between 0.01 and 50.
The prism direction. One of in or out.
Prism power, in prism diopters. The value must be between 0.01 and 50.
The prism direction. One of up or down.
A list of lab services for this order. Each value must be one of the values in services returned by Retrieve Order Settings . Free-text special instructions for the lab. The maximum length is 1,000 characters.
Details for a redo order. Required when submission_type is redo.
A description of why this order is being redone. The maximum length is 250 characters.
The identifier for the order being redone, such as an invoice number, tray number, or Rx number.
Details for a multi-pair order. Required when submission_type is multi_pair.
The identifier for the related order, such as an invoice number, tray number, or Rx number.
Shipping name and address.
Recipient name. The maximum length is 50 characters.
Address line 1, such as the street, PO Box, or company name.
Address line 2, such as the apartment, suite, unit, or building. Omit if unused.
City, district, suburb, town, or village.
State, county, province, or region (for the US, ISO 3166-2 subdivision code). Two letters; must be a US state or territory code the API allows. A two-letter country code (ISO 3166-1 alpha-2 ). Only US is supported. If omitted, defaults to US. Returns Returns an object with the order’s unique identifier and an optional url.
The unique identifier for the order.
The URL to review and finalize the order in the SpecCheck Dashboard. Present when mode is draft.
