Skip to main content

Input fields

address : RichAddressInput! required

The address of the supply point that should be quoted.

The postalCode is required.

affiliateSessionId : String

The session id of the affiliate.

electricity : SupplyTypeQuoteInput

If this is specified, the operation will include electricity products in the quote.

At least one of the electricity and gas fields is required.

If this is specified, the operation will include gas products in the quote.

At least one of the electricity and gas fields is required.

journeyType : String

Restrict the quoted products to those that are allowed to be in the specified onboarding journey.

qualifyingDate : DateTime
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

{ "address": RichAddressInput, "affiliateSessionId": "66402619", "electricity": SupplyTypeQuoteInput, "gas": SupplyTypeQuoteInput, "journeyType": "for-word-probably-employee-film", "qualifyingDate": "1998-06-04T04:00:54.219509+00:00" }