Activities catalog
The first step will be to get the complete catalog of providers, categories (productBases) and products for its internal processing.
The information in the catalog includes unique identifiers for Provider, Product and Ticket, which will subsequently be used to create a sale.
It will also include other data such as product price, depending on the dates, or the product’s commercial terms.
Misuse of the API
A misuse of this call could be to perform a query with each sale, the correct use must be to store and process locally and consult periodically the date of the last modification of the catalog. Only in the event that this date of modification is later than the one obtained in the catalog must we obtain the catalog again.
Access method
POST /activity/catalog
Request structure
We can filter the catalog result using different filters in the request's body.
Each filter will be considered an AND. For example, several ProductIds from different providers may be filtered, but it would not make sense to filter by a ProviderId and a ProductId not belonging to this ProviderId.
ProviderIds: (list)Optional. Provider identifier list.(string):Optional. Provider identifier.
ProductBaseIds: (list)Optional. Category identifier list.(string):Optional. ProductBase identifier.
ProductIds: (list)Optional. Product identifier list.(string):Optional. Product identifier.
FromDate: (date)Optional. Start date. Does not allow values less than the current day. ISO 8601 format (yyyy-MM-dd).ToDate: (date)Optional. Ending date. By default, its value is that of the date corresponding to a year from now. ISO 8601 format (yyyy-MM-dd).ReferenceDate: (date)Optional. Requires that the day that is taken as a reference for the calculation of prices and availability is not today, but the indicated one. For example it will be used if the prices change depending on the days left until the date of entry. ISO 8601 format (yyyy-MM-dd)LanguageCode: (string)Optional. Sets the language in which the catalog texts will be displayed (name, description, provider conditions, product, etc.). By default, the language configured for the partner will be returned. ISO 639-1 format.ShowProductsOutOfActiveDateRange: (boolean)Optional. When it istrue, the response will return products where today (or the day indicated inReferenceDate) is outside of their sale date range. For example, if it is December and there are products that can be sold from January, setting this value to true will allow us to discover that those products exist.
Request examples
{
"ProviderIds":
[
"dj48vjsyufvyu",
"ajr7v0alt62hl"
]
}
{
"ProductIds":
[
"dj48vjsyufvyu",
"ajr7v0alt62hl"
]
}
{
"FromDate": "2023-06-23",
"ToDate": "2023-08-29"
}
{
"ReferenceDate": "2023-10-05"
}
{
"ProviderIds":
[
"dj48vjsyufvyu",
"ajr7v0alt62hl"
],
"ProductBaseIds":
[
"duvjsigjscujc"
],
"ProductIds":
[
"fkijskfqnidfk"
],
"FromDate": "2023-06-23",
"ToDate": "2023-08-29"
}
Response structure
LastUpdatedDateTime: (dateTime). Last catalog modification date. ISO 8601 format (yyyy-MM-ddThh:mm:ss.fffffff).-
Providers: (list). Providers array.ProviderId: (string). Provider identifier. Alphanumeric of 13 characters.ProviderName: (string). Provider name.ProviderDescription: (string). Provider description.ProviderCommercialConditions: (string)Optional. Provider commercial terms. This field will not be displayed if it is not defined.ProviderAccessConditions: (string)Optional. Provider access conditions. This field will not be displayed if it is not defined.ExchangeVoucherPoint: (string)Optional. Place where the tickets can be used or exchanged.-
AdvancedDateSelectorMethodName: (string)Optional. Name of the method that determines if product tickets can have their own access date.Possible values
None
The tickets CANNOT have an access date that differs from that of the sale.
Therefore, and always in reference to the ticket, when we add the product to the cart, the
AccessDateTimefrom the ticket value will be ignored or it will be left null.DatePerTicketEnclosure
The tickets CAN have an access date that differs from that of the sale.
As we know, according to Products catalog, As we know, according to Products catalog, the tickets form part of an enclosure (
TicketEnclosureId). As such, for the DatePerTicketEnclosure each ticket enclosure can, optionally, have a different access date.For instance, imagine a product called “Adult Ticket Amusement Park+Aquatic”, made up of two tickets:
- Adult Amusement Park Ticket. Corresponding to the enclosure "Amusement Park".
- Adult Aquatic Ticket. Corresponding to the enclosure “Aquatic”.
In the case of DatePerTicketEnclosure we can have the "Adult Amusement Park Ticket” with the entry date of April 1, and the "Adult Aquatic Ticket" with the entry date of May 3.
Important limitation
All access dates, of all tickets which compose one sale, should belong to the same set of
PricesAndDates. In other words, we can pick a date with a price of €20, and another with a price of €25. -
CancellationPolicy: (object)Optional. Indicates the cancellation policies that apply when canceling a sale from this provider. If a specific product does not have cancellation policies, these will apply.IsRefundable: (boolean). Indicates if the customer can cancel for free at some point in time.Rules: (list). Rules that apply when making the cancellation.(object): cancellation ranges.HoursInAdvanceOfAccess: (decimal). Indicates the number of hours in advance regarding the access date from which the cancellation fee set inPercentagewill be applied.Percentage: (decimal). Penalty percentage on the ticket price.
DemandAccessDate: (boolean). Indicates whether the access date is needed. If it is not necessary, when adding the product to the cart, the date of purchase must be used.-
TaxType: (byte). Indicates the type of tax on the provider's products.Possible values
- 0: IVA
- 1: IGIC
-
Type: (byte). Indicates the type of provider. By default is 0.Possible values
- 0: Activity
- 1: Accommodation
- 2: Transport
-
DemandAccessDateOnOpenDate: (boolean). If the product is open dated, this parameter determines, with true or false, whether access dates must be requested. -
PurchaseFlowType: (byte). Indicates the provider's sale flow type. It is used to know whether the tickets and access codes will be available at the time of purchase or later.Possible values
- 1: Open sale.
- 2: Requires processing by the provider.
-
IsForGroups: (boolean). Indicates if the provider's products are intended for sale to groups. IsForSeasonTickets: (boolean). Indicates if the provider's products are season tickets.-
IsInsurable: (boolean)Optional. Indicates whether it is possible to add cancellation insurance for this product.Implications
If it is defined as
true, before starting any sale it will be necessary to make the call to check available policies. This function returns a list of available policies with their identifiers. If we want to add one of these policies to the sale, we will pass that policy identifier (Id) in theInsurancePolicyIdproperty in the reservation confirmation. -
LimitOfNumberOfPeopleToBeGroup: (int). Limits the number of people that make up a product from which the sale is considered for "groups". For example, if this limit is "19" and the provider is not for groups (IsForGroups == false), sales with 20 or more people will not be accepted. On the contrary, if the provider is for groups (IsForGroups == true), sales for 20 or more people will only be accepted. Logo: (string). URL to download the provider's logo.Tags: (list). Array of tag identifiers applied to the provider.(string): tag identifier.
Location: (object). Location information.CountryCode: (string). Country code (es, fr...).City: (string). City.Address: (string). Address.ZipCode: (string). Postal code.Lat: (double). Latitude.Lng: (double). Longitude.Region: (string). Region.
-
Ticket enclosures: (list). Provider enclosures information.TicketEnclosureId: (string). Enclosure identifier.TicketEnclosureName: (string). Enclosure name.TicketEnclosureConditions: (string)Optional. Enclosure conditions.-
TypeOfPersonDefinitionTypeChild: (byte)Optional. Indicates which attribute applies to the person to consider him a child.Possible values
- 1: Age
- 2: Height
Once the type is indicated by one of the above two options, the value is indicated by a decimal.
Example
To indicate that we consider a child to be a person under 120 centimeters tall and a senior to be over the age of 65 years old we have to indicate the following value:
- TypeOfPersonDefinitionTypeChild: 2
- TypeOfPersonDefinitionValueChild: 120
- TypeOfPersonDefinitionTypeSenior: 1
- TypeOfPersonDefinitionValueSenior: 65
-
TypeOfPersonDefinitionValueChild: (decimal)Optional. Indicates the value assigned to the type of person child. -
TypeOfPersonDefinitionTypeAdult: (byte)Optional. Indicates which attribute applies to the person to consider him an adult.Possible values
- 1: Age
- 2: Height
Once the type is indicated by one of the above two options, the value is indicated by a decimal.
Example
To indicate that we consider a child to be a person under 120 centimeters tall and a senior to be over the age of 65 years old we have to indicate the following value:
- TypeOfPersonDefinitionTypeChild: 2
- TypeOfPersonDefinitionValueChild: 120
- TypeOfPersonDefinitionTypeSenior: 1
- TypeOfPersonDefinitionValueSenior: 65
-
TypeOfPersonDefinitionValueAdult: (decimal)Optional. Indicates the value assigned to the type of person adult. -
TypeOfPersonDefinitionTypeSenior: (byte)Optional. Indicates which attribute applies to the person to consider him a senior.Possible values
- 1: Age
- 2: Height
Once the type is indicated by one of the above two options, the value is indicated by a decimal.
Example
To indicate that we consider a child to be a person under 120 centimeters tall and a senior to be over the age of 65 years old we have to indicate the following value:
- TypeOfPersonDefinitionTypeChild: 2
- TypeOfPersonDefinitionValueChild: 120
- TypeOfPersonDefinitionTypeSenior: 1
- TypeOfPersonDefinitionValueSenior: 65
-
TypeOfPersonDefinitionValueSenior: (decimal)Optional. Indicates the value assigned to the type of person senior. -
Sessions: (object)Optional. Defines the relationship between sessions and content. Before continuing, it is essential to study the sessions section.SessionContentProfileId: (string). For more information about this identifier, see the sessions page.SessionGroupProfileId: (string). For more information about this identifier, see the sessions page.HasSeating: (boolean). Indicates if the enclosure has seats, in which case it will be necessary to check the type of seat assignment at ticket level.SessionsGroupSessionContents: (object). Defines the relationship between session groups and session contents. That is, all sessions in the session group will have the session content assigned.SessionsGroupSessionContentsis exclusive with respect toSessionSessionContents.SessionsGroupId: (string). Session group identifier.SessionContentId: (string). Session content identifier.
SessionSessionContents: (list). Defines the relationship between sessions and session contents.SessionSessionContentsis exclusive with respect toSessionsGroupSessionContents.SessionId: (string). Session identifier.SessionContentId: (string). Session content identifier.SessionTime: (dateTime). Session date and time.HasLimitedCapacity: (boolean). Indicates if the session has limited capacity. If so, it will be essential to check the availability of the session before creating a sale. More information about it in obtaining available capacity.
-
TicketEnclosureAutoAssignSessionType: (byte). Indicates which attribute is applied when choosing sessions. They can be self-assigned sessions by the system, eligible, or a mixture of the two cases.In the case of self-assigned sessions, you can check which sessions are going to be assigned before adding the product to the cart using the method to check the auto-assigned session.Possible values
- 0: No. Sessions will not be auto-assigned. Must be defined during the sales flow.
- 1: IfNotSet. Sessions will be auto-assigned if they have not been defined during the sales flow.
- 2: ForceSet. Sessions will always be forcibly assigned, ignoring if they were defined during the sales flow.
-
ProductBases: (list). Categories array.ProductBaseId: (string). Category identifier. 13 character alphanumeric.ProductBaseName: (string). Category name.ProductBaseDescription: (string). Category description. It usually contains the conditions common to all its products.LimitOfNumberOfPeopleToBeGroup: (int)Optional. Same meaning as theLimitOfNumberOfPeopleToBeGroupproperty in theProvidernode. If specified, the most restrictive between this value and that of the provider will be used.-
IsInsurable: (boolean)Optional. Indicates whether it is possible to add cancellation insurance for this product.Implications
If it is defined as
true, before starting any sale it will be necessary to make the call to check available policies. This function returns a list of available policies with their identifiers. If we want to add one of these policies to the sale, we will pass that policy identifier (Id) in theInsurancePolicyIdproperty in the reservation confirmation. -
Tags: (list). Array of tag identifiers applied to the category.(string): tag identifier.
-
Products: (list). Product array.ProductId: (string). Product identifier. 13 character alphanumeric.ProductName: (string). Product name.SuggestedSalesProductName: (string). Suggested product name for sale.ProductDescription: (string). Product description. It usually contains the conditions of the product.Tags: (list). Array of tag identifiers applied to the product.(string): Tag identifier.
-
ProductInternalConsiderations: (string). Internal considerations of the product that only the collaborator should know.Important
NEVER show to end customer.
-
ProductCancellationConditions: (string). Cancellation conditions for the product. CancellationPolicy: (object). Indicates the cancellation policies that apply when canceling a sale of this product. If this node is present, it takes precedence over the provider'sCancellationPolicynode.IsRefundable: (boolean). Indicates if the customer can cancel for free at any time.Rules: (list). Rules that apply when making the cancellation.(object): cancellation ranges.HoursInAdvanceOfAccess: (decimal). Indicates the number of hours in advance with respect to the access date from which the price penalty indicated inPercentagewill be applied.Percentage: (decimal). Percentage of penalty on the ticket price.
StartIsActiveDate: (dateTime)Optional. If it exists, it defines the date from which it is possible to sell the product.EndIsActiveDate: (dateTime)Optional. If it exists, it defines the date until which it is possible to sell the product.DaysWithLimitedCapacity: (string). Dates in which the product has a limited capacity. Therefore, it will be essential to check the availability of the product before creating a sale. Dates will be in ISO 8601 format (yyyy-MM-dd), and will be separated from each other by a comma. More information about it in the section on obtaining available capacity.HoursInAdvanceOfPurchase: (short). Hours in advance of the purchase compared to 00:00 a.m. the day after the visit. For example, if a product hasHoursInAdvanceOfPurchase = 4, and a customer makes a purchase for August 15, the time limit that the product has to be sold is 8:00 p.m. on August 15 itself (that is, 4 hours before 00:00 a.m. on August 16). This is important, for example, so that a customer does not buy the products for a day when the venue is already closed.MaxHoursInAdvanceOfPurchase: (dateTime)Optional. Maximum hours in advance of the purchase compared to 00:00 a.m. the day after the visit. For example, if a product hasMaxHoursInAdvanceOfPurchase = 240, and a customer makes a purchase for August 15, the product cannot be sold before August 6 (that is, 240 hours = 10 days before 00:00 a.m. on August 16). This is useful, for example, to limit the period of sale of a product to a period of days before.MinimumNumberByTransaction: (int). Minimum number of products for each sale. Default is 1. For example, a product of the type "Entry ticket with discount starting from 3 products". In that case, MinimumNumberByTransaction would be 3.NumberOfPeople: (int). Number of people who compute to consider a sale as a "group". That is, it computes for the limitLimitOfNumberOfPeopleToBeGroup.NumberOfAdults: (byte). Number of adults, included in theNumberOfPeoplefield.NumberOfBabies: (byte). Number of babies, included in theNumberOfPeoplefield.NumberOfChildren: (byte). Number of children, included in theNumberOfPeoplefield.NumberOfSenior: (byte). Number of seniors, included in theNumberOfPeoplefield.NumberOfGeneric: (byte). Number of generics, included in theNumberOfPeoplefield. It is a very useful field, for example, if a product is valid for both adults and children as well as for seniors.-
RequiresRealTimePrice: (boolean). Indicates if the product requires real-time pricing.Implications
In case it is defined as
trueit will be necessary before starting any sale to make the call to check the price in real time. Since the product price may be different depending on some criteria. -
CanOnlyBeSoldAsPartOfCombinedProduct: (boolean)Optional. Iftrue, the product cannot be sold on its own, but it can be sold as part of at least oneCombinedProductavailable in the current query. -
IsInsurable: (boolean)Optional. Indicates whether it is possible to add cancellation insurance for this product.Implications
If it is defined as
true, before starting any sale it will be necessary to make the call to check available policies. This function returns a list of available policies with their identifiers. If we want to add one of these policies to the sale, we will pass that policy identifier (Id) in theInsurancePolicyIdproperty in the reservation confirmation. -
IsForPackaging: (boolean). Indicates if the product has to be packaged, e.g. with an accommodation. ValidDays: (int). Days of validity.-
ValidDaysType: (byte). Type of valid days.Possible values
- 0: consecutive.
- 1: not consecutive.
-
PriceMode: (byte). Indicate the type of price.Possible values
- 1: Retail price.
- 2: net price.
-
Commission: (list). In casePriceMode = Retail price, this indicates the commission.-
Type: (int). Indicates the type of commission applied.Possible values
- 1: percentage.
- 2: absolute value.
-
Value: (decimal). Value of that commission.Example
- if
Type = 1yValue = 10, indicates that the commission is 10% with respect to thePriceof the product. That is, if thePriceis equal to €100, the calculated commission would be €10. - if
Type = 2yValue = 3, indicates that the commission per product is €3.
- if
-
-
AccessDateCriteria: (byte). Indicates the criteria for the access date.Possible values
- 0: Closed date. The ticket will be only valid the on specified date.
- 1: Open date. The ticket will be valid any day of the season. Only in this case we'll take care of
AccessDateCriteriaOpenDateSalesDocument:- 1: Hide access date.
- 2: Valid on season.
- 3: View conditions.
- 4: Access dates range.
- 3: Valid during the stay in the selected accomodation.
-
BarcodeAssignment: (byte)Optional. Indicates what the barcode is to be assigned to.Possible values
- 1: Ticket (default value if
BarcodeAssignmentis not defined). - 2: Person.
Example
The "Two day ticket" product consisting of one adult and 2 tickets (day 1 ticket, day 2 ticket):
BarcodeAssignment = Ticket: each of the tickets will have its own barcode.BarcodeAssignment = Person: there will only be one barcode (shared by both tickets). A direct consequence of this case would be when printing a PDF with the tickets, since we would only have to print a PDF of the product, given that despite having two tickets there is only one barcode.
- 1: Ticket (default value if
-
PricesAndDates: (list). Array of "price and dates". It has a double functionality. On the one hand, it defines what access dates the product is available for, and on the other hand, it defines what price applies to what dates.Price: (decimal). Price.Currency: (string). Currency.CurrencyName: (string). Name of currency.Dates: (string). Dates will be in ISO 8601 format (yyyy-MM-dd) and will be separated from each other by a comma.OriginalPrice: (decimal)Optional. Price of the product before applying discounts if any.TaxBreakdown: (list). Array with the tax breakdown.TaxPercentage: (decimal). Tax percentage (out of 100).PriceWithoutTaxes: (decimal). Price without tax.PriceWithTaxes: (decimal) price with taxes.
-
Release: (short)Optional. Number of days in advance required for the customer to cancel the product at no cost.Example
- 0: The client can cancel the day of entry to the park at no cost.
- 1: The client can cancel one day before the entrance to the park without cost.
-
SalesDocumentSettings: (object). Settings regarding the access document (PDF, passbook). This information will also come as a result when confirming a sale.Advice
If the documents generated by us are used, it will not be necessary to take these settings into account. Otherwise, you should take them into consideration.
Disable: (boolean). Indicates if no access document will be generated for this product.ShowPrice: (boolean). Indicates if the price should be displayed in the access document.-
AccessDateCriteriaOpenDateSalesDocument: (int)Optional. Only in caseAccessDateCriteria == 1(open date). Indicates what we must inform the client regarding the date of access.Possible values of AccessDateCriteria and AccessDateCriteriaOpenDateSalesDocument
- 0: Closed date. The ticket will be only valid the on specified date.
- 1: Open date. The ticket will be valid any day of the season. Only in this case we'll take care of
AccessDateCriteriaOpenDateSalesDocument:- 1: Hide access date.
- 2: Valid on season.
- 3: View conditions.
- 4: Access dates range.
- 3: Valid during the stay in the selected accomodation.
-
HasSaleFlowRules: (boolean). Indicates if the product has any associated sales flow rule. In the case of beingtrue, it is recommended to consult the method Check sale flow rules to check what changes the inclusion of this product will produce when adding it to the cart. -
Tickets: (list)Optional. Ticket array. In case the product does not work with tickets, this field will not exist.TicketId: (string). Ticket identifier. 13 character alphanumeric.IsQuotaTicket: (boolean). Boolean indicating whether or not the ticket is capacity type, which means that iftruethe ticket will compute for the total capacity necessary to reserve the product. For example, if we have a product where it has 3 defined tickets but only 2 of them are capacity type, then when checking the availability for this product we must take into account that at the capacity level it needs 2 availability. In other words, if the available capacity was 1, we could not reserve this product. More information about it in the section on obtaining available capacity.TicketName: (string). Ticket name.TicketConditions: (string)Optional. Ticket conditions.TicketEnclosureId: (string). Identifier of the enclosure to which the ticket belongs. Several tickets can belong to the same enclosure.-
SeatingAssignType: (byte). Indicates the type of seat assignment that applies.Possible values
- 1: Auto assigned, seats will be automatically assigned by the system.
- 3: Processing required, the seats will be assigned later by the provider.
-
TicketsQuestionsProfileId: (string) question profile identifier. -
FromAccessDayandToAccessDay: if they are defined, they indicate for which days with respect to the first date of access the ticket is valid.Advice
The result of the call to confirm a sale already gives us the range of access dates for each ticket. So it's entirely feasible not to handle
FromAccessDayandToAccessDayand rely on what that call returns.Example
- If the ticket defines FromAccessDay = 1 and ToAccessDate = 1, the client must use it on the first day of access.
- If the ticket defines FromAccessDay = 2 and ToAccessDate = 2, the client must use it on the second day of access.
- If the ticket defines FromAccessDay = 1 and ToAccessDate = 2, the customer will be able to enter on either the first or second day.
- If the ticket defines FromAccessDay = 2 and ToAccessDate is not defined, the client will be able to enter from the second day to an indefinite day, for example until the end of the season, unless the product conditions indicate otherwise.
- If the ticket does not define either FromAccessDay or ToAccessDate, the customer will only be able to enter on the first day, unless the product conditions indicate otherwise.
-
TypeOfPerson: (list)Optional. Defines the type of person and their numbering.-
Type: (byte). Indicates the type of person.Possible values
- 1: Baby
- 2: Child
- 3: Adult
- 4: Senior
- 5: Generic
-
PersonNumber: (byte). Identifier of the person number by type.
Example
- "3x2 Ticket" product made up of two adults and one child and defined by three tickets:
- Adult Ticket: adult 1 (Type = 3, PersonNumber = 1)
- Adult Ticket: adult 2 (Type = 3, PersonNumber = 2)
- Child Ticket: child 1 (Type = 2, PersonNumber = 1)
- Product "2x1 ticket plus second consecutive day" consisting of two adults and 4 tickets:
- Adult First Day Ticket: adult 1 (Type = 3, PersonNumber = 1)
- Adult First Day Ticket: adult 2 (Type = 3, PersonNumber = 2)
- Second Day Adult Ticket: adult 1 (Type = 3, PersonNumber = 1)
- Second Day Adult Ticket: adult 2 (Type = 3, PersonNumber = 2)
-
-
RequiresDeliveryManagement: (boolean). Indicates if it is a ticket that requires physical delivery. If so, you will have to choose the delivery method when adding the product to the cart. You can check the available delivery methods in the section Get Delivery Methods.
-
ProductPaxGroupingId: (string)Optional. Identifier of the product group to which the product belongs.
-
ProductPaxGroupings: (list). Groupings of products whose main difference is the people who compose it.ProductPaxGroupingId: (string). Grouping identifier. 13 character alphanumeric.ProductPaxGroupingName: (string). Name of the grouping.
-
Urls: (list)Optional. Array of URLs to access the provider's ticket office page. Only when using custom DNS.LanguageCode: (string). Code of the language with which it is going to be accessed. Represented by the ISO format 639-1.Url: (string). Access URL.
-
CombinedProducts: (list). Array of combined products.CombinedProductId: (string). Combined product identifier.Name: (string). Combined product name.PriceFrom: (decimal). Price "from" for the combined product.PriceTo: (decimal). Price "to" for combined product.Products: (list). Array of products that are part of the combined product.ProductId: (string). Product identifier.
RequiresRealTimePrice: (boolean). Indicates if you need to consult the price in real time for the combined product. See obtaining the price in real time
SaleFlowRules: (object).HasSaleFlowRules: (boolean). Indicates whether there are products with any associated sale flow rule. If it istrue, it is recommended to consult the Check sale flow rules method to check what changes adding this product to the cart will produce.ProductIdsWithSaleFlowRules: (list). Array of product identifiers. Indicates which catalog products have any associated sale flow rule.DynamicProviderIdsWithSaleFlowRules: (list). Array of dynamic provider identifiers. Indicates which dynamic catalog providers have any associated sale flow rule.
-
PartnerSettings: (object). Shows the partner settings.DemandClientData: (boolean). Booleantrue/falsethat indicates if is mandatory to tell the client information when sale confirmation is done.DemandClientTaxData: (boolean). Booleantrue/falsethat indicates if is mandatory to tell the client tax information when sale confirmation is done.EnableCancellationRequest: (boolean). Booleantrue/falsethat indicates whether the partner is allowed to request cancellations via API.IsInsurancePolicyEnabled: (boolean). Booleantrue/falsevalue that indicates whether the partner has insurance policies available.-
PaymentType: (byte). Indicates the payment type for the partner.Possible values
- 1: Debit
- 2: Credit
- 3: Credit, except for groups
- 4: Prepaid
-
Success(boolean): value that indicates whether the call was processed correctly or not. Timestamp(dateTime): time at which the request was processed. ISO 8601 format (yyyy-MM-ddThh:mm:ss.fffffff).ErrorMessage(string): error message explaining why the request was not successful. If it was correct, it will returnnull.ErrorCodes(string[]): list of codes that identify the errors that occurred in the call.ErrorEntityBreakDown(list): list that contains objects with the name and ID in case of error.Id(string): identifierName(string): related name of the identifier.
Response example
{
"Success": true,
"Timestamp": "2022-01-01T17:02:27.8165916",
"ErrorMessage": null,
"Providers":
[
{
"ProviderId": "by81fymhsmjgw",
"ProviderName": "PTM",
"ProviderDescription": "Provider Description",
"ProviderAccessConditions": "Provider access conditions",
"ExchangeVoucherPoint": "Access point",
"AccessCodeMethodName": "TicketWaitForIt",
"AdvancedDateSelectorMethodName": "None",
"CancellationPolicy":
{
"IsRefundable": true,
"Rules":
[
{
"HoursInAdvanceOfAccess": 6,
"Percentage": 80
},
{
"HoursInAdvanceOfAccess": 120,
"Percentage": 75
}
]
},
"IsForGroups": false,
"LimitOfNumberOfPeopleToBeGroup": 19,
"Logo": "https://url.ofthelogo.com",
"Location":
{
"CountryCode": "es",
"City": "Torrevieja",
"Address": "Avda. Delfina Viudes, 99",
"ZipCode": "03183",
"Lat": 37.99,
"Lng": -0.68,
"Region": "Alicante"
},
"Urls":
[
{
"LanguageCode": "es",
"Url": "https://url.com/park1"
},
{
"LanguageCode": "en",
"Url": "https://en-url.com/park1"
}
],
"TicketEnclosures":
[
{
"TicketEnclosureId": "g5u6m3xew6hxy",
"TicketEnclosureName": "Sala 1",
"TicketEnclosureConditions": "Enclosure conditions",
"TypeOfPersonDefinitionTypeChild": 2,
"TypeOfPersonDefinitionValueChild": 120,
"TypeOfPersonDefinitionTypeSenior": 1,
"TypeOfPersonDefinitionValueSenior": 65,
"Sessions":
{
"SessionsGroupSessionContents":
[
{
"SessionsGroupId": "7q59grjg1tuxw",
"SessionContentId": "fiajih99h79ak"
},
{
"SessionsGroupId": "8o9tskd4szqgs",
"SessionContentId": "m6noaxhzr33an"
},
{
"SessionsGroupId": "i73hiypge5576",
"SessionContentId": "suefs1zzn5ser"
}
],
"SessionSessionContents": []
}
},
{
"TicketEnclosureId": "geu773xaqzh18",
"TicketEnclosureName": "Enclosure 2",
"TicketEnclosureConditions": "Enclosure 2 conditions",
"TypeOfPersonDefinitionTypeChild": 2,
"TypeOfPersonDefinitionValueChild": 120,
"TypeOfPersonDefinitionTypeSenior": 1,
"TypeOfPersonDefinitionValueSenior": 65
}
],
"ProductBases":
[
{
"ProductBaseId": "gfo753rgjfbw6",
"ProductBaseName": "Entradas",
"ProductBaseDescription": "No se permiten cambios ni devoluciones.",
"DaysWithLimitedCapacity": "2022-11-01",
"Products":
[
{
"ProductId": "ctgyir9m9q4bo",
"ProductName": "Entrada Adulto",
"ProductDescription": "Entrada para mayores de 12 años.",
"ProductInternalConsiderations": "Consideraciones internas",
"ProductCancellationConditions": "Condiciones de cancelación",
"CancellationPolicy":
{
"IsRefundable": true,
"Rules":
[
{
"HoursInAdvanceOfAccess": 6,
"Percentage": 80
}
]
},
"DaysWithLimitedCapacity": "",
"HoursInAdvanceOfPurchase": 4,
"MinimumNumberByTransaction": 1,
"NumberOfPeople": 1,
"NumberOfAdults": 1,
"NumberOfBabies": 1,
"NumberOfChildren": 0,
"NumberOfSenior": 0,
"NumberOfGeneric": 0,
"ValidDates": 1,
"ValidDatesType": 0,
"AccessDateCriteria": 0,
"PricesAndDates":
[
{
"Price": "20",
"Currency": "€",
"CurrencyName": "Euro",
"Dates": "2022-01-01,2022-01-02,2022-01-03,2022-07-31"
},
{
"Price": "30",
"Currency": "€",
"CurrencyName": "Euro",
"Dates": "2022-08-01,2022-08-02,2022-08-31"
},
{
"Price": "15",
"Currency": "€",
"CurrencyName": "Euro",
"Dates": "2022-09-01,2022-09-02,2022-12-31"
}
],
"SalesDocumentSettingsViewModel":
{
"ShowPrice": true
},
"Tickets":
[
{
"TicketId": "1tqgtrf7ctefc",
"IsQuotaTicket": true,
"TicketName": "Ticket Adulto",
"TicketEnclosureId": "geu773xaqzh18"
}
]
},
{
"ProductId": "htgy4tgm9q21n",
"ProductName": "Entrada 3x2",
"ProductDescription": "Por cada dos adultos, entra un niño gratis.",
"DaysWithLimitedCapacity": "2022-04-17,2022-08-15",
"HoursInAdvanceOfPurchase": 4,
"MinimumNumberByTransaction": 1,
"NumberOfPeople": 3,
"NumberOfAdults": 2,
"NumberOfChildren": 1,
"NumberOfSenior": 0,
"NumberOfGeneric": 0,
"ValidDates": 1,
"ValidDatesType": 0,
"AccessDateCriteria": 1,
"PricesAndDates":
[
{
"Price": "35",
"Currency": "€",
"CurrencyName": "Euro",
"Dates": "2022-01-01,2022-01-02,2022-01-03,2022-07-31"
},
{
"Price": "50",
"Currency": "€",
"CurrencyName": "Euro",
"Dates": "2022-08-01,2022-08-02,2022-08-31"
},
{
"Price": "25",
"Currency": "€",
"CurrencyName": "Euro",
"Dates": "2022-09-01,2022-09-02,2022-12-31"
}
],
"SalesDocumentSettingsViewModel":
{
"ShowPrice": true
},
"Tickets":
[
{
"TicketId": "1tqgtrf7ctefc",
"IsQuotaTicket": true,
"TicketName": "Ticket Adulto",
"TicketConditions": "Ticket conditions",
"TicketEnclosureId": "geu773xaqzh18",
"FromAccessDay": 1,
"ToAccessDay": 1,
"TicketsQuestionsProfileId": "MyProfilesQuestions"
},
{
"TicketId": "2lob55g8w3fff",
"IsQuotaTicket": true,
"TicketName": "Ticket Adulto segundo día",
"TicketConditions": "Ticket conditions",
"TicketEnclosureId": "geu773xaqzh18",
"FromAccessDay": 2,
"ToAccessDay": 2
},
{
"TicketId": "jkp78j40cnfh3",
"IsQuotaTicket": true,
"TicketName": "Ticket Niño",
"TicketEnclosureId": "geu773xaqzh18",
"FromAccessDay": 1,
"ToAccessDay": 1
},
{
"TicketId": "gggsijt911am4",
"IsQuotaTicket": true,
"TicketName": "Ticket Niño segundo día",
"TicketEnclosureId": "geu773xaqzh18",
"FromAccessDay": 2,
"ToAccessDay": 2
}
]
},
{
"ProductId": "q2oghu9mye7h2",
"ProductName": "Película de animación 3D",
"ProductDescription": "Película de animación para descansar de atracciones",
"DaysWithLimitedCapacity": "",
"HoursInAdvanceOfPurchase": 4,
"MinimumNumberByTransaction": 1,
"NumberOfPeople": 1,
"NumberOfAdults": 0,
"NumberOfChildren": 0,
"NumberOfSenior": 0,
"NumberOfGeneric": 1,
"ValidDates": 1,
"ValidDatesType": 0,
"AccessDateCriteria": 0,
"PricesAndDates":
[
{
"Price": "5",
"Currency": "€",
"CurrencyName": "Euro",
"Dates": "2022-01-01,2022-01-02,2022-01-03,2022-12-31"
}
],
"SalesDocumentSettingsViewModel":
{
"ShowPrice": false
},
"Tickets":
[
{
"TicketId": "fb8mcqxyo22rg",
"IsQuotaTicket": true,
"TicketName": "Entrada 3D",
"TicketEnclosureId": "g5u6m3xew6hxy"
}
]
}
]
}
]
}
]
}