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

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : CartProperties

Request object type CartProperties has the following properties.
Property Name Data Type Length Required Readonly Notes
AddressId integer N The address to set as the delivery address. If the delivery method specified does not require a postal address and you don’t want to associate one with the order, then you can specifiy 0 as the Addressid.
FK: T_ADDRESS.address_no   Resource: Addresses
CategoryId integer N The order category, identified by ID number, that will be selected for the order. Set the value to -1 to set the field to null for the order.
FK: TR_ORDER_CATEGORY.id   Resource: OrderCategories
ChannelId integer N The channel, identified by ID number, that will be selected for the order.
FK: TR_SALES_CHANNEL.id   Resource: SalesChannels
DeliveryMethodId integer N The delivery method to set for the order. /Web/Session/DeliveryMethods can be used to return valid delivery methods for the session.
FK: TR_ORDER_SHIP_METHOD .id   Resource: DeliveryMethods
ElectronicAddressId integer N The Email address to set as the delivery address.
FK: T_EADDRESS.eaddress_no   Resource: ElectronicAddresses
HoldUntilDateTime date N The hold until date to set for the order. This needs to be a valid date time.
InitiatorId integer N Sets or removes the initiator for the order. Note that an individual starts a session and the session context is shifted to the household, the original constituent (the individual) will automatically be recorded as the initiator on the order. Pass 0 to remove any existing initiator.
FK: T_CUSTOMER.customer_no   Resource: Constituents
ModeOfSaleId integer N Mode of sale to set for the session. Pass 0 to set the mode of sale to the default for the session(either the default web MOS, the MOS indicated by the source, or the MOS indicated by the constituent’s rank). The MOS can be set after products have been added to the cart as long as they are still valid in the new MOS. If the contents are not valid in the new mode of sale, an exception is thrown. If existing cart items exceed any quantity limits set at the price type level under the new mode of sale, an exception is thrown.
FK: TR_MOS.id   Resource: ModesOfSale
Notes string N The text of the note being added to the order.
OrderDateTime date N The order date for the order. This needs to be a valid date time, not a future date and not earlier than current active seasons start/end dates. This can only be set if the Mode of Sale permits editing the order date. Editing an order date can only be done on a new order or a rollover order with an empty (null) date.
PhoneId integer N The id of the phone to set as the contact phone number.
FK: T_PHONE.phone_no   Resource: Phones
Solicitor string N The solicitor, identified by user name, that will be used for the order.
FK: T_METUSER.userid   Resource: Users
SourceId integer N New source code for the session. To use a promo code for a source, /Web/Session/Promocode must be used to look up the source code associated with the promo code.
FK: TX_APPEAL_MEDIA_TYPE.source_no   Resource: Sources 
{
  "ModeOfSaleId": 1,
  "SourceId": 1,
  "Solicitor": "sample string 1",
  "CategoryId": 1,
  "ChannelId": 1,
  "HoldUntilDateTime": "2025-04-24T08:56:36.6685549-07:00",
  "Notes": "sample string 2",
  "InitiatorId": 1,
  "AddressId": 1,
  "PhoneId": 1,
  "ElectronicAddressId": 1,
  "DeliveryMethodId": 1,
  "OrderDateTime": "2025-04-24T08:56:36.6685549-07:00"
}
<CartProperties xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddressId>1</AddressId>
  <CategoryId>1</CategoryId>
  <ChannelId>1</ChannelId>
  <DeliveryMethodId>1</DeliveryMethodId>
  <ElectronicAddressId>1</ElectronicAddressId>
  <HoldUntilDateTime>2025-04-24T08:56:36.6685549-07:00</HoldUntilDateTime>
  <InitiatorId>1</InitiatorId>
  <ModeOfSaleId>1</ModeOfSaleId>
  <Notes>sample string 2</Notes>
  <OrderDateTime>2025-04-24T08:56:36.6685549-07:00</OrderDateTime>
  <PhoneId>1</PhoneId>
  <Solicitor>sample string 1</Solicitor>
  <SourceId>1</SourceId>
</CartProperties>

Response object type : CartProperties

