Cart Test
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.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Print/PrintStrings

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : PrintOrderRequest

Request object type PrintOrderRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
HeaderDesignId integer N Ticket design to use for headers. If included, header elements are returned by the service.
FK: T_DESIGN.deisgn_no   Resource: Designs
IncludeReceipts boolean N Pass True to include receipts for the order (default). Pass False to exclude receipts.
LineItems string N The li_seq_no of the line item(s) for which printed ticket information should be retrieved. Use a comma-delimited list of li_seq_nos to retrieve ticket information for multiple line items. If sublineitem number(s) or order ID is provided, leave blank. Parameter maps to li_seq_no column in the T_WEB_LINEITEM table. Only supported when Mode = 2.
FK: T_LINEITEM.li_seq_no
Mode integer 2 - Return ticket element data. 1 - Used by Print at Home (default).
NewTicketNoForReprints boolean Y Pass True if new ticket number should be created if order is reprinting (default). Pass False if existing ticket number should be used for reprinted order. This parameter is ignored, and treated as True if Mode = 1 (for Print at Home only).
OrderId integer N Order for which to retrieve ticket information. Leave blank if generating print information for single line item or sub line item. Required if Mode = 1.
FK: T_ORDER.order_no   Resource: Orders
PrinterType string "B" - Boca (default). "Z" - Zebra. This will choose the alternate zebra design for the returned elements.
ReprintTickets boolean Pass True to reprint already printed tickets. NewTicketNoForReprints controls if new ticket numbers are given when reprinting. Pass False to skip already printed tickets (default).
SubLineItems string N The sli_no of the sub line item(s) for which printed ticket information should be retrieved. Use a comma-delimited list of sli_nos to retrieve ticket information for multiple subline items. If line item number(s) or order ID is provided, leave blank. Only supported when Mode = 2.
FK: T_SUB_LINEITEM.sli_no   Resource: SubLineItems
TicketDesignId integer N Ticket design to use for retrieved ticket information. If design is specified, will override ticket design applied to order items.
FK: T_DESIGN.deisgn_no   Resource: Designs
{
  "OrderId": 1,
  "HeaderDesignId": 1,
  "IncludeReceipts": true,
  "ReprintTickets": true,
  "TicketDesignId": 1,
  "Mode": 1,
  "LineItems": "sample string 1",
  "SubLineItems": "sample string 2",
  "NewTicketNoForReprints": true,
  "PrinterType": "sample string 3"
}
<PrintOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HeaderDesignId>1</HeaderDesignId>
  <IncludeReceipts>true</IncludeReceipts>
  <LineItems>sample string 1</LineItems>
  <Mode>1</Mode>
  <NewTicketNoForReprints>true</NewTicketNoForReprints>
  <OrderId>1</OrderId>
  <PrinterType>sample string 3</PrinterType>
  <ReprintTickets>true</ReprintTickets>
  <SubLineItems>sample string 2</SubLineItems>
  <TicketDesignId>1</TicketDesignId>
</PrintOrderRequest>

Response object type : PrintOrderResponse

Response object type PrintOrderResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
PrintStrings Collection of string
{
  "PrintStrings": [
    "sample string 1",
    "sample string 2"
  ]
}
<PrintOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PrintStrings>
    <PrintString>sample string 1</PrintString>
    <PrintString>sample string 2</PrintString>
  </PrintStrings>
</PrintOrderResponse>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required