KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

itunes-connect-sales-api-php

★ 10 Open GitHub ↗

PHP iTunes Connect Sales Reports API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [UPDATE 10 Aug 2017]
Current version now uses the access token as described [on the Apple website](https://help.apple.com/itc/appsreporterguide/?lang=en#/apd2f1f1cfa3)
# [UPDATE 12 Feb 2017]
Current version now works with the reporter service as 
Apple have shutdown the autoingestion tool on december 13th 2016.

# itunes-connect-sales-api-php
PHP iTunes Connect Sales Reports API

## Features
- Simple, PHP class that returns iTunes Connect Sales Reports in JSON 
- Get daily, weekly, monthly or yearly sales (+ free app downloads as well) report directly from iTunes Connect

## Requirements ##
* PHP 
* Valid iTunes Connect Account 
**Watch out, your vendor ID might not be the one shown on "Payments and reports" page !** 
Get your vendor id by : 
>Login to iTunes Connect 
>Go to "Sales and trends" 
>Click on "Top content" ("Classement des contenus" in French) and then "Reports" 
>You'll see the list of vendors 
Or simply call the getVendors() of the iTunesSalesApi

## Limitations ##
* You will not be able to get a daily report for today (yesterday is the earliest)
* Most recent weekly report is last week
* Most recent monthly report is last month
* Most recent yearly report is last year

## Getting Started ##
Simply require the iTunesSalesApi.php and you're good to go 
`require_once("class/iTunesSalesApi.php");`
 
Create a new instance of iTunesSalesApi 
```php
$reporter = new iTunesSalesApi();

$reporter->setAccessToken("reporter-access-token")
			->setVendor("myVendorId");
```
## Quick Example ##
### Fetch the list of accounts ###
```php
try{
	//return is either an array or false
    //if false you can get errors by calling getErrorsAsString() or listing $reporter->errors
    if($accounts = $reporter->getAccounts()){
		//Do something with data your're good to go
		print_r(json_encode($accounts));
	}
	else{
		echo "Api  Errors : ".$reporter->getErrorsAsString();
	}
}catch (Exception $e){
	echo $e->getMessage();
}
```
### Set a specific account (optionnal if you have only one account) ###
```php
$accounts = $reporter->getAccounts();

//Example with first account returned from list
//account is numeric but setAccount parses raw return from the getAccounts() method
$reporter->setAccount($accounts[0]);

```
### Fetch the list of vendor id's ###
```php
try{
	//return is either an array or false
 //if false you can get errors by calling getErrorsAsString() or listing $reporter->errors
	if($vendors = $reporter->getVendors()){
		//Do something with data your're good to got
		print_r(json_encode($vendors));
		
		//Example
		$reporter->setVendor($vendors[0]);
	}
	else{
		echo "Api Errors : ".$reporter->getErrorsAsString();
	}
}catch (Exception $e){
	echo $e->getMessage();
}
```
### Daily report ###
```php
try{
	//$data is either an array or false
 //if false you can get errors by calling getErrorsAsString() or listing $reporter->errors
 //Date must be YYYYMMDD format (ex: 20161122) for the 22nd november 2016
	if($data = $reporter->getSalesDailyReport("20161122")) { // You do not need to specify a date (defaut is yesterday)
		//Do something with data your're good to go
		print_r(json_encode($data));
	}
	else{
		echo "Api Errors : ".$reporter->getErrorsAsString();
	}
}catch (Exception $e){
	echo $e->getMessage();
}
```
### Weekly report ###
```php
try{
	//Date must be YYYYMMDD format (ex: 20161122) for the 22nd november 2016 and week will be calculated
	if($data = $reporter->getSalesWeeklyReport()) { //Will get last week by default
		//Do something with data your're good to go
		print_r(json_encode($data));
	}
	else{
		echo "Api Errors : ".$reporter->getErrorsAsString();
	}
}catch (Exception $e){
	echo $e->getMessage();
}
```
### Monthly report ###
```php
try{
	//Date must be YYYYMM format (ex: 201611) for november 2016
	if($data = $reporter->getSalesMonthlyReport()) { //Will get last month by default
		//Do something with data your're good to go
		print_r(json_encode($data));
	}
	else{
		echo "Api Errors : ".$reporter->getErrorsAsString();
	}
}catch (Exception $e){
	echo $e->getMessage();
}
```
### Yearly report ###
```php
try{
	//Date must be YYYY format (ex: 2016) 
	if($data = $reporter->getSalesYearlyReport()) { //Will get last year by default
		//Do something with data your're good to go
		print_r(json_encode($data));
	}
	else{
		echo "Api Errors : ".$reporter->getErrorsAsString();
	}
}catch (Exception $e){
	echo $e->getMessage();
}
```
## Optional settings ##
If you want to save the reports locally, you can specify a folder you wish to save them to : 
```php
$reporter->setFolder("/path/to/my/folder"); //Not saved locally by default (no cache either)
```
If you want to stop script when non critical errors are encountered, set throwErrors to true : 
```php
$reporter->throwErrors = true; //False by default
```
If you have specified a folder, API will load previous cached files if available. If you do not want to use the cached file but want a fresh set of data, you can force the refresh request : 
```php
$reporter->setUseCache(false); //True by default
```
If you are only interested in how much money you're making, you can skip the free items of sale by setting the report mode to earnings only: 
```php
$reporter->setReportModeEarningsOnly(); //Default is $reporter->setReportModeAll();
```
## Example output ##
```php
{
 "success": true,
 "response": {
 "report_start_date": "20170212",
 "report_end_date": "20170212",
 "number_sales": 35,
 "app_downloads": 808,
 "revenues": {
 "USD": {
 "turnover": 35.88,
 "earnings": 25.2,
 "sales": 25
 },
 "PHP": {
 "turnover": 99,
 "earnings": 69.3,
 "sales": 1
 },
 "EUR": {
 "turnover": 7.97,
 "earnings": 4.62,
 "sales": 4
 },
 "CHF": {
 "turnover": 4,
 "earnings": 2.6,
 "sales": 2
 },
 "CAD": {
 "turnover": 2.79,
 "earnings": 1.95,
 "sales": 3
 }
 },
 "details": [
 {
 "Provider": "APPLE",
 "Provider Country": "US",
 "SKU": "AppSKU",
 "Developer": "Developer Name",
 "Title": "App Name",
 "Version": "1.4",
 "Product Type Identifier": "1F",
 "Units": "6",
 "Developer Proceeds": "0",
 "Begin Date": "02/12/2017",
 "End Date": "02/12/2017",
 "Customer Currency": "USD",
 "Country Code": "US",
 "Currency of Proceeds": "USD",
 "Apple Identifier": "1111111111",
 "Customer Price": "0",
 "Promo Code": " ",
 "Parent Identifier": " ",
 "Subscription": " ",
 "Period": " ",
 "Category": "Health & Fitness",
 "CMB": "",
 "Device": "iPad",
 "Supported Platforms": "iOS",
 "Proceeds Reason": " ",
 "Preserved Pricing": " ",
 "Client": " "
 },(...)
```
## Todo list ##
- Manage other types of reports (Subscription, Subscription Event and Newstand) : settings are there but have no idea of the possible outputs of such requests
- Return iTunes connect raw data if needed
- Manage Finance

itunes-connect-sales-api-php

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README