ShowClix APIs

https://technically.showclix.com
Admin
ShowClix APIs provide a suite of services for managing events, venues, authentication, reporting,...
Tokens:78,240
Snippets:193
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### Fetch Sales API Request Example

Source: https://technically.showclix.com/sales

Example of a GET request to the /api/sales endpoint with filter parameters for sale date and seller ID. The response includes pagination information and a 'filtered' object for large sales.

```bash
curl -X GET \ 
  'https://api.showclix.com/api/sales?filter=sale_date=2024-05-15,seller_id=67' \ 
  -H 'Content-Type: application/json' \ 
  -H 'x-api-token: token'
```

--------------------------------

### Fetch Coupons List API Endpoint

Source: https://technically.showclix.com/coupons

This snippet shows the GET request to fetch a list of all created coupons. It includes example URLs and expected request headers. The response body demonstrates the structure of a successful retrieval and potential error responses.

```http
GET /coupons

Headers:
Content-Type: application/json
Accept: application/json

Example Response Body (200 OK):
[
  {
    "id": 1,
    "name": "My Coupon",
    "type": "Discount",
    "code": "my-code",
    "amount": 10,
    "amount_type": "percentage",
    "modified_time": 1719827944
  },
  {
    "id": 2,
    "name": "Reserved Coupon",
    "type": "Reserved",
    "code": "reserved-1",
    "modified_time": 1719827011
  }
]

Example Error Response Body (400 Bad Request):
{
  "errors": [
    {
      "status": "400",
      "detail": [
        "Bad request"
      ]
    }
  ]
}
```

--------------------------------

### Talent JSON API Response Example

Source: https://technically.showclix.com/talent

This is an example of a successful 200 OK response from the Talent JSON API. The JSON object contains various details about the talent, including their identifier, social media links, image URLs, video status, description, and featured video information.

```json
{
  "identifier": "123456",
  "availableSocial": {
    "twitter": "https://twitter.com/12345",
    "facebook": "https://www.facebook.com/12345",
    "instagram": "https://www.instagram.com/12345",
    "spotify": "https://open.spotify.com/artist/12345",
    "youtube": "https://www.youtube.com/channel/12345",
    "soundcloud": "https://www.soundcloud.com/12345"
  },
  "smallImage": "https://media.example.com/images/12345/landscape/1x1/small1.jpg",
  "mediumImage": "https://media.example.com/images/12345/landscape/16x9/medium1.jpg",
  "landscapeImage": "https://media.example.com/images/12345/landscape/16x9/1.jpg",
  "availableVideo": "true",
  "description": "Lorem Ipsum",
  "featuredVideo": [
    {
      "id": "####",
      "name": "Song Title",
      "url": "https://www.youtube.com/watch?v=#####",
      "isFeatured": "true",
      "videoId": "#####",
      "embed": "https://www.youtube.com/embed/#####"
    }
  ]
}
```

--------------------------------

### API Response Examples for Coupon Assignment

Source: https://technically.showclix.com/coupon-assignment

Illustrates typical JSON responses for common HTTP status codes (400, 401, 403) when interacting with the coupon assignment API. These examples show the structure of error messages, including status codes and details.

```json
{
  "errors": [
    {
      "status": "400",
      "detail": [
        "Bad request"
      ]
    }
  ]
}

```

```json
{
  "errors": [
    {
      "status": "401",
      "detail": "Unauthorized"
    }
  ]
}

```

```json
{
  "errors": [
    {
      "status": "403",
      "detail": "Forbidden"
    }
  ]
}

```

--------------------------------

### API Token Generation Response (JSON Example)

Source: https://technically.showclix.com/authentication

This is an example of a successful response when generating an API token. It contains the authentication token, user ID, seller ID, user name, organization name, avatar URL, and locale.

