Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The Product Profile object represents a product in the public catalog.
This object contains the following attributes:
id
string, core
The identifier of the product profile.
externalId
string
The identifier within an external system.
name
string, core
A user-friendly name of the product profile.
icon
string
The icon to be shown in grids and information cards.
shortDescription
string
A short description of the product.
longDescription
string
A long description of the product.
featured
bool
Indicates whether this product should be featured on the UI.
website
string
A URL to the vendor’s website.
linkedin
string
A URL to the vendor’s LinkedIn page.
facebook
string
A URL to the vendor’s Facebook page.
youtube
string
A URL to the vendor’s Facebook page.
xProfile
string
A URL to the vendor’s X page.
categories
object
Represents the that owns this object.
Example:
industries
object
Represents the that owns this object.
Example:
segments
object
Represents the that owns this object.
Example:
vendorProfiles
object
Represents the that owns this object.
Example:
platformProducts
object
Indicates that have been linked to this profile.
status
string
Indicates whether the product is draft, published, unpublished, or deleted.
audit
object
(Read-only) Represents the object.
revision
integer, core
The entity's revision number.
{
"id": "PRP-1671-3887",
"externalId": "arK9uX45",
"name": "Office",
"vendorProfile": {
"id": "VNP-1671-3887",
"icon": "/v1/public-catalog/vendor-profiles/VNP-1671-3887/icon",
"name": "Microsoft"
},
"shortDescription": "Enterprise productivity suite",
"longDescription": "Enterprise productivity suites are cloud-based software packages designed to streamline communication.",
"website": "https://www.microsoft.com/office",
"linkedin": "https://www.linkedin.com/microsoft-office",
"facebook": "https://www.facebook.com/microsoft-office",
"xProfile": "https://www.x.com/microsoft-office",
"youtube": "https://www.youtube.com/microsoft-office",
"termsLink": "https://info.here",
"featured": false,
"categories": [],
"industries": [],
"segments": [],
"vendorProfiles": [],
"platformProducts": [
{
"id": "PRD-0049-1332",
"name": "Microsoft Office",
"icon": "/v1/catalog/products/PRD-0049-1332/icon",
"revision": 2,
"externalIds": {
"operations": "123"
},
"status": "Published"
}
],
"status": "Published",
"icon": "/v1/public-catalog/product-profiles/PRP-1671-3887/icon",
"revision": 2,
"audit": {
"created": {
"at": "2024-04-08T06:30:05.807Z",
"by": {
"id": "USR-2172-2499",
"revision": 1,
"name": "John User"
}
},
"updated": {
"at": "2024-05-16T09:17:36.406Z",
"by": {
"id": "TKN-3836-7769",
"revision": 2,
"name": "My token"
}
},
"deleted": {
"at": "2024-05-17T09:17:36.406Z",
"by": {
"id": "TKN-3836-7769",
"revision": 3,
"name": "My token"
}
}
}
}{
"categories": [
{
"id": "CAT-1671-3887",
"name": "Development",
"revision": 1,
"status": "Published"
}
]
}{
"industries": [
{
"id": "IND-8249-7679",
"name": "Development",
"revision": 1,
"status": "Published"
}
]
}"segments": [
{
"id": "SEG-1671-3887",
"name": "Development",
"revision": 1,
"status": "Published"
}{
"vendorProfiles": [
{
"id": "VNP-1671-3887",
"icon": "/v1/public-catalog/vendor-profiles/VNP-1671-3887/icon",
"name": "Microsoft",
"status": "Draft"
}
]
}The Category object represents a software category or sub-category. It is used to classify software in the Public Catalog.
This object contains the following attributes:
id
string, core
(Read-only) An identifier for the category.
externalId
string
Identifier in the external system.
parentCategory
object
Represents the parent category. If null, then this is a top-level category.
name
string, core
A user-friendly name of the category.
icon
string, core
Icon to be shown on grids and info cards
description
string
A short description of the category
longDescription
string
A long description of the category
featured
bool
Indicates whether this product should be featured on the UI.
status
string, core
Indicates the status of the category. Allowed values are:
Draft
Published
Unpublished
Deleted
audit
object
(Read-only) Represents the audit object.
revision
integer, core
The entity's revision number.
{
"id": "CAT-1671-3887",
"externalId": "arK9uX45",
"name": "Development",
"parentCategory": {
"id": "CAT-1671-3886",
"name": "Productivity"
},
"description": "Software development tools",
"status": "Draft",
"revision": 2,
"audit": {
"created": {
"at": "2024-04-08T06:30:05.807Z",
"by": {
"id": "USR-2172-2499",
"revision": 1,
"name": "John User"
}
},
"updated": {
"at": "2024-05-16T09:17:36.406Z",
"by": {
"id": "TKN-3836-7769",
"revision": 2,
"name": "My token"
}
},
"deleted": {
"at": "2024-05-17T09:17:36.406Z",
"by": {
"id": "TKN-3836-7769",
"revision": 3,
"name": "My token"
}
}
}
}
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.
Review the shared API docs before you work with public catalog 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.
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:
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.
POST
Creates a new vendor profile in draft.
ops
GET
Gets vendor profiles collection.
public, vendor, client, ops
GET
Gets vendor profile details.
public, vendor, client, ops
POST
Modifies vendor profile status to published.
vendor, ops
POST
Modifies vendor profile status to unpublished.
vendor, ops
PUT
Modifies an existing vendor profile.
vendor, ops
DELETE
Modifies vendor profile status to deleted.
ops
POST
Creates a new product profile in draft status.
ops
GET
Gets product profiles collection.
public, vendor, client, ops
GET
Gets product profile details.
public, vendor, client, ops
POST
Modifies product profile status to published.
vendor, ops
POST
Modifies product profile status to unpublished.
vendor, ops
PUT
Modifies an existing product profile.
vendor, ops
DELETE
Modifies product profile status to deleted.
ops
POST
Creates a new category.
ops
GET
Gets list of categories.
public, vendor, client, ops
GET
Gets category details.
public, vendor, client, ops
POST
Publishes a category and updates it from draft to published (active).
ops
POST
Unpublishes a category and updates it from published (active) to unpublished (disabled).
ops
PUT
Modifies a category.
ops
DELETE
Modifies the status of a category to deleted.
ops
POST
Creates a new industry.
ops
GET
Gets a list of industries.
public, vendor, client, ops
GET
Gets specific industry details.
public, vendor, client, ops
POST
Publishes an industry and updates it from draft to published (active).
ops
POST
Unpublishes an industry and updates it from published (active) to unpublished (disabled).
ops
PUT
Modifies an industry.
ops
DELETE
Deletes an industry.
ops
POST
Creates a new segment.
ops
GET
Gets a list of segments.
public, vendor, client, ops
GET
Gets specific segment details.
public, vendor, client, ops
POST
Publishes a segment and updates it from draft to published (active).
ops
POST
Unpublishes a segment and updates it from published (active) to unpublished (disabled).
ops
PUT
Modifies a segment.
ops
DELETE
Deletes a segment.
ops
Segments categorize products based on the size and type of organizations for which they are most suitable.
This classification helps users identify solutions that align with their company's scale, complexity, and resource capabilities. Common segments include Small Business, Mid-Market, Enterprise, and Startups. By providing information about these segments, we help users find software that not only meets their functional needs but also fits their organizational context. This ensures that the selected solutions have appropriate feature sets, pricing models, and scalability.
This object contains the following attributes:
id
string, core
(Read-only) The identifier for the segment.
externalId
string
The identifier in an external system.
name
string, core
A user-friendly name for the industry.
description
string
A short description of the segment.
status
string, core
The status of the segment. Allowed values are:
Draft
Published
Unpublished
Deleted
audit
object
(Read-only) Represents the audit object.
revision
integer, core
The entity's revision number.
{
"id": "SEG-1671-3887",
"externalId": "arK9uX45",
"name": "Enterprise",
"description": "Software development tools",
"status": "Draft",
"revision": 2,
"audit": {
"created": {
"at": "2024-04-08T06:30:05.807Z",
"by": {
"id": "USR-2172-2499",
"revision": 1,
"name": "John User"
}
},
"updated": {
"at": "2024-05-16T09:17:36.406Z",
"by": {
"id": "TKN-3836-7769",
"revision": 2,
"name": "My token"
},
"deleted": {
"at": "2024-05-17T09:17:36.406Z",
"by": {
"id": "TKN-3836-7769",
"revision": 3,
"name": "My token"
}
}
}
}The Vendor Profile object represents a vendor in the public catalog.
This object contains the following attributes:
id
string, core
(Read-only) The identifier of the vendor profile.
externalId
string
The identifier within an external system.
name
string, core
A user-friendly name of the vendor profile.
icon
string
Icon to be shown on grids and info cards.
description
string
A description of the vendor.
featured
bool
Indicates if this product should be featured on the user interface.
website
string
A URL to the vendor’s website.
linkedin
string
A URL to the vendor’s LinkedIn page.
facebook
string
A URL to the vendor’s Facebook page.
youtube
string
A URL to the vendor’s YouTube page.
xProfile
string
A URL to the vendor’s X page.
owner
object
The vendor account that owns this vendor profile, if applicable. The value is null for unclaimed profiles.
products
object
Represents the productProfile object.
categories
object
Represents the category that owns this object
status
string, core
Indicates whether the item is draft, published, unpublished, or deleted.
audit
object
(Read-only) Represents the audit object.
revision
integer, core
The revision number of the entity.
{
"id": "VNP-1671-3887",
"externalId": "arK9uX45", --??
"name": "Microsoft",
"icon": "/v1/public-catalog/vendor-profiles/VNP-1671-3887/icon",
"description": "Provides enterprise software",
"website": "www.microsoft.com",
"linkedin": "www.linkedin.com/microsoft",
"facebook": "www.facebook.com/microsoft",
"xProfile": "www.x.com/microsoft",
"youtube": "www.youtube.com/microsoft",
"featured": false,
"categories": [],
"status": "Published",
"revision": 2,
"owner": {
"id": "ACC-6881-3912",
"name": "Microsoft",
"icon": "/v1/accounts/accounts/ACC-6881-3912/icon",
"revision": 1,
"type": "Vendor",
"status": "Enabled"
},
"products": [
{
"id": "PRP-1671-3887",
"name": "Office",
"icon": "/v1/public-catalog/product-profiles/PRP-1671-3887/icon",
"revision": 2
}
],
"audit": {
"created": {
"at": "2024-04-08T06:30:05.807Z",
"by": {
"id": "USR-2172-2499",
"revision": 1,
"name": "John User"
}
},
"updated": {
"at": "2024-05-16T09:17:36.406Z",
"by": {
"id": "TKN-3836-7769",
"revision": 1,
"name": "My token"
},
"deleted": {
"at": "2024-05-17T09:17:36.406Z",
"by": {
"id": "TKN-3836-7769",
"revision": 1,
"name": "My token"
}
}
}
}Industries refer to specific business sectors or markets that products are designed to serve.
This classification helps users identify solutions tailored to the unique challenges and requirements of their field. Examples of industries include healthcare, finance, education, retail, manufacturing, and technology. By categorizing products by industry, we enable users to quickly find software that understands and addresses their sector-specific needs, compliance requirements, and best practices.
This object contains the following attributes:
id
string, core
(Read-only) An identifier for the industry.
externalId
string
The identifier in the external system.
name
string, core
A user-friendly name for the industry.
description
string
A short description of the industry.
status
string, core
The status of the industry. Allowed values are:
Draft
Published
Unpublished
Deleted
audit
object
(Read-only) Represents the audit object.
revision
integer, core
The entity's revision number.
{
"id": "IND-1671-3887",
"externalId": "arK9uX45",
"name": "Education",
"description": "Software development tools",
"status": "Draft",
"revision": 2,
"audit": {
"created": {
"at": "2024-04-08T06:30:05.807Z",
"by": {
"id": "USR-2172-2499",
"revision": 1,
"name": "John User"
}
},
"updated": {
"at": "2024-05-16T09:17:36.406Z",
"by": {
"id": "TKN-3836-7769",
"revision": 2,
"name": "My token"
},
"deleted": {
"at": "2024-05-17T09:17:36.406Z",
"by": {
"id": "TKN-3836-7769",
"revision": 3,
"name": "My token"
}
}
}
}
OK
GET /public/v1/public-catalog/vendor-profiles HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": "[Circular Reference]",
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
}
]
}OK
Bad Request
Forbidden
Not Found
POST /public/v1/public-catalog/segments/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}The industry identifier.
Optional select expression.
OK
Not Found
GET /public/v1/public-catalog/industries/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}The unique identifier of the industry to update.
OK
Bad Request
Not Found
PUT /public/v1/public-catalog/industries/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"name": "text",
"description": "text",
"productProfiles": [
{
"id": "text"
}
]
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}OK
Bad Request
PUT /public/v1/public-catalog/segments/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"name": "text",
"description": "text",
"productProfiles": [
{
"id": "text"
}
]
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}The category identifier.
Optional select expression.
OK
Not Found
GET /public/v1/public-catalog/categories/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"parentCategory": {
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
},
"status": "Draft"
}The unique identifier of the category to update.
OK
Bad Request
Not Found
PUT /public/v1/public-catalog/categories/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"name": "text",
"description": "text",
"optOutAllowed": true,
"note": "text",
"deleteAllowed": true,
"enabledByDefault": true
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"parentCategory": {
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
},
"status": "Draft"
}OK
GET /public/v1/public-catalog/categories HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"parentCategory": {
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
},
"status": "Draft"
}
]
}The unique identifier of the vendor-profiles to unpublish.
OK
Bad Request
Forbidden
Not Found
POST /public/v1/public-catalog/vendor-profiles/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
"[Circular Reference]"
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
}The unique identifier of the industry to be deleted.
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/public-catalog/industries/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Represents a request to create a new segment in the public catalog.
Created
Bad Request
POST /public/v1/public-catalog/segments HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"name": "text",
"description": "text",
"productProfiles": [
{
"id": "text"
}
]
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}The unique identifier of the product profiles to publish.
OK
Bad Request
Forbidden
Not Found
POST /public/v1/public-catalog/product-profiles/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"shortDescription": "text",
"longDescription": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"industries": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"segments": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": "[Circular Reference]",
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"products": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
],
"status": "Draft"
}The unique identifier of the vendor-profiles to be deleted.
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/public-catalog/vendor-profiles/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
OK
GET /public/v1/public-catalog/product-profiles HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"shortDescription": "text",
"longDescription": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"industries": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"segments": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
"[Circular Reference]"
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"products": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
],
"status": "Draft"
}
]
}The unique identifier of the product profiles to be deleted.
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/public-catalog/product-profiles/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
The unique identifier of the category to unpublish.
OK
Bad Request
Forbidden
Not Found
POST /public/v1/public-catalog/categories/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"parentCategory": {
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
},
"status": "Draft"
}The product profile identifier.
Optional select expression.
OK
Not Found
GET /public/v1/public-catalog/product-profiles/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"shortDescription": "text",
"longDescription": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"industries": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"segments": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": "[Circular Reference]",
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"products": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
],
"status": "Draft"
}The unique identifier of the vendor-profile to update.
OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/public-catalog/vendor-profiles/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 260
{
"vendorprofile": {
"name": "text",
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text"
}
],
"productProfiles": [
{
"id": "text"
}
],
"vendor": {
"id": "text"
}
},
"icon": "binary"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
"[Circular Reference]"
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
}The unique identifier of the category to publish.
OK
Bad Request
Forbidden
Not Found
POST /public/v1/public-catalog/categories/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"parentCategory": {
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
},
"status": "Draft"
}The unique identifier of the industry to publish.
OK
Bad Request
Forbidden
Not Found
POST /public/v1/public-catalog/industries/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/public-catalog/segments/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
The vendor profile identifier.
Optional select expression.
OK
Not Found
GET /public/v1/public-catalog/vendor-profiles/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
"[Circular Reference]"
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
}The unique identifier of the industry to unpublish.
OK
Bad Request
Forbidden
Not Found
POST /public/v1/public-catalog/industries/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}OK
Bad Request
Forbidden
Not Found
POST /public/v1/public-catalog/segments/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}The unique identifier of the category to be deleted.
No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/public-catalog/categories/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Created
Bad Request
POST /public/v1/public-catalog/vendor-profiles HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 253
{
"vendorprofile": {
"name": "text",
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text"
}
],
"productProfiles": [
{
"id": "text"
}
],
"icon": "binary"
},
"icon": "binary"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
"[Circular Reference]"
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
}OK
GET /public/v1/public-catalog/segments HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}
]
}The unique identifier of the product profiles to unpublish.
OK
Bad Request
Forbidden
Not Found
POST /public/v1/public-catalog/product-profiles/{id}/unpublish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"shortDescription": "text",
"longDescription": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"industries": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"segments": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": "[Circular Reference]",
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"products": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
],
"status": "Draft"
}The segment identifier.
Optional select expression.
OK
Not Found
GET /public/v1/public-catalog/segments/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}Represents a request to create a new category in the public catalog. Contains the necessary properties for specifying category details.
Created
Bad Request
POST /public/v1/public-catalog/categories HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 134
{
"name": "text",
"description": "text",
"parentCategory": {
"id": "text"
},
"vendorProfiles": [
{
"id": "text"
}
],
"productProfiles": [
{
"id": "text"
}
]
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"parentCategory": {
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
},
"status": "Draft"
}Represents a request to create a new industry in the public catalog. Contains the necessary properties for specifying industry details.
Created
Bad Request
POST /public/v1/public-catalog/industries HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"name": "text",
"description": "text",
"productProfiles": [
{
"id": "text"
}
]
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}OK
GET /public/v1/public-catalog/industries HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"revision": 1,
"description": "text",
"status": "Draft"
}
]
}The unique identifier of the vendor-profiles to publish.
OK
Bad Request
Forbidden
Not Found
POST /public/v1/public-catalog/vendor-profiles/{id}/publish HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
"[Circular Reference]"
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
}Created
Bad Request
POST /public/v1/public-catalog/product-profiles HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 318
{
"productprofile": {
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text"
}
],
"industries": [
{
"id": "text"
}
],
"segments": [
{
"id": "text"
}
],
"vendorProfile": {
"id": "text"
},
"icon": "binary"
},
"icon": "binary"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"shortDescription": "text",
"longDescription": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"industries": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"segments": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": "[Circular Reference]",
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"products": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
],
"status": "Draft"
}The unique identifier of the product-profile to update.
OK
Bad Request
Forbidden
Internal Server Error
No content
PUT /public/v1/public-catalog/product-profiles/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 329
{
"productprofile": {
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text"
}
],
"industries": [
{
"id": "text"
}
],
"segments": [
{
"id": "text"
}
],
"vendorProfile": {
"id": "text"
},
"products": [
{
"id": "text"
}
]
},
"icon": "binary"
}{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"shortDescription": "text",
"longDescription": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"industries": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"segments": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"vendorProfile": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"published": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"unpublished": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"description": "text",
"featured": true,
"website": "text",
"linkedIn": "text",
"facebook": "text",
"youTube": "text",
"xProfile": "text",
"categories": [
{
"id": "text",
"name": "text",
"revision": 1,
"status": "Draft"
}
],
"productProfiles": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"vendorProfile": "[Circular Reference]",
"status": "Draft"
}
],
"vendor": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"status": "Draft"
},
"products": [
{
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
}
],
"status": "Draft"
}