Skip to main content

Lab Test Packages and Properties

A test package is a predefined group of test properties that brands, retailers, suppliers, and lab agencies can use to streamline lab test requests. Selecting a test package ensures that all associated test properties are included in the request, reducing manual effort and the risk of omissions.

Test properties define the specific test methods applied during lab tests. Configuring and managing test properties ensures compliance with the latest standards and testing requirements.

The Lab Test Package and Lab Test Property API endpoints enable brands and retailers to manage lab test package and property data programmatically, while allowing third-party (3P) labs to retrieve test package and property details directly from the platform, reducing dependency on manual document sharing. This integration ensures that labs always reference the latest test requirements, reducing errors and improving efficiency.

Precondition​

Generate an API key for your organization and use it to authenticate your API requests.

Get Lab Test Package or Property Details and List​

The Get Lab Test Package Detail and Get Lab Test Property Detail API endpoints retrieve detailed information about a specific lab test package and test property, respectively.

The List Lab Test Packages and List Lab Test Properties API endpoints retrieve a list of lab test packages and test properties, respectively.

To retrieve shared test package or property data from a different or associated organization, you must specify the dataProvider query parameter or the local ID of the organization that owns the data, provided that sharing permissions are set.

If no data provider parameter is specified, the API returns only the data owned by your organization. Access control is enforced by data owner through sharing settings, which determine whether data is fully shared, restricted to selected organizations, or entirely private.

Create or Update Lab Test Package or Property Details​

The Create Lab Test Package and Create Lab Test Property API endpoints create a new lab test package and test property via API, respectively.

The Update Lab Test Package and Update Lab Test Property API endpoints update an existing test package or test property, respectively.

Only the owning organization can create or update lab test packages and test properties via API, ensuring data integrity and controlled modifications. Third-party labs cannot create or update test packages or properties, as the data provider parameter is not applicable for these operations.