```json
{
  "token": "3e9fa1980a283fe902c83a8929d0ae91",
  "user_id": "12345678",
  "seller_id": "1234567",
  "name": {
    "first": "John",
    "last": "Doe"
  },
  "org": "Doe Tickets",
  "avatar": "",
  "locale": "en_US"
}
```

--------------------------------

### Showclix API Success Response Example

Source: https://technically.showclix.com/coupon-assignment

This JSON object is an example of a successful response from the Showclix API. It includes various parameters for filtering and configuring offers, such as global settings, coupon IDs, event IDs, price level IDs, bundle IDs, limits, timezones, and date filters.

```json
{
  "global": false,
  "coupon_ids": [
    1
  ],
  "event_ids": [
    1,
    9
  ],
  "price_level_ids": [
    99
  ],
  "bundle_ids": [],
  "limit": 5,
  "ticket_limit": 0,
  "taggable": true,
  "timezone": "America/New_York",
  "start_date": "2023-06-22 12:00:00",
  "end_date": "2023-08-22 13:00:00",
  "date_filter": {
    "event_ids": [
      9
    ],
    "price_level_ids": [
      99
    ],
    "bundle_ids": [],
    "start": "2023-07-19 00:00:00",
    "end": "2023-07-30 23:59:59",
    "days": [
      {
        "day": 1,
        "start_time": "12:00:00",
        "end_time": "15:00:00"
      },
      {
        "day": 1,
        "start_time": "15:30:00",
        "end_time": "16:00:00"
      },
      {
        "day": 2
      }
    ],
    "exclude_dates": [
      "2023-07-22"
    ]
  }
}

```

--------------------------------

### POST /reports/foreground Request Example for All Tickets Report

Source: https://technically.showclix.com/reporting

Illustrates a POST request to the /reports/foreground endpoint for generating a comprehensive 'All Tickets' report. This example includes specific filters for customer names and event IDs, along with date range arguments for purchase time. It showcases the flexibility in defining report criteria.

```json
{
        "report":"TicketReport",
        "timezone":"America/New_York",
        "columns":[
            "order_id",
            "barcode",
            "name_on_order",
            "name_on_ticket",
            "event_name",
            "price_level_name",
            "cost",
            "status"
        ],
        "expanding_columns": {
            "answers_tickets": {
                "What brings you here?":"1",
                "Favorite Color": "2"
            }
        },
        "title":"All Tickets",
        "description":"All tickets for 2016 - Large Report",
        "arguments":[
            {"name": "event_id", "value": 3, "operator": "=", "input_type": "event", "filter_col_title": "Event ID"},
            {"name":"purchase_time","value":"2016-01-01 00:00:00","operator":">=","input_type":"datetime","filter_col_title":"Purchase Time"},
            {"name":"purchase_time","value":"2017-01-01 00:00:00","operator":"<","input_type":"datetime","filter_col_title":"Purchase Time"}
        ],
        "filters":[
            {"name": "customer_first_name", "field": "customer_first_name", "value": "John", "operator": "="},
            {"name": "customer_last_name", "field": "customer_last_name", "value": "Doe", "operator": "="},
        ],
        "filter_meta":"{}",
        "group_by":[],
        "filter_type":"and",
        "send_notification_email":false,
        "notification_email_address":"bob@example.com"
    }
```

--------------------------------

### Get Event Listings Example

Source: https://technically.showclix.com/events

Retrieves all listings associated with a specific event. Requires an API token for authentication. The response includes event data and an 'included' array containing listing settings.

```json
{
    "data": [
        {
            "id": "1",
            "type": "events",
            "attributes": {}
        }
    ],
    "included": [
        {
            "id": "1",
            "type": "listing-settings",
            "attributes": {
                "seller_id": 1,
                "primary_event_id": 1,
                "config": "{}",
                "name": "event name",
                "listingType": 1,
                "slug": "event-name-qwerty",
                "active": true
            },
            "relationships": {
                "seller": {
                    "links": {
                        "self": "/listing-settings/1/relationships/seller",
                        "related": "/listing-settings/1/seller"
                    }
                },
                "event": {
                    "links": {
                        "self": "/listing-settings/1/relationships/event",
                        "related": "/listing-settings/1/event"
                    }
                }
            },
            "dependents": []
        }
    ]
}
```

