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

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : AddGiftCertificateRequest

Request object type AddGiftCertificateRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Amount decimal number Y
Name string 100 N The name to use as the receipient for this gift certificate. This value can be printed on the gift certificate receipt.
Notes string 1024 N Notes to be included on the gift certificate payment.
PaymentMethodId integer Y Must be an id of a payment method where the payment method type is Gift Certificate. (pmt_type = 8).
FK: TR_PAYMENT_METHOD.id   Resource: PaymentMethods 
{
  "Amount": 1.0,
  "PaymentMethodId": 2,
  "Notes": "sample string 3",
  "Name": "sample string 4"
}
<AddGiftCertificateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <Name>sample string 4</Name>
  <Notes>sample string 3</Notes>
  <PaymentMethodId>2</PaymentMethodId>
</AddGiftCertificateRequest>

Response object type : CartProductResponse

Response object type CartProductResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
Id integer
ItemCount integer
ParentId integer N For Payments, parent id will be NULL. For Package and Performance responses, parent id will be the LineItem Id for the cart.
ProductTypeId integer 
{
  "Id": 1,
  "ProductTypeId": 2,
  "ParentId": 1,
  "ItemCount": 1
}
<CartProductResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <ItemCount>1</ItemCount>
  <ParentId>1</ParentId>
  <ProductTypeId>2</ProductTypeId>
</CartProductResponse>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required