v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Products

get product

Returns a specific product

For custom components:

RaiselyComponents.api.one('products', '{uuid}').get('{uuid}', params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

get/products/{uuid}

Path parameters

uuidstring required

The uuid of the record

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Response

The resulting Product record

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"
  }
}