Public Products API Overview

You can programmatically access your product catalog using the Public Products API to integrate product data with external systems.

API Purpose

• Access product data: Retrieve details about products configured in your Installer.com account.
• Integrate with external systems: Sync product information with e-commerce platforms, inventory management, or custom applications.

Available Parameters

• slugOrId: Filter products by a unique identifier or slug.
• pageSize: Control the number of results returned per page.
• page: Specify the page number for paginated results.
• phrase: Search for products containing a specific keyword or phrase.
• productTypes: Filter by product categories.
• productTags: Filter by specific product tags (AND logic).
• orProductTags: Filter by any of the specified product tags (OR logic).
• excludeProductIds: Exclude specific products from the results.

Example Usage

• Retrieve all products: Make a request without any parameters to get your entire product catalog.
• Search for specific products: Use phrase to find products by name or description.
• Filter by type or tag: Combine productTypes or productTags to narrow down results.

Response Structure

• Product details: Each product entry includes its name, description, pricing, and other relevant attributes.
• Pagination metadata: Information about the total number of products and current page.

Need help? Contact Installer.com support.