Skip to main content

Fields

customerDescription : String! required

Customer-facing description of the offering.

customerName : String! required

Customer-facing name of the offering.

groups : [GroupType]

Groups of components with cardinality constraints.

identifier : ID! required

Unique identifier of the offering.

internalName : String! required

Internal name used to identify the offering.

isActive : Boolean! required

Whether this offering is currently active.

isAmendable : Boolean! required

Whether this offering can be amended (only DRAFT offerings).

isDraft : Boolean! required

Whether this offering is in draft status.

isExpired : Boolean! required

Whether this offering has expired.

isFirstDraft : Boolean! required

Whether this is the first draft version (version 1, not yet activated).

isLatestVersion : Boolean! required

Whether this is the latest version of the offering.

isSellable : Boolean! required

Whether this offering can be sold stand-alone.

lifecycle : LifecycleType! required

Lifecycle information for this offering.

offeringComponents : [OfferingComponentType]

Nested offering components included in this offering.

productComponents : [ProductComponentType]

Product components included in this offering.

tags : [TagType]

Tags associated with this offering.

termTemplateComponents : [TermTemplateComponentType]

Contract term template components included in this offering.

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

{ "customerDescription": "step-smile-could-size-only", "customerName": "class-late-race-city-suddenly", "groups": [GroupType], "identifier": "68398513", "internalName": "treat-her-wife-training-family", "isActive": true, "isAmendable": true, "isDraft": true, "isExpired": true, "isFirstDraft": true, "isLatestVersion": true, "isSellable": true, "lifecycle": LifecycleType, "offeringComponents": [OfferingComponentType], "productComponents": [ProductComponentType], "tags": [TagType], "termTemplateComponents": [TermTemplateComponentType] }