> For the complete documentation index, see [llms.txt](https://docs.platform.softwareone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platform.softwareone.com/developer-resources/rest-api/product-catalog-api.md).
# Product Catalog API
The Public Catalog API provides access to the SoftwareOne Marketplace product catalog.
It exposes software product listings, vendor profiles, and classification data (categories, industries, and segments) through a RESTful interface, allowing you to:
* Browse the full range of software products, vendors, and categories available on the SoftwareOne Marketplace.
* Create and manage vendor profiles.
* Create and manage product profiles.
* Publish and unpublish catalog entries.
* Manage categories, industries, and segments used to organize the catalog.
Access to this API is role-based. Clients can view published items, vendors can manage their own vendor and product profiles, and SoftwareOne Operations has full access to all entities and states.
## Before you start
Review the shared API docs before you work with public catalog resources.
* [Authentication](/developer-resources/rest-api.md)
* [URL structure](/developer-resources/api-usage-and-reference/url-structure.md)
* [Error handling](/developer-resources/api-usage-and-reference/errors-handling.md)
## Core resources
The Program API is built around the following core resources:
* **Vendor profile** – Represents a `vendor` in the public catalog.
* **Product profile** – Represents a `product` in the public catalog.
* **Category** – Represents a software category or sub-category, used to classify software in the public catalog.
* **Industry** – Represents specific business sectors or markets that products are designed to serve.
* **Segment** – Categorizes `products` based on the size and type of organizations for which they are most suitable.
## Browse collections
The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a `client`, `vendor`, or `operations` user.
Use the following links to jump to the collection you need:
* [Vendor Profile](#vendor-profile)
* [Product Profile](#product-profile)
* [Category](#category)
* [Industry](#industry)
* [Segment](#segment)
### Vendor Profile
View Vendor Profile operations
| Operation | Method | Description | Access |
| ------------------------------------------------------------------------------------------------------------------------ | ------ | ---------------------------------------------- | --------------------------- |
| [Create vendor profile](/developer-resources/rest-api/product-catalog-api/vendor-profile/create-vendor-profile.md) | POST | Creates a new vendor profile in draft. | ops |
| [List vendor profiles](/developer-resources/rest-api/product-catalog-api/vendor-profile/list-vendor-profiles.md) | GET | Gets vendor profiles collection. | public, vendor, client, ops |
| [Get vendor profile by id](/developer-resources/rest-api/product-catalog-api/vendor-profile/get-vendor-profile.md) | GET | Gets vendor profile details. | public, vendor, client, ops |
| [Publish vendor profile](/developer-resources/rest-api/product-catalog-api/vendor-profile/publish-vendor-profile.md) | POST | Modifies vendor profile status to published. | vendor, ops |
| [Unpublish vendor profile](/developer-resources/rest-api/product-catalog-api/vendor-profile/unpublish-vendor-profile.md) | POST | Modifies vendor profile status to unpublished. | vendor, ops |
| [Update vendor profile](/developer-resources/rest-api/product-catalog-api/vendor-profile/update-vendor-profile.md) | PUT | Modifies an existing vendor profile. | vendor, ops |
| [Delete vendor profile](/developer-resources/rest-api/product-catalog-api/vendor-profile/delete-vendor-profile.md) | DELETE | Modifies vendor profile status to deleted. | ops |
### Product Profile
View Product Profile operations
| Operation | Method | Description | Access |
| --------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------------------------------- | --------------------------- |
| [Create product profile](/developer-resources/rest-api/product-catalog-api/product-profile/create-product-profile.md) | POST | Creates a new product profile in draft status. | ops |
| [List product profiles](/developer-resources/rest-api/product-catalog-api/product-profile/list-product-profiles.md) | GET | Gets product profiles collection. | public, vendor, client, ops |
| [Get product profile by id](/developer-resources/rest-api/product-catalog-api/product-profile/get-product-profile.md) | GET | Gets product profile details. | public, vendor, client, ops |
| [Publish product profile](/developer-resources/rest-api/product-catalog-api/product-profile/publish-product-profile.md) | POST | Modifies product profile status to published. | vendor, ops |
| [Unpublish product profile](/developer-resources/rest-api/product-catalog-api/product-profile/unpublish-product-profile.md) | POST | Modifies product profile status to unpublished. | vendor, ops |
| [Update product profile](/developer-resources/rest-api/product-catalog-api/product-profile/update-product-profile.md) | PUT | Modifies an existing product profile. | vendor, ops |
| [Delete product profile](/developer-resources/rest-api/product-catalog-api/product-profile/delete-product-profile.md) | DELETE | Modifies product profile status to deleted. | ops |
### Category
View Category operations
| Operation | Method | Description | Access |
| ------------------------------------------------------------------------------------------------------ | ------ | ---------------------------------------------------------------------------------------- | --------------------------- |
| [Create category](/developer-resources/rest-api/product-catalog-api/category/create-category.md) | POST | Creates a new category. | ops |
| [List categories](/developer-resources/rest-api/product-catalog-api/category/list-categories.md) | GET | Gets list of categories. | public, vendor, client, ops |
| [Get category by id](/developer-resources/rest-api/product-catalog-api/category/get-category.md) | GET | Gets category details. | public, vendor, client, ops |
| [Publish category](/developer-resources/rest-api/product-catalog-api/category/publish-category.md) | POST | Publishes a category and updates it from draft to published (active). | ops |
| [Unpublish category](/developer-resources/rest-api/product-catalog-api/category/unpublish-category.md) | POST | Unpublishes a category and updates it from published (active) to unpublished (disabled). | ops |
| [Update category](/developer-resources/rest-api/product-catalog-api/category/update-category.md) | PUT | Modifies a category. | ops |
| [Delete category](/developer-resources/rest-api/product-catalog-api/category/delete-category.md) | DELETE | Modifies the status of a category to deleted. | ops |
### Industry
View Industry operations
| Operation | Method | Description | Access |
| ------------------------------------------------------------------------------------------------------ | ------ | ----------------------------------------------------------------------------------------- | --------------------------- |
| [Create industry](/developer-resources/rest-api/product-catalog-api/industry/create-industry.md) | POST | Creates a new industry. | ops |
| [List industries](/developer-resources/rest-api/product-catalog-api/industry/list-industries.md) | GET | Gets a list of industries. | public, vendor, client, ops |
| [Get industry by id](/developer-resources/rest-api/product-catalog-api/industry/get-industry.md) | GET | Gets specific industry details. | public, vendor, client, ops |
| [Publish industry](/developer-resources/rest-api/product-catalog-api/industry/publish-industry.md) | POST | Publishes an industry and updates it from draft to published (active). | ops |
| [Unpublish industry](/developer-resources/rest-api/product-catalog-api/industry/unpublish-industry.md) | POST | Unpublishes an industry and updates it from published (active) to unpublished (disabled). | ops |
| [Modify industry](/developer-resources/rest-api/product-catalog-api/industry/modify-industry.md) | PUT | Modifies an industry. | ops |
| [Delete industry](/developer-resources/rest-api/product-catalog-api/industry/delete-industry.md) | DELETE | Deletes an industry. | ops |
### Segment
View Segment operations
| Operation | Method | Description | Access |
| --------------------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------- | --------------------------- |
| [Create segment](/developer-resources/rest-api/product-catalog-api/segment/create-segment.md) | POST | Creates a new segment. | ops |
| [List segments](/developer-resources/rest-api/product-catalog-api/segment/list-segments.md) | GET | Gets a list of segments. | public, vendor, client, ops |
| [Get segment by id](/developer-resources/rest-api/product-catalog-api/segment/get-segment.md) | GET | Gets specific segment details. | public, vendor, client, ops |
| [Publish segment](/developer-resources/rest-api/product-catalog-api/segment/publish-segment.md) | POST | Publishes a segment and updates it from draft to published (active). | ops |
| [Unpublish segment](/developer-resources/rest-api/product-catalog-api/segment/unpublish-segment.md) | POST | Unpublishes a segment and updates it from published (active) to unpublished (disabled). | ops |
| [Update segment](/developer-resources/rest-api/product-catalog-api/segment/update-segment.md) | PUT | Modifies a segment. | ops |
| [Delete segment](/developer-resources/rest-api/product-catalog-api/segment/delete-segment.md) | DELETE | Deletes a segment. | ops |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.platform.softwareone.com/developer-resources/rest-api/product-catalog-api.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.