productsWithEstimates

Get all products providing an estimate, either CUPS or annualConsumption.

Arguments

brand : String default: OCTOPUS_ENERGY_SPAIN

The market brand code.

date : Date

The date when product must be available.

electricityAnnualConsumption : Int

Estimated electricity annual consumption.

electricityCups : String

Supply point electricity CUPS.

gasAnnualConsumption : Int

Estimated gas annual consumption.

gasCups : String

Supply point gas CUPS.

isHidden : Boolean

Get products based on its hidden attribute.

organizationName : String

The organization from which filter the products.

Returns

ProductWithEstimates

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

(No)

Query Complexity

Examples

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.

query ProductsWithEstimates(
  $brand: String,
  $date: Date,
  $electricityAnnualConsumption: Int,
  $electricityCups: String,
  $gasAnnualConsumption: Int,
  $gasCups: String,
  $isHidden: Boolean,
  $organizationName: String
) {
  productsWithEstimates(
    brand: $brand,
    date: $date,
    electricityAnnualConsumption: $electricityAnnualConsumption,
    electricityCups: $electricityCups,
    gasAnnualConsumption: $gasAnnualConsumption,
    gasCups: $gasCups,
    isHidden: $isHidden,
    organizationName: $organizationName
  ) {
    dualFuel {
      ...DualFuelProductQuoteFragment
    }
    singleFuel {
      ...SingleFuelProductQuoteFragment
    }
  }
}

{
  "brand": "site-suffer-should-spring-painting",
  "date": "1989-10-22",
  "electricityAnnualConsumption": 34,
  "electricityCups": "sometimes-in-rate-field-left",
  "gasAnnualConsumption": 34,
  "gasCups": "machine-level-animal-member-seat",
  "isHidden": true,
  "organizationName": "institution-great-prevent-after-medical"
}

{
  "data": {
    "productsWithEstimates": {
      "dualFuel": [DualFuelProductQuote],
      "singleFuel": [SingleFuelProductQuote]
    }
  }
}