--------------------------------

### Create Coupon Assignment Request Body

Source: https://technically.showclix.com/coupon-assignment

Example JSON payload for the POST /coupons-assignment endpoint. This demonstrates how to specify assignment details such as event IDs, price level IDs, limits, date ranges, and timezones. 'date_filter' is set to null in this example.

```json
{
  "edit_id": 1,
  "event_ids": [
    1,
    9
  ],
  "price_level_ids": [
    99
  ],
  "bundle_ids": [],
  "limit": 5,
  "ticket_limit": 0,
  "taggable": true,
  "timezone": "America/New_York",
  "start_date": "2023-06-22 12:00:00",
  "end_date": "2023-08-22 13:00:00",
  "date_filter": null
}

```

--------------------------------

### GET /coupons

Source: https://technically.showclix.com/coupons

Fetches a list of created coupons. Supports filtering by modification time and pagination.

```APIDOC
## GET /coupons

### Description
Fetches a list of created coupons. Supports filtering by modification time and pagination.

### Method
GET

### Endpoint
/coupons

#### Query Parameters
- **modified_time** (number) - Optional - Unix timestamp to filter coupons modified after this time.
- **page** (number) - Optional - The page number for paginated results.
- **sellerId** (number) - Optional - The ID of the seller to filter coupons by.

### Request Example
```json
GET /coupons?modified_time=1719827944&page=1
```

### Response
#### Success Response (200)
- **id** (number) - Unique identifier for the coupon.
- **name** (string) - The name of the coupon.
- **type** (string) - The type of coupon (e.g., 'Discount', 'Reserved').
- **code** (string) - The coupon code.
- **amount** (number) - The value of the discount.
- **amount_type** (string) - The type of amount (e.g., 'percentage', 'fixed').
- **modified_time** (number) - Unix timestamp of the last modification.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "My Coupon",
    "type": "Discount",
    "code": "my-code",
    "amount": 10,
    "amount_type": "percentage",
    "modified_time": 1719827944
  }
]
```

#### Error Responses
- **400 Bad Request**: Returned if the request is malformed.
  ```json
  {
    "errors": [
      {
        "status": "400",
        "detail": [
          "Bad request"
        ]
      }
    ]
  }
  ```
- **401 Unauthorized**: Returned if the client is not authenticated.
  ```json
  {
    "errors": [
      {
        "status": "401",
        "detail": "Unauthorized"
      }
    ]
  }
  ```
- **403 Forbidden**: Returned if the client does not have permission to access the resource.
  ```json
  {
    "errors": [
      {
        "status": "403",
        "detail": "Forbidden"
      }
    ]
  }
  ```
```

--------------------------------

### POST /events

Source: https://technically.showclix.com/events

Creates a new event. The request example shows the necessary headers for interacting with this endpoint.

```APIDOC
## POST /events

### Description
This endpoint allows for the creation of new events.

### Method
POST

### Endpoint
`/events`

### Request Example
##### Headers
```
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
```

