energyProducts

Get all products for a given brand and postcode. The supplied postcode will ensure that there are tariffs available on the product for the GSP.

Arguments

after : String

availability : EnergyProductAvailability

Filter for available or unavailable products only.

before : String

brand : String

Filter by a specific energy brand.

brands : [String]

Filter by these brands.

direction : EnergyProductDirection

Energy product direction to filter products by.

excludeTags : [String]

Exclude products with these tag codes.

filterBy : [EnergyProductFilters]

Filter by the type of energy product.

first : Int

last : Int

postcode : String!


            required

Postcode to search energy products for.

tags : [String]

Filter by specific tags which are attached to the product.

Returns

EnergyProductConnectionTypeConnection

This field is a connection type. Connections are used to implement cursor based pagination.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

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 EnergyProducts(
  $after: String,
  $availability: EnergyProductAvailability,
  $before: String,
  $brand: String,
  $brands: [String],
  $direction: EnergyProductDirection,
  $excludeTags: [String],
  $filterBy: [EnergyProductFilters],
  $first: Int,
  $last: Int,
  $postcode: String!,
  $tags: [String]
) {
  energyProducts(
    after: $after,
    availability: $availability,
    before: $before,
    brand: $brand,
    brands: $brands,
    direction: $direction,
    excludeTags: $excludeTags,
    filterBy: $filterBy,
    first: $first,
    last: $last,
    postcode: $postcode,
    tags: $tags
  ) {
    edgeCount
    edges {
      ...EnergyProductConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "availability": "AVAILABLE",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "brand": "information-public-budget-enter-everything",
  "brands": "look-soldier-tax-skill-quality",
  "direction": "IMPORT",
  "excludeTags": "beautiful-hope-protect-family-meet",
  "filterBy": "PREPAY",
  "first": 10,
  "last": 10,
  "postcode": "toward-break-take-black-hit",
  "tags": "town-cut-minute-indicate-thousand"
}

{
  "data": {
    "energyProducts": {
      "edgeCount": 69,
      "edges": [EnergyProductConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 37
    }
  }
}