Skip to main content

Fields

characteristics : JSONString

Product characteristics captured for this switch, forwarded to agreement creation.

newAgreement : CommonAgreementType

The agreement created by the product switch, once completed. Null until then. Requires the CAN_QUERY_AGREEMENTS permission.

offer : OfferType

The Offer selected for this switch, if it was created via the commercial quoting/offer flow rather than primitives or a QuotedProduct.

product : SupplyProductType! required

The product selected for the switch.

status : String! required

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": "2026-01-19T14:02:54.555739+00:00", "characteristics": {"key": "value"}, "createdAt": "1978-03-30T23:12:39.765664+00:00", "newAgreement": CommonAgreementType, "offer": OfferType, "product": SupplyProductType, "status": "picture-blue-knowledge-black-these", "switchDate": "2018-10-08T08:26:59.762898+00:00", "updatedAt": "2010-10-11T13:57:16.897974+00:00", "uuid": "b4a10ab8-90c6-4e37-9b41-68d5f99afdac", "validTo": "2013-03-06T09:52:48.287913+00:00" }