##### Body
```json
{
  "data": {
    "type": "event",
    "attributes": {
      "name": "Example Event",
      "description": "This is a sample event description.",
      "start_time": "2024-07-20T10:00:00Z",
      "end_time": "2024-07-20T12:00:00Z"
    },
    "relationships": {
      "categories": {
        "data": [
          { "type": "category", "id": "26" },
          { "type": "category", "id": "32" }
        ]
      }
    }
  }
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier of the created event.
- **type** (string) - The resource type, always "event".
- **attributes** (object) - Contains the event's details.
  - **name** (string) - The name of the event.
  - **description** (string) - The description of the event.
  - **start_time** (string) - The start date and time of the event in ISO 8601 format.
  - **end_time** (string) - The end date and time of the event in ISO 8601 format.
  - **categories** (array) - An array of category objects associated with the event.

#### Response Example
```json
{
  "data": {
    "id": "evt_12345abcde",
    "type": "event",
    "attributes": {
      "name": "Example Event",
      "description": "This is a sample event description.",
      "start_time": "2024-07-20T10:00:00Z",
      "end_time": "2024-07-20T12:00:00Z"
    },
    "relationships": {
      "categories": {
        "data": [
          { "type": "category", "id": "26" },
          { "type": "category", "id": "32" }
        ]
      }
    }
  }
}
```
```

--------------------------------

### GET /bundles

Source: https://technically.showclix.com/events

Retrieves a list of all bundles. Supports filtering and pagination via query parameters.

```APIDOC
## GET /bundles

### Description
Retrieves a list of all bundles. Supports filtering and pagination via query parameters.

### Method
GET

### Endpoint
/bundles

### Parameters
#### Query Parameters
- **filter[name]** (string) - Optional - Filter bundles by name.
- **filter[active]** (boolean) - Optional - Filter bundles by active status.
- **page[size]** (integer) - Optional - Number of items per page.
- **page[number]** (integer) - Optional - Page number.

### Request Example
```http
GET /bundles?filter[name]=Sample%20Bundle&page[size]=10
```

### Response
#### Success Response (200)
- **data** (array) - An array of bundle objects.
  - Each object contains 'type', 'id', 'attributes', and 'relationships'.

#### Response Example
```json
{
  "data": [
    {
      "type": "bundles",
      "id": "123",
      "attributes": {
        "name": "Sample Bundle",
        "description": "A sample bundle for testing.",
        "inventory": 100,
        "active": true,
        "price": {
          "amount": 5000,
          "currency": "USD",
          "symbol": "$"
        }
      },
      "relationships": {
        "schedules": {
          "data": []
        },
        "event": null
      }
    }
  ],
  "links": {
    "self": "/bundles?page[size]=10",
    "next": "/bundles?page[size]=10&page[number]=2"
  }
}
```
```

--------------------------------

### GET /venues/{id} - Get Venue by ID

Source: https://technically.showclix.com/events

Retrieves the details of a specific venue using its unique identifier.

```APIDOC
## GET /venues/{id}

### Description
Retrieves the details of a specific venue using its unique identifier.

### Method
GET

### Endpoint
/venues/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the venue to retrieve.

### Request Example
```json
{
  "Accept": "application/vnd.api+json"
}
```

### Response
#### Success Response (200)
- **data** (object) - The venue object.
  - **type** (string) - Always "venues".
  - **id** (string) - The unique identifier for the venue.
  - **attributes** (object) - The attributes of the venue (same structure as POST /venues).
  - **relationships** (object) - Relationships to other resources (sellers, events).

#### Response Example
```json
{
  "data": {
    "type": "venues",
    "id": "venue_abc123",
    "attributes": {
      "name": "Example Venue",
      "capacity": 1000,
      "description": "A venue for various events.",
      "address": {
        "lines": ["123 Main St"],
        "city": "Anytown",
        "region": "CA",
        "postal_code": "90210",
        "country": "USA"
      },
      "latitude": 34.0522,
      "longitude": -118.2437,
      "timezone": {
        "offset": "-08:00",
        "name": "America/Los_Angeles"
      },
      "behavior": {
        "seated": true
      }
    },
    "relationships": {
      "sellers": {
        "type": "sellers",
        "relation": "has-many"
      },
      "events": {
        "type": "events",
        "relation": "has-many"
      }
    }
  }
}
```
```

--------------------------------

### POST /bundles

Source: https://technically.showclix.com/events

