Skip to main content

Input fields

availabilityStatus : ProductAvailability! required

The product availability status.

availableFrom : DateTime! required

The date the product is available from.

availableTo : DateTime

The date the product is available to.

brandCode : NonEmptyString! required

The brand code.

characteristicOverrides : [CharacteristicOverride!]

Overrides for product characteristics.

code : NonEmptyString! required

The product code.

description : String! required

The product description.

displayName : NonEmptyString! required

The product description.

endsAt : DateTime

The date the product ends.

fullName : NonEmptyString! required

The product title.

isHidden : Boolean! required

Whether the product is hidden.

marketName : NonEmptyString! required

The name of the market the product belongs to.

notes : String! required

The product notes.

params : JSONString

The product parameters.

specificationCode : String

The product specification code.

specificationIdentifier : ID

The product specification ID.

Deprecation
The 'specificationIdentifier' field is deprecated.

This field is deprecated. Please use the 'specificationCode' field instead.

- Marked as deprecated on 2025-07-08.
- Scheduled for removal on or after 2025-09-01.
tags : [String!]! required

Tags associated with the product.

term : Int

The product term in months.

termsAndConditionsTypes : [String!]! required

A list of terms and conditions specified by codes to associate with the product.

termsContractType : String! required

The product contract type.

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

{ "availabilityStatus": "EVERYONE", "availableFrom": "1995-12-24T14:41:36.271043+00:00", "availableTo": "1985-03-28T01:04:08.985922+00:00", "brandCode": "nature-whatever-accept-situation-star", "characteristicOverrides": CharacteristicOverride, "code": "though-scientist-speak-million-no", "description": "international-argue-thank-now-customer", "displayName": "measure-machine-ground-get-Mrs", "endsAt": "2005-04-12T07:10:33.250016+00:00", "fullName": "partner-leader-agreement-director-concern", "isHidden": true, "marketName": "once-technology-sometimes-someone-staff", "notes": "effort-success-pull-bar-admit", "params": {"key": "value"}, "specificationCode": "address-sense-economic-body-person", "tags": "general-attorney-city-month-collection", "term": 35, "termsAndConditionsTypes": "possible-family-reflect-market-box", "termsContractType": "find-gas-someone-election-effect" }