Response object type CartProperties has the following properties.
Property Name Data Type Length Required Readonly Notes
AddressId integer N The address to set as the delivery address. If the delivery method specified does not require a postal address and you don’t want to associate one with the order, then you can specifiy 0 as the Addressid.
FK: T_ADDRESS.address_no   Resource: Addresses
CategoryId integer N The order category, identified by ID number, that will be selected for the order. Set the value to -1 to set the field to null for the order.
FK: TR_ORDER_CATEGORY.id   Resource: OrderCategories
ChannelId integer N The channel, identified by ID number, that will be selected for the order.
FK: TR_SALES_CHANNEL.id   Resource: SalesChannels
DeliveryMethodId integer N The delivery method to set for the order. /Web/Session/DeliveryMethods can be used to return valid delivery methods for the session.
FK: TR_ORDER_SHIP_METHOD .id   Resource: DeliveryMethods
ElectronicAddressId integer N The Email address to set as the delivery address.
FK: T_EADDRESS.eaddress_no   Resource: ElectronicAddresses
HoldUntilDateTime date N The hold until date to set for the order. This needs to be a valid date time.
InitiatorId integer N Sets or removes the initiator for the order. Note that an individual starts a session and the session context is shifted to the household, the original constituent (the individual) will automatically be recorded as the initiator on the order. Pass 0 to remove any existing initiator.
FK: T_CUSTOMER.customer_no   Resource: Constituents
ModeOfSaleId integer N Mode of sale to set for the session. Pass 0 to set the mode of sale to the default for the session(either the default web MOS, the MOS indicated by the source, or the MOS indicated by the constituent’s rank). The MOS can be set after products have been added to the cart as long as they are still valid in the new MOS. If the contents are not valid in the new mode of sale, an exception is thrown. If existing cart items exceed any quantity limits set at the price type level under the new mode of sale, an exception is thrown.
FK: TR_MOS.id   Resource: ModesOfSale
Notes string N The text of the note being added to the order.
OrderDateTime date N The order date for the order. This needs to be a valid date time, not a future date and not earlier than current active seasons start/end dates. This can only be set if the Mode of Sale permits editing the order date. Editing an order date can only be done on a new order or a rollover order with an empty (null) date.
PhoneId integer N The id of the phone to set as the contact phone number.
FK: T_PHONE.phone_no   Resource: Phones
Solicitor string N The solicitor, identified by user name, that will be used for the order.
FK: T_METUSER.userid   Resource: Users
SourceId integer N New source code for the session. To use a promo code for a source, /Web/Session/Promocode must be used to look up the source code associated with the promo code.
FK: TX_APPEAL_MEDIA_TYPE.source_no   Resource: Sources 
{
  "ModeOfSaleId": 1,
  "SourceId": 1,
  "Solicitor": "sample string 1",
  "CategoryId": 1,
  "ChannelId": 1,
  "HoldUntilDateTime": "2025-04-24T08:56:36.6685549-07:00",
  "Notes": "sample string 2",
  "InitiatorId": 1,
  "AddressId": 1,
  "PhoneId": 1,
  "ElectronicAddressId": 1,
  "DeliveryMethodId": 1,
  "OrderDateTime": "2025-04-24T08:56:36.6685549-07:00"
}
<CartProperties xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddressId>1</AddressId>
  <CategoryId>1</CategoryId>
  <ChannelId>1</ChannelId>
  <DeliveryMethodId>1</DeliveryMethodId>
  <ElectronicAddressId>1</ElectronicAddressId>
  <HoldUntilDateTime>2025-04-24T08:56:36.6685549-07:00</HoldUntilDateTime>
  <InitiatorId>1</InitiatorId>
  <ModeOfSaleId>1</ModeOfSaleId>
  <Notes>sample string 2</Notes>
  <OrderDateTime>2025-04-24T08:56:36.6685549-07:00</OrderDateTime>
  <PhoneId>1</PhoneId>
  <Solicitor>sample string 1</Solicitor>
  <SourceId>1</SourceId>
</CartProperties>
Change Version Description Contract Old New
Property Added 15.1.7 OrderDateTime has been added to CartProperties CartProperties CartProperties.OrderDateTime
Property Added 15.1.7 OrderDateTime has been added to CartProperties CartProperties CartProperties.OrderDateTime
Property Added 15.1.16 PhoneId has been added to CartProperties CartProperties CartProperties.PhoneId
Property Added 15.1.16 PhoneId has been added to CartProperties CartProperties CartProperties.PhoneId
Parameter Changed 15.0.0 sessionKey has been marked as required. Required