Skip to main content

Fields

availableFrom : DateTime

The available from datetime in industry time.

availableTo : DateTime

The available to datetime in industry time.

brand : Brand

Brand details.

code : String! required
currentAgreementCount : Int

Amount of active agreements with this product.

description : String! required

This will be shown to customers during sign-up

displayName : String! required

This name will be shown to customers during sign-up

dualFuelDescription : String

Product details dual fuel description.

fullName : String! required
id : ID! required
isHidden : Boolean! required

Use this field to temporarily make a product unavailable

marketName : String! required
notes : String! required

These are internal notes to explain why this product exists

params : ProductParams

Kraken product params.

prices : ProductPrices

List of market prices.

term : Int

Duration of agreements using this product in months

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

{ "availableFrom": "2002-09-16T18:00:39.395090+00:00", "availableTo": "1980-12-23T04:28:48.626380+00:00", "brand": Brand, "code": "prove-want-main-girl-tax", "currentAgreementCount": 63, "description": "others-rest-performance-quite-matter", "displayName": "final-why-because-view-bring", "dualFuelDescription": "focus-kid-science-eye-eye", "fullName": "media-skill-treat-left-change", "id": "88164927", "isHidden": true, "marketName": "especially-study-still-write-almost", "notes": "than-respond-majority-want-star", "params": ProductParams, "prices": ProductPrices, "term": 94 }