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 Purchase Response Items

Purchase.PaidOrderNotification.Items.Item

object

Information about a purchase item.

Purchase.PaidOrderNotification.Items.Item.@RunningNo

string

Running number of the item.

Purchase.PaidOrderNotification.Items.Item.ProductId

string

ID of the product.

Purchase.PaidOrderNotification.Items.Item.ProductName

string

Product name used in customer communication.

Purchase.PaidOrderNotification.Items.Item.ProductNameExtension

string

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

Purchase.PaidOrderNotification.Items.Item.ProductReportingGroup

string

Type of product. For example, B2B or B2C.

Purchase.PaidOrderNotification.Items.Item.SupportContactId

string

Unique ID for customer support.

Purchase.PaidOrderNotification.Items.Item.SupportContact

string

Name of customer support.

Purchase.PaidOrderNotification.Items.Item.ClientId

string

The cleverbridge ID for your company.

Purchase.PaidOrderNotification.Items.Item.Quantity

string

Number of items.

Purchase.PaidOrderNotification.Items.Item.YourCurrency

string

The currency on your account.

Purchase.PaidOrderNotification.Items.Item.YourCustomerId

string

Your unique ID for a customer.

Purchase.PaidOrderNotification.Items.Item.ProfitCalculation

object

Financial figures related to the purchase.

Purchase.PaidOrderNotification.Items.Item.ProfitCalculation.GrossRevenue

string

Money cleverbridge received from customer, including taxes.

Purchase.PaidOrderNotification.Items.Item.ProfitCalculation.CollectVat

string

Taxes cleverbridge received from customer.

Purchase.PaidOrderNotification.Items.Item.ProfitCalculation.NetRevenue

string

Money cleverbridge received from customer, not including taxes.

Purchase.PaidOrderNotification.Items.Item.ProfitCalculation.CbMarginPercentage

string

Percentage of NetRevenue that cleverbridge kept.

Purchase.PaidOrderNotification.Items.Item.ProfitCalculation.CbMarginFix

string

Fixed amount of NetRevenue that cleverbridge kept.

Purchase.PaidOrderNotification.Items.Item.ProfitCalculation.YourNetProfit

string

Money you received from cleverbridge, not including taxes.

Purchase.PaidOrderNotification.Items.Item.ProfitCalculation.YourVat

string

Taxes that you must pay.

Purchase.PaidOrderNotification.Items.Item.ProfitCalculation.YourGrossProfit

string

Money you received from cleverbridge, including taxes.

Purchase.PaidOrderNotification.YourPrice.ProductSinglePrice

object

Basic pricing information for one unit of a product.

Purchase.PaidOrderNotification.YourPrice.ProductSinglePrice.NetPrice

string

Price for one unit of a product, not including taxes.

Purchase.PaidOrderNotification.YourPrice.ProductSinglePrice.VatPrice

string

Taxes for one unit of a product.

Purchase.PaidOrderNotification.YourPrice.ProductSinglePrice.GrossPrice

string

Price for one unit of a product, including taxes.

Purchase.PaidOrderNotification.YourPrice.ProductSinglePrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.YourPrice.ProductTotalPrice

object

Basic pricing information for all units of a product.

Purchase.PaidOrderNotification.YourPrice.ProductTotalPrice.NetPrice

string

Price for all units of a product, not including taxes.

Purchase.PaidOrderNotification.YourPrice.ProductTotalPrice.VatPrice

string

Taxes for all units of a product.

Purchase.PaidOrderNotification.YourPrice.ProductTotalPrice.GrossPrice

string

Price for all units of a product, including taxes.

Purchase.PaidOrderNotification.YourPrice.ProductTotalPrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.YourPrice.TotalSinglePrice

object

Complete pricing information for one unit.

Purchase.PaidOrderNotification.YourPrice.TotalSinglePrice.NetPrice

string

Price for one unit of a product, not including taxes.

Purchase.PaidOrderNotification.YourPrice.TotalSinglePrice.VatPrice

string

Taxes for one unit of a product.

Purchase.PaidOrderNotification.YourPrice.TotalSinglePrice.GrossPrice

string

Price for one unit of a product, including taxes.

Purchase.PaidOrderNotification.YourPrice.TotalSinglePrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.YourPrice.TotalTotalPrice

object

Complete pricing information for all units of a product.

Purchase.PaidOrderNotification.YourPrice.TotalTotalPrice.NetPrice

string

Price for all units of a product, not including taxes.

Purchase.PaidOrderNotification.YourPrice.TotalTotalPrice.VatPrice

string

Taxes for all units of a product.

Purchase.PaidOrderNotification.YourPrice.TotalTotalPrice.GrossPrice

string

Price for all units of a product, including taxes.

Purchase.PaidOrderNotification.YourPrice.TotalTotalPrice.VatPercentage

string

Tax rate (percentage).

Purchase.PaidOrderNotification.Deliveries.Key

object

Information about a delivery

Purchase.PaidOrderNotification.Deliveries.Key.DeliveryType

string

The way in which the purchase item was delivered. This field corresponds to the Products > Delivery > Delivery > Delivery type field in the Commerce Assistant.

Purchase.PaidOrderNotification.Deliveries.Key.DeliveryTypeId

string

ID that corresponds to the DeliveryType.

Purchase.PaidOrderNotification.Deliveries.Key.Key

string

License key specifications and delivery message (if applicable).

Purchase.PaidOrderNotification.Deliveries.Key.KeyRaw

string

License key specifications..