Creates a new bundle with specified attributes and relationships. This endpoint allows for detailed configuration of bundle pricing, availability, and associated events.

```APIDOC
## POST /bundles

### Description
Creates a new bundle with the provided details. This includes setting up pricing, inventory, and linking to specific events.

### Method
POST

### Endpoint
/bundles

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (object) - Required - The main data object for the bundle.
  - **type** (string) - Required - The type of resource, should be "bundles".
  - **id** (integer) - Optional - The unique identifier for the bundle.
  - **attributes** (object) - Required - Contains the properties of the bundle.
    - **name** (string) - Required - The name of the bundle.
    - **description** (string) - Optional - A description of the bundle.
    - **inventory** (integer) - Required - The number of available items in the bundle.
    - **active** (boolean) - Required - Whether the bundle is currently active.
    - **flex** (boolean) - Optional - Indicates if the bundle offers flexible pricing.
    - **flex_minimum** (integer) - Optional - The minimum price for flexible bundles.
    - **flex_maximum** (integer) - Optional - The maximum price for flexible bundles.
    - **flex_itemize** (boolean) - Optional - Whether flexible pricing can be itemized.
    - **flex_percent_discount** (integer) - Optional - Percentage discount for flexible bundles.
    - **flex_flat_discount** (float) - Optional - Flat discount amount for flexible bundles.
    - **settings** (object) - Optional - Configuration settings for the bundle.
      - **multiple_holders** (boolean) - Optional - Allows multiple holders for the bundle.
      - **online_hide** (boolean) - Optional - Hides the bundle from online sales.
      - **box_office_hide** (boolean) - Optional - Hides the bundle from box office sales.
      - **transaction_limit** (integer) - Optional - Maximum number of transactions allowed.
      - **minimum_purchase_limit** (integer) - Optional - Minimum number of items to purchase.
    - **price_levels** (collection) - Optional - Price levels associated with the bundle.
    - **price** (object) - Required - The base price of the bundle.
      - **amount** (integer) - Required - The price amount.
      - **currency** (string) - Required - The currency code (e.g., USD).
      - **symbol** (string) - Required - The currency symbol (e.g., $).
    - **service_fee** (object) - Optional - Service fee details.
      - **amount** (integer) - Required - The service fee amount.
      - **currency** (string) - Required - The currency code.
      - **symbol** (string) - Required - The currency symbol.
    - **bos_service_fee** (object) - Optional - Box office service fee details.
      - **amount** (integer) - Required - The service fee amount.
      - **currency** (string) - Required - The currency code.
      - **symbol** (string) - Required - The currency symbol.
    - **box_office_price** (object) - Optional - The price for box office sales.
      - **amount** (integer) - Required - The price amount.
      - **currency** (string) - Required - The currency code.
      - **symbol** (string) - Required - The currency symbol.
    - **minimum_price** (object) - Optional - The minimum allowed price for the bundle.
      - **amount** (integer) - Required - The minimum price amount.
      - **currency** (string) - Required - The currency code.
      - **symbol** (string) - Required - The currency symbol.
  - **relationships** (object) - Optional - Relationships to other resources.
    - **schedules** (object) - Optional - Relationship to price level schedules.
      - **type** (string) - Required - Type of relationship, "price_level_schedules".
      - **relation** (string) - Required - Type of relation, "has_many".
    - **event** (object) - Optional - Relationship to an event.
      - **type** (string) - Required - Type of relationship, "events".
      - **relation** (string) - Required - Type of relation, "has_one".

### Request Example
```json
{
  "data": {
    "type": "bundles",
    "attributes": {
      "name": "Example Bundle",
      "description": "A sample bundle for testing.",
      "inventory": 100,
      "active": true,
      "price": {
        "amount": 5000,
        "currency": "USD",
        "symbol": "$"
      }
    },
    "relationships": {
      "event": {
        "type": "events",
        "id": 123
      }
    }
  }
}
```

### Response
#### Success Response (200)
- **data** (object) - The created bundle object, including its ID and all provided attributes and relationships.

#### Response Example
```json
{
  "data": {
    "type": "bundles",
    "id": "456",
    "attributes": {
      "name": "Example Bundle",
      "description": "A sample bundle for testing.",
      "inventory": 100,
      "active": true,
      "price": {
        "amount": 5000,
        "currency": "USD",
        "symbol": "$"
      },
      "created_at": "2023-10-27T10:00:00Z",
      "updated_at": "2023-10-27T10:00:00Z"
    },
    "relationships": {
      "event": {
        "data": {
          "type": "events",
          "id": "123"
        }
      }
    }
  }
}
```
```

