Package com.apple.itunes.storekit.client

Enum Class APIError

java.lang.Object
java.lang.Enum<APIError>
com.apple.itunes.storekit.client.APIError
All Implemented Interfaces:
Serializable, Comparable<APIError>, Constable
public enum APIError extends Enum<APIError>
An error returned by the App Store Server API indicating an issue with processing a request. See the specific documentation for each endpoint to learn more about what codes are possible from each endpoint.

  • Enum Constant Details

    • GENERAL_BAD_REQUEST

      public static final APIError GENERAL_BAD_REQUEST
      An error that indicates an invalid request.
      See Also:

    • INVALID_APP_IDENTIFIER

      public static final APIError INVALID_APP_IDENTIFIER
      An error that indicates an invalid app identifier.
      See Also:

    • INVALID_REQUEST_REVISION

      public static final APIError INVALID_REQUEST_REVISION
      An error that indicates an invalid request revision.
      See Also:

    • INVALID_TRANSACTION_ID

      public static final APIError INVALID_TRANSACTION_ID
      An error that indicates an invalid transaction identifier.
      See Also:

    • INVALID_ORIGINAL_TRANSACTION_ID

      public static final APIError INVALID_ORIGINAL_TRANSACTION_ID
      An error that indicates an invalid original transaction identifier.
      See Also:

    • INVALID_EXTEND_BY_DAYS

      public static final APIError INVALID_EXTEND_BY_DAYS
      An error that indicates an invalid extend-by-days value.
      See Also:

    • INVALID_EXTEND_REASON_CODE

      public static final APIError INVALID_EXTEND_REASON_CODE
      An error that indicates an invalid reason code.
      See Also:

    • INVALID_REQUEST_IDENTIFIER

      public static final APIError INVALID_REQUEST_IDENTIFIER
      An error that indicates an invalid request identifier.
      See Also:

    • START_DATE_TOO_FAR_IN_PAST

      public static final APIError START_DATE_TOO_FAR_IN_PAST
      An error that indicates that the start date is earlier than the earliest allowed date.
      See Also:

    • START_DATE_AFTER_END_DATE

      public static final APIError START_DATE_AFTER_END_DATE
      An error that indicates that the end date precedes the start date, or the two dates are equal.
      See Also:

    • INVALID_PAGINATION_TOKEN

      public static final APIError INVALID_PAGINATION_TOKEN
      An error that indicates the pagination token is invalid.
      See Also:

    • INVALID_START_DATE

      public static final APIError INVALID_START_DATE
      An error that indicates the start date is invalid.
      See Also:

    • INVALID_END_DATE

      public static final APIError INVALID_END_DATE
      An error that indicates the end date is invalid.
      See Also:

    • PAGINATION_TOKEN_EXPIRED

      public static final APIError PAGINATION_TOKEN_EXPIRED
      An error that indicates the pagination token expired.
      See Also:

    • INVALID_NOTIFICATION_TYPE

      public static final APIError INVALID_NOTIFICATION_TYPE
      An error that indicates the notification type or subtype is invalid.
      See Also:

    • MULTIPLE_FILTERS_SUPPLIED

      public static final APIError MULTIPLE_FILTERS_SUPPLIED
      An error that indicates the request is invalid because it has too many constraints applied.
      See Also:

    • INVALID_TEST_NOTIFICATION_TOKEN

      public static final APIError INVALID_TEST_NOTIFICATION_TOKEN
      An error that indicates the test notification token is invalid.
      See Also:

    • INVALID_SORT

      public static final APIError INVALID_SORT
      An error that indicates an invalid sort parameter.
      See Also:

    • INVALID_PRODUCT_TYPE

      public static final APIError INVALID_PRODUCT_TYPE
      An error that indicates an invalid product type parameter.
      See Also:

    • INVALID_PRODUCT_ID

      public static final APIError INVALID_PRODUCT_ID
      An error that indicates the product ID parameter is invalid.
      See Also:

    • INVALID_SUBSCRIPTION_GROUP_IDENTIFIER

      public static final APIError INVALID_SUBSCRIPTION_GROUP_IDENTIFIER
      An error that indicates an invalid subscription group identifier.
      See Also:

    • INVALID_EXCLUDE_REVOKED

      @Deprecated public static final APIError INVALID_EXCLUDE_REVOKED
      Deprecated.
      An error that indicates the query parameter exclude-revoked is invalid.
      See Also:

    • INVALID_IN_APP_OWNERSHIP_TYPE

      public static final APIError INVALID_IN_APP_OWNERSHIP_TYPE
      An error that indicates an invalid in-app ownership type parameter.
      See Also:

    • INVALID_EMPTY_STOREFRONT_COUNTRY_CODE_LIST

      public static final APIError INVALID_EMPTY_STOREFRONT_COUNTRY_CODE_LIST
      An error that indicates a required storefront country code is empty.
      See Also:

    • INVALID_STOREFRONT_COUNTRY_CODE

      public static final APIError INVALID_STOREFRONT_COUNTRY_CODE
      An error that indicates a storefront code is invalid.
      See Also:

    • INVALID_REVOKED

      public static final APIError INVALID_REVOKED
      An error that indicates the revoked parameter contains an invalid value.
      See Also:

    • INVALID_STATUS

      public static final APIError INVALID_STATUS
      An error that indicates the status parameter is invalid.
      See Also:

    • INVALID_ACCOUNT_TENURE

      public static final APIError INVALID_ACCOUNT_TENURE
      An error that indicates the value of the account tenure field is invalid.
      See Also:

    • INVALID_APP_ACCOUNT_TOKEN

      public static final APIError INVALID_APP_ACCOUNT_TOKEN
      An error that indicates the value of the app account token field is invalid.
      See Also:

    • INVALID_CONSUMPTION_STATUS

      public static final APIError INVALID_CONSUMPTION_STATUS
      An error that indicates the value of the consumption status field is invalid.
      See Also:

    • INVALID_CUSTOMER_CONSENTED

      public static final APIError INVALID_CUSTOMER_CONSENTED
      An error that indicates the customer consented field is invalid or doesn’t indicate that the customer consented.
      See Also:

    • INVALID_DELIVERY_STATUS

      public static final APIError INVALID_DELIVERY_STATUS
      An error that indicates the value in the delivery status field is invalid.
      See Also:

    • INVALID_LIFETIME_DOLLARS_PURCHASED

      public static final APIError INVALID_LIFETIME_DOLLARS_PURCHASED
      An error that indicates the value in the lifetime dollars purchased field is invalid.
      See Also:

    • INVALID_LIFETIME_DOLLARS_REFUNDED

      public static final APIError INVALID_LIFETIME_DOLLARS_REFUNDED
      An error that indicates the value in the lifetime dollars refunded field is invalid.
      See Also:

    • INVALID_PLATFORM

      public static final APIError INVALID_PLATFORM
      An error that indicates the value in the platform field is invalid.
      See Also:

    • INVALID_PLAY_TIME

      public static final APIError INVALID_PLAY_TIME
      An error that indicates the value in the playtime field is invalid.
      See Also:

    • INVALID_SAMPLE_CONTENT_PROVIDED

      public static final APIError INVALID_SAMPLE_CONTENT_PROVIDED
      An error that indicates the value in the sample content provided field is invalid.
      See Also:

    • INVALID_USER_STATUS

      public static final APIError INVALID_USER_STATUS
      An error that indicates the value in the user status field is invalid.
      See Also:

    • INVALID_TRANSACTION_NOT_CONSUMABLE

      @Deprecated public static final APIError INVALID_TRANSACTION_NOT_CONSUMABLE
      Deprecated.
      An error that indicates the transaction identifier doesn’t represent a consumable in-app purchase.
      See Also:

    • INVALID_TRANSACTION_TYPE_NOT_SUPPORTED

      public static final APIError INVALID_TRANSACTION_TYPE_NOT_SUPPORTED
      An error that indicates the transaction identifier represents an unsupported in-app purchase type.
      See Also:

    • APP_TRANSACTION_ID_NOT_SUPPORTED_ERROR

      public static final APIError APP_TRANSACTION_ID_NOT_SUPPORTED_ERROR
      An error that indicates the endpoint doesn't support an app transaction ID.
      See Also:

    • INVALID_IMAGE

      public static final APIError INVALID_IMAGE
      An error that indicates the image that's uploading is invalid.
      See Also:

    • HEADER_TOO_LONG

      public static final APIError HEADER_TOO_LONG
      An error that indicates the header text is too long.
      See Also:

    • BODY_TOO_LONG

      public static final APIError BODY_TOO_LONG
      An error that indicates the body text is too long.
      See Also:

    • INVALID_LOCALE

      public static final APIError INVALID_LOCALE
      An error that indicates the locale is invalid.
      See Also:

    • ALT_TEXT_TOO_LONG

      public static final APIError ALT_TEXT_TOO_LONG
      An error that indicates the alternative text for an image is too long.
      See Also:

    • INVALID_APP_ACCOUNT_TOKEN_UUID_ERROR

      public static final APIError INVALID_APP_ACCOUNT_TOKEN_UUID_ERROR
      An error that indicates the app account token value is not a valid UUID.
      See Also:

    • FAMILY_TRANSACTION_NOT_SUPPORTED_ERROR

      public static final APIError FAMILY_TRANSACTION_NOT_SUPPORTED_ERROR
      An error that indicates the transaction is for a product the customer obtains through Family Sharing, which the endpoint doesn’t support.
      See Also:

    • TRANSACTION_ID_IS_NOT_ORIGINAL_TRANSACTION_ID_ERROR

      public static final APIError TRANSACTION_ID_IS_NOT_ORIGINAL_TRANSACTION_ID_ERROR
      An error that indicates the endpoint expects an original transaction identifier.
      See Also:

    • SUBSCRIPTION_EXTENSION_INELIGIBLE

      public static final APIError SUBSCRIPTION_EXTENSION_INELIGIBLE
      An error that indicates the subscription doesn't qualify for a renewal-date extension due to its subscription state.
      See Also:

    • SUBSCRIPTION_MAX_EXTENSION

      public static final APIError SUBSCRIPTION_MAX_EXTENSION
      An error that indicates the subscription doesn’t qualify for a renewal-date extension because it has already received the maximum extensions.
      See Also:

    • FAMILY_SHARED_SUBSCRIPTION_EXTENSION_INELIGIBLE

      public static final APIError FAMILY_SHARED_SUBSCRIPTION_EXTENSION_INELIGIBLE
      An error that indicates a subscription isn't directly eligible for a renewal date extension because the user obtained it through Family Sharing.
      See Also:

    • MAXIMUM_NUMBER_OF_IMAGES_REACHED

      public static final APIError MAXIMUM_NUMBER_OF_IMAGES_REACHED
      An error that indicates when you reach the maximum number of uploaded images.
      See Also:

    • MAXIMUM_NUMBER_OF_MESSAGES_REACHED

      public static final APIError MAXIMUM_NUMBER_OF_MESSAGES_REACHED
      An error that indicates when you reach the maximum number of uploaded messages.
      See Also:

    • MESSAGE_NOT_APPROVED

      public static final APIError MESSAGE_NOT_APPROVED
      An error that indicates the message isn't in the approved state, so you can't configure it as a default message.
      See Also:

    • IMAGE_NOT_APPROVED

      public static final APIError IMAGE_NOT_APPROVED
      An error that indicates the image isn't in the approved state, so you can't configure it as part of a default message.
      See Also:

    • IMAGE_IN_USE

      public static final APIError IMAGE_IN_USE
      An error that indicates the image is currently in use as part of a message, so you can't delete it.
      See Also:

    • ACCOUNT_NOT_FOUND

      public static final APIError ACCOUNT_NOT_FOUND
      An error that indicates the App Store account wasn't found.
      See Also:

    • ACCOUNT_NOT_FOUND_RETRYABLE

      public static final APIError ACCOUNT_NOT_FOUND_RETRYABLE
      An error response that indicates the App Store account wasn’t found, but you can try again.
      See Also:

    • APP_NOT_FOUND

      public static final APIError APP_NOT_FOUND
      An error that indicates the app wasn’t found.
      See Also:

    • APP_NOT_FOUND_RETRYABLE

      public static final APIError APP_NOT_FOUND_RETRYABLE
      An error response that indicates the app wasn’t found, but you can try again.
      See Also:

    • ORIGINAL_TRANSACTION_ID_NOT_FOUND

      public static final APIError ORIGINAL_TRANSACTION_ID_NOT_FOUND
      An error that indicates an original transaction identifier wasn't found.
      See Also:

    • ORIGINAL_TRANSACTION_ID_NOT_FOUND_RETRYABLE

      public static final APIError ORIGINAL_TRANSACTION_ID_NOT_FOUND_RETRYABLE
      An error response that indicates the original transaction identifier wasn’t found, but you can try again.
      See Also:

    • SERVER_NOTIFICATION_URL_NOT_FOUND

      public static final APIError SERVER_NOTIFICATION_URL_NOT_FOUND
      An error that indicates that the App Store server couldn’t find a notifications URL for your app in this environment.
      See Also:

    • TEST_NOTIFICATION_NOT_FOUND

      public static final APIError TEST_NOTIFICATION_NOT_FOUND
      An error that indicates that the test notification token is expired or the test notification status isn’t available.
      See Also:

    • STATUS_REQUEST_NOT_FOUND

      public static final APIError STATUS_REQUEST_NOT_FOUND
      An error that indicates the server didn't find a subscription-renewal-date extension request for the request identifier and product identifier you provided.
      See Also:

    • TRANSACTION_ID_NOT_FOUND

      public static final APIError TRANSACTION_ID_NOT_FOUND
      An error that indicates a transaction identifier wasn't found.
      See Also:

    • IMAGE_NOT_FOUND

      public static final APIError IMAGE_NOT_FOUND
      An error that indicates the system can't find the image identifier.
      See Also:

    • MESSAGE_NOT_FOUND

      public static final APIError MESSAGE_NOT_FOUND
      An error that indicates the system can't find the message identifier.
      See Also:

    • APP_TRANSACTION_DOES_NOT_EXIST_ERROR

      public static final APIError APP_TRANSACTION_DOES_NOT_EXIST_ERROR
      An error response that indicates an app transaction doesn’t exist for the specified customer.
      See Also:

    • IMAGE_ALREADY_EXISTS

      public static final APIError IMAGE_ALREADY_EXISTS
      An error that indicates the image identifier already exists.
      See Also:

    • MESSAGE_ALREADY_EXISTS

      public static final APIError MESSAGE_ALREADY_EXISTS
      An error that indicates the message identifier already exists.
      See Also:

    • RATE_LIMIT_EXCEEDED

      public static final APIError RATE_LIMIT_EXCEEDED
      An error that indicates that the request exceeded the rate limit.
      See Also:

    • GENERAL_INTERNAL

      public static final APIError GENERAL_INTERNAL
      An error that indicates a general internal error.
      See Also:

    • GENERAL_INTERNAL_RETRYABLE

      public static final APIError GENERAL_INTERNAL_RETRYABLE
      An error response that indicates an unknown error occurred, but you can try again.
      See Also:

  • Method Details

    • values

      public static APIError[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static APIError valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • fetchErrorResponseFromErrorCode

      public static APIError fetchErrorResponseFromErrorCode(long errorCode)

    • errorCode

      public long errorCode()