Catalog API

Manage your products programmatically using the Catalog API.

The Catalog API enables you to create, retrieve, and manage products. You can also configure individual items as well as item groups through the API.

Additionally, you can define parameters and parameter groups, and manage pricing with price lists. You can also create custom templates and product variants. The API also includes endpoints for managing product media, documents, listings, and terms and conditions.

Try APIDownload API

Core Concepts

The Catalog API is built around the following core resources:

• Authorization - Represents the permissions and credentials that are required for interactions between sellers and vendors in the scope of a product.

• Document - Used to upload product documentation (via an online link or file) to the product object.

• Item - Represent the individual stock-keeping units (SKUs) or transactable element of a product. Items are shown as a line item in an order.

• Item group - Represents a group of items.

• Listing - Represents a business entity that aligns a product with a specific SoftwareOne seller.

• Media - Enables vendors to add, view, or delete media from the product object.

• Product - Represents a collection of items and their associated parameters organized into a unified group.

• Parameter - Allows vendors to define additional information that must be collected from and shared with the client, enabling the client to self-serve within the SoftwareOne Marketplace.

• Parameter group - Represents a group of parameters.

• Pricelist - Includes key pricing details such as sales and purchase prices, enabling vendors and operations to effectively manage and apply different price points for product items.

• Pricing policy - Defines client-specific markup and pricing rules based on negotiated terms and special agreements.

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.

Refer to the following capability matrix to see which roles are authorized to perform specific operations within each collection:

Authorization

Capability	Client	Vendor	Operations
List authorizations	✅	✅	✅
Get authorization	✅	✅	✅
Create authorization	❌	❌	✅
Update authorization	❌	❌	✅
Delete authorization	❌	❌	✅

Documents

Capability	Client	Vendor	Operations
List documents	✅	✅	✅
Get document	✅	✅	✅
Create document	❌	✅	❌
Update document	❌	✅	✅
Delete document	❌	✅	✅
Mark document for review	❌	✅	❌
Publish document	❌	❌	✅
Unpublish document	❌	✅	✅

Items

Capability	Client	Vendor	Operations
List items	✅	✅	✅
Get item	✅	✅	✅
Create item	❌	✅	❌
Update item by ID	❌	✅	❌
Delete item	❌	✅	✅
Mark item for review	❌	✅	❌
Publish item	❌	❌	✅
Unpublish item	❌	✅	✅

Item Group

Capability	Client	Vendor	Operations
List item groups	✅	✅	✅
Get item group	✅	✅	✅
Create item group	❌	✅	❌
Update item group	❌	✅	❌
Delete item group	❌	✅	✅

Listings

Capability	Client	Vendor	Operations
List all listings	✅	✅	✅
Get listing	✅	✅	✅
Create listing	❌	❌	✅
Update listing	❌	❌	✅
Delete listing	❌	❌	✅

Media

Capability	Client	Vendor	Operations
List product media	✅	✅	✅
Get product media	✅	✅	✅
Create product media	❌	✅	❌
Update product media	❌	✅	❌
Delete product media	❌	✅	✅
Mark a media for review	❌	✅	❌
Publish a media for product	❌	✅	✅
Unpublish a media for product	❌	✅	✅

Parameters

Capability	Client	Vendor	Operations
List parameters for a product	✅	✅	✅
Get parameter	✅	✅	✅
Create parameter	❌	✅	❌
Update parameter	❌	✅	❌
Delete parameter	❌	✅	✅

Parameters Groups

Capability	Client	Vendor	Operations
List parameter groups	✅	✅	✅
Get parameter group	✅	✅	✅
Create parameter group	❌	✅	❌
Update parameter group	❌	✅	❌
Delete parameter group	❌	✅	✅

Price Lists

Capability	Client	Vendor	Operations
List price lists	✅	✅	✅
Get price list	✅	✅	✅
Create price list	❌	✅	✅
Update price list	❌	✅	✅
Delete price list	❌	✅	✅
List price list items	✅	✅	✅
Get price list items	✅	✅	✅
Update price list items	❌	✅	✅

Pricing Policy

Capability	Client	Vendor	Operations
List pricing policies	❌	❌	✅
Get pricing policy	✅	❌	✅
Create pricing policy	✅	❌	✅
Update pricing policy	❌	❌	✅
Delete pricing policy	❌	❌	✅
Activate pricing policy	❌	❌	✅
Disable pricing policy	❌	❌	✅
List of pricing policy attachments	❌	❌	✅
Get pricing policy attachment	❌	❌	✅
Create pricing policy attachment	❌	❌	✅
Update pricing policy attachment	❌	❌	✅
Delete pricing policy attachment	❌	❌	✅

Product

Capability	Client	Vendor	Operations
List products	✅	✅	✅
Get product	✅	✅	✅
Create product	❌	✅	❌
Update product by ID	❌	✅	❌
Delete product	❌	✅	✅
Mark product for review	❌	✅	❌
Publish product	❌	❌	✅
Unpublish product	❌	✅	✅
Update product settings	❌	✅	❌

Product Templates

Capability	Client	Vendor	Operations
List product templates	✅	✅	✅
Get product template	✅	✅	✅
Create product template	❌	✅	❌
Update product template	❌	✅	❌
Delete product templates	❌	✅	❌

Terms

Capability	Client	Vendor	Operations
List terms	✅	✅	✅
Get terms	✅	✅	✅
Create terms	❌	✅	✅
Update terms	❌	✅	✅
Delete terms	❌	✅	✅
Mark terms for review	❌	✅	❌
Publish terms	❌	❌	✅
Unpublish terms	❌	✅	✅

Units of Measure

Capability	Client	Vendor	Operations
List units of measure	❌	✅	✅
Get units of measure	❌	✅	✅
Create units of measure	❌	❌	✅
Update units of measure	❌	❌	✅

Variant

Capability	Client	Vendor	Operations
List variant	✅	✅	✅
Get variant	✅	✅	✅
Create variant	❌	✅	✅
Update variant	❌	✅	✅
Delete variant	❌	✅	✅
Mark variant for review	❌	✅	❌
Publish variant	❌	❌	✅
Unpublish variant	❌	✅	✅