--------------------------------

### Get Talent JSON API Request

Source: https://technically.showclix.com/talent

This snippet demonstrates how to make a GET request to the Talent JSON API endpoint. It requires specific headers and a request body containing the service and talent IDs. The expected response is a JSON object with talent details.

```http
GET /api/talent/json

Headers:
Content-Type: application/x-www-form-urlencoded

Body:
service=1&talent_id=123456
```

--------------------------------

### POST /websites/technically_showclix/bundles

Source: https://technically.showclix.com/events

Creates a new bundle for the technically_showclix website. This endpoint requires a request body containing the bundle's details.

```APIDOC
## POST /websites/technically_showclix/bundles

### Description
Creates a new bundle for the technically_showclix website. This endpoint requires a request body containing the bundle's details.

### Method
POST

### Endpoint
/websites/technically_showclix/bundles

### Parameters
#### Request Body
- **data** (object) - Required - The bundle resource object.
  - **type** (string) - Required - The type of resource, must be "bundles".
  - **attributes** (object) - Required - Contains the bundle's properties:
    - **name** (string) - Required - The name of the bundle.
    - **description** (string) - Optional - A description of the bundle.
    - **inventory** (integer) - Required - The available inventory for the bundle.
    - **active** (boolean) - Optional - Indicates if the bundle is currently active. Defaults to false.
    - **flex** (boolean) - Optional - Indicates if the bundle has flexible pricing options. Defaults to false.
    - **flex_minimum** (integer) - Optional - The minimum quantity for flexible pricing.
    - **flex_maximum** (integer) - Optional - The maximum quantity for flexible pricing.
    - **flex_itemize** (boolean) - Optional - Whether flexible pricing items are itemized. Defaults to false.
    - **flex_percent_discount** (integer) - Optional - Percentage discount for flexible pricing.
    - **flex_flat_discount** (float) - Optional - Flat discount amount for flexible pricing.
    - **settings** (object) - Optional - Bundle-specific settings:
      - **multiple_holders** (boolean) - Defaults to false.
      - **online_hide** (boolean) - Defaults to false.
      - **box_office_hide** (boolean) - Defaults to false.
      - **transaction_limit** (integer) - Optional.
      - **minimum_purchase_limit** (integer) - Optional.
    - **price** (object) - Required - The standard price of the bundle.
      - **amount** (integer) - Required - The price amount.
      - **currency** (string) - Required - The currency code (e.g., "USD").
    - **service_fee** (object) - Optional - The service fee.
      - **amount** (integer) - Required - The service fee amount.
      - **currency** (string) - Required - The currency code.
    - **bos_service_fee** (object) - Optional - The Box Office service fee.
      - **amount** (integer) - Required - The service fee amount.
      - **currency** (string) - Required - The currency code.
    - **box_office_price** (object) - Optional - The Box Office price.
      - **amount** (integer) - Required - The Box Office price amount.
      - **currency** (string) - Required - The currency code.
    - **minimum_price** (object) - Optional - The minimum allowed price.
      - **amount** (integer) - Required - The minimum price amount.
      - **currency** (string) - Required - The currency code.
  - **relationships** (object) - Optional - Relationships to other resources:
    - **schedules** (object) - Relationship to price level schedules.
      - **data** (array) - An array of schedule resource identifier objects.
    - **event** (object) - Relationship to the event.
      - **data** (object) - A schedule resource identifier object.

### Request Example
```json
{
  "data": {
    "type": "bundles",
    "attributes": {
      "name": "Standard Ticket Bundle",
      "description": "A basic bundle for event access.",
      "inventory": 500,
      "active": true,
      "price": {
        "amount": 10000,
        "currency": "USD"
      },
      "service_fee": {
        "amount": 200,
        "currency": "USD"
      }
    },
    "relationships": {
      "event": {
        "data": {
          "type": "events",
          "id": "evt_abc123"
        }
      }
    }
  }
}
```

### Response
#### Success Response (201 Created)
- **data** (object) - The newly created bundle object, including its `id` and any server-generated default values.

#### Response Example
```json
{
  "data": {
    "type": "bundles",
    "id": 456,
    "attributes": {
      "name": "Standard Ticket Bundle",
      "description": "A basic bundle for event access.",
      "inventory": 500,
      "active": true,
      "flex": false,
      "settings": {
        "multiple_holders": false,
        "online_hide": false,
        "box_office_hide": false,
        "transaction_limit": null,
        "minimum_purchase_limit": null
      },
      "price_levels": [],
      "price": {
        "amount": 10000,
        "currency": "USD",
        "symbol": "$"
      },
      "service_fee": {
        "amount": 200,
        "currency": "USD",
        "symbol": "$"
      },
      "bos_service_fee": null,
      "box_office_price": null,
      "minimum_price": null
    },
    "relationships": {
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}
```

#### Error Response (400, 409, 500)
- **errors** (array) - An array of error objects describing the issue.
  - **status** (integer) - The HTTP status code.
  - **title** (string) - A short, human-readable summary of the error.
  - **detail** (string) - A more detailed explanation of the error.
  - **code** (string) - An application-specific error code.

#### Error Response Example
```json
{
  "errors": [
    {
      "status": 400,
      "title": "Bad Request",
      "detail": "Missing required field: name."
    }
  ]
}
```
```

--------------------------------

### Create Bundle API Request - ShowClix

Source: https://technically.showclix.com/events

This snippet demonstrates the structure of a POST request to the /bundles endpoint for creating a new bundle in ShowClix. It includes the required headers and a detailed JSON body specifying bundle attributes and relationships. Note that this is a JSON schema and not directly executable code.

```json
{
  "data": {
    "type": "bundles",
    "id": {
      "type": "integer"
    },
    "attributes": {
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "inventory": {
        "type": "integer"
      },
      "active": {
        "type": "boolean"
      },
      "flex": {
        "type": "boolean"
      },
      "flex_minimum": {
        "type": "integer"
      },
      "flex_maximum": {
        "type": "integer"
      },
      "flex_itemize": {
        "type": "boolean"
      },
      "flex_percent_discount": {
        "type": "integer"
      },
      "flex_flat_discount": {
        "type": "float"
      },
      "settings": {
        "multiple_holders": {
          "type": "boolean"
        },
        "online_hide": {
          "type": "boolean"
        },
        "box_office_hide": {
          "type": "boolean"
        },
        "transaction_limit": {
          "type": "integer"
        },
        "minimum_purchase_limit": {
          "type": "integer"
        }
      },
      "price_levels": {
        "type": "collection"
      },
      "price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "bos_service_fee": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "box_office_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "minimum_price": {
        "meta-type": "currency",
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      }
    },
    "relationships": {
      "schedules": {
        "type": "price_level_schedules",
        "relation": "has_many"
      },
      "event": {
        "type": "events",
        "relation": "has_one"
      }
    }
  }
}
```

--------------------------------

### GET /scanner-statuses

Source: https://technically.showclix.com/events

Retrieves a collection of all scanner statuses.

```APIDOC
## GET /scanner-statuses

### Description
Retrieves a collection of all scanner statuses.

### Method
GET

### Endpoint
/scanner-statuses

### Query Parameters
None

### Request Example
```json
{
  "Headers": {
    "Accept": "application/vnd.api+json"
  }
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of scanner status objects.
  - Each object contains:
    - **type** (string) - 'scanner-statuses'.
    - **id** (string) - The unique identifier for the scanner status.
    - **attributes** (object) - The attributes of the scanner status (see POST /scanner-statuses for details).

#### Response Example
```json
{
  "data": [
    {
      "type": "scanner-statuses",
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "attributes": {
        "active": true,
        "battery_level": "85%",
        "wifi_strength": "High",
        "mac_address": "00:1A:2B:3C:4D:5E",
        "axess_version": "1.2.3",
        "device_identifier": "SCANNER-XYZ-789",
        "display_name": "Main Entrance Scanner",
        "active_user_name": "johndoe",
        "last_sync_user_name": "johndoe",
        "last_sync_date": "2023-10-27T10:00:00Z",
        "check_in_mode": "check-in"
      }
    },
    {
      "type": "scanner-statuses",
      "id": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
      "attributes": {
        "active": false,
        "battery_level": "20%",
        "wifi_strength": "Low",
        "mac_address": "AA:BB:CC:DD:EE:FF",
        "axess_version": "1.2.2",
        "device_identifier": "SCANNER-ABC-123",
        "display_name": "Back Office Scanner",
        "active_user_name": null,
        "last_sync_user_name": "janedoe",
        "last_sync_date": "2023-10-26T15:30:00Z",
        "check_in_mode": "check-out"
      }
    }
  ]
}
```
```

--------------------------------

### Generate API Token (cURL Example)

Source: https://technically.showclix.com/authentication

This snippet demonstrates how to generate an API token using cURL. It shows the necessary headers and the request body containing user credentials. The response includes the generated token and user details.

```curl
curl -X POST \
  http://api.showclix.com/api/registration \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'email=api@example.com&password=opensesame'
```

--------------------------------

### GET /price_levels

Source: https://technically.showclix.com/events

Retrieves a list of price levels.

```APIDOC
## GET /price_levels

### Description
Retrieves a list of price levels. This endpoint can be used to fetch all available price levels or filter them based on specific criteria (though filtering parameters are not detailed here).

### Method
GET

### Endpoint
/price_levels

### Headers
- **Accept**: `application/vnd.api+json` (Required)

### Response
#### Success Response (200)
- **data** (array) - An array of price level objects.

#### Response Example
```json
{
  "data": [
    {
      "type": "price_levels",
      "id": "123",
      "attributes": {
        "price": {
          "meta-type": "currency",
          "amount": 1000,
          "currency": "USD",
          "symbol": "$"
        },
        "box_office_price": null,
        "minimum_price": {
          "meta-type": "currency",
          "amount": 1000,
          "currency": "USD",
          "symbol": "$"
        },
        "name": "General Admission",
        "description": null,
        "inventory": 500,
        "settings": {
          "transaction_limit": null,
          "minimum_purchase_limit": null,
          "hide_online": false,
          "hide_box_office": false
        },
        "parent_id": null,
        "price_breakdown": null
      },
      "relationships": {
        "question_maps": {
          "data": []
        },
        "questions": {
          "data": []
        },
        "schedules": {
          "data": []
        },
        "event": {
          "data": null
        }
      }
    }
  ]
}
```
```

--------------------------------

### Get Related Scheme

Source: https://technically.showclix.com/events

Retrieves the scheme associated with an event.

```APIDOC
## GET /events/{id}/scheme

### Description
Retrieves the scheme associated with an event.

### Method
GET

### Endpoint
`/events/{id}/scheme`

### Parameters
#### Path Parameters
- **id** (string) - Required - Event ID
```
Tokens:
Raw