Beta Order Lab Shipment

Description

order-lab-shipment
Order Lab Shipment

A shipment from a lab associated with an order.

Properties

Property Description
created read-only
string
date-time

The creation date of this shipment record.
id read-only
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
labOrderNumber nullable
string

The order number created by the lab for processing this order, this may match thirdPartyOrderId on the order.
labReference nullable
string

Text field used by lab to reference the unique identifier the order was submitted to the lab with. Optional reference value that may be used by the lab.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
shipDate
string
date-time

The date when this shipment was reported as shipped.
trackingId nullable
string

The shipment tracking ID, used for tracking the shipment.
trackingUrl nullable
string

The shipment tracking URL, used for tracking the shipment. If the trackingUrl is not provided and a trackingId is provided, we may attempt to build a tracking URL with the trackingId.
type
string
enum
  • order-lab-shipment

The model type for the response object.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A shipment from a lab associated with an order.",
  "properties": {
    "created": {
      "description": "The creation date of this shipment record.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Id"
        },
        {
          "readOnly": true
        }
      ]
    },
    "labOrderNumber": {
      "description": "The order number created by the lab for processing this\norder, this may match `thirdPartyOrderId` on the order.",
      "nullable": true,
      "type": "string"
    },
    "labReference": {
      "description": "Text field used by lab to reference the unique identifier the\norder was submitted to the lab with. Optional reference value\nthat may be used by the lab.",
      "nullable": true,
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "shipDate": {
      "description": "The date when this shipment was reported as `shipped`.",
      "format": "date-time",
      "type": "string"
    },
    "trackingId": {
      "description": "The shipment tracking ID, used for tracking the shipment.",
      "nullable": true,
      "type": "string"
    },
    "trackingUrl": {
      "description": "The shipment tracking URL, used for tracking the shipment. If the `trackingUrl` is not provided and a `trackingId` is provided, we may attempt to build a tracking URL with the `trackingId`.",
      "nullable": true,
      "type": "string"
    },
    "type": {
      "description": "The model type for the response object.",
      "enum": [
        "order-lab-shipment"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "shipDate"
  ],
  "title": "Order Lab Shipment",
  "type": "object",
  "x-beta": true
}
Order Lab Shipment