Skip to main content

IntegrationDetails

Integration details for connecting third-party services to your brand.

Integrations enable data synchronization between external platforms (such as e-commerce stores, marketplaces, or shipping carriers) and your brand's operations.

Each integration includes:

Connection credentials (API keys, tokens, secrets)
Platform-specific configuration settings
Current connection status
Optional managed setup where our team handles configuration

For managed integrations, use the collab_status field to track the collaboration process between you and our support team.

type IntegrationDetails {
  apiKey: String
  apiSecret: String
  apiToken: String
  brand: Brand @deprecated
  brandId: ID @deprecated
  carrierMapping: JSON
  codeName: String!
  collabCode: String
  collaborationStatus: IntegrationCollaborationStatus!
  company: Company!
  companyId: ID!
  connectionStatus: IntegrationConnectionStatusEnum
  createdAt: ISO8601DateTime!
  description: String
  id: ID!
  integrationType: IntegrationTypeEnum
  managed: Boolean!
  name: String
  oauthToken: String
  prettyName: String
  settings: JSON
  status: StatusEnum
  updatedAt: ISO8601DateTime!
}

Fields

`IntegrationDetails.apiKey` ● `String` scalar common

The API key for the integration. This field will be obfuscated when returned for security purposes.

`IntegrationDetails.apiSecret` ● `String` scalar common

The API secret for the integration. This field will be obfuscated when returned for security purposes.

`IntegrationDetails.apiToken` ● `String` scalar common

The API token for the integration. This field will be obfuscated when returned for security purposes.

`IntegrationDetails.brand` ● `Brand` deprecated object common

DEPRECATED

This field will be removed in the future. Brand is becoming a product-only attribute.

`IntegrationDetails.brandId` ● `ID` deprecated scalar common

DEPRECATED

This field will be removed in the future. Brand is becoming a product-only attribute.

`IntegrationDetails.carrierMapping` ● `JSON` scalar common

`IntegrationDetails.codeName` ● `String!` non-null scalar common

`IntegrationDetails.collabCode` ● `String` scalar common

`IntegrationDetails.collaborationStatus` ● `IntegrationCollaborationStatus!` non-null object integrations

`IntegrationDetails.company` ● `Company!` non-null object companies

`IntegrationDetails.companyId` ● `ID!` non-null scalar common

`IntegrationDetails.connectionStatus` ● `IntegrationConnectionStatusEnum` enum integrations

`IntegrationDetails.createdAt` ● `ISO8601DateTime!` non-null scalar common

`IntegrationDetails.description` ● `String` scalar common

`IntegrationDetails.id` ● `ID!` non-null scalar common

`IntegrationDetails.integrationType` ● `IntegrationTypeEnum` enum integrations

`IntegrationDetails.managed` ● `Boolean!` non-null scalar common

`IntegrationDetails.name` ● `String` scalar common

`IntegrationDetails.oauthToken` ● `String` scalar common

The API oauth token for the integration. This field will be obfuscated when returned for security purposes.

`IntegrationDetails.prettyName` ● `String` scalar common

`IntegrationDetails.settings` ● `JSON` scalar common

`IntegrationDetails.status` ● `StatusEnum` enum common

`IntegrationDetails.updatedAt` ● `ISO8601DateTime!` non-null scalar common

Member Of

Integration object

Implemented By

PartyDetails union

Fields
Member Of
Implemented By