Skip to main content

list-catalog-products

List the products that belong to one specific GPA catalog. Use when you have a catalog id (from list-catalogs) and want the products inside it. Supports the same paging, search, sort, and product filters as list-products, scoped to the given catalog.

This lists products the caller owns within the catalog — it is not a buyer-facing browse of another company's catalog.

Company-scoped callers are auto-scoped. Host / NetworkAdmin callers must pass companyId.

Tool Name

datasync_catalog_list-products

Credential Required

X-DataSync-API-Key — your GPA Personal Access Token (PAT)

Parameters

ParameterTypeRequiredDescription
request.catalogIdstringYesThe catalog's GUID id whose products to list.
request.pageinteger | nullNo1-based page number. Omit for the first page.
request.pageSizeinteger | nullNoPage size (max 1000). Omit for backend default.
request.searchstring | nullNoFree-text search across product name and SKU.
request.sortBystring | nullNoField to sort by.
request.sortDescboolean | nullNoSort descending when true.
request.statusstring | nullNoFilter by lifecycle status: Active, Draft, or Archived.
request.productCategoryGlobalstring | nullNoFilter by global product-category code.
request.currencyCodeIsostring | nullNoFilter by ISO currency code (e.g. USD).
request.priceFromnumber | nullNoMinimum selling price (inclusive).
request.priceTonumber | nullNoMaximum selling price (inclusive).
request.stockFrominteger | nullNoMinimum available quantity (inclusive).
request.stockTointeger | nullNoMaximum available quantity (inclusive).
request.skuInternalIdentifierstring | nullNoFilter by internal SKU identifier.
request.companyIdstring | nullNoTarget company GUID. Required for Host / NetworkAdmin callers; ignored for company-scoped callers.

Response

Returns a page of products plus pagination totals.

{
"totalCount": 124,
"totalPages": 2,
"products": [
{
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Men's Polo Shirt",
"skuInternalIdentifier": "SKU-POLO-M-BLU",
"status": "Active",
"productCategoryGlobal": "Apparel",
"price": 29.99,
"currencyCodeIso": "USD",
"availableQuantity": 500
}
]
}

Example Call

{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "datasync_catalog_list-products",
"arguments": {
"request": {
"catalogId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"status": "Active",
"search": "polo"
}
}
}
}

Example Prompts

  • What products are in catalog X?
  • List active products in the Apparel Spring 2026 catalog
  • Find polo shirts in my spring catalog

See Also