Skip to content

Latest commit

 

History

History

pims

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/pims

Client library for Pims

Installation and Usage

npm install --save @datafire/pims
let pims = require('@datafire/pims').create({
  username: "",
  password: ""
});

.then(data => {
  console.log(data);
});

Description

Hereafter is the documentation of the private API of Pims: Pointages Intelligents pour le Monde du Spectacle. This API is designed for 3rd-party softwares, editors and partners. Its main purpose is to give access the core data of a Pims customer (i.e. events, ticket counts and promotions).

Authentication

The API uses basic access authentication, meaning you will need a username and password to get authorized.

As each customer in Pims has its own domain (e.g. caramba.pims.io, gdp.pims.io...), each credentials will be valid for one domain/customer only. If you need dedicated credentials for one domain, please contact us. (In any case, we will need an explicit agreement from the customer before we create these credentials.)

To make your life easy, you can try all endpoints with the public credentials below, pointing to our [demo domain](https://demo.pims.io):

Response format

The API returns JSON and matches the HAL specification. The Content-Type of each response will be application/hal+json, unless an error occurs.

Please note that this documentation describes all responses “as if” they were plain JSON. The specificities of HAL are ignored on purpose, in order to remain compact and avoid repetition.

So when you read in the doc: 
{
	"id": 123,
	"property1": "Lorem ipsum",
	"object": {
		"id": 456,
		"property2": 7.89
	}
}
... you'll get in the Real World®: 
{
	"id": 123,
	"property2": "Lorem ipsum",
	"_embedded": {
		"object": {
			"id": 456,
			"property2": 7.89,
			"_links": {
				"self": {
					"href": "https://api.mydomain.com/other-item/456"
				}
			}
		}
	}
	"_links": {
		"self": {
			"href": "https://api.mydomain.com/item/123"
		}
	}
}

Errors

Errors return JSON too and tries to match the Problem Details for HTTP APIs specification. If it does not match this spec, that's either a bug or a compatibility issue. Please contact us to solve the problem.

The Content-Type of errors will be application/problem+json. The content will match the following JSON:

{
	"type": "https://tools.ietf.org/html/rfc2616#section-10",
    "title": "Not Found",
	"status": 404,
    "detail": "Entity not found"
}

Versioning

The API is fully versionned, using an URL-versioning scheme: https://demo.pims.io/api/v1/events, https://demo.pims.io/api/v2/events,...

The version part of the URL is optional, and will be completed with the last stable version if omitted.

Pagination

All responses corresponding to a collection of resources (e.g. /venues or /series/:id/events) are paginated. When so, you will only get the first 25 resources you asked for.

If you need to get more resources in one call, you can use the page_size query parameter. E.g. /venues?page_size=50 to get the 50 first venues.

Also note that with HAL, the navigation in paginated responses is a piece of cake, as you can see below:

{
	"_links": {
		"self": {
			"href": "https://demo.pims.io/api/v1/events?page=1"
		},
		"first": {
			"href": "https://demo.pims.io/api/v1/events"
		},
		"last": {
			"href": "https://demo.pims.io/api/v1/events?page=14"
		},
		"next": {
			"href": "https://demo.pims.io/api/v1/events?page=2"
		}
	},
	"_embedded": {
 		... // data content goes here
	},
	"page_count": 14,
	"page_size": 25,
	"total_items": 331,
	"page": 1
}

Filtering and sorting

Every textual filter (e.g. /events?label=U2) and/or sort (e.g. /events?sort=label) performed with the API uses UTF8_UNICODE_CI collation, meaning it is:

  • Case insensitive: “Chloé” will be considered the same as “CHLOÉ”;
  • Diacritic insensitive: “Chloé” will be considered the same as “Chloe”.

When performing a sort, it will always be ascending by default. To make it descending, just use a minus sign (-) in front of the parameter value (e.g. /events?sort=-label).

I18n

In responses, some labels can be translated (e.g. promotion types, event input types, etc.). These translatable labels are clearly indicated in the documentation below.

By default, they will be displayed in English, but you can change this behaviour via the Accept-Language header. E.g., use fr as a value for French.

PHP SDK

We provide a simple yet convenient SDK for the PHP language, see the Github page of the project.

And now?

Generaly, you will start by fetching one or more events. An event can be anything that occurs in one venue at one given date and time: a concert, a play, a match, a conference, etc. Additionnally, you can explore the series: a series is just a group of events (e.g. a tour or a festival).

Once you retrieved the events you were interested in, you can look for the sales (ticket counts):

Eventually, you may also want to fetch the promotions. A promotion can be anything meant to leverage the sales: ads, marketing campaigns, buzz or news around the event, etc. A promotion can be linked to any combination of events and/or series.

Actions

fetchAllCategories

Find all categories

pims.fetchAllCategories({}, context)

Input

  • input object
    • label string: Find only the categories whose label/short label contains this value.
    • show_ignored boolean: If set to false, show only the categories which are not ignored. If set to true, show all categories.
    • sort string (values: label, -label, order, -order): Sort the categories in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchOneCategory

Get one category by ID

pims.fetchOneCategory({
  "category_id": 0
}, context)

Input

  • input object
    • category_id required integer: ID of the targeted category.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchAllChannels

Find all channels

pims.fetchAllChannels({}, context)

Input

  • input object
    • label string: Find only the channels whose label contains this value.
    • show_ignored boolean: If set to false, show only the channels which are not ignored. If set to true, show all channels.
    • sort string (values: label, -label, order, -order): Sort the channels in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchOneChannel

Get one channel by ID

pims.fetchOneChannel({
  "channel_id": 0
}, context)

Input

  • input object
    • channel_id required integer: ID of the targeted channel.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchAllEvents

Find all events

pims.fetchAllEvents({}, context)

Input

  • input object
    • label string: Find only the events whose label contains this value.
    • from_datetime string: Find only the events starting after this date.
    • to_datetime string: Find only the events starting before this date.
    • city string: Find only the events whose venue city (or metropolitan area) contains this value.
    • sort string (values: label, -label, datetime, -datetime, venue_label, -venue_label, city, -city): Sort the events in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchOneEvent

Get one event by ID

pims.fetchOneEvent({
  "event_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchAllEventsCapacities

Find all capacities for one event

pims.fetchAllEventsCapacities({
  "event_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • show_ignored boolean: If set to false, show only the [event-]categories which are not ignored. If set to true, show everything.
    • sort string (values: date, -date): Sort the capacities in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.

Output

fetchOneEventCapacity

Get one capacity by ID

pims.fetchOneEventCapacity({
  "event_id": 0,
  "capacity_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • capacity_id required integer: ID of the targeted capacity.
    • show_ignored boolean: If set to false, show only the [event-]categories which are not ignored. If set to true, show everything.

Output

fetchAllEventsCategories

Find all categories for one event

pims.fetchAllEventsCategories({
  "event_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • show_ignored boolean: If set to false, show only the [event-]categories/[event-]price ranges which are not ignored. If set to true, show everything.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.

Output

fetchOneEventCategory

Get one event category by ID

pims.fetchOneEventCategory({
  "event_id": 0,
  "category_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • category_id required number: ID of the targeted event category.
    • show_ignored boolean: If set to false, show only the embedded [event-]price ranges which are not ignored. If set to true, show everything.

Output

fetchAllEventsChannels

Find all channels for one event

pims.fetchAllEventsChannels({
  "event_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • show_ignored boolean: If set to false, show only the [event-]channels which are not ignored. If set to true, show everything.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.

Output

fetchOneEventChannel

Get one event channel by ID

pims.fetchOneEventChannel({
  "event_id": 0,
  "channel_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • channel_id required integer: ID of the targeted event channel.

Output

fetchAllEventsPromotions

Find all promotions for one event

pims.fetchAllEventsPromotions({
  "event_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • label string: Find only the promotions whose label contains this value.
    • from_date string: Find only the promotions starting after this date.
    • to_date string: Find only the promotions ending before this date.
    • type string: Find only the promotions whose type is equal to this value.
    • family string: Find only the promotions whose family is equal to this value.
    • sort string (values: date, -date, total_cost, -total_cost): Sort the promotions in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchAllTicketCounts

Find all ticket counts for one event

pims.fetchAllTicketCounts({
  "event_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • from_date string: Find only the ticket counts after this date.
    • to_date string: Find only the ticket counts before this date.
    • show_ignored boolean: If set to false, show only the [event-]categories/[event-]price ranges/[event]channels which are not ignored. If set to true, show everything.
    • show_not_approved boolean: If set to false, show only the approved ticket counts. If set to true, show all the ticket counts.
    • sort string (values: date, -date): Sort the ticket counts in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.

Output

fetchAllDetailedTicketCounts

Find all detailed ticket counts for one event

pims.fetchAllDetailedTicketCounts({
  "event_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • from_date string: Find only the ticket counts after this date.
    • to_date string: Find only the ticket counts before this date.
    • show_ignored boolean: If set to false, show only the [event-]categories/[event-]price ranges/[event]channels which are not ignored. If set to true, show everything.
    • show_not_approved boolean: If set to false, show only the approved ticket counts. If set to true, show all the ticket counts.
    • sort string (values: date, -date): Sort the ticket counts in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.

Output

fetchOneDetailedTicketCount

Get one detailed ticket count by ID

pims.fetchOneDetailedTicketCount({
  "event_id": 0,
  "ticket_count_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • ticket_count_id required integer: ID of the targeted ticket count.
    • show_ignored boolean: If set to false, show only the [event-]categories/[event-]price ranges/[event]channels which are not ignored. If set to true, show everything.

Output

fetchOneTicketCount

Get one ticket count by ID

pims.fetchOneTicketCount({
  "event_id": 0,
  "ticket_count_id": 0
}, context)

Input

  • input object
    • event_id required integer: ID of the targeted event.
    • ticket_count_id required integer: ID of the targeted ticket count.
    • show_ignored boolean: If set to false, show only the [event-]categories/[event-]price ranges/[event]channels which are not ignored. If set to true, show everything.

Output

fetchAllPriceRanges

Find all price ranges

pims.fetchAllPriceRanges({}, context)

Input

  • input object
    • label string: Find only the price ranges whose label contains this value.
    • show_ignored boolean: If set to false, show only the price ranges which are not ignored. If set to true, show all price ranges.
    • sort string (values: label, -label, order, -order): Sort the price ranges in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchOnePriceRange

Get one price range by ID

pims.fetchOnePriceRange({
  "price_range_id": 0
}, context)

Input

  • input object
    • price_range_id required integer: ID of the targeted price range.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchAllPromotions

Find all promotions

pims.fetchAllPromotions({}, context)

Input

  • input object
    • label string: Find only the promotions whose label contains this value.
    • from_date string: Find only the promotions starting after this date.
    • to_date string: Find only the promotions ending before this date.
    • type string: Find only the promotions whose type is equal to this value.
    • family string: Find only the promotions whose family is equal to this value.
    • sort string (values: date, -date, total_cost, -total_cost): Sort the promotions in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchOnePromotion

Get one promotion by ID

pims.fetchOnePromotion({
  "promotion_id": 0
}, context)

Input

  • input object
    • promotion_id required integer: ID of the targeted promotion.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchAllSeries

Find all series

pims.fetchAllSeries({}, context)

Input

  • input object
    • label string: Find only the venues whose label contains this value.
    • from_date string: Find only the series starting after this date.
    • to_date string: Find only the series ending before this date.
    • type string (values: TOU, LGS): Find only the series whose type is equal to this value.
    • sort string (values: label, -label, first_date, -first_date, last_date, -last_date): Sort the series in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchOneSeries

Get one series by ID

pims.fetchOneSeries({
  "series_id": 0
}, context)

Input

  • input object
    • series_id required integer: ID of the targeted series.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchAllSeriesEvents

Find all events for one series

pims.fetchAllSeriesEvents({
  "series_id": 0
}, context)

Input

  • input object
    • series_id required integer: ID of the targeted series.
    • from_datetime string: Find only the events starting after this date.
    • to_datetime string: Find only the events starting before this date.
    • city string: Find only the events whose venue city (or metropolitan area) contains this value.
    • sort string (values: label, -label, datetime, -datetime, venue_label, -venue_label, city, -city): Sort the events in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchAllSeriesPromotions

Find all promotions for one series

pims.fetchAllSeriesPromotions({
  "series_id": 0
}, context)

Input

  • input object
    • series_id required integer: ID of the targeted series.
    • label string: Find only the promotions whose label contains this value.
    • from_date string: Find only the promotions starting after this date.
    • to_date string: Find only the promotions ending before this date.
    • type string: Find only the promotions whose type is equal to this value.
    • family string: Find only the promotions whose family is equal to this value.
    • sort string (values: date, -date, total_cost, -total_cost): Sort the promotions in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchAllVenues

Find all venues

pims.fetchAllVenues({}, context)

Input

  • input object
    • label string: Find only the venues whose label contains this value.
    • city string: Find only the venues whose city contains this value.
    • country_code string: Find only the venues whose country_code is equal to this value.
    • type string (values: SAL, FES): Find only the venues whose type is equal to this value.
    • sort string (values: label, -label, city, -city, country, -country): Sort the venues in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchOneVenue

Get one venue by ID

pims.fetchOneVenue({
  "venue_id": 0
}, context)

Input

  • input object
    • venue_id required integer: ID of the targeted venue.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

fetchAllVenuesEvents

Find all events for one venue

pims.fetchAllVenuesEvents({
  "venue_id": 0
}, context)

Input

  • input object
    • venue_id required integer: ID of the targeted venue.
    • from_datetime string: Find only the events starting after this date.
    • to_datetime string: Find only the events starting before this date.
    • city string: Find only the events whose venue city (or metropolitan area) contains this value.
    • sort string (values: label, -label, datetime, -datetime, venue_label, -venue_label, city, -city): Sort the events in the corresponding order.
    • page_size integer: Pagination size, i.e. maximum number of items to be displayed in the response.
    • Accept-Language string (values: de, en, fr): Language used for the translatable labels.

Output

Definitions

CategoriesEntity

  • Category object
    • id required integer: Unique ID of the category.
    • ignored required boolean: Defines whether this category is ignored or not.
    • label required string: Full label of the category.
    • last_update_timestamp required integer: Timestamp for when the category was last updated in the customer's database.
    • short_label required string: Short label of the category (generally less than 5 characters).

ChannelsEntity

  • Channel object
    • id required integer: Unique ID of the channel.
    • ignored required boolean: Defines whether this channel is ignored or not.
    • label required string: Full label of the channel.
    • last_update_timestamp required integer: Timestamp for when the channel was last updated in the customer's database.
    • short_label required string: Short label of the channel (generally less than 5 characters).

Error401

  • Error401 object
    • detail required string: Description of the error.
    • status required integer: Status code of the error.
    • title required string: Message corresponding to the status code.
    • type required string: Link to RFC 2616 about status codes definitions.

Error403

  • Error403 object
    • detail required string: Description of the error.
    • status required integer: Status code of the error.
    • title required string: Message corresponding to the status code.
    • type required string: Link to RFC 2616 about status codes definitions.

Error404

  • Error404 object
    • detail required string: Description of the error.
    • status required integer: Status code of the error.
    • title required string: Message corresponding to the status code.
    • type required string: Link to RFC 2616 about status codes definitions.

Error422

  • Error422 object
    • detail required string: Description of the error.
    • status required integer: Status code of the error.
    • title required string: Message corresponding to the status code.
    • type required string: Link to RFC 2616 about status codes definitions.

Error500

  • Error500 object
    • detail required string: Description of the error.
    • status required integer: Status code of the error.
    • title required string: Message corresponding to the status code.
    • type required string: Link to RFC 2616 about status codes definitions.

EventsCapacitiesEntity

  • Event capacity object
    • date required string: Date from which the capacity is active.
    • event_categories array: Array of categories with their detailed capacities.
      • items object
        • comps required integer: Number of comps in the category.
        • holds required integer: Number of holds in the category. Holds are seats/places that are not in sale at the date of the capacity, but will eventually be later.
        • id required integer: Unique ID of the event category.
        • kills required integer: Number of kills in the category. Kills are seats/places that will not be sold for technical reasons.
        • sellable_capacity required integer: Number of sellable seats/places in the category. This is calculated by the formula: total_capacity - kills - comps - holds.
        • total_capacity required integer: Total number of seats/places in the category.
    • id required integer: Unique ID of the event capacity.

EventsCategoriesEntity

  • Event category object
    • category required CategoriesEntity
    • event_price_ranges array: Array of event price ranges.
      • items object
        • base_price required number: Base price of the event price range (i.e. including VAT but excluding all commissions).
        • currency required string: Currency of the prices.
        • id required integer: ID of the event price range.
        • ignored boolean: Defines whether this event price range is ignored or not.
        • price_range required PriceRangesEntity
        • public_price required number: Public price of the event price range (i.e. including VAT and all commissions).
    • id required integer: Unique ID of the event category.
    • ignored required boolean: Defines whether this event category is ignored or not.

EventsChannelsEntity

  • Event channel object
    • channel required ChannelsEntity
    • id required integer: Unique ID of the event channel.
    • ignored required boolean: Defines whether this event channel is ignored or not.

EventsEntity

  • Event object
    • break_even integer: Value of the break-even for the event.
    • cancellation_date string: Date the event was canceled.
    • contract required object: Contract of the series.
      • partner required object: Contract partner.
        • id required integer: Unique ID identifying the contract partner.
        • label required string: Label of the contract partner.
      • type required object: Contract type.
        • id required string (values: PRO, COP, PLO, COR, CES): String identifying the contract type.
        • label required string: Label of the contract type. This value is translated according to the 'Accept-Language' header.
    • costing_capacity integer: Costing capacity of the event.
    • creation_timestamp required integer: Timestamp for when the venue was created in the customer's database.
    • currency string: Currency of the prices.
    • datetime required string: Datetime of the event (relative to the timezone of the venue).
    • free required boolean: Whether this event is free or not.
    • general_sales_date string: Date the event went on general sales (relative to the timezone of the venue).
    • id required integer: Unique ID of the event.
    • input_type required object: Input type of the event.
      • id required string (values: DET, GLO): String identifying the input type of the event.
      • label required string: Label of the input type. This value is translated according to the 'Accept-Language' header.
    • label required string: Label of the event.
    • last_update_timestamp required integer: Timestamp for when the venue was last updated in the customer's database.
    • max_capacity integer: Maximum capacity for the venue in which the event occurs.
    • presales_date string: Date the event went on presales (relative to the timezone of the venue).
    • series_id required integer: ID of the series the event belongs to.
    • sold_out_date string: Date the event was sold out.
    • venue required VenuesEntity

PriceRangesEntity

  • Price range object
    • id required integer: Unique ID of the price range.
    • ignored required boolean: Defines whether this price range is ignored or not.
    • label required string: Full label of the price range.
    • last_update_timestamp required integer: Timestamp for when the price range was last updated in the customer's database.
    • short_label required string: Short label of the price range (generally less than 5 characters).

PromotionsEntity

  • Promotion object
    • applied_to required array: List of events and/or series where the promotion is applied. A promotion can be applied on several events, and its costs can be split between those events.
      • items object
        • event_id integer: ID of the event the promotion applies to. This property is exclusive with 'series_id': if defined, then 'series_id' will not be displayed.
        • quantity number: Quantity share of the promotion devoted to this event/series.
        • series_id integer: ID of the series the promotion applies to. This property is exclusive with 'event_id': if defined, then 'event_id' will not be displayed.
        • unit_cost number: Unit cost share of the promotion devoted to this event/series. The total cost of the share can be calculated with: quantity × unit_cost. This field may be omitted according to the customer configuration.
        • valorized_quantity number: Valorized quantity share of the promotion devoted to this event/series. This field may be omitted according to the customer configuration.
        • valorized_unit_cost number: Valorized unit cost share of the promotion devoted to this event/series. The total valorized cost of the share can be calculated with: valorized_quantity × valorized_unit_cost.
    • comments required string: Comments on the promotion.
    • cost required object: Cost of the promotion.
      • currency string: Currency of the unit_cost (ISO 4212 alphabetic code).
      • exchange string: What was offered in exchange of the promotion.
      • quantity number: Quantity of the promotion (see unit_cost).
      • state object: State of the promotion cost. This object may be omitted according to the customer configuration.
        • id required string (values: PRE, ENG, FAC, PAY): String identifying the state of the promotion cost.
        • label required string: Label of the state of the promotion cost. This value is translated according to the 'Accept-Language' header.
      • type required object: Type of the promotion cost.
        • id required string (values: PAY, ECH, GRA): String identifying the type of the promotion cost.
        • label required string: Label of the type of the promotion cost. This value is translated according to the 'Accept-Language' header.
      • unit_cost number: Unit cost of the promotion. The total cost of the promotion can be calculated with: quantity × unit_cost.
      • valorized_quantity number: Valorized quantity of the promotion (see valorized_unit_cost). This field may be omitted according to the customer configuration.
      • valorized_unit_cost number: Valorized unit cost of the promotion. The total valorized cost of the promotion can be calculated with: valorized_quantity × valorized_unit_cost. This field may be omitted according to the customer configuration.
    • end_date required string: Date the promotion ends. (If null, has the same value as start_date.)
    • file string: File associated to the promotion.
    • id required integer: Unique ID of the promotion.
    • label required string: Label of the promotion.
    • start_date required string: Date the promotion begins.
    • supplier required object: Supplier of the promotion.
      • id required integer: Unique ID of the supplier.
      • label required string: Name of the supplier.
    • type required object: Type of the promotion.
      • family required object: Family the promotion type belongs to.
        • id required string: String identifying the promotion family.
        • label required string: Label of the promotion family. This value is translated according to the 'Accept-Language' header.
      • id required string: String identifying the promotion type.
      • label required string: Label of the promotion type. This value is translated according to the 'Accept-Language' header.

SeriesEntity

  • Series object
    • contract object: Contract of the series.
      • partner object: Contract partner.
        • id required integer: Unique ID identifying the contract partner.
        • label required string: Label of the contract partner.
      • type required object: Contract type.
        • id required string (values: PRO, COP, PLO, COR, CES): String identifying the contract type.
        • label required string: Label of the contract type. This value is translated according to the 'Accept-Language' header.
    • costing_capacity integer: Value of the costing capacity.
    • creation_timestamp required integer: Timestamp for when the series was created in the customer's database.
    • first_date required string: Date of the first event in the series.
    • id required integer: Unique ID of the series.
    • label required string: Label of the series.
    • last_date required string: Date of the last event in the series.
    • last_update_timestamp required integer: Timestamp for when the series was last updated in the customer's database.
    • type required object: Type of the series
      • id required string (values: TOU, LGS): String identifying the series type.
      • label required string: Label of the series type. This value is translated according to the 'Accept-Language' header.
    • venue VenuesEntity

TicketCountsDetailedEntity

  • Detailed ticket count object
    • approved required boolean: Defines whether this ticket count is approved or not.
    • comment required string: Comment for the ticket count.
    • date required string: Date of the ticket count.
    • event_channels array: Array of event channels where the sales were made.
      • items object
        • event_categories required array: Array of event categories which where sold.
          • items object
            • event_price_ranges required array: Array of event price ranges which where sold.
            • id required integer: ID of the event category.
        • id required integer: ID of the event channel.
    • final required boolean: Whether this ticket count is the last and final one of its event or not. If it is, it means that no further ticket counts will be added for the event it belongs to.
    • id required integer: Unique ID of the ticket count.

TicketCountsEntity

  • Ticket count object
    • approved required boolean: Defines whether this ticket count is approved or not.
    • comment required string: Comment for the ticket count.
    • currency string: Currency of the gross (ISO 4212 alphabetic code).
    • date required string: Date of the ticket count.
    • final required boolean: Whether this ticket count is the last and final one of its event or not. If it is, it means that no further ticket counts will be added for the event it belongs to.
    • gross number: Gross (= income for the sold tickets, including VAT but excluding all commissions).
    • id required integer: Unique ID of the ticket count.
    • reservations integer: Ticket reservations (= number of reserved tickets). This field may be omitted according to the customer configuration.
    • sales required integer: Ticket sales (= number of sold tickets).

VenuesEntity

  • Venue object
    • alternative_labels array: Array of alternative/old names of the venue.
      • items string
    • city required string: City in which the venue is.
    • country_code required string: Country in which the venue is (ISO 3166-1 alpha-3 code).
    • creation_timestamp required integer: Timestamp for when the venue was created in the customer's database.
    • first_address required string: First address field of the venue.
    • id required integer: Unique ID of the venue.
    • label required string: Name of the venue.
    • last_update_timestamp required integer: Timestamp for when the venue was last updated in the customer's database.
    • major_city required string: Major city or metropolitan area the venue belongs to.
    • second_address required string: Second address field of the venue.
    • type required object
      • id required string (values: SAL, FES): String identifying the venue type.
      • label required string: Label of the venue type. This value is translated according to the 'Accept-Language' header.
    • zip_code required string: ZIP code of the venue.