@apple/app-store-server-library
    Preparing search index...

    Enumeration APIError

    Error codes that App Store Server API responses return.

    Error codes

    Index

    Enumeration Members

    ACCOUNT_NOT_FOUND ACCOUNT_NOT_FOUND_RETRYABLE ALT_TEXT_TOO_LONG APP_NOT_FOUND APP_NOT_FOUND_RETRYABLE APP_TRANSACTION_DOES_NOT_EXIST_ERROR APP_TRANSACTION_ID_NOT_SUPPORTED_ERROR BODY_TOO_LONG FAMILY_SHARED_SUBSCRIPTION_EXTENSION_INELIGIBLE FAMILY_TRANSACTION_NOT_SUPPORTED_ERROR GENERAL_BAD_REQUEST GENERAL_INTERNAL GENERAL_INTERNAL_RETRYABLE HEADER_TOO_LONG IMAGE_ALREADY_EXISTS IMAGE_IN_USE IMAGE_NOT_APPROVED IMAGE_NOT_FOUND INVALID_ACCOUNT_TENURE INVALID_APP_ACCOUNT_TOKEN INVALID_APP_ACCOUNT_TOKEN_UUID_ERROR INVALID_APP_IDENTIFIER INVALID_CONSUMPTION_STATUS INVALID_CUSTOMER_CONSENTED INVALID_DELIVERY_STATUS INVALID_EMPTY_STOREFRONT_COUNTRY_CODE_LIST INVALID_END_DATE INVALID_EXCLUDE_REVOKED INVALID_EXTEND_BY_DAYS INVALID_EXTEND_REASON_CODE INVALID_IMAGE INVALID_IN_APP_OWNERSHIP_TYPE INVALID_LIFETIME_DOLLARS_PURCHASED INVALID_LIFETIME_DOLLARS_REFUNDED INVALID_LOCALE INVALID_NOTIFICATION_TYPE INVALID_ORIGINAL_TRANSACTION_ID INVALID_PAGINATION_TOKEN INVALID_PLATFORM INVALID_PLAY_TIME INVALID_PRODUCT_ID INVALID_PRODUCT_TYPE INVALID_REQUEST_IDENTIFIER INVALID_REQUEST_REVISION INVALID_REVOKED INVALID_SAMPLE_CONTENT_PROVIDED INVALID_SORT INVALID_START_DATE INVALID_STATUS INVALID_STOREFRONT_COUNTRY_CODE INVALID_SUBSCRIPTION_GROUP_IDENTIFIER INVALID_TEST_NOTIFICATION_TOKEN INVALID_TRANSACTION_ID INVALID_TRANSACTION_NOT_CONSUMABLE INVALID_TRANSACTION_TYPE_NOT_SUPPORTED INVALID_USER_STATUS MAXIMUM_NUMBER_OF_IMAGES_REACHED MAXIMUM_NUMBER_OF_MESSAGES_REACHED MESSAGE_ALREADY_EXISTS MESSAGE_NOT_APPROVED MESSAGE_NOT_FOUND MULTIPLE_FILTERS_SUPPLIED ORIGINAL_TRANSACTION_ID_NOT_FOUND ORIGINAL_TRANSACTION_ID_NOT_FOUND_RETRYABLE PAGINATION_TOKEN_EXPIRED RATE_LIMIT_EXCEEDED SERVER_NOTIFICATION_URL_NOT_FOUND START_DATE_AFTER_END_DATE START_DATE_TOO_FAR_IN_PAST STATUS_REQUEST_NOT_FOUND SUBSCRIPTION_EXTENSION_INELIGIBLE SUBSCRIPTION_MAX_EXTENSION TEST_NOTIFICATION_NOT_FOUND TRANSACTION_ID_IS_NOT_ORIGINAL_TRANSACTION_ID_ERROR TRANSACTION_ID_NOT_FOUND

    Enumeration Members

    ACCOUNT_NOT_FOUND: 4040001

    An error that indicates the App Store account wasn't found.

    AccountNotFoundError

    ACCOUNT_NOT_FOUND_RETRYABLE: 4040002

    An error response that indicates the App Store account wasn’t found, but you can try again.

    AccountNotFoundRetryableError

    ALT_TEXT_TOO_LONG: 4000175

    An error that indicates the alternative text for an image is too long.

    AltTextTooLongError

    APP_NOT_FOUND: 4040003

    An error that indicates the app wasn’t found.

    AppNotFoundError

    APP_NOT_FOUND_RETRYABLE: 4040004

    An error response that indicates the app wasn’t found, but you can try again.

    AppNotFoundRetryableError

    APP_TRANSACTION_DOES_NOT_EXIST_ERROR: 4040019

    An error response that indicates an app transaction doesn’t exist for the specified customer.

    AppTransactionDoesNotExistError

    APP_TRANSACTION_ID_NOT_SUPPORTED_ERROR: 4000048

    An error that indicates the endpoint doesn't support an app transaction ID.

    AppTransactionIdNotSupportedError

    BODY_TOO_LONG: 4000163

    An error that indicates the body text is too long.

    BodyTooLongError

    FAMILY_SHARED_SUBSCRIPTION_EXTENSION_INELIGIBLE: 4030007

    An error that indicates a subscription isn't directly eligible for a renewal date extension because the user obtained it through Family Sharing.

    FamilySharedSubscriptionExtensionIneligibleError

    FAMILY_TRANSACTION_NOT_SUPPORTED_ERROR: 4000185

    An error that indicates the transaction is for a product the customer obtains through Family Sharing, which the endpoint doesn’t support.

    FamilyTransactionNotSupportedError

    GENERAL_BAD_REQUEST: 4000000

    An error that indicates an invalid request.

    GeneralBadRequestError

    GENERAL_INTERNAL: 5000000

    An error that indicates a general internal error.

    GeneralInternalError

    GENERAL_INTERNAL_RETRYABLE: 5000001

    An error response that indicates an unknown error occurred, but you can try again.

    GeneralInternalRetryableError

    HEADER_TOO_LONG: 4000162

    An error that indicates the header text is too long.

    HeaderTooLongError

    IMAGE_ALREADY_EXISTS: 4090000

    An error that indicates the image identifier already exists.

    ImageAlreadyExistsError

    IMAGE_IN_USE: 4030019

    An error that indicates the image is currently in use as part of a message, so you can't delete it.

    ImageInUseError

    IMAGE_NOT_APPROVED: 4030018

    An error that indicates the image isn't in the approved state, so you can't configure it as part of a default message.

    ImageNotApprovedError

    IMAGE_NOT_FOUND: 4040014

    An error that indicates the system can't find the image identifier.

    ImageNotFoundError

    INVALID_ACCOUNT_TENURE: 4000032

    An error that indicates the value of the account tenure field is invalid.

    InvalidAccountTenureError

    INVALID_APP_ACCOUNT_TOKEN: 4000033

    An error that indicates the value of the app account token field is invalid.

    InvalidAppAccountTokenError

    INVALID_APP_ACCOUNT_TOKEN_UUID_ERROR: 4000183

    An error that indicates the app account token value is not a valid UUID.

    InvalidAppAccountTokenUUIDError

    INVALID_APP_IDENTIFIER: 4000002

    An error that indicates an invalid app identifier.

    InvalidAppIdentifierError

    INVALID_CONSUMPTION_STATUS: 4000034

    An error that indicates the value of the consumption status field is invalid.

    InvalidConsumptionStatusError

    INVALID_CUSTOMER_CONSENTED: 4000035

    An error that indicates the customer consented field is invalid or doesn’t indicate that the customer consented.

    InvalidCustomerConsentedError

    INVALID_DELIVERY_STATUS: 4000036

    An error that indicates the value in the delivery status field is invalid.

    InvalidDeliveryStatusError

    INVALID_EMPTY_STOREFRONT_COUNTRY_CODE_LIST: 4000027

    An error that indicates a required storefront country code is empty.

    InvalidEmptyStorefrontCountryCodeListError

    INVALID_END_DATE: 4000016

    An error that indicates the end date is invalid.

    InvalidEndDateError

    INVALID_EXCLUDE_REVOKED: 4000025

    An error that indicates the query parameter exclude-revoked is invalid.

    InvalidExcludeRevokedError

    INVALID_EXTEND_BY_DAYS: 4000009

    An error that indicates an invalid extend-by-days value.

    InvalidExtendByDaysError

    INVALID_EXTEND_REASON_CODE: 4000010

    An error that indicates an invalid reason code.

    InvalidExtendReasonCodeError

    INVALID_IMAGE: 4000161

    An error that indicates the image that's uploading is invalid.

    InvalidImageError

    INVALID_IN_APP_OWNERSHIP_TYPE: 4000026

    An error that indicates an invalid in-app ownership type parameter.

    InvalidInAppOwnershipTypeError

    INVALID_LIFETIME_DOLLARS_PURCHASED: 4000037

    An error that indicates the value in the lifetime dollars purchased field is invalid.

    InvalidLifetimeDollarsPurchasedError

    INVALID_LIFETIME_DOLLARS_REFUNDED: 4000038

    An error that indicates the value in the lifetime dollars refunded field is invalid.

    InvalidLifetimeDollarsRefundedError

    INVALID_LOCALE: 4000164

    An error that indicates the locale is invalid.

    InvalidLocaleError

    INVALID_NOTIFICATION_TYPE: 4000018

    An error that indicates the notification type or subtype is invalid.

    InvalidNotificationTypeError

    INVALID_ORIGINAL_TRANSACTION_ID: 4000008

    An error that indicates an invalid original transaction identifier.

    InvalidOriginalTransactionIdError

    INVALID_PAGINATION_TOKEN: 4000014

    An error that indicates the pagination token is invalid.

    InvalidPaginationTokenError

    INVALID_PLATFORM: 4000039

    An error that indicates the value in the platform field is invalid.

    InvalidPlatformError

    INVALID_PLAY_TIME: 4000040

    An error that indicates the value in the playtime field is invalid.

    InvalidPlayTimeError

    INVALID_PRODUCT_ID: 4000023

    An error that indicates the product ID parameter is invalid.

    InvalidProductIdError

    INVALID_PRODUCT_TYPE: 4000022

    An error that indicates an invalid product type parameter.

    InvalidProductTypeError

    INVALID_REQUEST_IDENTIFIER: 4000011

    An error that indicates an invalid request identifier.

    InvalidRequestIdentifierError

    INVALID_REQUEST_REVISION: 4000005

    An error that indicates an invalid request revision.

    InvalidRequestRevisionError

    INVALID_REVOKED: 4000030

    An error that indicates the revoked parameter contains an invalid value.

    InvalidRevokedError

    INVALID_SAMPLE_CONTENT_PROVIDED: 4000041

    An error that indicates the value in the sample content provided field is invalid.

    InvalidSampleContentProvidedError

    INVALID_SORT: 4000021

    An error that indicates an invalid sort parameter.

    InvalidSortError

    INVALID_START_DATE: 4000015

    An error that indicates the start date is invalid.

    InvalidStartDateError

    INVALID_STATUS: 4000031

    An error that indicates the status parameter is invalid.

    InvalidStatusError

    INVALID_STOREFRONT_COUNTRY_CODE: 4000028

    An error that indicates a storefront code is invalid.

    InvalidStorefrontCountryCodeError

    INVALID_SUBSCRIPTION_GROUP_IDENTIFIER: 4000024

    An error that indicates an invalid subscription group identifier.

    InvalidSubscriptionGroupIdentifierError

    INVALID_TEST_NOTIFICATION_TOKEN: 4000020

    An error that indicates the test notification token is invalid.

    InvalidTestNotificationTokenError

    INVALID_TRANSACTION_ID: 4000006

    An error that indicates an invalid transaction identifier.

    InvalidTransactionIdError

    INVALID_TRANSACTION_NOT_CONSUMABLE: 4000043

    An error that indicates the transaction identifier doesn’t represent a consumable in-app purchase.

    InvalidTransactionNotConsumableError

    INVALID_TRANSACTION_TYPE_NOT_SUPPORTED: 4000047

    An error that indicates the transaction identifier represents an unsupported in-app purchase type.

    InvalidTransactionTypeNotSupportedError

    INVALID_USER_STATUS: 4000042

    An error that indicates the value in the user status field is invalid.

    InvalidUserStatusError

    MAXIMUM_NUMBER_OF_IMAGES_REACHED: 4030014

    An error that indicates when you reach the maximum number of uploaded images.

    MaximumNumberOfImagesReachedError

    MAXIMUM_NUMBER_OF_MESSAGES_REACHED: 4030016

    An error that indicates when you reach the maximum number of uploaded messages.

    MaximumNumberOfMessagesReachedError

    MESSAGE_ALREADY_EXISTS: 4090001

    An error that indicates the message identifier already exists.

    MessageAlreadyExistsError

    MESSAGE_NOT_APPROVED: 4030017

    An error that indicates the message isn't in the approved state, so you can't configure it as a default message.

    MessageNotApprovedError

    MESSAGE_NOT_FOUND: 4040015

    An error that indicates the system can't find the message identifier.

    MessageNotFoundError

    MULTIPLE_FILTERS_SUPPLIED: 4000019

    An error that indicates the request is invalid because it has too many constraints applied.

    MultipleFiltersSuppliedError

    ORIGINAL_TRANSACTION_ID_NOT_FOUND: 4040005

    An error that indicates an original transaction identifier wasn't found.

    OriginalTransactionIdNotFoundError

    ORIGINAL_TRANSACTION_ID_NOT_FOUND_RETRYABLE: 4040006

    An error response that indicates the original transaction identifier wasn’t found, but you can try again.

    OriginalTransactionIdNotFoundRetryableError

    PAGINATION_TOKEN_EXPIRED: 4000017

    An error that indicates the pagination token expired.

    PaginationTokenExpiredError

    RATE_LIMIT_EXCEEDED: 4290000

    An error that indicates that the request exceeded the rate limit.

    RateLimitExceededError

    SERVER_NOTIFICATION_URL_NOT_FOUND: 4040007

    An error that indicates that the App Store server couldn’t find a notifications URL for your app in this environment.

    ServerNotificationUrlNotFoundError

    START_DATE_AFTER_END_DATE: 4000013

    An error that indicates that the end date precedes the start date, or the two dates are equal.

    StartDateAfterEndDateError

    START_DATE_TOO_FAR_IN_PAST: 4000012

    An error that indicates that the start date is earlier than the earliest allowed date.

    StartDateTooFarInPastError

    STATUS_REQUEST_NOT_FOUND: 4040009

    An error that indicates the server didn't find a subscription-renewal-date extension request for the request identifier and product identifier you provided.

    StatusRequestNotFoundError

    SUBSCRIPTION_EXTENSION_INELIGIBLE: 4030004

    An error that indicates the subscription doesn't qualify for a renewal-date extension due to its subscription state.

    SubscriptionExtensionIneligibleError

    SUBSCRIPTION_MAX_EXTENSION: 4030005

    An error that indicates the subscription doesn’t qualify for a renewal-date extension because it has already received the maximum extensions.

    SubscriptionMaxExtensionError

    TEST_NOTIFICATION_NOT_FOUND: 4040008

    An error that indicates that the test notification token is expired or the test notification status isn’t available.

    TestNotificationNotFoundError

    TRANSACTION_ID_IS_NOT_ORIGINAL_TRANSACTION_ID_ERROR: 4000187

    An error that indicates the endpoint expects an original transaction identifier.

    TransactionIdIsNotOriginalTransactionIdError

    TRANSACTION_ID_NOT_FOUND: 4040010

    An error that indicates a transaction identifier wasn't found.

    TransactionIdNotFoundError