Products

List all product types

get

Returns all available diagnostic test categories (e.g., Blood Tests, DNA Tests)

Authorizations

BasicAuth

AuthorizationstringRequired

Responses

200

Successfully retrieved product types

application/json

descriptionstringOptional

idinteger · int64Optional

namestringOptional

401

Unauthorized - invalid credentials

application/json

500

Internal server error

application/json

get

/products

HTTPcURLJavaScriptPython

GET /products HTTP/1.1
Host: vantage.tryterra.co
Authorization: Basic username:password
Accept: */*

[
  {
    "description": "text",
    "id": 1,
    "name": "text"
  }
]

Get products by type ID

get

Returns all products within a specific product type category

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

idinteger · min: 1Required

Product Type ID

Responses

200

Successfully retrieved products

application/json

availabilityinteger · enumOptionalPossible values:

basePriceCentsinteger · int32Optional

currencyinteger · enumOptionalPossible values:

descriptionstringOptional

idinteger · int64Optional

namestringOptional

productTypeIDinteger · int64Optional

supplierIDinteger · int32Optional

400

Invalid product type ID format

application/json

401

Unauthorized - invalid credentials

application/json

404

No product types were found

application/json

500

Internal server error

application/json

get

/products/{id}

HTTPcURLJavaScriptPython

GET /products/{id} HTTP/1.1
Host: vantage.tryterra.co
Authorization: Basic username:password
Accept: */*

[
  {
    "availability": 0,
    "basePriceCents": 1,
    "currency": 0,
    "description": "text",
    "id": 1,
    "images": [
      {
        "altText": "text",
        "displayOrder": 1,
        "height": 1,
        "id": 1,
        "productID": 1,
        "url": "text",
        "variantID": 1,
        "width": 1
      }
    ],
    "modelDescriptiveAttrs": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text",
    "productTypeID": 1,
    "supplierID": 1,
    "variants": [
      {
        "availableCollectionTypes": [
          1
        ],
        "currency": 1,
        "descriptiveAttrsOverride": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": 1,
        "images": [
          {
            "altText": "text",
            "displayOrder": 1,
            "height": 1,
            "id": 1,
            "productID": 1,
            "url": "text",
            "variantID": 1,
            "width": 1
          }
        ],
        "priceCents": 1,
        "productExternalSKU": "text",
        "productID": 1,
        "productTypeID": 1,
        "supplierID": 1,
        "variantAvailability": 1,
        "variantDefiningAttrs": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "variantName": "text"
      }
    ]
  }
]

Get product variants by product ID

get

Returns all available variants/options for a specific diagnostic test product (e.g., different panel sizes, customizations)

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

idinteger · min: 1Required

Product ID

Responses

200

Successfully retrieved variants

application/json

availableCollectionTypesinteger · int32[]Optional

currencyinteger · int32Optional

idinteger · int64Optional

priceCentsinteger · int32Optional

productExternalSKUstringOptional

productIDinteger · int64Optional

productTypeIDinteger · int64Optional

supplierIDinteger · int32Optional

variantAvailabilityinteger · int32Optional

variantNamestringOptional

400

Invalid product ID format

application/json

401

Unauthorized - invalid credentials

application/json

404

No product variants were found

application/json

500

Internal server error

application/json

get

/products/{id}/variants

HTTPcURLJavaScriptPython

GET /products/{id}/variants HTTP/1.1
Host: vantage.tryterra.co
Authorization: Basic username:password
Accept: */*

[
  {
    "availableCollectionTypes": [
      1
    ],
    "currency": 1,
    "descriptiveAttrsOverride": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": 1,
    "images": [
      {
        "altText": "text",
        "displayOrder": 1,
        "height": 1,
        "id": 1,
        "productID": 1,
        "url": "text",
        "variantID": 1,
        "width": 1
      }
    ],
    "priceCents": 1,
    "productExternalSKU": "text",
    "productID": 1,
    "productTypeID": 1,
    "supplierID": 1,
    "variantAvailability": 1,
    "variantDefiningAttrs": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "variantName": "text"
  }
]