ConnectedService

Connected Services to the Promotions API i.e.: Shopify

type ConnectedService {
  name: String!
  enabled: Boolean!
  serviceType: ConnectedServiceType!
  roles: [ConnectedServiceRole!]!
  scope: String
  needsReauth: Boolean!
  uid: String
  sandbox: Boolean!
  metadata(
    refresh: Boolean
  ): ConnectedServiceMetadata
}

Fields

ConnectedService.name ● String! non-null scalar

The name of the Connected Service

ConnectedService.enabled ● Boolean! non-null scalar

If the Connected Service is enabled or not

ConnectedService.serviceType ● ConnectedServiceType! non-null enum

The type of connected service

ConnectedService.roles ● [ConnectedServiceRole!]! non-null enum

Roles supported by this connected service

ConnectedService.scope ● String scalar

The scope of the connected service

ConnectedService.needsReauth ● Boolean! non-null scalar

If the connected service needs re-authenticating

ConnectedService.uid ● String scalar

The external UID of the connected service account

ConnectedService.sandbox ● Boolean! non-null scalar

True if the connected service is using a sandbox environment

ConnectedService.metadata ● ConnectedServiceMetadata union

Stored metadata for the connected service

ConnectedService.metadata.refresh ● Boolean scalar

Refresh the metadata for the connected service

Member Of

Account object ● CreditEntry object ● Promotion object ● PromotionDestination object