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.
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:
vendor
Reference to the vendor Account object.
Example:
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:
statistics
ProductStatistics
Product statistics.
Example:
ProductSettings
productOrdering
boolean
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
Settings for product requests page.
preValidation
Settings for pre validation phase during purchase.
ProductRequestSettings
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
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
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
Last updated
Was this helpful?