Get tickets

GET

tickets

curl --request GET \
  --url https://api-alpha.fourvenues.com/integrations/tickets/ \
  --header 'integration_id: <api-key>' \
  --header 'secret: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "data": [
    {
      "_id": "el7yuiyep0006msyw2pri1tem1LpJwSc",
      "activation_date": "2022-09-15T23:00:00.000Z",
      "channel_id": "ajifs2hke000dwemmurwd3kuqN3Kopcx",
      "code": "P6J21FF2S",
      "discount_quantity_subtract": 0,
      "email": "my-client-email@fourvenues.com",
      "gender": "female",
      "address": "Calle de la Rosa 1",
      "language": "es",
      "country": "ES",
      "postal_code": "28001",
      "enter": 0,
      "entry_date": 0,
      "event_id": "Mjo4f9o9h01fdjvmmrgn9aoh4s5IBHzX",
      "for": 1,
      "name": "Miguel Román",
      "payment_id": "Cl7yuiyhy0007msyw4vfl5ai6YF4WZRn",
      "phone": "+34666666666",
      "price": 10,
      "raised": 0,
      "rate_id": "Tl4gr63fr0xkr01i1gk354qbrSCMLTwl",
      "rate_name": "General Access",
      "rate_slug": "general-access",
      "referral_id": "ñeifupjvx000rwe2m2zuba1z9FqyR2dSL",
      "refunded": 0,
      "sale_type": "online",
      "price_info": {
        "_id": "1712861139741",
        "price": 10,
        "age": 18,
        "content": "",
        "additional_info": ""
      },
      "supplements": [
        {
          "_id": "1712861146044",
          "price": 2,
          "label": "Bus",
          "description": "Bus from the city center to the venue.",
          "has_fake_price": false,
          "fake_price": 0,
          "product_quantity": 1,
          "product_quantity_used": 1
        }
      ],
      "status": "activated",
      "total_extras": 2,
      "total_fees": 1.2,
      "total_paid": 13.2,
      "invoice_reference": "EV24T-TOX2-0000215",
      "corrective_invoice_references": [
        "EV24T-COR-H58Z-0000002",
        "EV24T-COR-H58Z-0000003"
      ]
    }
  ]
}

Authorizations

integration_id

string

header

required

Identifier of the integration (Auth v1)

secret

string

header

required

Secret of the organization (Auth v1)

x-api-key

string

header

required

API key (Auth v2)

Query Parameters

event_id

string

required

Event identifier.

start_date

string

Start date.

end_date

string

End date.

date_field

object

Date field.

limit

string

Limit of tickets.

offset

string

Offset of tickets.

Response

200

application/json

HTTP OK

success

boolean

Example:

true

data

object[]

Array of Ticket

data._id

string

Unique ID of the ticket.

Example:

"el7yuiyep0006msyw2pri1tem1LpJwSc"

data.activation_date

string

Date when the ticket was activated (Paid or activated via SMS) in ISO 8601 format..

Example:

"2022-09-15T23:00:00.000Z"

data.channel_id

string

Unique identifier of the channel. (It can be the same or other organization).

Example:

"ajifs2hke000dwemmurwd3kuqN3Kopcx"

data.code

string

Access code (QR) of the ticket.

Example:

"P6J21FF2S"

data.discount_quantity_subtract

number

default:0

Total amount of discount code that will be subtracted from the final price.

Example:

0

data.email

string

Email filled with the ticket.

Example:

"my-client-email@fourvenues.com"

data.gender

string

Gender: female, male, other.

Example:

"female"

data.address

string

Address filled with the ticket.

Example:

"Calle de la Rosa 1"

data.language

string

Language of the client.

Example:

"es"

data.country

string

Country filled with the ticket.

Example:

"ES"

data.postal_code

string

Postal code filled with the ticket.

Example:

"28001"

data.enter

integer

default:0

Number of people entered.

Required range: 0 <= x <= 1

Example:

0

data.entry_date

number

Date when the ticket was checked in (unix).

Example:

0

data.event_id

string

Event identifier.

Example:

"Mjo4f9o9h01fdjvmmrgn9aoh4s5IBHzX"

data.for

integer

Number of people enlisted.

Required range: 1 <= x <= 1

Example:

1

data.name

string

Name filled with the ticket.

