The Donor Approved API allows you to get and change some details without the need to login to Donor Approved. The API is meant for server-side calls only and should not be used for AJAX calls.

Note that use of the API requires programming knowledge.

General Information (GET)

API Code

JSON:

https://www.donorapproved.com/api/sites/?siteid=56470&token=dh98ab5670

XML:

https://www.donorapproved.com/api/xml/sites/?siteid=56470&token=dh98ab5670

The following information will be returned in the format you chose (xml / json):

site:

Yoursite.org

url:

siteid:

56470

review_count:

0

average:

0

Get Reviews (GET)

Returns a list of reviews (up to 100) based on the specified criteria provided

Optional Parameters

from:

The collection start date
(yyyy-mm-dd)

to:

The collection end date
(yyyy-mm-dd)

sort:

How you would like the reviews sorted
(highest | lowest | oldest | newest)

page:

The current page number
(note: only 100 reviews will be returned at a time)

API Code:

JSON:

https://www.donorapproved.com/api/reviews/?siteid=56470&token=dh98ab5670=2019-01-01&to=2019-02-01&sort=newest&page=0

XML:

https://www.donorapproved.com/api/xml/reviews/?siteid=56470&token=dh98ab5670=2019-01-01&to=2019-02-01&sort=newest&page=0

A list with the following information will be returned in the format you chose (xml / json):

Name:

The Donor Name

displaydate:

The date of the review

textcomments:

The comments made by the donor

fullurl:

The url of the review

overall:

The overall score of the review

recommend:

The recommendation score from the review

Get Reviews by Order ID (GET)

Returns a specific review based on the order ID from your shipping cart

Required Parameters

orderid:

The Order ID from your Cart

API Code:

JSON:

https://www.donorapproved.com/api/review/?siteid=56470&token=dh98ab5670=012563

XML:

https://www.donorapproved.com/api/xml/review/?siteid=56470&token=dh98ab5670=756

A list with the following information will be returned in the format you chose (xml / json):

Name:

The Donor Name

displaydate:

The date of the review

textcomments:

The comments made by the donor

fullurl:

The url of the review

overall:

The overall score of the review

recommend:

The recommendation score from the review

Cancel Review (POST)

Allow you to cancel an initial review after an order cancellation. Cancelling a review within the API will stop the followup email and mark the initial review as having been canceled.
Note: This is a post request and requires data to be posted.

Required Parameters

orderid:

The Order ID from your Cart

reviewid:

The review ID from the “Get Reviews” query

cancel:

1 (This value is always set to 1 – indicating it is being cancelled)

API Code:

JSON:

https://www.donorapproved.com/api/review/?siteid=56470&token=dh98ab5670=48563

XML:

https://www.donorapproved.com/api/xml/review/?siteid=56470&token=dh98ab5670&cancel=1&orderid=456

Move up follow-up survey email. (POST)

This will allow you to bump up the date of the follow up survey email.
Note: This is a post request and requires data to be posted.

Required Parameters

orderid:

The Order ID from your Cart

reviewid:

The review ID from the “Get Reviews” query

shipped:

1 (This value is always set to 1 – indicating you are changing the shipping date)

date:

(yyyy-mm-dd) The new date you want the survey email to go out

API Code:

JSON:

https://www.donorapproved.com/api/review/?siteid=56470&token=dh98ab5670&orderid=45863

XML:

https://www.donorapproved.com/api/xml/review/?siteid=56470&token=dh98ab5670&cancel=1&orderid=453

Note that use of the API requires programming knowledge.

Get Reviews (GET)

Returns a list of reviews (up to 100) based on the specified criteria provided

Optional Parameters

from:

The collection start date
(yyyy-mm-dd)

to:

The collection end date
(yyyy-mm-dd)

sort:

How you would like the reviews sorted
(highest | lowest | oldest | newest)

page:

The current page number
(note: only 100 reviews will be returned at a time)

API Code:

JSON:

https://www.donorapproved.com/api/reviews/?siteid=29038&token=ad47af4095&from=2014-01-01&to=2014-02-01&sort=newest&page=0

XML:

https://www.donorapproved.com/api/xml/reviews/?siteid=29038&token=ad47af4095&from=2014-01-01&to=2014-02-01&sort=newest&page=0

A list with the following information will be returned in the format you chose (xml / json):

Name:

The Customers Name

location:

The Customers Location (if available)

displaydate:

The date of the review

textcomments:

The comments made by the customer

fullurl:

The url of the review

overall:

The overall score of the review

productId:

The product id (if available)

public:

If the review is public

Get Review By Product ID (GET)

Returns a list of reviews for the specified product id

Required Parameters

productid:

The product id

Optional Parameters

to:

The collection end date
(yyyy-mm-dd)

sort:

How you would like the reviews sorted
(highest | lowest | oldest | newest)

page:

The current page number
(note: only 100 reviews will be returned at a time)

API Code:

JSON:

https://www.donorapproved.com/api/reviews/?siteid=29038&token=ad47af4095&from=2014-01-01&to=2014-02-01&sort=newest&page=0

XML:

https://www.donorapproved.com/api/xml/reviews/?siteid=29038&token=ad47af4095&from=2014-01-01&to=2014-02-01&sort=newest&page=0

A list with the following information will be returned in the format you chose (xml / json):

Name:

The Customers Name

location:

The Customers Location (if available)

displaydate:

The date of the review

textcomments:

The comments made by the customer

fullurl:

The url of the review

overall:

The overall score of the review

productId:

The product id (if available)

public:

If the review is public

Get Aggregate Information (GET)

Returns the aggregate information

Optional Parameters

productid:

The product id

to:

The collection end date
(yyyy-mm-dd)

sort:

How you would like the reviews sorted
(highest | lowest | oldest | newest)

page:

The current page number
(note: only 100 reviews will be returned at a time)

API Code:

JSON:

https://www.donorapproved.com/api/reviews/?siteid=29038&token=ad47af4095&from=2014-01-01&to=2014-02-01&sort=newest&page=0

XML:

https://www.donorapproved.com/api/xml/reviews/?siteid=29038&token=ad47af4095&from=2014-01-01&to=2014-02-01&sort=newest&page=0

A list with the following information will be returned in the format you chose (xml / json):

SiteId:

Your site id

ProductId:

The product id

Overall:

The overall review rating

Count:

The number of reviews