Get Donation List CSV By Charity

get

https://reporting.api.shoppinggives.com/orders/donation-list/csv/charities

Authorization: Store:Reporting

Query Params

string | null

A search term to filter the donations list.

sources

string | null

List of sources to return a donation list for; must be a CSV of valid integer values.

orderByAsc

string | null

Name of the property to order results by (ascending). Valid values: purchaseDate, donation, orderid.

orderByDesc

string | null

Name of the property to order results by (descending). Valid values: purchaseDate, donation, orderid.

startDateTime

date-time | null

Start date donations will be returned after.

endDateTime

date-time | null

End date donations will be returned before.

page

int32

Defaults to 1

Page of the search results that will be returned

pageLength

int32

Defaults to 25

Number of results that will be returned per page.

timeOffset

int32

Defaults to 0

Offset from UTC of the user's time zone, calculated by UTC - local time (ie: CST would be -6).

filterOnDirectDonation

array of int32s | null

filterOnDirectDonation

filterOutDirectDonation

boolean

Defaults to false

Whether or not to remove all direct donations from the results.

filterToDirectDonations

boolean

Defaults to false

Whether or not to filter all results down to just direct donations.

Headers

x-store-id

string | null

Your store ID (we will provide this).

Response

200

Success