ProductSwitchProcessType
Fields
Product characteristics captured for this switch, forwarded to agreement creation.
Whether the product switch process is still active (not yet terminal).
Whether the product switch process has completed.
Whether the product switch process has errored.
Whether the product switch process has failed.
The agreement created by the product switch, once completed. Null until then. Requires the CAN_QUERY_AGREEMENTS permission.
The Offer selected for this switch, if it was created via the commercial quoting/offer flow rather than primitives or a QuotedProduct. Requires the CAN_CREATE_QUOTING_OFFER_GROUP permission.
The product selected for the switch.
The current status of the product switch process.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
Example
{
"agreedAt": "1975-01-27T21:31:45.635995+00:00",
"characteristics": {"key": "value"},
"createdAt": "2012-09-26T23:19:04.248389+00:00",
"id": "22145152",
"isActive": true,
"isCompleted": true,
"isErrored": true,
"isFailed": true,
"newAgreement": CommonAgreementType,
"offer": OfferType,
"product": SupplyProductType,
"status": "present-poor-wait-hospital-fill",
"switchDate": "1988-07-26T06:07:21.201127+00:00",
"updatedAt": "1987-12-21T12:56:21.351794+00:00",
"validTo": "2018-01-23T17:41:13.184836+00:00"
}