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
  brandId: ID
  carrierMapping: JSON
  codeName: String!
  collabCode: String
  collaborationStatus: IntegrationCollaborationStatus!
  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

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

IntegrationDetails.apiSecret ● String scalar

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

IntegrationDetails.apiToken ● String scalar

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

IntegrationDetails.brand ● Brand object

IntegrationDetails.brandId ● ID scalar

IntegrationDetails.carrierMapping ● JSON scalar

IntegrationDetails.codeName ● String! non-null scalar

IntegrationDetails.collabCode ● String scalar

IntegrationDetails.collaborationStatus ● IntegrationCollaborationStatus! non-null object

IntegrationDetails.createdAt ● ISO8601DateTime! non-null scalar

IntegrationDetails.description ● String scalar

IntegrationDetails.id ● ID! non-null scalar

IntegrationDetails.integrationType ● IntegrationTypeEnum enum

IntegrationDetails.managed ● Boolean! non-null scalar

IntegrationDetails.name ● String scalar

IntegrationDetails.oauthToken ● String scalar

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

IntegrationDetails.prettyName ● String scalar

IntegrationDetails.settings ● JSON scalar

IntegrationDetails.status ● StatusEnum enum

IntegrationDetails.updatedAt ● ISO8601DateTime! non-null scalar

Member Of

Integration object

Implemented By

PartyDetails union