REST web service interface

GET donations/product/{idOrNum}/raised/

Updated, 2015-24-03 09:11

Returns statistics for a specific donation

Resource Information

Rate Limited? No
Authentication Optional
Response Formats json,xml
HTTP Methods GET
Response Object Donation

Resource URL

https://ecommerce.dexero.com/service/rest/2/merchant/catalog/donations/product/{id}/raised.format

Parameters

Parameter Description
goal The goal for the donation campaign
Example Values : 5800
locale Formatting
Example Values : fr, en

Example Request

https://ecommerce.dexero.com/service/rest/2/merchand/catalogue/donations/product/123/raised.json

Example Response

XML JSON 
{
  "donation" : {
    "amount" : "4830.00",
    "percent" : 83,
    "formattedPercent" : "83%",
    "formattedAmount" : "4 830,00 $",
    "formattedTarget" : "5 800,00 $",
    "target" : 5800
  }
}

Response Object "Donation"

Field Data type Description
amount decimal(20,2) The amount raised
percent string The percentage of the target
formattedPercent string The percentage of the target (formatted)
formattedAmount string The amount raised (formatted)
formattedGoal int The goal (formatted)
goal decimal(20,2) The goal