Product

Product object

The product object represents a collection of items and their relevant parameters curated into a cohesive group for business purposes. Defined by Vendors, Products are accessible through Listings, providing a structured framework for transactional activities.

FieldTypeDescription

id

string

Product Identifier.

Example: "PRD-1234-1234"

href

string

Relative reference to product on API (always v1/products/{id})

Example: "/v1/products/PRD-1234-1234"

name

string

Product name

Example: "Microsoft 365 online services for commercial"

shortDescription

string

Short description of product.

Example: "Microsoft 365 and Office 365 are cloud-based productivity suites that offer a range of applications and services to help businesses of all sizes work more efficiently."

longDescription

string

Long description of product.

Example: "Microsoft 365 and Office 365 are cloud-based productivity suites that offer a range of applications and services to help businesses of all sizes work more efficiently. These plans combine the familiar Microsoft Office desktop suite with cloud-based versions of Microsoft's next-generation communications and collaboration services (including Office for the web, Microsoft Exchange Online, Microsoft Teams, and Microsoft SharePoint Online) to help users be productive from virtually anywhere through the Internet"

website

string

URL for Product website.

Example: "https://www.microsoft.com"

icon

string

Product logo (aka icon)

Example: "/static/PRD-1234-1234/logo.png"

externalIds

ExternalIds

Example:

{
  "operations": "op-322-322",
}

vendor

Reference to the vendor Account object.

Example:

{
    "id": "ACC-1234-1234",
    "href": "/accounts/accounts/ACC-1234-1234",
    "name": "Microsoft",
    "icon": "/static/ACC-1234-1234/account.png"
}

status

status

Possible values: Draft, Pending, Published, and Unpublished.

settings

ProductSettings

Activate item selection validation:

Used in the “Purchase wizard” to validate vendor-specific compatibility of selected items, before the order is submitted.

Activate validation of change orders in a draft state

Used to validate vendor-specific rules on a change order within the Purchase wizard (via existing agreement) and Subscription edit screen

Activate validation of product requests in a draft state

Used to perform vendor-specific validation on the product’s request form before form submission.

Activate validation of purchase orders in a draft state

Used to perform vendor-specific validation of purchase order within the “Purchase wizard”

Activate validation of purchase orders in a querying state

Used to perform vendor-specific validation when client is responding to a purchase order where vendor has requested additional information from the client.

Activate validation of termination order in a draft state

Used to perform vendor-specific validation when client initiates termination order on an agreement or subscription.

Example:

{
  "productOrdering": true,
  "productRequests": {
    "enabled": true,
    "title": "Contact us about Microsoft 365 Online Services",
    "label": "Contact us"
  },
  "itemSelection": false,
  "orderQueueChanges": false,
  "preValidation": {
    "purchaseOrderDraft": false,
    "purchaseOrderQuerying": false,
    "changeOrderDraft": false,
    "terminationOrder": false,
    "productRequest": false
  }
} 

statistics

ProductStatistics

Product statistics.

Example:

{
  "items": 110,
  "orders": 123,
  "agreements": 1,
  "subscriptions": 20
}

ProductSettings

FieldTypeConstraints

productOrdering

boolean

IDX

Displays “Buy” button on the product card, enabling clients to place an order for this product.

Example: "true"

itemSelection

boolean

Validates compatibility of selected product items within the purchase order, supporting order processing.

Example: "false"

orderQueueChanges

boolean

Enables notifications of changes in the order queue.

Example: "false"

productRequests

OPTIONAL

Settings for product requests page.

Example: ProductRequestSettings

preValidation

Settings for pre validation phase during purchase.

Example: PreValidationSettings

ProductRequestSettings

FieldTypeDescription

enabled

boolean

Displays request button on the product card, enabling clients to request more information about a product.

Example: "true"

name

string

This will appear as the title on the request wizard.

Example: "Contact us about Microsoft 365 Online Services"

label

string

This will appear as the button label on the product listing card.

Example: "Contact us"

PreValidationSettings

FieldTypeDescription

purchaseOrderDraft

boolean

Validates purchase order during the creation and before the order is submitted.

Example: "false"

purchaseOrderQuerying

boolean

Validates purchase orders when client is requested to provide more information to the vendor on that order.

Example: "false"

changeOrderDraft

boolean

Validates change order during the creation and before the order is submitted.

Example: "false"

terminationOrder

boolean

Validates termination orders during the creation and before the order is submitted.

Example: "false"

productRequest

boolean

Validates the product request form while client is filling in information and before the form is submitted.

Example: "false"

ProductStatistics

FieldTypeDescription

items

integer

Number of items assigned to the product.

Example: "1"

orders

integer

Number of orders placed with the product.

Example: "2"

agreements

integer

Number of agreements signed with the product.

Example: "4000"

subscriptions

integer

Number of existing subscriptions with the product.

Example: "2"

requests

integer

Number of requests related to the product.

Example: "100"

Example

{
  "id": "PRD-1234-1234",
  "href": "/v1/products/PRD-1234-1234",
  "name": "Microsoft 365 online services for commercial",
  "shortDescription": "Microsoft 365 and Office 365 are cloud-based productivity suites that offer a range of applications and services to help businesses of all sizes work more efficiently. These plans combine the familiar Microsoft Office desktop suite with cloud-based versions of Microsoft’s next-generation communications and collaboration services to help users be productive from virtually anywhere through the Internet.",
  "longDescription": "<p>Microsoft 365 and Office 365 are cloud-based productivity suites that offer a range of applications and services to help businesses of all sizes work more efficiently. These plans combine the familiar Microsoft Office desktop suite with cloud-based versions of Microsoft's next-generation communications and collaboration services (including Office for the web, Microsoft Exchange Online, Microsoft Teams, and Microsoft SharePoint Online) to help users be productive from virtually anywhere through the Internet. Microsoft 365 and Office 365 are available in a variety of plans to best meet the needs of your organization. For detailed plan information on subscriptions that enable users for Microsoft 365 and Office 365 platform, see the full subscription comparison table.</p>",
  "website": "https://www.microsoft.com",
  "icon": "/static/PRD-1234-1234/logo.png"
  "vendor": {
      "id": "ACC-1234-1234"
  },
  "state": "Published",
  "settings":{
    "productOrdering": true,
    "productRequests": {
      "enabled": true,
      "name": "Contact us about Microsoft 365 Online Services",
      "label": "Contact us"
    },
    "itemSelection": false,
    "orderQueueChanges": false,
    "preValidation": {
      "purchaseOrderDraft": false,
      "purchaseOrderQuerying": false,
      "changeOrderDraft": false,
      "terminationOrder": false,
      "productRequest": false
    }
  },
  "statistics": {
    "item": 100,
    "orders": 123,
    "agreement": 1,
    "subscription": 20
  }
}
    

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.