TABLE OF CONTENTS
Get Donations Available for Sale
Use this API to get a list of Donations that are available for sale by Sales Channel.
GET /v2/b2c/addons
Parameters:
| Field | Values | Notes |
|---|---|---|
| saleChannel (optional) | {online, pointOfSale, reseller, customerRep, manualEntry, insideSalesIndividual} | This is optional. Use if you want to filter the list to just the donations available on certain sales channels. |
| addOnTypes | {donation,fixedDonation} | Use 'fixedDonation' for donations with a set price Use 'donation' for donations with a variable price |
| tenantId |
Headers:
| x-acme-api-key |
| x-b2c-tenant-id |
Body:
None
Response:
Donation Information. See the Donation Object.
Example Response:
{
"list": [
{
"id": 3571,
"tenantId": 246,
"name": "Donation",
"description": "Thank you for your support!",
"sku": "",
"price": "0.00",
"quantity": 0,
"type": "donation",
"displayOrder": 0,
"active": true,
"createdOn": "2020-05-18T16:15:30-07:00",
"updatedOn": "2020-05-18T16:15:30-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": false
},
{
"id": 3573,
"tenantId": 246,
"name": "Donation $10",
"description": "Thank you for your support!",
"sku": "",
"price": "10.00",
"quantity": 0,
"type": "fixedDonation",
"displayOrder": 0,
"active": true,
"createdOn": "2020-05-18T16:15:51-07:00",
"updatedOn": "2020-05-18T16:15:51-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": false
},
{
"id": 3576,
"tenantId": 246,
"name": "Donation $100",
"description": "Thank you for your support!",
"sku": "",
"price": "100.00",
"quantity": 0,
"type": "fixedDonation",
"displayOrder": 0,
"active": true,
"createdOn": "2020-05-18T16:16:19-07:00",
"updatedOn": "2020-05-18T16:16:19-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": false
},
{
"id": 3579,
"tenantId": 246,
"name": "Donation $1000",
"description": "Thank you for your support!",
"sku": "",
"price": "1000.00",
"quantity": 0,
"type": "fixedDonation",
"displayOrder": 0,
"active": true,
"createdOn": "2020-05-18T16:16:48-07:00",
"updatedOn": "2020-05-18T16:16:48-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": false
},
{
"id": 3574,
"tenantId": 246,
"name": "Donation $25",
"description": "Thank you for your support!",
"sku": "",
"price": "25.00",
"quantity": 0,
"type": "fixedDonation",
"displayOrder": 0,
"active": true,
"createdOn": "2020-05-18T16:16:02-07:00",
"updatedOn": "2020-05-18T16:16:02-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": false
},
{
"id": 3577,
"tenantId": 246,
"name": "Donation $250",
"description": "Thank you for your support!",
"sku": "",
"price": "250.00",
"quantity": 0,
"type": "fixedDonation",
"displayOrder": 0,
"active": true,
"createdOn": "2020-05-18T16:16:29-07:00",
"updatedOn": "2020-05-18T16:16:29-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": false
},
{
"id": 3572,
"tenantId": 246,
"name": "Donation $5",
"description": "Thank you for your support!",
"sku": "",
"price": "5.00",
"quantity": 0,
"type": "fixedDonation",
"displayOrder": 0,
"active": true,
"createdOn": "2020-05-18T16:15:40-07:00",
"updatedOn": "2020-05-18T16:15:40-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": false
},
{
"id": 3575,
"tenantId": 246,
"name": "Donation $50",
"description": "Thank you for your support!",
"sku": "",
"price": "50.00",
"quantity": 0,
"type": "fixedDonation",
"displayOrder": 0,
"active": true,
"createdOn": "2020-05-18T16:16:10-07:00",
"updatedOn": "2020-05-18T16:16:10-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": false
},
{
"id": 3578,
"tenantId": 246,
"name": "Donation $500",
"description": "Thank you for your support!",
"sku": "",
"price": "500.00",
"quantity": 0,
"type": "fixedDonation",
"displayOrder": 0,
"active": true,
"createdOn": "2020-05-18T16:16:39-07:00",
"updatedOn": "2020-05-18T16:16:39-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": false
},
{
"id": 4619,
"tenantId": 246,
"name": "Guidebook",
"description": "Guidebook",
"sku": "",
"price": "20.00",
"quantity": 0,
"type": "doNotTrack",
"displayOrder": 0,
"active": true,
"createdOn": "2023-04-13T14:43:48-07:00",
"updatedOn": "2023-04-13T14:43:48-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": true
},
{
"id": 4621,
"tenantId": 246,
"name": "Umbrella",
"description": "",
"sku": "",
"price": "25.00",
"quantity": 0,
"type": "doNotTrack",
"displayOrder": 0,
"active": true,
"createdOn": "2023-09-05T10:26:25-07:00",
"updatedOn": "2023-09-05T10:26:25-07:00",
"salesChannels": [
{
"name": "Web",
"channel": "online",
"enabled": true
},
{
"name": "Customer Rep",
"channel": "customerRep",
"enabled": true
},
{
"name": "Point of Sale",
"channel": "pointOfSale",
"enabled": true
},
{
"name": "Manual Entry",
"channel": "manualEntry",
"enabled": true
},
{
"name": "Reseller",
"channel": "reseller",
"enabled": true
},
{
"name": "Kiosk",
"channel": "kiosk",
"enabled": true
}
],
"printTicket": false
}
],
"pagination": {
"page": 1,
"pageSize": 100,
"sortDirection": "asc",
"sortField": "name",
"count": 11,
"hasMore": false
}
}Get Donation Funds
Use this API to get a list of Donation Funds.
GET /v2/b2c/donation/funds
Headers:
| x-acme-api-key |
| x-b2c-tenant-id |
Body:
None
Response:
Donation Fund Information.
Example Response:
{
"list": [
{
"id": 10095,
"tenantId": 246,
"name": "Education Fund",
"description": "",
"isDefault": false,
"online": false,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:18:59-07:00",
"createdBy": 2262,
"updatedOn": "2020-05-18T16:18:59-07:00",
"updatedBy": 2262
},
{
"id": 10094,
"tenantId": 246,
"name": "Exhibition Fund",
"description": "",
"isDefault": false,
"online": false,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:18:51-07:00",
"createdBy": 2262,
"updatedOn": "2020-05-18T16:18:51-07:00",
"updatedBy": 2262
},
{
"id": 10093,
"tenantId": 246,
"name": "General Fund",
"description": "",
"isDefault": true,
"online": true,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:18:41-07:00",
"createdBy": 2262,
"updatedOn": "2020-05-18T16:18:41-07:00",
"updatedBy": 2262
}
],
"pagination": {
"page": 1,
"pageSize": 100,
"sortDirection": "asc",
"sortField": "name",
"count": 3,
"hasMore": false
}
}Get Donation Campaigns
Use this API to get a list of Donation Campaigns.
GET /v2/b2c/donation/campaigns
Headers:
| x-acme-api-key |
| x-b2c-tenant-id |
Body:
None
Response:
Donation Campaign Information.
Example Response:
{
"list": [
{
"id": 10037,
"tenantId": 246,
"name": "Annual Campaign",
"description": "",
"isDefault": true,
"online": true,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:17:07-07:00",
"createdBy": 2262,
"updatedOn": "2023-08-25T14:15:22-07:00",
"updatedBy": 8185
},
{
"id": 10038,
"tenantId": 246,
"name": "Capital Campaign",
"description": "",
"isDefault": false,
"online": false,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:17:24-07:00",
"createdBy": 2262,
"updatedOn": "2020-05-18T16:17:24-07:00",
"updatedBy": 2262
},
{
"id": 10039,
"tenantId": 246,
"name": "Endowment Campaign",
"description": "",
"isDefault": false,
"online": false,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:17:33-07:00",
"createdBy": 2262,
"updatedOn": "2020-05-18T16:17:33-07:00",
"updatedBy": 2262
}
],
"pagination": {
"page": 1,
"pageSize": 100,
"sortDirection": "asc",
"sortField": "name",
"count": 3,
"hasMore": false
}
}Get Donation Appeals
Use this API to get a list of Donation Appeals.
GET /v2/b2c/donation/appeals
Headers:
| x-acme-api-key |
| x-b2c-tenant-id |
Body:
None
Response:
Donation Appeal Information.
Example Response:
{
"list": [
{
"id": 10033,
"tenantId": 246,
"name": "COVID-19 Appeal",
"description": "",
"isDefault": false,
"online": false,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:17:50-07:00",
"createdBy": 2262,
"updatedOn": "2020-05-18T16:17:50-07:00",
"updatedBy": 2262
},
{
"id": 10034,
"tenantId": 246,
"name": "Holiday Appeal",
"description": "",
"isDefault": false,
"online": true,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:18:02-07:00",
"createdBy": 2262,
"updatedOn": "2023-08-25T14:15:27-07:00",
"updatedBy": 8185
},
{
"id": 10035,
"tenantId": 246,
"name": "Re-opening Appeal",
"description": "",
"isDefault": false,
"online": false,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:18:10-07:00",
"createdBy": 2262,
"updatedOn": "2020-05-18T16:18:10-07:00",
"updatedBy": 2262
},
{
"id": 10036,
"tenantId": 246,
"name": "Spring Appeal",
"description": "",
"isDefault": false,
"online": false,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:18:17-07:00",
"createdBy": 2262,
"updatedOn": "2020-05-18T16:18:17-07:00",
"updatedBy": 2262
},
{
"id": 10037,
"tenantId": 246,
"name": "Thanksgiving Annual Appeal",
"description": "",
"isDefault": false,
"online": false,
"csr": true,
"pos": true,
"insideSalesIndividual": true,
"createdOn": "2020-05-18T16:18:25-07:00",
"createdBy": 2262,
"updatedOn": "2020-05-18T16:18:25-07:00",
"updatedBy": 2262
}
],
"pagination": {
"page": 1,
"pageSize": 100,
"sortDirection": "asc",
"sortField": "name",
"count": 5,
"hasMore": false
}
}