Product

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.

This object contains the following attributes:

Field	Type	Description
id	string, core	(Read-only) The identifier for the product.
name	string, core	The name of the product.
shortDescription	string	A short description of the product.
longDescription	string	A long description of the product.
website	string	The URL for the product website.
icon	string, core	A logo of the product.
externalIds	object, core	Represents the externalIds object.
vendor	object	Represents the vendor account object.
status	string, core	Represents the product status. Allowed values are: Draft Pending Published Unpublished
settings	object	Represents the productSettings object. 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 the 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	object	(Read-only) Represents the productStatistics object.
audit	object	(Read-only) Represents the audit object.

ProductSettings object

This object contains the following attributes:

Field	Type	Description
productOrdering	boolean	Displays the Buy button, enabling clients to place an order.
itemSelection	boolean	Validates the compatibility of selected product items within the purchase order.
orderQueueChanges	boolean	Enables notifications of changes in the order queue.
sendCostToErp	boolean	Allows cost price values to pass through to final billing.
productRequests	object	(Optional) Represents the productRequestSettings object, which defines the settings for the product requests page.
preValidation	object	Represents the productStatistics object, which contains settings used during the pre‑validation phase of the purchase process.
splitBilling	object	Represents the splitBillingSettings object.
subscriptionCessation	object	Represents the subscriptionCessationSettings object, which contains settings related to product cessation.

Product Request Settings object

This object contains the following attributes:

Field	Type	Description
enabled	boolean	Displays a request button on the product card, enabling clients to request more information about a product.
name	string	The product name, which appears as a title within the request wizard.
label	string	The label on the product listing card.

Product Statistics object

This object contains the following attributes:

Field	Type	Description
items	integer	(Read-only) Number of items assigned to the product.
orders	integer	(Read-only) Number of orders placed for the product.
agreements	integer	(Read-only) Number of agreements signed with the product.
subscriptions	integer	(Read-only) Number of existing subscriptions to the product.
requests	integer	(Read-only) Number of requests related to the product.

Split Billing Settings object

This object contains the following attributes:

Field	Type	Description
enabled	boolean	Displays the split‑billing button in the dropdown, allowing clients and operations teams to enable split billing for this product.
type	string	Defines the type of split billing. Allowed values are orderBased or percentageBased.

Subscription Cessation Settings object

This object contains the following attributes:

Field	Type	Description
enabled	boolean	Specifies whether the product cessation functionality is enabled for this product.
mode	string	Specifies the cessation mode. Allowed values are: Termination Auto-renewal Termination or Auto-renewal

Pre-Validation Settings object

This object contains the following attributes:

Field	Type	Description
purchaseOrderDraft	boolean	Validates purchase order during the creation and before the order is submitted.
purchaseOrderQuerying	boolean	Validates purchase orders when the client is requested to provide more information to the vendor on that order.
changeOrderDraft	boolean	Validates change order during the creation and before the order is submitted.
terminationOrder	boolean	Validates termination orders during the creation and before the order is submitted.
productRequest	boolean	Validates the product request form while the client is filling in information and before the form is submitted.

Example

PRODUCT OBJECT

{
  "id": "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 the Microsoft 365 and Office 365 platforms, 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
  }
}