TABLE OF CONTENTS


To assist in organizing and categorizing donations, ACME allows the assignment of campaigns, funds and appeals. Creating these initiatives can be done in ACME Back Office.


Get Campaigns 

Get a list of existing Campaigns 


Sample Request

GET /v2/b2b/donation/campaigns


Response

A list of existing campaign objects


Sample Response

{
    "list": [{
      "id": 10042,
      "tenantId": 165,
      "name": "Save the Clock Tower!",
      "description": "Funds from this campaign will be used to preserve the historic Hill Valley clock.",
      "isDefault": false,   //is the default fund
      "online": true,   //available on this sales channel
      "csr": true,    //available on this sales channel
      "pos": true,   //available on this sales channel
      "insideSalesIndividual": true,   //available on this sales channel
      "createdOn": "2019-11-25T09:42:42-05:00",
      "createdBy": 575,
      "updatedOn": "2019-11-25T09:42:42-05:00",
      "updatedBy": 575
    }],
    "pagination": {
      "page": 1,
      "pageSize": 50,
      "sortDirection": "asc",
      "sortField": "name",
      "count": 1
    }
}



Get Appeals 

Get a list of existing Appeals 


Sample Request

GET /v2/b2b/donation/appeals


Response 

A list of existing appeal objects


Sample Response

{
    "list": [{
      "id": 10036,
      "tenantId": 165,
      "name": "Fall Flyer Distribution",
      "description": "October 25",
      "isDefault": false,  //is the default fund
      "online": true,  //available on this sales channel
      "csr": true,   //available on this sales channel
      "pos": true,   //available on this sales channel
      "insideSalesIndividual": true,  //available on this sales channel
      "createdOn": "2019-11-25T10:50:37-05:00",
      "createdBy": 575,
      "updatedOn": "2019-11-25T10:50:37-05:00",
          "updatedBy": 575
    }],
    "pagination": {
      "page": 1,
      "pageSize": 50,
      "sortDirection": "asc",
      "sortField": "name",
      "count": 1
    }
}



Get Funds 

Get a list of existing Funds 


Sample Request

GET /v2/b2c/donation/funds


Response 

A list of existing fund objects


Sample Response

{
    "list": [{
      "id": 10099,
      "tenantId": 165,
      "name": "Capital Fund",
      "description": "Fund used for all capital improvement projects over $10,000",
      "isDefault": false, //is the default fund
      "online": true, //available on this sales channel
      "csr": true, //available on this sales channel
      "pos": true, //available on this sales channel
      "insideSalesIndividual": true, //available on this sales channel
      "createdOn": "2019-11-25T10:50:37-05:00",
      "createdBy": 575,
      "updatedOn": "2019-11-25T10:50:37-05:00",
          "updatedBy": 575
    }],
    "pagination": {
      "page": 1,
      "pageSize": 50,
      "sortDirection": "asc",
      "sortField": "name",
      "count": 1
    }
  }