Get list rate by slug

GET

list-rates

by-slug

{slug}

curl --request GET \
  --url https://channels-service-alpha.fourvenues.com/list-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",
    "valid_until": "2022-01-01T00:00:00.000Z",
    "complete": false,
    "type": "limited",
    "prices": [
      {
        "_id": "1643064796675",
        "price": 12,
        "from": 14400,
        "valid_from": "2022-01-01T00:00:00.000Z",
        "valid_until": "2022-01-01T00:00:00.000Z",
        "men": true,
        "women": true,
        "age": 18,
        "additional_info": "Subject to capacity."
      }
    ],
    "available": true,
    "availability": {
      "sold": 10,
      "available": 90
    },
    "max": 10
  },
  "success": true
}

Authorizations

X-Api-Key

string

header

required

Path Parameters

slug

string

required

List rate slug

Response

200

application/json

data

object

data.organization_id

string

required

List rate organization unique identifier.

Example:

"abcdefghi1234567890"

data.event_id

string

required

Event unique identifier.

Example:

"abcdefghi1234567890"

data.name

string

required

Name of the list rate.

Example:

"General Access"

data.slug

string

required

Name URL-friendly identifier.

Example:

"general-access"

data.valid_from

string

required

Date when the price will be available for sale.

Example:

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

data.complete

boolean

required

If the list 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 list rate.

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

data.available

boolean

required

If the list rate is available.

Example:

true

data.availability

object

required

data.max

number

required

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

Example:

10

data._id

string

List rate unique identifier.

Example:

"abcdefghi1234567890"

data.valid_until

string

Date until the price will be available.

Example:

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

success

boolean

Get list rate by id Get all lists

curl --request GET \
  --url https://channels-service-alpha.fourvenues.com/list-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",
    "valid_until": "2022-01-01T00:00:00.000Z",
    "complete": false,
    "type": "limited",
    "prices": [
      {
        "_id": "1643064796675",
        "price": 12,
        "from": 14400,
        "valid_from": "2022-01-01T00:00:00.000Z",
        "valid_until": "2022-01-01T00:00:00.000Z",
        "men": true,
        "women": true,
        "age": 18,
        "additional_info": "Subject to capacity."
      }
    ],
    "available": true,
    "availability": {
      "sold": 10,
      "available": 90
    },
    "max": 10
  },
  "success": true
}

Introduction

API Reference

Webhooks

Recipes

Authorizations

Path Parameters

Response