Contents

Get Test Notification Status

Check the status of the test App Store server notification sent to your server.

URL

GET https://api.storekit.apple.com/inApps/v1/notifications/test/{testNotificationToken}

Sandbox URL

GET https://api.storekit-sandbox.apple.com/inApps/v1/notifications/test/{testNotificationToken}

Path Parameters

NameTypeDescription
testNotificationToken RequiredtestNotificationToken

The token that uniquely identifies a test, that you receive when you call Request a Test Notification.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
CheckTestNotificationResponse

Success.

400Bad Request
Content-Type: application/json
InvalidTestNotificationTokenError

The test notification token is invalid. Use a valid token that you receive in the SendTestNotificationResponse.

401Unauthorized

The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests.

404Not Found
Content-Type: application/json
TestNotificationNotFoundError

The status isn’t yet available or the test notification token wasn’t found.

429
Content-Type: application/json
RateLimitExceededError

The request exceeded the rate limit.

500Internal Server Error
Content-Type: application/json
(GeneralInternalError | GeneralInternalRetryableError)

Server error. Try again later.

Mentioned in

Discussion

Call this endpoint using the testNotificationToken you receive when you call Request a Test Notification. You can check the status using the testNotificationToken for up to six months. Use the information in the CheckTestNotificationResponse to troubleshoot your server if it’s unable to receive App Store Server Notifications successfully.

See Also

App Store Server Notifications testing