Skip to main content

Integration

No description

type Integration {
  capabilities: [String!]!
  createdAt: ISO8601DateTime!
  details: IntegrationDetails!
  id: ID!
  name: String
  oauthRedirectUri: String
  orderLookupHint: String
  partyType: String
  provisionedApiKey: ProvisionedApiKey
  roles: [Role!]
  updatedAt: ISO8601DateTime!
}

Fields​

Integration.capabilities ● [String!]! non-null scalar common​

Capabilities enabled for this integration and its current configuration.

Integration.createdAt ● ISO8601DateTime! non-null scalar common​

Integration.details ● IntegrationDetails! non-null object integrations​

The details of the party. The details are different for every party type. For example, a company has a name, a person has a first name and a last name.

Integration.id ● ID! non-null scalar common​

Integration.name ● String scalar common​

Integration.oauthRedirectUri ● String scalar common​

The OAuth redirect/callback URL the brand must register on their own provider app. For QuickBooks: register this exact URL in your Intuit app under Developer Portal -> Settings -> Redirect URIs. Read-only; null for integrations that don't use OAuth or don't expose a redirect URI.

Integration.orderLookupHint ● String scalar common​

Human-readable guidance for the reference accepted by this integration when looking up orders. Null when unavailable.

Integration.partyType ● String scalar common​

The type of party. Party can have different types and every type has different attributes. For example, a company has a name, a person has a first name and a last name.

Integration.provisionedApiKey ● ProvisionedApiKey object integrations​

Bearer token + API key/secret provisioned for custom integrations. Returned only for custom integration types (custom_sale, custom_fulfillment, celigo, etc.).

Integration.roles ● [Role!] list object roles-permissions​

Integration.updatedAt ● ISO8601DateTime! non-null scalar common​

Returned By​

connectIntegration mutation ● connectIntegrationWithAccessToken mutation ● connectIntegrationWithCredentials mutation ● connectIntegrationWithRefreshToken mutation ● connectIntegrationWithTokens mutation ● integration query ● setupIntegration mutation

Member Of​

CarrierMapping object ● CarrierServiceMapping object ● CustomerIntegrationMapping object ● FulfillmentRule object ● IntegrationConnection object ● IntegrationConnectionStatus object ● IntegrationEdge object ● Order object ● OrderFulfillment object ● SalesChannelIntegrationMapping object ● V2Order object ● Warehouse object ● WarehouseExternalData object