Example:

"Miguel Román"

data.payment_id

string

Payment identifier.

Example:

"Cl7yuiyhy0007msyw4vfl5ai6YF4WZRn"

data.phone

string

Phone number filled with the ticket.

Example:

"+34666666666"

data.price

number

Base rate price.

Example:

10

data.raised

number

Total amount raised.

Example:

0

data.rate_id

string

Rate identifier.

Example:

"Tl4gr63fr0xkr01i1gk354qbrSCMLTwl"

data.rate_name

string

Rate name.

Example:

"General Access"

data.rate_slug

string

Rate slug.

Example:

"general-access"

data.referral_id

string

PPRR identifier.

Example:

"ñeifupjvx000rwe2m2zuba1z9FqyR2dSL"

data.refunded

number

default:0

Refunded amount.

Example:

0

data.sale_type

enum<string>

Sale type.

Available options:

online,

sms,

imported,

invitation,

paylink,

print,

box-office

Example:

"online"

data.price_info

object

data.supplements

object[]

data.status

enum<string>[]

Ticket status: - Activated: A ticket is activated when it is filled and already paid. It can be checked in correctly. - Cancelled: The ticket is cancelled and the system will raise an error if is checked in. - Filling client: The SMS has been sent, and the client has to fill the data in order to activate the ticket.

Available options:

activated,

cancelled,

filling_client

Example:

"activated"

data.total_extras

number

Amount paid for the extras. (Example: 2€ for Fast pass).

Example:

2

data.total_fees

number

Amount paid for the fees. (Example: 10%)

Example:

1.2

data.total_paid

number

Total amount paid (Base price + Extras + Fees - Discount).

Example:

13.2

data.invoice_reference

string

Invoice reference.

Example:

"EV24T-TOX2-0000215"

data.corrective_invoice_references

string[]

Corrective invoice references.

Example:

[
  "EV24T-COR-H58Z-0000002",
  "EV24T-COR-H58Z-0000003"
]

Post subscriptions Get ticket by id

curl --request GET \
  --url https://api-alpha.fourvenues.com/integrations/tickets/ \
  --header 'integration_id: <api-key>' \
  --header 'secret: <api-key>' \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "data": [
    {
      "_id": "el7yuiyep0006msyw2pri1tem1LpJwSc",
      "activation_date": "2022-09-15T23:00:00.000Z",
      "channel_id": "ajifs2hke000dwemmurwd3kuqN3Kopcx",
      "code": "P6J21FF2S",
      "discount_quantity_subtract": 0,
      "email": "my-client-email@fourvenues.com",
      "gender": "female",
      "address": "Calle de la Rosa 1",
      "language": "es",
      "country": "ES",
      "postal_code": "28001",
      "enter": 0,
      "entry_date": 0,
      "event_id": "Mjo4f9o9h01fdjvmmrgn9aoh4s5IBHzX",
      "for": 1,
      "name": "Miguel Román",
      "payment_id": "Cl7yuiyhy0007msyw4vfl5ai6YF4WZRn",
      "phone": "+34666666666",
      "price": 10,
      "raised": 0,
      "rate_id": "Tl4gr63fr0xkr01i1gk354qbrSCMLTwl",
      "rate_name": "General Access",
      "rate_slug": "general-access",
      "referral_id": "ñeifupjvx000rwe2m2zuba1z9FqyR2dSL",
      "refunded": 0,
      "sale_type": "online",
      "price_info": {
        "_id": "1712861139741",
        "price": 10,
        "age": 18,
        "content": "",
        "additional_info": ""
      },
      "supplements": [
        {
          "_id": "1712861146044",
          "price": 2,
          "label": "Bus",
          "description": "Bus from the city center to the venue.",
          "has_fake_price": false,
          "fake_price": 0,
          "product_quantity": 1,
          "product_quantity_used": 1
        }
      ],
      "status": "activated",
      "total_extras": 2,
      "total_fees": 1.2,
      "total_paid": 13.2,
      "invoice_reference": "EV24T-TOX2-0000215",
      "corrective_invoice_references": [
        "EV24T-COR-H58Z-0000002",
        "EV24T-COR-H58Z-0000003"
      ]
    }
  ]
}

Introduction

API Reference

Recipes

Authorizations

Query Parameters

Response