Configurator Input

Input representation of the request to modify the product configuration.

This example shows a sample to initiate a context based on a transaction ID.

This example shows a sample to add, update, or delete a node in an existing context.

NameTypeDescriptionRequired or OptionalAvailable Version
added​NodesConfigurator Added Node Input[]List of added context nodes that’s passed to the product configurator.Optional60.0
configurator​OptionsConfigurator Options Input[]Options to pass to the configurator.Optional60.0
context​ResponseTypeStringSpecifies the type of transaction context response. Valid values are:
  • Delta—Returns the sales transaction items that are added or updated.
  • Full—Returns all sales transaction items in a transaction.
  • None—Returns empty transaction context response.
  • Product—Returns the sales transaction items related to the product that’s being configured.
Required for large sales transactions with more than 1000 line items and less than 15K line items.65.0
correlation​IdStringID that’s specified for traceability of logs.Optional60.0
deleted​NodesConfigurator Deleted Node Input[]List of deleted context nodes that’s passed to the product configurator.Optional60.0
qualification​ContextUser Context Input[]Details such as account ID, contact ID, and context ID that are used for executing qualification rules.Optional60.0
transaction​ContextIdStringID of the transaction context.Optional60.0
transaction​IdStringID of the sales transaction that’s being configured such as a quote or an order.Required60.0
transaction​LineIdStringID of the top-level line item that’s being configured.Optional60.0
updated​NodesConfigurator Updated Node Input[]List of updated context nodes that’s passed to the product configurator.Optional60.0