Beta Order Lab Shipment Collection

OpenAPI Schema

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

{
  "description": "A collection of order lab shipments.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "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
      },
      "title": "Order Lab Shipment",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The model type for the list response object.",
      "enum": [
        "order-lab-shipment-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Order Lab Shipment Collection",
  "type": "object",
  "x-beta": true
}