MarketingActivityExtensionAppErrorCode

Version 2019-04

The error code resulted from the marketing activity extension integration.

Show definition
"""
The error code resulted from the marketing activity extension integration.
"""
enum MarketingActivityExtensionAppErrorCode {
  """
  The app is not responding or returning unexpected data.
  """
  API_ERROR
  """
  The app needs to be installed.
  """
  INSTALL_REQUIRED_ERROR
  """
  The shop/user must be onboarded to use the app.
  """
  NOT_ONBOARDED_ERROR
  """
  The app has returned an error when invoking the platform.
  """
  PLATFORM_ERROR
  """
  The app has returned validation errors.
  """
  VALIDATION_ERROR
}

Values

API_ERROR

The app is not responding or returning unexpected data.

INSTALL_REQUIRED_ERROR

The app needs to be installed.

NOT_ONBOARDED_ERROR

The shop/user must be onboarded to use the app.

PLATFORM_ERROR

The app has returned an error when invoking the platform.

VALIDATION_ERROR

The app has returned validation errors.

Version 2019-07 (Latest)

The error code resulted from the marketing activity extension integration.

Show definition
"""
The error code resulted from the marketing activity extension integration.
"""
enum MarketingActivityExtensionAppErrorCode {
  """
  The app is not responding or returning unexpected data.
  """
  API_ERROR
  """
  The app needs to be installed.
  """
  INSTALL_REQUIRED_ERROR
  """
  The shop/user must be onboarded to use the app.
  """
  NOT_ONBOARDED_ERROR
  """
  The app has returned an error when invoking the platform.
  """
  PLATFORM_ERROR
  """
  The app has returned validation errors.
  """
  VALIDATION_ERROR
}

Values

API_ERROR

The app is not responding or returning unexpected data.

INSTALL_REQUIRED_ERROR

The app needs to be installed.

NOT_ONBOARDED_ERROR

The shop/user must be onboarded to use the app.

PLATFORM_ERROR

The app has returned an error when invoking the platform.

VALIDATION_ERROR

The app has returned validation errors.

Version 2019-10 (Release candidate)

The error code resulted from the marketing activity extension integration.

Show definition
"""
The error code resulted from the marketing activity extension integration.
"""
enum MarketingActivityExtensionAppErrorCode {
  """
  The app is not responding or returning unexpected data.
  """
  API_ERROR
  """
  The app needs to be installed.
  """
  INSTALL_REQUIRED_ERROR
  """
  The shop/user must be onboarded to use the app.
  """
  NOT_ONBOARDED_ERROR
  """
  The app has returned an error when invoking the platform.
  """
  PLATFORM_ERROR
  """
  The app has returned validation errors.
  """
  VALIDATION_ERROR
}

Values

API_ERROR

The app is not responding or returning unexpected data.

INSTALL_REQUIRED_ERROR

The app needs to be installed.

NOT_ONBOARDED_ERROR

The shop/user must be onboarded to use the app.

PLATFORM_ERROR

The app has returned an error when invoking the platform.

VALIDATION_ERROR

The app has returned validation errors.

Sign up for a Partner account to get started.

Sign up