Listings

Listing object

The Listing object represents a business object that positions a Product within the purview of a particular SoftwareOne seller, characterized by a specific Authorization and an assigned Price List. Listings play a crucial role in controlling the visibility and availability of Products in various markets and managing their lifecycle in a scalable and efficient manner.

FieldTypeDescription

id

string

Primary listing identifier

href

string

Relative reference to object on API (always /listing/{id}).

Example: "LST-1234-4678"

product

Reference to Product object.

Example:

{
    "id": "PRD-1111-1111",
    "href": "/products/PRD-1111-1111",
    "name": "Microsoft Office 365 NCE",
    "icon": "/static/PRD-1111-1111/logo.png"
}

authorization

Reference to Authorization object.

Example:

{
    "id": "AUT-1234-4567",
    "href": "/authorization/ATH-1234-45678",
    "name": "Salesforce Enterprise License"
}

seller

Reference to Seller object.

Example:

{
    "id": "SEL-1234-4567",
    "href": "/seller/SEL-1234-45678",
    "name": "SoftwareOne, Inc."
}

priceList

Reference to PriceList object.

Example:

{
    "id": "PRC-1234-5678-1234,
    "href": "/price-list/PRC-1234-5678-1234
}

primary

boolean

If product has more associated listings with the same seller, the “primary” flag is used to indicate which listing is used in purchase wizard.

Example: "true"

notes

string

Any user notes about the Listing.

Example: "This is the primary Listing for the EU region"

statistics

System calculated metrics about the Listing.

Example:

{
  "subscriptionCount": 10,
  "agreementCount": 5
}

audit

AuditObject

Audit object with possible entries: created, updated, activated, terminated, according to lifecycle of the object. Possible audit events: created, updated, activated, terminated, failed.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } },
  "terminated": { "at": "...", "by": { } }
}

ListingStatistics

FieldTypeDescription

subscriptions

int

Number of associated subscriptions.

Example: "10"

agreements

int

Number of associated agreements

Example: "5"

Example

{
  "id": "LST-1234-4678",
  "href": "/listing/LST-1234-4678",
  "product": {
    "id": "PRD-1111-1111",
    "href": "/products/PRD-1111-1111",
    "name": "Microsoft Office 365 NCE",
    "icon": "/static/PRD-1111-1111/logo.png"
  },
  "authorization": {
    "id": "AUT-1234-4567",
    "href": "/authorization/ATH-1234-45678",
    "name": "Salesforce Enterprise License"
  }, 
  "seller": {
    "id": "SEL-1234-45678",
    "href": "/seller/SEL-1234-4567",
    "name": "SoftwareOne, Inc."
  },
  "priceList": {
    "id": "PRC-1234-5678-1234",
    "href": "/price-list/PRC-1234-5678-1234"
  },
  "primary": true,
  "notes": "This is the primary Listing for the EU region.",
  "statistics": {
    "subscriptions": 10,
    "agreements": 5
  },
  "audit": {
    "created": { "at": "...", "by": { } },
    "updated": { "at": "...", "by": { } }
  },
}

Last updated

SoftwareOne is a trademark of SoftwareOne, Inc. "The Software Licensing Experts" is a service mark of SoftwareOne, Inc. VAR assist is a trademark of SoftwareOne, Inc. "It pays to partner" is a service mark of SoftwareOne, Incorporated.