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"
}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"
}
]
}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 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 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 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 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 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"
}
]
}