Skip to main content

UpdateIntegrationInput

Autogenerated input type of UpdateIntegration

input UpdateIntegrationInput {
  apiKey: String
  apiSecret: String
  apiToken: String
  brandId: ID @deprecated
  carrierMapping: JSON
  clientMutationId: String
  collabCode: String
  companyGs1PrefixId: ID
  description: String
  integrationId: ID!
  managed: Boolean
  name: String
  oauthToken: String
  settings: JSON
  status: IntegrationStatusEnum
}

Fields​

UpdateIntegrationInput.apiKey ● String scalar common​

The API key for the integration. This argument can be also used to store the main API key or secret for the integration. It is very important to store the main connection credential using this argument because it will be encrypted and stored in the database.

UpdateIntegrationInput.apiSecret ● String scalar common​

The API secret for the integration. This argument will be encrypted and stored in the database.

UpdateIntegrationInput.apiToken ● String scalar common​

The API token for the integration. This argument will be encrypted and stored in the database.

UpdateIntegrationInput.brandId ● ID deprecated scalar common​

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Integration's company context is used instead.

The brand id. If the header X-Brand-Id is provided then this argument is optional, otherwise it is required.

UpdateIntegrationInput.carrierMapping ● JSON scalar common​

UpdateIntegrationInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

UpdateIntegrationInput.collabCode ● String scalar common​

UpdateIntegrationInput.companyGs1PrefixId ● ID scalar common​

The company GS1 prefix this integration mints SSCCs under. Pass null explicitly to unassign the prefix; omit the argument to leave the assignment unchanged.

UpdateIntegrationInput.description ● String scalar common​

UpdateIntegrationInput.integrationId ● ID! non-null scalar common​

UpdateIntegrationInput.managed ● Boolean scalar common​

UpdateIntegrationInput.name ● String scalar common​

UpdateIntegrationInput.oauthToken ● String scalar common​

The Shopify OAuth token for the integration. This argument will be encrypted and stored in the database.

UpdateIntegrationInput.settings ● JSON scalar common​

Additional settings for the integration. This argument can be used to store any additional settings for the integration different from the api_key, the api_secret or the api_token.

UpdateIntegrationInput.status ● IntegrationStatusEnum enum integrations​

Member Of​

updateIntegration mutation