The following diagram shows the status transition process of a listing in the platform.
The Listing object represents a business entity that aligns a product with a specific SoftwareOne seller. It's defined by an authorization and an assigned price list.
Listings are essential for managing the visibility and availability of products across markets.
This object contains the following attributes:
id
string
(Read-only) The primary identifier for the listing.
product
object
(Read-only) Represents the object.
eligibility
object, core
Represents the object, which defines the eligibility status.
authorization
object
(Read-only) Represents the object.
vendor
The vendor that the listing belongs to.
seller
object
(Read-only) Represents the object.
priceList
object
Represents the object.
primary
boolean
Indicates the listing used in the purchase wizard. If the product has multiple associated listings from the same seller, the primary flag identifies which one is selected.
notes
string
(Optional) The user notes about the listing.
statistics
object
(Read-only) Represents the object, containing system-calculated metrics about the listing.
audit
object
(Read-only) Represents the object.
subscriptions
integer
(Read-only) Number of associated subscriptions.
agreements
integer
client
integer
Indicates direct client.
partner
integer
{
"id": "LST-1234-4678",
"product": {
"id": "PRD-1111-1111",
"name": "Microsoft Office 365 NCE",
"icon": "/static/PRD-1111-1111/logo.png"
},
"authorization": {
"id": "AUT-1234-4567",
"name": "Salesforce Enterprise License"
},
"seller": {
"id": "SEL-1234-45678",
"name": "SoftwareOne, Inc."
},
"priceList": {
"id": "PRC-1234-5678-1234"
},
"primary": true,
"notes": "This is the primary Listing for the EU region.",
"eligibility": {
"client": true,
"partner": true
},
"statistics": {
"subscriptions": 10,
"agreements": 5
},
"audit": {
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
},
}(Read-only) Number of associated agreements.
Indicates indirect client, also called partners.
OK
GET /public/v1/catalog/listings 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
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"authorization": {
"id": "text",
"name": "text",
"revision": 1,
"currency": "text"
},
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"seller": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"priceList": {
"id": "text",
"revision": 1,
"currency": "text"
},
"primary": true,
"notes": "text",
"statistics": {
"subscriptions": 1,
"agreements": 1
},
"eligibility": {
"client": true,
"partner": true
}
}
]
}Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/catalog/listings HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 179
{
"primary": true,
"notes": "text",
"product": {
"id": "text"
},
"authorization": {
"id": "text"
},
"seller": {
"id": "text"
},
"priceList": {
"id": "text"
},
"eligibility": {
"client": true,
"partner": 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
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"authorization": {
"id": "text",
"name": "text",
"revision": 1,
"currency": "text"
},
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"seller": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"priceList": {
"id": "text",
"revision": 1,
"currency": "text"
},
"primary": true,
"notes": "text",
"statistics": {
"subscriptions": 1,
"agreements": 1
},
"eligibility": {
"client": true,
"partner": true
}
}OK
Not Found
GET /public/v1/catalog/listings/{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
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"authorization": {
"id": "text",
"name": "text",
"revision": 1,
"currency": "text"
},
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"seller": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"priceList": {
"id": "text",
"revision": 1,
"currency": "text"
},
"primary": true,
"notes": "text",
"statistics": {
"subscriptions": 1,
"agreements": 1
},
"eligibility": {
"client": true,
"partner": true
}
}No Content
No content
Forbidden
Not Found
Internal Server Error
No content
DELETE /public/v1/catalog/listings/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
No content
Created
Bad Request
Forbidden
Internal Server Error
No content
POST /public/v1/catalog/listings HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 179
{
"primary": true,
"notes": "text",
"product": {
"id": "text"
},
"authorization": {
"id": "text"
},
"seller": {
"id": "text"
},
"priceList": {
"id": "text"
},
"eligibility": {
"client": true,
"partner": 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
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"authorization": {
"id": "text",
"name": "text",
"revision": 1,
"currency": "text"
},
"product": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"status": "text"
},
"vendor": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"seller": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"externalId": "text"
},
"priceList": {
"id": "text",
"revision": 1,
"currency": "text"
},
"primary": true,
"notes": "text",
"statistics": {
"subscriptions": 1,
"agreements": 1
},
"eligibility": {
"client": true,
"partner": true
}
}