MS:getTransactionList

From Wiki

Jump to: navigation, search

Gets the transactions that fall under the specified criteria

Parameters


Element

Type

aAffiliateIds optional

Array of publisher IDs

Value Type: ArrayOfInt
Example: array(1011, 1012, 1013)

dStartDate required

Start date of a transaction search

Value Type: dateTime
Example: 2013-01-01T00:00:00

dEndDate required

End date of a transaction search

Value Type: dateTime
Example: 2013-01-31T23:59:59

sDateType required

Date range type

Value Type: DateType
Example: transaction

sTransactionStatus optional

The transaction status (i.e pending, confirmed, declined)

Value Type: TransactionStatus
Example: pending

iLimit optional

Limit a result set - max 100 - default 100

Value Type: int
Example: 0

iOffset optional

Offset results - default 0

Value Type: int
Example: 0


Response


getTransactionReturn

Array of Transaction objects

Value Type: Transaction

getTransactionListCountReturn

Number of rows returned/available

Value Type: RowCounts


Example Request (parameters)


$aParams2 = array(
	'dStartDate'	=>	'2014-02-01T00:00:00', 
	'dEndDate'		=>	'2014-02-28T23:59:59', 
	'sDateType'		=>	'transaction'
);

$oResponse = $oClient->call('getTransactionList', $aParams2);


Example Response


stdClass Object
(
    [getTransactionListReturn] => Array
        (
            [0] => stdClass Object
                (
                    [iId] => ...
                    [sStatus] => confirmed
                    [sType] => normal
                    [sOrderRef] => ...
                    [sIp] => ...
                    [bPaid] => 1
                    [iPaymentId] => ...
                    [iAffiliateId] => ...
                    [fSaleAmount] => 306.67
                    [fCommissionAmount] => 6.13
                    [dClickDate] => 2014-02-02 21:45:55
                    [dTransactionDate] => 2014-02-02 21:49:57
                    [dValidationDate] => 2014-02-02 22:51:58
                    [sClickref] => ...
                    [aTransactionParts] => Array
                        (
                            [0] => stdClass Object
                                (
                                    [sCommissionGroupName] => DEFAULT
                                    [fSaleAmount] => 306.67
                                    [fCommissionAmount] => 6.13
                                    [iCommission] => 2
                                    [sCommissionType] => percentage
                                )

                        )

                )
...
        )
)

Limitations/Notes

  • The maximum date range is 30 days per API request

Privacy

Due to new European legislation regarding how websites store information about you, AWIN is updating its privacy policy. You can see the new version of our policy here. If you would like to see the information we capture on this website, please click here for further details. In order to accept cookies on this site please click the 'I ACCEPT' button