Get List of Transaction Queries

Updated on Oct 6, 2026
Published on Jun 3, 2024

Get

/publisher/{publisherId}/transactionqueries

GET transaction queries (list)

Publishers can pull individual transaction queries, to check the status of the transaction query, create own reports, and pull additional information that can be shared between publishers and advertisers via clickref (from publisher to advertiser).

Who can use it

Publishers

Header parameters

Authorization

string

accessToken

Path parameters

publisherId

integer (int64) Required

publisherId

Query parameters

advertiserIds

array of integer

A list of advertiser ids. 708226738,708226739,708226740...

clickRefs

array of string

A list of click refs. clickRef1,clickRef2,clickRef3...

dateType

string

The date field to search date times on. If not supplied will default to transactionDate

Valid values[ "enquiryDate", "transactionDate", "validationDate" ]

endDate

string (date-time) Required

end date

Default"2021-03-15T01:59:59Z"

pageNumber

integer (int32)

The page number to return. Defaults to 1 if not supplied

Minimum1

pageSize

integer (int32)

The number of results per page. Defaults to 100 if not supplied

Minimum1

Maximum500

startDate

string (date-time) Required

start date

Default"2021-01-01T12:00:00Z"

statuses

array of string

A list of transaction query statuses to search for

Valid values[ "pending", "approved", "declined" ]

Valid Item values[ "pending", "approved", "declined" ]

timezone

string

Further details on query parameter
Please note: the maximum date range between startDate and endDate currently supported is 31 days.

Parameter	Format	Mandatory/optional	Data Type
startDate	yyyy-MM-ddThh:mm:ss	mandatory	date-time
endDate	yyyy-MM-ddThh:mm:ss	mandatory	date-time
dateType	enquiryDate transactionDate validationDate	optional (falls back to "transactionDate" if not set)	string
timezone	See https://help.awin.com/apidocs/timezones for timezone details.	mandatory	string
publisherId	12345	mandatory	integer(64)
advertiserId	12345 or 12345,67890 for multiple ones	optional, available for publishers	array[integer]
statuses	pending approved declined pending,declined for multiple ones	optional	array[string]
clickRefs	clickRef1 or clickRef1 (value2),clickRef1 (value3 )for multiple ones	optional	array[string]
pageNumber	3	optional (Defaults to 1 if not supplied)	integer(32)
pageSize	20	optional (Defaults to 100 if not supplied)	integer(32)

Responses

200

Expand All

object

pageItems

Array of object (TransactionQuery)

object

advertiserId

integer (int32)

advertiserName

string

clickRef

string

commissionAmount

object (Amount)

amount

number

currency

string

declineReason

string

description

string

enquiryDate

string

enquiryId

integer

enquiryStatus

string

Valid values[ "pending", "approved", "declined" ]

enquiryType

string

Valid values[ "declined", "incorrect", "untracked" ]

orderRef

string

saleAmount

object (Amount)

amount

number

currency

string

transactionDate

string

validationDate

string

pageNumber

integer (int32)

pageSize

integer (int32)

totalPagesAvailable

integer (int32)

totalRowsAvailable

integer (int32)

Common Error Messages

Some errors appear when incorrect API values are parsed.

Error Scenario	Error Message
Start date after end date	endDate cannot be before startDate
Start date greater than 31days	This endpoint only supports a date range of 31 days. Please adjust your startDate or endDate.
Using an invalid date type	Wrong data type for parameter 'dateType'
Using an invalid status type	Wrong data type for parameter 'statuses'