Orders
get all
Returns all orders in a campaign
For custom components:
RaiselyComponents.api.all('orders').get(params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
get/orders
Headers
Authorizationstring
A valid HTTP Bearer token, required to access private records.
Response
The resulting collection of Order records
Example response
{
"data": [
{
"campaignUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"createdAt": "2020-12-03T06:52:46.330Z",
"date": "2020-12-03T06:52:46.330Z",
"discountTotal": 2625,
"donation": {
"address1": "31 Sunset Boulevard",
"address2": "Unit 31b",
"amount": 2500,
"amountRefunded": 2500,
"anonymous": true,
"campaignAmount": 2500,
"campaignDisplayTotal": 2625,
"campaignFee": 125,
"campaignUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"card": "card_aabbccddeeffaabbccddeeff",
"charge": "ch_aaaaaaaaaaaaaaaaaaaaaaaa",
"country": "AU",
"createdAt": "2020-12-03T06:52:46.330Z",
"currency": "AUD",
"currencySymbol": "a",
"date": "2020-12-03T06:52:46.330Z",
"designationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"displayTotal": 2625,
"donationTotal": 2625,
"email": "harveymilk@example.com",
"fee": 125,
"feeOptIn": true,
"firstName": "Leila",
"fullName": "Leila Norma Eulalia Josefa Magistrado de Lima",
"gst": 150,
"id": 12345,
"includesGiftAid": true,
"isExpress": true,
"isFraud": true,
"isSuspicious": true,
"items": [
{
"amount": 850,
"attendance": "CHECKED_IN",
"campaignAmount": 950,
"status": "ISSUED",
"type": "DONATION"
}
],
"lastName": "de Lima",
"message": "Glad to help out with the fundraising!",
"method": "CREDIT_CARD",
"methodType": "APPLE_PAY",
"mode": "LIVE",
"orderTotal": 2625,
"orderUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"phoneNumber": "+1 123-456-7890",
"postcode": "AAA BBBB",
"preferredName": "Norma",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"processing": "ONCE",
"profileUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"providerRaisely": 12345,
"providerUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"publicAmount": 2500,
"publicFee": 125,
"publicTotal": 2625,
"status": "OK",
"subscriptionUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"swiftAidStatus": "OK",
"taxTotal": 2625,
"thankyou": {
"message": "Thank you for your wonderful donation!"
},
"token": "tok_aaaaaaaaaaaaaaaaaaaaaaaa",
"total": 2625,
"type": "ONLINE",
"updatedAt": "2020-12-03T06:52:46.330Z",
"usedSwiftAid": true,
"userId": 12345,
"userUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
},
"donationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"eventUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"items": [
{
"amount": 850,
"attendance": "CHECKED_IN",
"campaignAmount": 950,
"status": "ISSUED",
"type": "DONATION"
}
],
"mode": "LIVE",
"numberOfItems": 12345,
"orderId": "ORD-1234",
"organisationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"profileUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"type": "ONLINE",
"userUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"pagination": {
"total": 10,
"pages": 2,
"offset": 5,
"limit": 5
}
}