deliver • snapshot • frameit • PEM • sigh • produce • cert • codes

This document describes the iTunes Connect JSON API and how to use it. The API is used by the AngularJS based iTunes Connect front-end to update app metadata. It is public once you have a valid session.

To test your requests, I recommend the awesome Paw HTTP Client for Mac OS.

fastlane and some of the fastlane tools make use of the iTunes Connect API. Using this git repository it's easy to keep the documentation up to date.

All requests (except for the login action) require you to pass cookies. If you're using a HTTP client, you'll get this for free.

Download the pre-filled PAW file and open it with Paw.

Next, you can enter your iTunes Connect credentials in the Default Domain settings:

The app_id is the ID of your app. You only need to fill that in, if you want to fetch the metadata for one of your apps.

Switch back to the list of requests on the left side and select Login. Click CMD + R to send the request to login.

For all requests listed below, you'll need a valid cookie which you have to pass for each request.

POST

https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/wo/0.0.1.11.3.15.2.1.1.3.1.1

Available parameters

• theAccountName (POST): Your Apple ID
• theAccountPW (POST): Your password

The response HTTP status codes are confusing:

• 302 Moved Temporarily: Login successful
• 200 OK: Login unsucessful, wrong credentials

If you get 200 and your credentials are correct, try deleting the cookies.

List all your apps with the most basic app metadata:

GET

https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/apps/manageyourapps/summary

If you get 401, try deleting the cookies and sending a new login request.

Receive all metadata information available for this app, including app description, screenshots, review status and much more.

GET

https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/apps/version/[app_id]

Available parameters

• App ID (GET): The ID of your app (e.g. 903020700)
• v (GET): Defines if the app metadata of the version currently available in the App Store or the new version should be used.

Example:

https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/apps/version/[app_id]?v=live

This will fetch the app metadata from the version, that is currently available in the App Store. If you don't define this parameter, you receive the metadata from the version that is currently being edited. Usually you don't need this parameter.

You can update the app metadata using this request. It's not very easy to build the request, as there are many parameters required.

To upload screenshots it's recommended to use the iTMSTransporter, which is also used by deliver.

POST

https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/apps/version/save/[app_id]

Available parameters

See example POST Request (quite complex)

Create a new version of your existing app.

POST

https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/apps/version/create/[app_id]

Available parameters

• App ID (GET): The ID of your app (e.g. 903020700) GET
• JSON (POST): {"version": "2.0"}

Creates a new app on iTunes Connect

POST

https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/apps/create/?appType=ios

Available parameters

See example POST Request

The response HTTP status codes are not correctly used:

• 200 OK: An error occured, check the response JSON to read the error message
• 200 OK: Successfully created a new app

You have to read the response["data"]["sectionErrorKeys"] to be sure the request was successful.

Uploading a new binary is only possible using the iTMSTransporter. You can take a look at deliver how this is implemented.

This documentation is part of the fastlane toolchain.

Special thanks to this GitHub Issue in particular @spidfire and Christian Beer.