Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

GET /api/v2/orders/{orderIdentifier}/pick

This endpoint is used to check the required items for Lens/Frame Pick Verification

image-20240111-165137.png

Accepts

  • An order identifier, which can be the order number, tray number, or purchase order number

    • This order can be retrieved using 72544, 337178, or Example

    • Tray numbers can only be used to look up active orders

    • If lookup is done by po number then you must be using unique values in this field

Returns

Success

On a successful request the pick information for the order will be returned

{
  "orderNumber": "228844",
  "trayNumber": "45478",
  "poNumber": "XYZ123",
  "rtLensPicked": true,
  "ltLensPicked": true,
  "framePicked": false,
  "framePartPicked": false,
  "frameSideShieldPicked": false,
  "misc1Picked": false,
  "misc2Picked": false,
  "warehouse": "DEFAULT",
  "pickAllowed": false,
  "pickRejectReason": "Order already picked",
  "rtOPC": "0209448281",
  "ltOPC": "0209448281",
  "frameUPC": null,
  "frameSKU": null,
  "framePartSKU": null,
  "frameSideShieldSKU": null,
  "misc1SKU": null,
  "misc2SKU": null
}

Property

Description

orderNumber

string

The identifier for the order

trayNumber

string

The tray number the order is attached to

poNumber

string

Job reference (PO NUM field)

rtLensPicked

boolean

True if lens pick verification has been performed for the right lens for this order

ltLensPicked

boolean

True if lens pick verification has been performed for the left lens for this order

framePicked

boolean

True if frame pick verification has been performed for the frame for this order

framePartPicked

boolean

True if frame pick verification has been performed for the frame part for this order

frameSideShieldPicked

boolean

True if frame pick verification has been performed for the side shield for this order

misc1Picked

boolean

True if frame pick verification has been performed for the first miscellaneous item for this order

misc2Picked

boolean

True if frame pick verification has been performed for the second miscellaneous itefor this order

warehouse

string

The warehouse the order is associated with. Currently always “DEFAULT”.

pickAllowed

boolean

If true, there is at least one item attached to the order that the system will accept pick verification for

pickRejectReason

string|null

If pickAllowed is false, this will explain why. Picking is disallowed if:

  • The order is flagged for deletion

  • The order is not valid

  • The order is a stock order

  • The order is an addon order and the lab is not supplying the frame

  • The order is completed

  • The order is on hold

  • All items have already been picked

rtOPC

string|null

If the order requires a right lens this will be the OPC of the stock item

ltOPC

string|null

If the order requires a left lens this will be the OPC of the stock item

frameUPC

string|null

If the order requires a frame this will be the UPC of the stock item

frameSKU

string|null

If the order requires a frame this will be the SKU of the stock item

framePartSKU

string|null

If the order requires a frame part this will be the SKU of the stock item

frameSideShieldSKU

string|null

If the order requires a side shield this will be the SKU of the stock item

misc1SKU

string|null

If the order requires a miscellaneous this will be the SKU of the stock item

misc2SKU

string|null

If the order requires a second miscellaneous this will be the SKU of the stock item

Error

  • If the order number does not exist in Rx-Universe an HTTP 404 code will be returned with an error

    {
      "error": "No record found",
      "details": [
        "Provided: bad order"
      ]
  • No labels