List Catalog Items

import requests
url = "https://dev-api.truemed.com/api/v1/product_catalog/items/list"
payload = {}
headers = {
    "x-truemed-api-key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

{
  "data": [
    {
      "created_at": "2024-01-15T09:30:00Z",
      "name": "HydroFlow Insulated Water Bottle",
      "sku": "HF-WB-750-BL",
      "description": "Reusable stainless steel water bottle, BPA-free and insulated to keep drinks cold for 24 hours.",
      "eligibility": "eligible",
      "gtin": "00380012345678",
      "image_urls": [
        "https://cdn.truemed.com/images/products/water-bottle-12345.jpg"
      ],
      "metadata": "color: blue; capacity: 750ml",
      "product_id": "prod-987654321",
      "reviewed_at": "2024-01-20T14:45:00Z",
      "url": "https://store.truemed.com/products/hydroflow-insulated-water-bottle"
    }
  ],
  "pagination": {
    "count": 1,
    "current_page": 1,
    "last_page": 1,
    "page_size": 30
  }
}

Lists catalog items for the authenticated merchant, including current HSA/FSA eligibility for each item. This endpoint is intended to complement the `Item Eligibility Updated` webhook: use the webhook to receive ongoing updates, and use this endpoint to enumerate items that were already categorized before webhook ingestion began (or to reconcile after a gap). Use `eligibility` to scope the response to a specific eligibility state, and `updated_after` to incrementally sync only items changed since the last poll.

import requests
url = "https://dev-api.truemed.com/api/v1/product_catalog/items/list"
payload = {}
headers = {
    "x-truemed-api-key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

{
  "data": [
    {
      "created_at": "2024-01-15T09:30:00Z",
      "name": "HydroFlow Insulated Water Bottle",
      "sku": "HF-WB-750-BL",
      "description": "Reusable stainless steel water bottle, BPA-free and insulated to keep drinks cold for 24 hours.",
      "eligibility": "eligible",
      "gtin": "00380012345678",
      "image_urls": [
        "https://cdn.truemed.com/images/products/water-bottle-12345.jpg"
      ],
      "metadata": "color: blue; capacity: 750ml",
      "product_id": "prod-987654321",
      "reviewed_at": "2024-01-20T14:45:00Z",
      "url": "https://store.truemed.com/products/hydroflow-insulated-water-bottle"
    }
  ],
  "pagination": {
    "count": 1,
    "current_page": 1,
    "last_page": 1,
    "page_size": 30
  }
}

Lists catalog items for the authenticated merchant, including current HSA/FSA eligibility for each item.

This endpoint is intended to complement the Item Eligibility Updated webhook: use the webhook to receive ongoing updates, and use this endpoint to enumerate items that were already categorized before webhook ingestion began (or to reconcile after a gap).

Use eligibility to scope the response to a specific eligibility state, and updated_after to incrementally sync only items changed since the last poll.

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Query parameters

pageintegerOptional

Optional field indicating which page to access. Defaults to 1.

page_sizeintegerOptional

Optional field indicating the number of records per page. Defaults to 30.

eligibilitystringOptional

Filter results to items whose eligibility matches the given value. Items that have not been reviewed yet are excluded when this filter is set.

updated_afterdatetimeOptional

Return only catalog items whose last update is at or after this ISO 8601 timestamp. Useful for incremental sync after Item Eligibility Updated webhooks.

Response

Successful response

datalist of objects

An array of catalog item objects for the current page.

paginationobject or null

A pagination object with information about the current page, page size, total count, and last page.

Errors

400

Bad Request Error

404

Not Found Error

405

Method Not Allowed Error

500

Internal Server Error

501

Not Implemented Error

1	import requests
2
3	url = "https://dev-api.truemed.com/api/v1/product_catalog/items/list"
4
5	payload = {}
6	headers = {
7	"x-truemed-api-key": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.get(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"data": [
3	{
4	"created_at": "2024-01-15T09:30:00Z",
5	"name": "HydroFlow Insulated Water Bottle",
6	"sku": "HF-WB-750-BL",
7	"description": "Reusable stainless steel water bottle, BPA-free and insulated to keep drinks cold for 24 hours.",
8	"eligibility": "eligible",
9	"gtin": "00380012345678",
10	"image_urls": [
11	"https://cdn.truemed.com/images/products/water-bottle-12345.jpg"
12	],
13	"metadata": "color: blue; capacity: 750ml",
14	"product_id": "prod-987654321",
15	"reviewed_at": "2024-01-20T14:45:00Z",
16	"url": "https://store.truemed.com/products/hydroflow-insulated-water-bottle"
17	}
18	],
19	"pagination": {
20	"count": 1,
21	"current_page": 1,
22	"last_page": 1,
23	"page_size": 30
24	}
25	}