Preview

distributionCatalogProducts is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

distributionCatalogProducts

Consolidated catalog for the Distribution Catalog UI.

Returns exactly one node per product owned by the vendor. Each node is the product's PUBLISHED snapshot when one exists, and its WORKING (draft) snapshot otherwise — so name, logo, and branding always reflect what buyers currently see when the product is live, and reflect the draft when it is not.

Product.version identifies which snapshot a node came from ("PUBLISHED" or "WORKING"). Status badge display is left to the UI for v1 — derive from version, status, and distributionStatus on each node. Check version first: on a node whose version is "WORKING", distributionStatus is a stale working-document value and must not be used to render a badge.

Bundles and internal product types are always excluded.

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_CHANNEL_ADMIN

    ROLE_DEVELOPER

    ROLE_PARTNER

    Arguments

    vendorId ID

    Vendor whose catalog to browse. Defaults to the calling user's own account.

    searchText String

    Free-text, case-insensitive search over:

    • the effective (displayed) localized product name,
    • the product reference id (Product.id), matched as a prefix, and
    • the marketplace reference id (appMarketId), matched as a prefix. Null or blank applies no text filter.
    productType EnhancedProductType PREVIEW

    Restrict to a single product category.

    Reuses EnhancedProductType from the network catalog (PFM-5071) — the same UI taxonomy, including the WEB_APP-family variants (PRODUCT / ADD_ON / SSO_IMPORTED / REFERRAL) that are distinguished by flags rather than by type. Values are not redefined here.

    status [DistributionCatalogStatus!] PREVIEW

    Consolidated status values, OR'd together. Null or empty returns all statuses ("Show All"). Note that DISTRIBUTED and PENDING_APPROVAL products are also published, so selecting PUBLISHED together with either value widens the result set.

    manualIntegration Boolean

    When true, narrows the result to manual-integration products (type = WEB_APP_MANUAL_SETUP). Composes with productType rather than replacing it: productType: ADD_ON with manualIntegration: true returns manual-setup add-ons.

    singleSubscription Boolean

    When true, restrict to single-subscription products (usageType = SINGLE_USER).

    first Int

    Page size. Default 20, maximum 100.

    after String

    Cursor from pageInfo.endCursor for forward pagination.

    Return Fields

    ProductConnection! PREVIEW

    Interactive example

    This is an example query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.