Skip to main content

LabTestProductSampleWriteList

Samples of this Product, each with its own details. Required when the Lab Test Form includes the Sample Information component.

Send the complete list, not a patch. Samples are matched by sampleName, and any stored sample missing from the list is deleted. sampleSize then becomes the sample count and unit the samples' shared unit, overriding both sent on the Product.

sampleName must be unique within the Product, and all samples must share one unit.

  • Array [
    • sampleNamestringrequired

    Sample name. Must not be blank (surrounding whitespace is trimmed) and must be unique within the Product.

    Possible values: <= 255 characters

    Example: Lot A
    lotBatchNumberstring

    Lot / batch number

    Possible values: <= 255 characters

    Example: LB-2026-001
    colorstring

    Color

    Possible values: <= 255 characters

    Example: Navy
    sampleAmountnumbernullable

    Sample amount

    Possible values: >= 0

    Example: 2
    unitstring

    Unit of the sample amount. All samples of a Product must share the same unit.

    Possible values: <= 255 characters

    Example: pcs
    sampleDescriptionstring

    Sample description

    Example: Front panel swatch
  • ]
    • LabTestProductSampleWriteList
    [
      {
        "sampleName": "Lot A",
        "lotBatchNumber": "LB-2026-001",
        "color": "Navy",
        "sampleAmount": 2,
        "unit": "pcs",
        "sampleDescription": "Front panel swatch"
      }
    ]