Products
all products
Returns all products in a campaign
For custom components:
RaiselyComponents.api.one('campaigns', '{campaign}').get('products', params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
get/campaigns/{campaign}/products
Path parameters
campaignstring required
The uuid, path or domain of the campaign to associate with the request
Headers
Authorizationstring
A valid HTTP Bearer token, required to access private records.
Response
The resulting collection of Product records
Example response
{
"data": [
{
"bundle": {
"tickets": [
{
"productUuid": 1,
"quantity": 3
},
{
"productUuid": 2,
"quantity": 3
}
]
},
"description": "Full access to the event for people over 16 years.",
"displayName": "Adult",
"isActive": true,
"maxQuantity": 100,
"name": "Adult Ticket",
"numIssued": 12345,
"photoUrl": "https://example.com/image.jpg",
"price": 1500,
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"sortOrder": 12345,
"type": "TICKET",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"validFrom": "2022-01-01T00:00:00.000Z",
"validTo": "2022-12-01T00:00:00.000Z"
}
],
"pagination": {
"total": 10,
"pages": 2,
"offset": 5,
"limit": 5
}
}