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

• URL structure

• Error handling

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

• Product Profile

• Category

• Industry

• Segment

Vendor Profile

View Vendor Profile operations

Operation	Method	Description	Access
Create vendor profile	POST	Creates a new vendor profile in draft.	ops
List vendor profiles	GET	Gets vendor profiles collection.	public, vendor, client, ops
Get vendor profile by id	GET	Gets vendor profile details.	public, vendor, client, ops
Publish vendor profile	POST	Modifies vendor profile status to published.	vendor, ops
Unpublish vendor profile	POST	Modifies vendor profile status to unpublished.	vendor, ops
Update vendor profile	PUT	Modifies an existing vendor profile.	vendor, ops
Delete vendor profile	DELETE	Modifies vendor profile status to deleted.	ops

Product Profile

View Product Profile operations

Operation	Method	Description	Access
Create product profile	POST	Creates a new product profile in draft status.	ops
List product profiles	GET	Gets product profiles collection.	public, vendor, client, ops
Get product profile by id	GET	Gets product profile details.	public, vendor, client, ops
Publish product profile	POST	Modifies product profile status to published.	vendor, ops
Unpublish product profile	POST	Modifies product profile status to unpublished.	vendor, ops
Update product profile	PUT	Modifies an existing product profile.	vendor, ops
Delete product profile	DELETE	Modifies product profile status to deleted.	ops

Category

View Category operations

Operation	Method	Description	Access
Create category	POST	Creates a new category.	ops
List categories	GET	Gets list of categories.	public, vendor, client, ops
Get category by id	GET	Gets category details.	public, vendor, client, ops
Publish category	POST	Publishes a category and updates it from draft to published (active).	ops
Unpublish category	POST	Unpublishes a category and updates it from published (active) to unpublished (disabled).	ops
Update category	PUT	Modifies a category.	ops
Delete category	DELETE	Modifies the status of a category to deleted.	ops

Industry

View Industry operations

Operation	Method	Description	Access
Create industry	POST	Creates a new industry.	ops
List industries	GET	Gets a list of industries.	public, vendor, client, ops
Get industry by id	GET	Gets specific industry details.	public, vendor, client, ops
Publish industry	POST	Publishes an industry and updates it from draft to published (active).	ops
Unpublish industry	POST	Unpublishes an industry and updates it from published (active) to unpublished (disabled).	ops
Modify industry	PUT	Modifies an industry.	ops
Delete industry	DELETE	Deletes an industry.	ops

Segment

View Segment operations

Operation	Method	Description	Access
Create segment	POST	Creates a new segment.	ops
List segments	GET	Gets a list of segments.	public, vendor, client, ops
Get segment by id	GET	Gets specific segment details.	public, vendor, client, ops
Publish segment	POST	Publishes a segment and updates it from draft to published (active).	ops
Unpublish segment	POST	Unpublishes a segment and updates it from published (active) to unpublished (disabled).	ops
Update segment	PUT	Modifies a segment.	ops
Delete segment	DELETE	Deletes a segment.	ops