|
Get Web/Cart/{sessionKey}?messageTypes={messageTypes}&savedCart={savedCart} Gets the cart details
|
|
GET
|
Method: Get, URL: Web/Cart/{sessionKey}?messageTypes={messageTypes}&savedCart={savedCart}
|
Test
|
|
Gets the cart details
|
|
GetCartProperties Web/Cart/{sessionKey}/Properties Returns cart properties
|
|
GET
|
Method: GetCartProperties, URL: Web/Cart/{sessionKey}/Properties
|
Test
|
|
Returns cart properties
|
|
GetMessages Web/Cart/{sessionKey}/Messages?messageTypes={messageTypes}&savedCart={savedCart} Gets the pricing rule messages for the current cart.
Both Message Only and Rule messages are returned.
|
|
GET
|
Method: GetMessages, URL: Web/Cart/{sessionKey}/Messages?messageTypes={messageTypes}&savedCart={savedCart}
|
Test
|
|
Gets the pricing rule messages for the current cart.
|
|
GetReceiptString Web/Cart/{sessionKey}/ReceiptString?receiptSettingsId={receiptSettingsId}&targetFormat={targetFormat} Returns a formatted receipt for a cart
|
|
GET
|
Method: GetReceiptString, URL: Web/Cart/{sessionKey}/ReceiptString?receiptSettingsId={receiptSettingsId}&targetFormat={targetFormat}
|
Test
|
|
Returns a formatted receipt for a cart
|
|
GetSummary Web/Cart/{sessionKey}/Summary?messageTypes={messageTypes}&savedCart={savedCart} Gets the cart summary
Used by TRBO. Returns the cart with product lines summarized by price type, zone and price.
|
|
GET
|
Method: GetSummary, URL: Web/Cart/{sessionKey}/Summary?messageTypes={messageTypes}&savedCart={savedCart}
|
Test
|
|
Gets the cart summary
|
|
AddBooking Web/Cart/{sessionKey}/Bookings Attach an existing booking to the cart.
|
|
POST
|
Method: AddBooking, URL: Web/Cart/{sessionKey}/Bookings
|
Test
|
|
Attach an existing booking to the cart.
|
|
AddContribution Web/Cart/{sessionKey}/Contributions Adds a contribution to the cart
The donation must be applied directly to a fund. This method also allows a specific membership level ID to be specified.
|
|
POST
|
Method: AddContribution, URL: Web/Cart/{sessionKey}/Contributions
|
Test
|
|
Adds a contribution to the cart
|
|
AddGiftCertificate Web/Cart/{sessionKey}/GiftCertificates Adds a gift certificate for the specified amount to the cart
The resulting gift certificate number can be found with /Web/Cart (GET).
|
|
POST
|
Method: AddGiftCertificate, URL: Web/Cart/{sessionKey}/GiftCertificates
|
Test
|
|
Adds a gift certificate for the specified amount to the cart
|
|
AddNFSPackagePerformanceItem Web/Cart/{sessionKey}/Packages/Nfs Adds a new nfs package item to the cart
This method adds a seated or unseated non fixed seat (NFS) or flex package to the cart by adding the component performances. When the package is seated, the best seating function can be used or specific seat numbers can be passed for use with SYOS functionality.
A NFS or flex package line item is created when the first component performance is added to the cart.The ID number from the package line item is required when the remaining component performances are added. It is returned as NFSPackageLineItemId in the method's response.
/Web/Cart/Validation can be called at any time, setting the ValidateNFSPackages boolean to true, to determine whether all of the rules for the package have been met with items in the shopping cart.
This method will allow the reservation of held seats. To enable this functionality, add the key ''Reserve Held Seats' to T_DEFAULTS with a value of 'Yes' under the "Tessitura Web" parent table (or organization name if operating in a consortium environment).
|
|
POST
|
Method: AddNFSPackagePerformanceItem, URL: Web/Cart/{sessionKey}/Packages/Nfs
|
Test
|
|
Adds a new nfs package item to the cart
|
|
AddOnAccount Web/Cart/{sessionKey}/OnAccount Adds an On Account balance to the cart
Checkout will not be allowed for a general public order if On Account balance is added.
|
|
POST
|
Method: AddOnAccount, URL: Web/Cart/{sessionKey}/OnAccount
|
Test
|
|
Adds an On Account balance to the cart
|
|
AddPackageItem Web/Cart/{sessionKey}/Packages/Fixed Adds a new fixed seat package item to the cart
Adds a seated or unseated fixed seat package line item to the cart and reserves seats using either the best seat function or reserves specific seats.
PackageId line items can be added as alternate/upgrade line items to another line item in the cart. To add an alternate/upgrade line item, the parent line item ID must be retrieved using /Web/Cart (GET) and then passed as the ParentPackageLineItemId parameter value for this method.
This method will allow the reservation of held seats.To enable this functionality, add the key ''Reserve Held Seats' to T_DEFAULTS with a value of 'Yes' under the "Tessitura Web" parent table (or organization name if operating in a consortium environment).
|
|
POST
|
Method: AddPackageItem, URL: Web/Cart/{sessionKey}/Packages/Fixed
|
Test
|
|
Adds a new fixed seat package item to the cart
|
|
AddPaymentPlan Web/Cart/{sessionKey}/Payments/Plan/NumberOfPayments Sets a payment plan on the cart using a start date, end date and a specific number of payments to be spread across the date range.
The due date for the first payment is set to the entered beginning date, and the due date for subsequent payments is calculated by adding an equal number of days to each previous payment, based on the amount of time between the beginning and ending dates.
|
|
POST
|
Method: AddPaymentPlan, URL: Web/Cart/{sessionKey}/Payments/Plan/NumberOfPayments
|
Test
|
|
Sets a payment plan on the cart using a start date, end date and a specific number of payments to be spread across the date range.
|
|
AddPaymentPlanBasedOnBillingSchedule Web/Cart/{sessionKey}/Payments/Plan/Schedule Sets a payment plan on the cart using a start date, end date and a pre-defined billing schedule.
The number of payments, payment amounts, and payment due dates are calculated based on the selected billing schedule. For details on setting up billing schedules see the TR_BILLING_SCHEDULE section of the System Tables document.
|
|
POST
|
Method: AddPaymentPlanBasedOnBillingSchedule, URL: Web/Cart/{sessionKey}/Payments/Plan/Schedule
|
Test
|
|
Sets a payment plan on the cart using a start date, end date and a pre-defined billing schedule.
|
|
AddPaymentPlanInstallments Web/Cart/{sessionKey}/Payments/Plan/Installments Sets a payment plan on the cart using a start date, end date and a list of installments with amount and due date.
The total of the installment amounts must add up to the cart total. /Web/Cart/Validation can be used to validate that the payment plan is correct by passing True for ValidatePaymentPlan in that method.
|
|
POST
|
Method: AddPaymentPlanInstallments, URL: Web/Cart/{sessionKey}/Payments/Plan/Installments
|
Test
|
|
Sets a payment plan on the cart using a start date, end date and a list of installments with amount and due date.
|
|
AddSubPackageItem Web/Cart/{sessionKey}/Packages/Super Adds a new sub package item to the cart
This method is used to add a seated or unseated super package line item to the cart for the specified session by adding the component sub packages. When the package is seated, the best seating function can be used or specific seat numbers can be passed for use with SYOS functionality. The method must be called once for each sub package.
A super package line item is created when the first sub package is added to the cart.The ID number from the super package line item is required when the remaining component sub packages are added.It is returned as SuperPackageLineItemId in the response.
Super package line items can be added as alternate/upgrade line items to another super package line item in the cart. To add an alternate/upgrade line item, the parent line item ID must be passed as the ParentSuperPackageLineItemId parameter value for this method.The parent line item ID can be retrieved using the /Web/Cart (GET) method.
|
|
POST
|
Method: AddSubPackageItem, URL: Web/Cart/{sessionKey}/Packages/Super
|
Test
|
|
Adds a new sub package item to the cart
|
|
AddUpdateFee Web/Cart/{sessionKey}/Fees Adds or Updates a fee
Only user-defined fees can be added. Seat-based fees can be overridden to zero only, while order-based or user-defined fees can be overridden to any amount, as allowed by the rules in fee setup. To add and edit a user-defined fee call this method twice, once to add the fee, and once to override the amount.
|
|
POST
|
Method: AddUpdateFee, URL: Web/Cart/{sessionKey}/Fees
|
Test
|
|
Adds or Updates a fee
|
|
ApplyCashPayment Web/Cart/{sessionKey}/Payments/Cash Applies a cash payment to the cart
|
|
POST
|
Method: ApplyCashPayment, URL: Web/Cart/{sessionKey}/Payments/Cash
|
Test
|
|
Applies a cash payment to the cart
|
|
ApplyCheckPayment Web/Cart/{sessionKey}/Payments/Check Applies a check payment to the cart
|
|
POST
|
Method: ApplyCheckPayment, URL: Web/Cart/{sessionKey}/Payments/Check
|
Test
|
|
Applies a check payment to the cart
|
|
ApplyGiftCertificate Web/Cart/{sessionKey}/Payments/GiftCertificate Applies a gift certificate as payment for a cart
|
|
POST
|
Method: ApplyGiftCertificate, URL: Web/Cart/{sessionKey}/Payments/GiftCertificate
|
Test
|
|
Applies a gift certificate as payment for a cart
|
|
ApplyInvoicePayment Web/Cart/{sessionKey}/Payments/Invoice Applies an invoice payment to the cart
Checkout will not be allowed for a general public order if an Invoice payment is applied
|
|
POST
|
Method: ApplyInvoicePayment, URL: Web/Cart/{sessionKey}/Payments/Invoice
|
Test
|
|
Applies an invoice payment to the cart
|
|
ApplyOnAccountPayment Web/Cart/{sessionKey}/Payments/OnAccount Applies an On Account payment to the cart.
Not valid for a general public cart.
|
|
POST
|
Method: ApplyOnAccountPayment, URL: Web/Cart/{sessionKey}/Payments/OnAccount
|
Test
|
|
Applies an On Account payment to the cart.
|
|
ApplyOtherPayment Web/Cart/{sessionKey}/Payments/Other Applies an other payment to the cart
|
|
POST
|
Method: ApplyOtherPayment, URL: Web/Cart/{sessionKey}/Payments/Other
|
Test
|
|
Applies an other payment to the cart
|
|
Authorize Web/Cart/{sessionKey}/Payments/EMV/Authorize Authorize payment using a card reader in a web based transaction.
|
|
POST
|
Method: Authorize, URL: Web/Cart/{sessionKey}/Payments/EMV/Authorize
|
Test
|
|
Authorize payment using a card reader in a web based transaction.
|
|
Checkout Web/Cart/{sessionKey}/Checkout Validates, processes payment for, and saves an order for a specified session.
Payment information can be provided as follows:
- The full card details can be provided in the request
- The request includes parameters for use with the 3D Secure protocol used by credit card verification services such as Verified by Visa and MasterCard SecureCode.
- The method also allows the credit card authorization process to be skipped, which allows the use of third party authorizations.
- The AccountID property in the request can be used in place of specifying credit card information. When a valid id value from CRM/Accounts is provided and the stored card data belongs to either the session owner or the session initiator, then that card data is passed through for authorization.If the account is invalid or does not belong to the session owner or initiator, then an error is returned.
- Additionally, this method has two additional Address Verification parameters, allowing a calling application to optionally specify the street address and zip code that represents the billing address for the credit card.
When the method is run the status of the order is checked to ensure checkout has not started. The procedure will set the status in T_WEB_CHECKOUT to one of the following values: (S)ave in progress, (C)ompleted save, (E)rror when saving.
The response includes a status and message details about the status.Possible status results are: SaveInProgress, SaveComplete, Error.
In order to facilitate the use of the interceptor capability, the checkout method now makes a POST call to Txn / Orders.By default this call does nothing unless a developer has added interceptor plug -in code to the exposure.
|
|
POST
|
Method: Checkout, URL: Web/Cart/{sessionKey}/Checkout
|
Test
|
|
Validates, processes payment for, and saves an order for a specified session.
|
|
CheckoutWithCard Web/Cart/{sessionKey}/CheckoutWithCard Processes checkout for the cart, using card swipe information for payment. Used by TRBO.
When the method is run the status of the order is checked to ensure checkout has not started. The procedure will set the status in T_WEB_CHECKOUT to one of the following values: (S)ave in progress, (C)ompleted save, (E)rror when saving.
The response includes a status and message details about the status.Possible status results are: SaveInProgress, SaveComplete, Error.
In order to facilitate the use of the interceptor capability, the checkout method now makes a POST call to Txn / Orders.By default this call does nothing unless a developer has added interceptor plug -in code to the exposure.
|
|
POST
|
Method: CheckoutWithCard, URL: Web/Cart/{sessionKey}/CheckoutWithCard
|
Test
|
|
Processes checkout for the cart, using card swipe information for payment. Used by TRBO.
|
|
PreviewPaymentPlanBasedOnBillingSchedule Web/Cart/{sessionKey}/Payments/Plan/Schedule/Preview Returns the payment schedule that would be applied to the current cart for the selected billing schedule without applying it to the cart.
The number of payments, payment amounts, and payment due dates are calculated based on the selected billing schedule. For details on setting up billing schedules see the TR_BILLING_SCHEDULE section of the System Tables document.
|
|
POST
|
Method: PreviewPaymentPlanBasedOnBillingSchedule, URL: Web/Cart/{sessionKey}/Payments/Plan/Schedule/Preview
|
Test
|
|
Returns the payment schedule that would be applied to the current cart for the selected billing schedule without applying it to the cart.
|
|
Price Web/Cart/{sessionKey}/Price Price the current web cart associated with the specified sessionKey.
|
|
POST
|
Method: Price, URL: Web/Cart/{sessionKey}/Price
|
Test
|
|
Price the current web cart associated with the specified sessionKey.
|
|
PrintEmail Web/Cart/{sessionKey}/Print/Email?receiptSettingsId={receiptSettingsId} Prints tickets for specified order, lineitems, or sublineitems and returns a formatted html body and attachments
The method returns tickets for unprinted fully-paid orders or reprints printed tickets specified via order number, one or more line item numbers, or one or more sub line item numbers. In the case of partially-paid orders, only line items or sub line items which have been fully-paid will be eligible for printing. Only tickets belonging to the customer associated via the current web session can be returned. Ticket information can be returned in the default design specified for the ticket price type, or you may specify a ticket design to utilize via the request parameters. After the tickets have been returned via the API, seats will be flagged as Ticketed in Tessitura.
When reprinting tickets, one of the request parameters provides you with the option to regenerate the ticket number or reuse the current ticket number.
If PrinterType = "B", ticket designs with images are not supported
|
|
POST
|
Method: PrintEmail, URL: Web/Cart/{sessionKey}/Print/Email?receiptSettingsId={receiptSettingsId}
|
Test
|
|
Prints tickets for specified order, lineitems, or sublineitems and returns a formatted html body and attachments
|
|
PrintPrintStrings Web/Cart/{sessionKey}/Print/PrintStrings Prints tickets for specified order, lineitems, or sublineitems and returns a collection of formatted strings based on printer type.
The returned strings can then be sent to the appropriate printer. NOTE: Currently only Zebra printer types are supported by this method. (PrinterType = "Z")
The method returns tickets for unprinted fully-paid orders or reprints printed tickets specified via order number, one or more line item numbers, or one or more sub line item numbers. In the case of partially-paid orders, only line items or sub line items which have been fully-paid will be eligible for printing. Only tickets belonging to the customer associated via the current web session can be returned. Ticket information can be returned in the default design specified for the ticket price type, or you may specify a ticket design to utilize via the request parameters. After the tickets have been returned via the API, seats will be flagged as Ticketed in Tessitura.
When reprinting tickets, one of the request parameters provides you with the option to regenerate the ticket number or reuse the current ticket number.
|
|
POST
|
Method: PrintPrintStrings, URL: Web/Cart/{sessionKey}/Print/PrintStrings
|
Test
|
|
Prints tickets for specified order, lineitems, or sublineitems and returns a collection of formatted strings based on printer type.
|
|
PrintTicketElements Web/Cart/{sessionKey}/Print/TicketElements Prints tickets for specified order, lineitems, or sublineitems and returns all ticket elements.
The method returns ticket data for unprinted fully-paid orders or reprints printed tickets specified via order number, one or more line item numbers, or one or more sub line item numbers. In the case of partially-paid orders, only line items or sub line items which have been fully-paid will be eligible for printing. Only tickets belonging to the customer associated via the current web session can be returned. Ticket information can be returned in the default design specified for the ticket price type, or you may specify a ticket design to utilize via the request parameters. After the ticket data has been returned via the API, seats will be flagged as Ticketed in Tessitura.
When reprinting tickets, one of the request parameters provides you with the option to regenerate the ticket number or reuse the current ticket number.
|
|
POST
|
Method: PrintTicketElements, URL: Web/Cart/{sessionKey}/Print/TicketElements
|
Test
|
|
Prints tickets for specified order, lineitems, or sublineitems and returns all ticket elements.
|
|
ReserveTickets Web/Cart/{sessionKey}/Tickets Reserves tickets in cart
Adds a seated or unseated performance line item to the cart and reserves seats using either the best seat function or reserves specific seats.
This method will allow the reservation of held seats.To enable this functionality, add the key ''Reserve Held Seats' to T_DEFAULTS with a value of 'Yes' under the "Tessitura Web" parent table (or organization name if operating in a consortium environment).
|
|
POST
|
Method: ReserveTickets, URL: Web/Cart/{sessionKey}/Tickets
|
Test
|
|
Reserves tickets in cart
|
|
ReserveTicketsForLineItem Web/Cart/{sessionKey}/LineItems/{lineItemId}/Tickets Reserves tickets in cart for an existing line item
PerformanceId specified must be valid for the line item
|
|
POST
|
Method: ReserveTicketsForLineItem, URL: Web/Cart/{sessionKey}/LineItems/{lineItemId}/Tickets
|
Test
|
|
Reserves tickets in cart for an existing line item
|
|
ReturnTicket Web/Cart/{sessionKey}/Tickets/Return Return a ticket by ticket number.
This method is used to return tickets (generally for exchanges). The method can also be used to donate a ticket for resale.
Returning a ticket will generate a credit on the ticket order.The credit must be applied to another line item(performance, package, etc.), fee, contribution, or on account payment method.
Donating a ticket uses the standard Tessitura Donate for Resale function, which releases the seat without generating a credit.
|
|
POST
|
Method: ReturnTicket, URL: Web/Cart/{sessionKey}/Tickets/Return
|
Test
|
|
Return a ticket by ticket number.
|
|
ReturnTicketWithSeat Web/Cart/{sessionKey}/Tickets/ReturnWithSeat Return a ticket by seat number.
This method is used to return tickets (generally for exchanges). The method can also be used to donate a ticket for resale.
Returning a ticket will generate a credit on the ticket order.The credit must be applied to another line item(performance, package, etc.), fee, contribution, or on account payment method.
Donating a ticket uses the standard Tessitura Donate for Resale function, which releases the seat without generating a credit.
|
|
POST
|
Method: ReturnTicketWithSeat, URL: Web/Cart/{sessionKey}/Tickets/ReturnWithSeat
|
Test
|
|
Return a ticket by seat number.
|
|
Validate Web/Cart/{sessionKey}/Validate Validates various aspects of the cart
Payment Plans, Fixed Seat Packages, Non-Fixed Seat (flex) packages and Super Packages can be validated by setting the appropriate boolean in the request.
|
|
POST
|
Method: Validate, URL: Web/Cart/{sessionKey}/Validate
|
Test
|
|
Validates various aspects of the cart
|
|
ValidateLimits Web/Cart/{sessionKey}/ValidateLimits Validates ticket limits
Offer Limits are evaluated for the specified price type and seat count using the cart source code. Requires either a performance ID or a package ID.
To enable ticket limit validation, add the Field Name "ENFORCE_SEAT_LIMIT_FOR_ORDERS" under the "Impresario" parent table with a value of "Yes." This setting applies to both the Web API and the Tessitura Client Application.
|
|
POST
|
Method: ValidateLimits, URL: Web/Cart/{sessionKey}/ValidateLimits
|
Test
|
|
Validates ticket limits
|
|
ApplyLineItemDiscount Web/Cart/{sessionKey}/LineItems/{lineItemId}/Discount Applies a discounted price to all sub line items for a line item
For packages, the discount can only be applied to package line items.
The status field in the response will return as S if the discount can be used or E with a description of the error if the discount cannot be used.
|
|
PUT
|
Method: ApplyLineItemDiscount, URL: Web/Cart/{sessionKey}/LineItems/{lineItemId}/Discount
|
Test
|
|
Applies a discounted price to all sub line items for a line item
|
|
ApplySubLineItemDiscount Web/Cart/{sessionKey}/SubLineItems/{subLineItemId}/Discount Applies a discounted price to a sub line item
The status field in the response will return as S if the discount can be used or E with a description of the error if the discount cannot be used.
|
|
PUT
|
Method: ApplySubLineItemDiscount, URL: Web/Cart/{sessionKey}/SubLineItems/{subLineItemId}/Discount
|
Test
|
|
Applies a discounted price to a sub line item
|
|
UpdateCartFlags Web/Cart/{sessionKey}/CartFlags Updates flags on the cart
|
|
PUT
|
Method: UpdateCartFlags, URL: Web/Cart/{sessionKey}/CartFlags
|
Test
|
|
Updates flags on the cart
|
|
UpdateCartProperties Web/Cart/{sessionKey}/Properties Updates cart properties
See the notes on the request for specific documentation on each item that can be set.
Before making a request to PUT cart properties, you should make a GET request to obtain all current property values. Make updates to any of the properties that need changing, and pass the entire cart properties object back into your put request. This ensures that all property values that are set, but should not change, persist and are not overwritten unintentioanlly.
|
|
PUT
|
Method: UpdateCartProperties, URL: Web/Cart/{sessionKey}/Properties
|
Test
|
|
Updates cart properties
|
|
UpdateCartPropertiesCustomData Web/Cart/{sessionKey}/CustomData/{customId} Updates a custom data value in the cart properties
Note: Only the Index and Value properties in the request should be used.
|
|
PUT
|
Method: UpdateCartPropertiesCustomData, URL: Web/Cart/{sessionKey}/CustomData/{customId}
|
Test
|
|
Updates a custom data value in the cart properties
|
|
UpdateContributionCustomData Web/Cart/{sessionKey}/Contributions/{lineItemId}/CustomData/{customId} Updates a custom data value for a contribution in the cart
Note: Only the Index and Value properties in the request object should be used.
|
|
PUT
|
Method: UpdateContributionCustomData, URL: Web/Cart/{sessionKey}/Contributions/{lineItemId}/CustomData/{customId}
|
Test
|
|
Updates a custom data value for a contribution in the cart
|
|
UpdateLineItemPrice Web/Cart/{sessionKey}/LineItems/{lineItemId}/Price Updates the price on all sub line items for the line item
A price can only be edited if the price type has been marked as editable, zones on the price map have been designated as editable, and the seat is in one of the editable zones.
The status field in the response will return as S if the price can be applied or E with a description of the error if the price cannot be applied.
|
|
PUT
|
Method: UpdateLineItemPrice, URL: Web/Cart/{sessionKey}/LineItems/{lineItemId}/Price
|
Test
|
|
Updates the price on all sub line items for the line item
|
|
UpdateLineItemPriceType Web/Cart/{sessionKey}/LineItems/{lineItemId}/PriceTypeId Updates the price type on all sub line items for a given lineitem
Can be filtered by those have a current price type as specified by OriginalPriceType
|
|
PUT
|
Method: UpdateLineItemPriceType, URL: Web/Cart/{sessionKey}/LineItems/{lineItemId}/PriceTypeId
|
Test
|
|
Updates the price type on all sub line items for a given lineitem
|
|
UpdateLineItemSource Web/Cart/{sessionKey}/LineItems/{lineItemId}/Source Updates the source on a line item
Allows the source of an individual line to be updated. When a line is created, by reserving a tickets for a performance or package, the line source is copied from the session source. This method allows the line source to be updated.
Offers and Pricing Rules consider line source, not the session source.
|
|
PUT
|
Method: UpdateLineItemSource, URL: Web/Cart/{sessionKey}/LineItems/{lineItemId}/Source
|
Test
|
|
Updates the source on a line item
|
|
UpdateLineItemSpecialRequest Web/Cart/{sessionKey}/LineItems/{lineItemId}/SpecialRequest Updates Special Request info on a line item
|
|
PUT
|
Method: UpdateLineItemSpecialRequest, URL: Web/Cart/{sessionKey}/LineItems/{lineItemId}/SpecialRequest
|
Test
|
|
Updates Special Request info on a line item
|
|
UpdatePaymentPlan Web/Cart/{sessionKey}/Payments/Plan Allows the billing and credit card information to be updated on an existing payment plan for the cart.
|
|
PUT
|
Method: UpdatePaymentPlan, URL: Web/Cart/{sessionKey}/Payments/Plan
|
Test
|
|
Allows the billing and credit card information to be updated on an existing payment plan for the cart.
|
|
UpdateSubLineItemPrice Web/Cart/{sessionKey}/SubLineItems/{subLineItemId}/Price Updates the price on a sub line item.
A price can only be edited if the price type has been marked as editable, zones on the price map have been designated as editable, and the seat is in one of the editable zones.
The status field in the response will return as S if the price can be applied or E with a description of the error if the price cannot be applied.
|
|
PUT
|
Method: UpdateSubLineItemPrice, URL: Web/Cart/{sessionKey}/SubLineItems/{subLineItemId}/Price
|
Test
|
|
Updates the price on a sub line item.
|
|
UpdateSubLineItemPriceType Web/Cart/{sessionKey}/SubLineItems/{subLineItemId}/PriceTypeId Updates the price type on a sub line item
|
|
PUT
|
Method: UpdateSubLineItemPriceType, URL: Web/Cart/{sessionKey}/SubLineItems/{subLineItemId}/PriceTypeId
|
Test
|
|
Updates the price type on a sub line item
|
|
UpdateSubLineItemRecipient Web/Cart/{sessionKey}/SubLineItems/{subLineItemId}/Recipient Updates the recipient on a sub line item
|
|
PUT
|
Method: UpdateSubLineItemRecipient, URL: Web/Cart/{sessionKey}/SubLineItems/{subLineItemId}/Recipient
|
Test
|
|
Updates the recipient on a sub line item
|
|
ClearCart Web/Cart/{sessionKey} Cancels and clears the cart
Releases any performance and package tickets that have been added to the cart and reverses unsaved payment authorizations if applicable.
|
|
DELETE
|
Method: ClearCart, URL: Web/Cart/{sessionKey}
|
Test
|
|
Cancels and clears the cart
|
|
RemoveBooking Web/Cart/{sessionKey}/Bookings Remove the booking attached to the cart.
|
|
DELETE
|
Method: RemoveBooking, URL: Web/Cart/{sessionKey}/Bookings
|
Test
|
|
Remove the booking attached to the cart.
|
|
RemoveCartPropertiesCustomData Web/Cart/{sessionKey}/CustomData/{customId} Removes a custom data value from the cart properties
|
|
DELETE
|
Method: RemoveCartPropertiesCustomData, URL: Web/Cart/{sessionKey}/CustomData/{customId}
|
Test
|
|
Removes a custom data value from the cart properties
|
|
RemoveContribution Web/Cart/{sessionKey}/Contributions/{lineItemId} Removes a contribution from the cart
|
|
DELETE
|
Method: RemoveContribution, URL: Web/Cart/{sessionKey}/Contributions/{lineItemId}
|
Test
|
|
Removes a contribution from the cart
|
|
RemoveContributionCustomData Web/Cart/{sessionKey}/Contributions/{lineItemId}/CustomData/{customId} Removes a custom data value for a contribution in the cart
|
|
DELETE
|
Method: RemoveContributionCustomData, URL: Web/Cart/{sessionKey}/Contributions/{lineItemId}/CustomData/{customId}
|
Test
|
|
Removes a custom data value for a contribution in the cart
|
|
RemoveFee Web/Cart/{sessionKey}/Fees/{itemFeeId} Removes a fee from the cart
Only user-defined fees can be removed.
|
|
DELETE
|
Method: RemoveFee, URL: Web/Cart/{sessionKey}/Fees/{itemFeeId}
|
Test
|
|
Removes a fee from the cart
|
|
RemoveGiftCertificate Web/Cart/{sessionKey}/GiftCertificates/{giftCertificateNumber} Removes a gift certificate product from the cart
|
|
DELETE
|
Method: RemoveGiftCertificate, URL: Web/Cart/{sessionKey}/GiftCertificates/{giftCertificateNumber}
|
Test
|
|
Removes a gift certificate product from the cart
|
|
RemoveNFSPackage Web/Cart/{sessionKey}/Packages/Nfs/{nfsPackageLineItemId} Removes an entire NFS package item from the cart
All seats are released for the specified package lineitem.
|
|
DELETE
|
Method: RemoveNFSPackage, URL: Web/Cart/{sessionKey}/Packages/Nfs/{nfsPackageLineItemId}
|
Test
|
|
Removes an entire NFS package item from the cart
|
|
RemoveNFSPackagePerformanceItem Web/Cart/{sessionKey}/Packages/Nfs/{nfsPackageLineItemId}/{performanceLineItemId}/{performanceId} Removes an NFS performance item from the cart
Seats are released for the specified performance in the package.
|
|
DELETE
|
Method: RemoveNFSPackagePerformanceItem, URL: Web/Cart/{sessionKey}/Packages/Nfs/{nfsPackageLineItemId}/{performanceLineItemId}/{performanceId}
|
Test
|
|
Removes an NFS performance item from the cart
|
|
RemoveOnAccount Web/Cart/{sessionKey}/OnAccount/{paymentId} Removes On Account balance from the cart
|
|
DELETE
|
Method: RemoveOnAccount, URL: Web/Cart/{sessionKey}/OnAccount/{paymentId}
|
Test
|
|
Removes On Account balance from the cart
|
|
RemovePackageItem Web/Cart/{sessionKey}/Packages/Fixed/{packageId}/{lineItemId} Removes a fixed seat package item from the cart
All seats are released for the specified package lineitem.
|
|
DELETE
|
Method: RemovePackageItem, URL: Web/Cart/{sessionKey}/Packages/Fixed/{packageId}/{lineItemId}
|
Test
|
|
Removes a fixed seat package item from the cart
|
|
RemovePackagePerformanceItem Web/Cart/{sessionKey}/Packages/Fixed/{fixedPackageLineItemId}/{performanceLineItemId}/{performanceId} Removes a performance item from a fixed seat package in the cart
Seats are released for the specified performance in the package.
|
|
DELETE
|
Method: RemovePackagePerformanceItem, URL: Web/Cart/{sessionKey}/Packages/Fixed/{fixedPackageLineItemId}/{performanceLineItemId}/{performanceId}
|
Test
|
|
Removes a performance item from a fixed seat package in the cart
|
|
RemovePayment Web/Cart/{sessionKey}/Payments/{paymentId} Removes a payment from the cart
All payment types, except gift certificates, can be removed with this method.
This method will also reverse or void the associated web EMV authorization, if the cart has not been saved.
|
|
DELETE
|
Method: RemovePayment, URL: Web/Cart/{sessionKey}/Payments/{paymentId}
|
Test
|
|
Removes a payment from the cart
|
|
RemovePaymentPlans Web/Cart/{sessionKey}/Payments/Plan Removes the payment plan associated with the cart
|
|
DELETE
|
Method: RemovePaymentPlans, URL: Web/Cart/{sessionKey}/Payments/Plan
|
Test
|
|
Removes the payment plan associated with the cart
|
|
RemoveSubLineItem Web/Cart/{sessionKey}/LineItems/{lineItemId}/SubLineItems/{subLineItemId} Removes a sub line item.
Not allowed for packages.
|
|
DELETE
|
Method: RemoveSubLineItem, URL: Web/Cart/{sessionKey}/LineItems/{lineItemId}/SubLineItems/{subLineItemId}
|
Test
|
|
Removes a sub line item.
|
|
RemoveSuperPackageItem Web/Cart/{sessionKey}/Packages/Super/{superPackageId}/{superPackageLineItemId} Removes a super package item from the cart
All seats are released for the specified package lineitem.
|
|
DELETE
|
Method: RemoveSuperPackageItem, URL: Web/Cart/{sessionKey}/Packages/Super/{superPackageId}/{superPackageLineItemId}
|
Test
|
|
Removes a super package item from the cart
|
|
RemoveSuperPackagePerformanceItem Web/Cart/{sessionKey}/Packages/Super/{superPackageLineItemId}/{subPackageId}/{performanceLineItemId}/{performanceId} Removes a performance item from a super package in the cart
Seats are released for the specified performance in the package.
|
|
DELETE
|
Method: RemoveSuperPackagePerformanceItem, URL: Web/Cart/{sessionKey}/Packages/Super/{superPackageLineItemId}/{subPackageId}/{performanceLineItemId}/{performanceId}
|
Test
|
|
Removes a performance item from a super package in the cart
|
|
RemoveTickets Web/Cart/{sessionKey}/Tickets/{performanceId}/{lineItemId} Removes tickets from the cart
|
|
DELETE
|
Method: RemoveTickets, URL: Web/Cart/{sessionKey}/Tickets/{performanceId}/{lineItemId}
|
Test
|
|
Removes tickets from the cart
|
|
UnapplyGiftCertificate Web/Cart/{sessionKey}/Payments/GiftCertificate/{giftCertificateNumber} Removes a gift certificate payment from the cart.
|
|
DELETE
|
Method: UnapplyGiftCertificate, URL: Web/Cart/{sessionKey}/Payments/GiftCertificate/{giftCertificateNumber}
|
Test
|
|
Removes a gift certificate payment from the cart.
|