availableProducts

Get available products for the given market.

Arguments

marketName : String!


            required

Products available for the target market.

Returns

[SupplyProductType]

GraphQL type for a supply product.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query available products

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 AvailableProducts($marketName: String!) {
  availableProducts(marketName: $marketName) {
    availabilityStatus
    availableFrom
    availableTo
    brandCode
    code
    description
    displayName
    endsAt
    fullName
    id
    isHidden
    marketName
    notes
    params
    rates {
      ...ApplicableRateTypeFragment
    }
    tags {
      ...SupplyProductTagTypeFragment
    }
    term
    termsAndConditions {
      ...TermsAndConditionsTypeFragment
    }
    termsContractType
  }
}

{
  "marketName": "building-cut-shake-her-lot"
}

{
  "data": {
    "availableProducts": [
      {
        "availabilityStatus": "EVERYONE",
        "availableFrom": "2004-09-19T13:57:03.187779+00:00",
        "availableTo": "1985-02-22T14:23:39.430743+00:00",
        "brandCode": "point-public-TV-me-talk",
        "code": "whose-shoulder-inside-evening-best",
        "description": "store-can-nice-law-and",
        "displayName": "Democrat-statement-much-under-traditional",
        "endsAt": "1975-04-28T05:15:51.080399+00:00",
        "fullName": "question-amount-institution-kid-whatever",
        "id": "89902162",
        "isHidden": true,
        "marketName": "maybe-suggest-his-guess-discussion",
        "notes": "probably-only-serious-worker-game",
        "params": {"key": "value"},
        "rates": [ApplicableRateType],
        "tags": [SupplyProductTagType],
        "term": 7,
        "termsAndConditions": [TermsAndConditionsType],
        "termsContractType": "learn-street-computer-challenge-trade"
      }
    ]
  }
}