Get ticket rate by slug

GET

ticket-rates

by-slug

{slug}

curl --request GET \
  --url https://channels-service-alpha.fourvenues.com/ticket-rates/by-slug/{slug} \
  --header 'X-Api-Key: <api-key>'

{
  "data": {
    "_id": "abcdefghi1234567890",
    "organization_id": "abcdefghi1234567890",
    "event_id": "abcdefghi1234567890",
    "name": "General Access",
    "slug": "general-access",
    "valid_from": "2022-01-01T00:00:00.000Z",
    "complete": false,
    "type": "limited",
    "show_all_prices": true,
    "prices": [
      {
        "_id": "1643064796675",
        "name": "Early Bird",
        "price": 12,
        "valid_until": "2022-01-01T00:00:00.000Z",
        "quantity": 0,
        "fee_type": "percentage",
        "fee_quantity": 10,
        "includes": "1 Drink",
        "additional_info": "Only valid before 2:00 am."
      }
    ],
    "supplements": [
      {
        "_id": "1643064796675",
        "label": "1 Copa",
        "price": 12,
        "has_fake_price": false,
        "fake_price": 15
      }
    ],
    "available": true,
    "current_price": {
      "_id": "1643064796675",
      "name": "Early Bird",
      "price": 12,
      "valid_until": "2022-01-01T00:00:00.000Z",
      "quantity": 0,
      "fee_type": "percentage",
      "fee_quantity": 10,
      "includes": "1 Drink",
      "additional_info": "Only valid before 2:00 am."
    },
    "warranty": {
      "enabled": true,
      "percentage": 20,
      "hours": 12
    },
    "availability": {
      "sold": 10,
      "available": 90
    },
    "min": 1,
    "max": 10,
    "questions": [
      {
        "_id": "1643064796675",
        "label": "¿How did you hear about us?",
        "type": "dropdown",
        "required": true,
        "items": [
          "Instagram",
          "Appear"
        ]
      }
    ]
  },
  "success": true
}

Authorizations

X-Api-Key

string

header

required

Path Parameters

slug

string

required

Ticket rate slug

Example:

"abcde12345"

Query Parameters

event_id

string

required

Event of the ticke rate

Response

200

application/json

data

object

data.organization_id

string

required

Ticket rate organization unique identifier.

Example:

"abcdefghi1234567890"

data.event_id

string

required

Event unique identifier.

Example:

"abcdefghi1234567890"

data.name

string

required

Name of the ticket rate.

Example:

"General Access"

data.slug

string

required

Name URL-friendly identifier.

Example:

"general-access"

data.valid_from

string

required

Date when the ticket rate will be available for sale.

Example:

"2022-01-01T00:00:00.000Z"

data.complete

boolean

required

If the ticket rate is marked as complete.

Example:

false

data.type

enum<string>

required

Available options:

limited,

public

Example:

"limited"

data.prices

object[]

required

Prices of the ticket rate.

A ticket rate can have one or multiple prices but only one can be active at a time.

data.supplements

object[]

required

Supplements of the ticket rate. Each supplement increases the price of the ticket.

data.available

boolean

required

If the ticket rate is available.

Example:

true

data.availability

object

required

data.min

number

required

Minimum number of tickets that can be purchased in a single order.

Example:

1

data.max

number

required

Maximum number of tickets that can be purchased in a single order.

Example:

10

data.questions

object[]

required

Questions of the ticket rate.

data.questions._id

string

required

Unique identifier for the question.

Example:

"1643064796675"

data.questions.label

string

required

Label of the question.

Example:

"¿How did you hear about us?"

data.questions.type

enum<string>

required

Available options:

text,

dropdown

Example:

"dropdown"

data.questions.required

boolean

required

If the question is required.

Example:

true

data.questions.items

string[]

Options of the question.

Example:

["Instagram", "Appear"]

data._id

string

Ticket rate unique identifier.

Example:

"abcdefghi1234567890"

data.show_all_prices

boolean

If the ticket rate is configured to show all prices.

Example:

true

data.current_price

object

Current price available of the ticket rate.

data.warranty

object

success

boolean

Get pricing info of a ticket rate given a quantity of tickets Get tickets

curl --request GET \
  --url https://channels-service-alpha.fourvenues.com/ticket-rates/by-slug/{slug} \
  --header 'X-Api-Key: <api-key>'

{
  "data": {
    "_id": "abcdefghi1234567890",
    "organization_id": "abcdefghi1234567890",
    "event_id": "abcdefghi1234567890",
    "name": "General Access",
    "slug": "general-access",
    "valid_from": "2022-01-01T00:00:00.000Z",
    "complete": false,
    "type": "limited",
    "show_all_prices": true,
    "prices": [
      {
        "_id": "1643064796675",
        "name": "Early Bird",
        "price": 12,
        "valid_until": "2022-01-01T00:00:00.000Z",
        "quantity": 0,
        "fee_type": "percentage",
        "fee_quantity": 10,
        "includes": "1 Drink",
        "additional_info": "Only valid before 2:00 am."
      }
    ],
    "supplements": [
      {
        "_id": "1643064796675",
        "label": "1 Copa",
        "price": 12,
        "has_fake_price": false,
        "fake_price": 15
      }
    ],
    "available": true,
    "current_price": {
      "_id": "1643064796675",
      "name": "Early Bird",
      "price": 12,
      "valid_until": "2022-01-01T00:00:00.000Z",
      "quantity": 0,
      "fee_type": "percentage",
      "fee_quantity": 10,
      "includes": "1 Drink",
      "additional_info": "Only valid before 2:00 am."
    },
    "warranty": {
      "enabled": true,
      "percentage": 20,
      "hours": 12
    },
    "availability": {
      "sold": 10,
      "available": 90
    },
    "min": 1,
    "max": 10,
    "questions": [
      {
        "_id": "1643064796675",
        "label": "¿How did you hear about us?",
        "type": "dropdown",
        "required": true,
        "items": [
          "Instagram",
          "Appear"
        ]
      }
    ]
  },
  "success": true
}

Introduction

API Reference

Webhooks

Recipes

Authorizations

Path Parameters

Query Parameters

Response