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:
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.
status
string, core
Represents the product status. Allowed values are:
DraftPendingPublishedUnpublished
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:
ProductSettings object
This object contains the following attributes:
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.
subscriptionCessation
object
Represents the subscriptionCessationSettings object, which contains settings related to product cessation.
Product Request Settings object
This object contains the following attributes:
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:
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:
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:
enabled
boolean
Specifies whether the product cessation functionality is enabled for this product.
mode
string
Specifies the cessation mode. Allowed values are:
TerminationAuto-renewalTermination or Auto-renewal
Pre-Validation Settings object
This object contains the following attributes:
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
Last updated
Was this helpful?