ProductIntegration
Attributes available for a product integration.
This page contains
Fields
id: ID! | Unique identifier of the product integration. |
version: String! | Version of the product integration:
|
type: ProductIntegrationType PREVIEW | Type of the product integration. |
createdOn: DateTime | Timestamp showing when the product integration was created. |
lastModified: DateTime | Timestamp of the last update to the product integration. |
name: String | The name of the product integration. |
vendor: Account PREVIEW | Vendor information. |
partner: String | If provided, this is a marketplace product integration, i.e. this will be the product integration
used for product types relying on the common centralized product integration (eg.: product types
with the flag |
createUrl: ProductIntegrationEventURL | Integration Event URL for marketplace events of type |
createUrlInteractive: Boolean | Indicates whether the associated |
upgradeUrl: ProductIntegrationEventURL | Integration Event URL for marketplace events of type |
upgradeUrlInteractive: Boolean | Indicates whether the associated |
cancelUrl: ProductIntegrationEventURL | Integration Event URL for marketplace events of type |
cancelUrlInteractive: Boolean | Indicates whether the associated |
notifyUrl: ProductIntegrationEventURL | Integration Event URL for marketplace events of type |
eventStatusUrl: URL | Integration Event URL for marketplace events of type |
addonNotificationUrl: URL | Integration Event URL for marketplace events of type:
|
assignUrl: ProductIntegrationEventURL | Integration Event URL for marketplace events of type |
unassignUrl: ProductIntegrationEventURL | Integration Event URL for marketplace events of type |
userUpdatedUrl: URL | Integration Event URL for marketplace events of type |
lastTest: ProductIntegrationTest | Last product integration test. |
multipleSubscriptionsEnabled: Boolean | Indicates whether the associated products can be purchased more than once, that is, whether they are stackable products.
Note that |
notificationEmail: EmailAddress | E-mail address used to send any kind of vendor notifications. This attribute is marked as optional, but some legacy flows may require it. |
preSubmitValidationRequired: Boolean | Indicates whether the user must explicitly validate settings (by clicking a button) before submitting them and continuing the purchase. |
orderRequireFormFields: Boolean | Indicates whether the purchaser must provide additional information for this product integration during the purchase.
The additional information is described by |
updateRequireFormFields: Boolean | Indicates whether the additional information must also be provided during a product upgrade. |
additionalSettingsForms: [ProductIntegrationAdditionalSettingsForm] | List of forms to be collected during checkout when |
orderValidationUrl: URL | Validation URL used to perform the validation of the additional information values during a purchase or update. |
inboundClientId: String | Inbound Client Id which can be used for fetching the credentials used to sign incoming requests. |
outboundCredentials: ProductIntegrationOutboundCredentials | outbound credentials used to sign outgoing requests. |
domainAssociationConfiguration: DomainAssociationConfiguration | For products that require domains, input to configure the domain association. |
domainManagementEnabled: Boolean | Indicates whether a customer must purchase a domain, or add a domain that they already own, when they purchase this product. |
restrictionUrl: URL | URL used to check whether restrictions apply to the purchase or upgrade of this product. No placeholders available. |
vendorRequiredFieldsUrl: URL | For a connector integration with vendor required fields, the URL to fetch vendor required fields. |
vendorValidationsUrl: URL | For a connector integration with vendor required fields, the URL to validate vendor required fields. |
validationErrors: [ProductIntegrationValidationError!] | Validation errors found when resolving the product integration (null if there are no errors). |
singleSignOnConfigurations: [ProductIntegrationSingleSignOnConfiguration!] PREVIEW | List of single sign-on configurations associated with this integration. Note, currently limited to one. |
Parent objects of ProductIntegration
Product PREVIEW | Product definition |
ProductIntegrationConnection | Paginated list of product integrations. |
Mutations for ProductIntegration
createProductIntegration | Create product integration. |
publishProductIntegration | Publish product integration. |
triggerProductIntegrationPingTest | Trigger ping tests for a product integration. |
updateProductIntegration | Update an existing product integration. |
Queries for ProductIntegration
product | Query a product |
productIntegration | Query product integrations by integration ref ID and version. |
productIntegrationsByVendorId | Query product integrations by vendor identifier. |