API Reference | cleverbridge

Want to find out about the assortment of APIs that cleverbridge offers? The cleverbridge API Reference is the place to learn about our API resources, request items, and responses. You can also try out our endpoints using the API explorer.

Get Started    

Additional Cart Parameters

Cart.CartItems.CartItem

object

REQUIRED

The cart item to be processed.

Cart.CartItems.CartItem.ProductId

int64

Unique ID of the product. You must submit either ProductID or InternalProductId.

Cart.CartItems.CartItem.Quantity

int32

REQUIRED

Number of items.

Cart.CartItems.CartItem.Name

string

Product name used in customer communication.

Cart.CartItems.CartItem.AdditionalName

string

Product description. Corresponds to the 'Additional name information' in the Commerce Assistant.

Cart.CartItems.CartItem.DynamicPrice

object

Set a special product price for the transaction. Dynamic pricing must be enabled both for the product and your account. For more information, see Price Options Tab in the Product Portal.

Cart.CartItems.CartItem.DynamicPrice.IncreaseNetPrice

boolean

Applies only if you define gross prices (IsGross=true). If set to true, for customers who don't pay taxes, the net price is increased by the same percentage as customers who do pay taxes. All customers pay the same total price, whether they pay taxes or not. If set to false, for customers who don't pay taxes, the net price is decreased by the same percentage as customers who do pay taxes. Customers pay a different total price.

Cart.CartItems.CartItem.DynamicPrice.IsGross

boolean

Set to true if taxes should be included in the item price. Set to false if taxes should be added on top of the item price. For more information, see Using the IsGross Subparameter.

Cart.CartItems.CartItem.DynamicPrice.Items

array of objects

List of dynamic price items.

Cart.CartItems.CartItem.DynamicPrice.Items.DynamicPriceItem

object

The dynamic price item.

Cart.CartItems.CartItem.DynamicPrice.Items.DynamicPriceItem.Currency

string

The currency of the defined price.

Cart.CartItems.CartItem.DynamicPrice.Items.DynamicPriceItem.Price

double

A special price value.

Cart.CartItems.CartItem.DynamicPrice.YourCurrency

string

Currency in which prices are fixed for calculating the payout amount for the transaction.

Cart.CartItems.CartItem.DynamicDiscount

object

Set a special discount for the transaction. Use Percent for percentage discounts and DynamicDiscountItem for absolute discounts.

Cart.CartItems.CartItem.DynamicDiscount.IncreaseNetPrice

boolean

Applies only if you define gross prices (IsGross=true). If set to true, for customers who don't pay taxes, the net price is increased by the same percentage as customers who do pay taxes. All customers pay the same total price, whether they pay taxes or not. If set to false, for customers who don't pay taxes, the net price is decreased by the same percentage as customers who do pay taxes. Customers pay a different total price.

Cart.CartItems.CartItem.DynamicDiscount.IsGross

boolean

Set to true if taxes should be included in the item price. Set to false if taxes should be added on top of the item price. Applies only to absolute discounts. For more information, see Using the IsGross Subparameter.

Cart.CartItems.CartItem.DynamicDiscount.MaxIntervalNo

int64

Applies only to orders containing a subscription product. The subscription interval up to which the dynamic discount is to be applied. Counting of intervals starts at 0. For an unlimited discount, use 0.

Cart.CartItems.CartItem.DynamicDiscount.Percent

double

Percentage which is subtracted from the price of the product.

Cart.CartItems.CartItem.DynamicDiscount.Items

array of objects

List of dynamic discount items.

Cart.CartItems.CartItem.DynamicDiscount.Items.DynamicDiscountItem

object

The dynamic discount item.

Cart.CartItems.CartItem.DynamicDiscount.Items.DynamicDiscountItem.Currency

string

REQUIRED

The currency of the defined price.

Cart.CartItems.CartItem.DynamicDiscount.Items.DynamicDiscountItem.Price

double

REQUIRED

Discounted price of the product.

Cart.CartItems.CartItem.DynamicDiscount.YourCurrency

string

Currency in which prices are fixed for calculating the payout amount for the transaction.

Cart.CartItems.CartItem.DynamicSubscription

object

Change the length of the first subscription interval.

Cart.CartItems.CartItem.DynamicSubscription.SubscriptionInterval

integer

REQUIRED

Time unit of the subscription interval. For an XML request the data type is string. Use the following values:
0 - Day
1 - Month

Cart.CartItems.CartItem.DynamicSubscription.IntervalCount

integer

REQUIRED

Number of days or months between billing events.

Cart.CartItems.CartItem.InternalProductId

string

Your custom unique product ID.

Cart.CartItems.CartItem.DynamicInternalProductId

string

Overwrites the InternalProductId with a custom ID for the respective transaction.

Cart.CartItems.CartItem.ExtraParameters

string

List of x-parameters for adding additional information to the purchase item. Submit as key-value pairs. All keys must begin with x-. For more information, see X-Parameters.