Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

download

Pricing Totalling Callback Parameters

Aggregate Cart Request Interface

Below is the definition for the IAggregateCartRequest interface used in the Pricing Totalling callback.

public interface IAggregateCartRequest : ICartBaseRequest
    {
        /// <summary>
        /// Get Cart Context
        /// </summary>
        /// <returns></returns>
        public ICartContext GetCartContext ();

        /// <summary>
        /// Request Id
        /// </summary>
        public string RequestId { get; }
    }

Method

Description

ICartBaseRequest

This is the base Interface which IAggregatecartrequest inherits.

GetCartContext

This method provides the context of the cart.

RequestId

This property provides the request ID.

Cart Base Request Interface

Below is the definition of the ICartBaseRequest interface which IAggregateCartRequest inherits.

public interface ICartBaseRequest : ICallbackBaseRequest
    {
        /// <summary>
        /// Cart Id
        /// </summary>
        public string CartId { get; }
 
        /// <summary>
        /// Cart Object
        /// </summary>
        public IProductConfigurationModel GetCart();
    }

Method

Description

GetCart

This method provides the details of the cart.

CartId

This property provides the value of the cart id.

Cart Context

Below are the ICartContext interface details which is used by GetCartContext() method in IAggregateCartRequest interface.

public interface ICartContext
    {
        /// <summary>
        /// Cart header model
        /// </summary>
        public IProductConfigurationModel GetCart();
 
        /// <summary>
        /// All product lines present in the cart
        /// </summary>
        public List<IProductLineItemModel> GetLineItems();
 
        /// <summary>
        /// Get Summary Groups
        /// </summary>
        List<ISummaryGroup> GetSummaryGroups();
    }

Method

Description

GetCart

This method provides the details of the cart.

GetLineItems

This method provides the data about the lineitems inside the cart.

GetSummaryGroups

This method provides the details of all summary groups present in the cart.

IProductConfiguration

IProductConfigurationModel interface is used by GetCart() method in ICartBaseRequest interface.

Public interface IProductConfigurationModel : IBaseModel<IProductConfiguration>
    {
 
    }
 
IProductConfigurationModel  is inheriting IProductConfiguration so below is the definition of IProductConfiguration.
 
public interface IProductConfiguration : IBaseEntity
    {
        /// <summary>
        /// Sold to Account Id.
        /// </summary>
        public string AccountId { get; set; }
 
        /// <summary>
        /// Price List Id.
        /// </summary>
        public string PriceListId { get; set; }
 
        /// <summary>
        /// Cart Approval Preview Status (pending or complete)
        /// </summary>
        public string ApprovalPreviewStatus { get; set; }
 
        /// <summary>
        /// Cart Approval Status
        /// </summary>
        public string ApprovalStatus { get; set; }
 
        /// <summary>
        /// Billing Preference Id
        /// </summary>
        public string BillingPreferenceId { get; set; }
 
        /// <summary>
        /// Pricing Date for the Cart.
        /// </summary>
        public DateTime? PricingDate { get; set; }
 
        /// <summary>
        /// Start date for the Cart.
        /// </summary>
        public DateTime? ExpectedStartDate { get; set; }
 
        /// <summary>
        /// End date for the Cart.
        /// </summary>
        public DateTime? ExpectedEndDate { get; set; }
 
        /// <summary>
        /// Contract Numbers for querying Price Lists.
        /// </summary>
        public string ContractNumbers { get; set; }
 
        /// <summary>
        /// CouponCodes
        /// </summary>
        public string CouponCodes { get; set; }
 
        /// <summary>
        /// Contains the Effective Price List Id (Quote PriceList)
        /// </summary>
        public string EffectivePriceListId { get; set; }
 
        /// <summary>
        /// To identify cart business object type
        /// </summary>
        public string BusinessObjectType { get; set; }
 
        /// <summary>
        /// Cart Status
        /// </summary>
        public string Status { get; set; }
    }

Method

Description

AccountId

This property provides the details of an account Id against the cart that has been created.

PriceListId

This property contains the details of a Price List id.

ApprovalPreviewStatus

This property contains the details of the status of a cart approval (pending or complete).

ApprovalStatus

This property contains the details of the status of the cart approval.

BillingPreferenceId

This property contains the details of the billing preference ID.

PricingDate

This property contains the details of the date and time of the pricing for the cart.

ExpectedStartDate

This property contains the details of the start date and time of the cart.

ExpectedEndDate

This property contains the details of the end date and time of the cart.

ContractNumbers

This property contains the details of the contact numbers for querying price lists.

CouponCodes

This property contains the details of the coupon codes applied on the cart.

EffectivePriceListId

This property contains the details of the effective price list id of the quote price list.

BusinessObjectType

This property contains the details of the identified business object type of the cart.

Status

This property contains the details of the cart status.