Catalog order session content object

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Overview

Use this object to retrieve session content and to guide shoppers through advanced payment flows, such as those of PayPal, PayPal Express, Wire, Check, etc.

Attributes

Order session contents
Errors				Optional (StringArray)
				Payment gateway processing errors.
Items				Array of objects
				Details below.
	ProductDetails			Object
				Details below.
		Name		Optional (string)
				Product name.
		ExtraInfo		Optional (string)
				The text entered in the Additional information field when generating Buy links, or via the INFO[PRODUCT_ID] parameter used in Buy links.
		RenewalStatus		Optional (boolean)
				true for orders renewing subscriptions. false for all other orders: new purchases, upgrades.
		Subscriptions		Object
				Details below.
			SubscriptionReference	Optional (string)
				Unique, system-generated subscription identifier.
			PurchaseDate	Optional (string)
				The date time stamp when shoppers acquired their subscriptions corresponding to the moment when the Avangate system marks the purchase as finished. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00. e.g. 2015-08-11 15:18:52
			SubscriptionStartDate	Optional (string)
				Example: 2015-09-29 17:57:59
			ExpirationDate	Optional (string)
				The date time stamp of upcoming renewal/expiration for subscriptions not taking into account grace period settings. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00. e.g. 2015-09-11 15:18:52
			Lifetime	Optional (boolean)
				true – For non-recurring, evergreen subscriptions. false – For recurring subscriptions with a specific billing cycle from 7 days to 36 months.
			Trial	Optional (boolean)
				true – For trial subscriptions. false – For non-trial, recurring subscriptions with a specific billing cycle from 7 days to 36 months.
			Enabled	Optional (boolean)
				true – For active and past due subscriptions. false – For expired and cancelled subscriptions.
			RecurringEnabled	Optional (boolean)
				true - customers opted for subscriptions to renew automatically when they expire. false - customers did not choose to renew the subscription automatically.
	PriceOptions			Optional (Array of strings)
				Product price options.
	Price			Object
				This object returns the price per unit at order line level. In the case of trials, the object returns the costs for the trial to full subscription conversion.
		UnitNetPrice		Optional (double)
				The value per product unit, excluding sales tax/VAT expressed in the payment currency.
		UnitGrossPrice		Optional (double)
				Total value per product unit, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
		UnitVAT		Optional (double)
				Sales tax/VAT per product unit expressed in the payment currency.
		UnitDiscount		Optional (double)
				Value of the discount per product unit expressed in the payment currency.
		UnitNetDiscountedPrice		Optional (double)
				The value per product unit, expressed in the payment currency, excluding sales tax/VAT, from which Avangate deducts the unit discount.
		UnitGrossDiscountedPrice		Optional (double)
				Total costs shoppers incur per product unit, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts.
		UnitAffiliateCommission		Optional (double)
				Value of the affiliate commission per product unit calculated expressed in the payment currency. Avangate deducts discounts from the costs incurred by shoppers before calculating affiliate commissions. Avangate does not take into account shipping costs when calculating affiliate commissions. NULL when Avangate does not apply an affiliate commission.
		Currency		Optional (string)
				The currency ISO code for the payment - ISO 4217. Example: usd.
		NetPrice		Optional (double)
				The value per order line, excluding sales tax/VAT expressed in the payment currency.
		GrossPrice		Optional (double)
				Total value per order line, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
		NetDiscountedPrice		Optional (double)
				The NetPrice value per order line, excluding sales tax/VAT, from which Avangate deducts discounts. NetDiscountedPrice is expressed in the payment currency.
		GrossDiscountedPrice		Optional (double)
				Total costs shoppers incur per order line, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts. Example: UnitNetPrice: 99 UnitGrossPrice: 120.39 UnitVAT: 21.39 UnitDiscount: 9.9 UnitNetDiscountedPrice: 89.1 UnitGrossDiscountedPrice: 110.49 UnitAffiliateCommission: 22.28 Currency: "usd" NetPrice: 198 GrossPrice: 240.77 NetDiscountedPrice: 178.2 GrossDiscountedPrice: 220.97 Discount: 19.8 VAT: 42.77 AffiliateCommission: 44.56
		Discount		Optional (double)
				Value of the discounts per order line expressed in the payment currency.
		VAT		Optional (double)
				Value of sales tax/VAT per order line expressed in the payment currency.
		AffiliateCommission		Optional (double)
				Value of the affiliate commission per order line, calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. Avangate does not take into account shipping costs when calculating affiliate commissions.
	Code			Optional (string)
				Unique product identifier your control. Max length 256 characters.
	Quantity			Optional (integer)
				Number of units
	SKU			Optional (string)
				SKU identifier.
	CrossSell			Optional (Object)
				Details below.
		ParentCode		Optional (string)
				The product code of the master product you set to trigger the campaign.
		CampaignCode		Optional (string)
				Unique, system-generated identifier for cross-sell campaigns.
	Trial			Optional (Object)
				Details below.
		Period		Optional (integer)
				The length of the trial subscription lifetime in days.
		GrossPrice		Optional (double)
				Total trial price in the payment currency before Avangate deducts any taxes, discounts, etc.
		VAT		Optional (double)
				The total value of taxes for the trial in the payment currency, before Avangate deducts any discounts.
		NetPrice		Optional (double)
				Total trial price in the payment currency, not including taxes, before Avangate deducts any discounts.
	AdditionalFields			Optional (array of objects)
				Details below.
		Code		Optional (string)
				The alpha-numeric characters, underscores and dashes that are set as the field identifier.
		Text		Optional (string)
				Field text visible to shoppers in the cart.
		Value		Optional (string)
				Selected field value.
	Promotion			Optional (object)
				Details below.
		Name		Optional (string)
				Promotion name.
		Description		Optional (string)
				Promotion description.
		StartDate		Optional (string)
				The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
		EndDate		Optional (string)
				The date when you set the promotion to end. NULL for promotions you want active indefinitely.
		MaximumOrdersNumber		Optional (integer)
				Avangate only applies the promotion to a maximum number of orders you define. Can be NULL if you want the promotion to apply to an unlimited number of orders.
		MaximumQuantity		Optional (integer)
				Discount only applies to a maximum number of units purchased through a single order, smaller than the quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
		InstantDiscount		Optional (boolean)
				The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
		Coupon		Optional (string)
				Promotion coupon/voucher.
		DiscountLabel		Optional (string)
				Discounts can be set as a percentage from the product price or as a fixed amount in the chosen currency.
		Enabled		Optional (string)
				true or false, depending on whether a promotion is active or disabled.
		Type		Optional (string)
				REGULAR – product/cart line level discounts. ORDER – quantity discounts. GLOBAL – order-level discounts.
Promotions				Optional (Array of objects)
				Details below.
	Name			Optional (string)
				Promotion name.
	Description			Optional (string)
				Promotion description.
	StartDate			Optional (string)
				The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
	EndDate			Optional (string)
				The date when you set the promotion to end. NULL for promotions you want active indefinitely.
	MaximumOrdersNumber			Optional (integer)
				Avangate only applies the promotion to a maximum number of orders you define. Can be NULL if you want the promotion to apply to an unlimited number of orders.
	MaximumQuantity			Optional (integer)
				Discount only applies to a specific number of units purchased at once, smaller than the maximum quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
	InstantDiscount			Optional (boolean)
				The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
	Coupon			Optional (string)
				Promotion coupon/voucher.
	DiscountLabel			Optional (string)
				Discounts can be set as a percentage from the product price or as a fixed amount in the payment currency.
	Enabled			Optional (string)
				true or false, depending on whether a promotion is active or disabled.
	Type			Optional (string)
				REGULAR – product/cart line level discounts. ORDER – quantity discounts. GLOBAL – order-level discounts.
AdditionalFields				Optional (array of objects)
				Details below.
	Code			Optional (string)
				The alpha-numeric characters, underscores and dashes that are set as the field identifier.
	Text			Optional (string)
				Field text visible to shoppers in the cart.
	Value			Optional (string)
				Selected field value.
Currency				Optional (string)
				The currency ISO code for the payment - ISO 4217. Example: usd.
NetPrice				Optional (double)
				Order value excluding sales tax/VAT expressed in the payment currency.
GrossPrice				Optional (double)
				Total order value, including sales tax/VAT expressed in the payment currency. GrossPrice does not reflect any discounts.
NetDiscountedPrice				Optional (double)
				The NetPrice order value excluding sales tax/VAT, from which Avangate deducts discounts. NetDiscountedPrice is expressed in the payment currency.
GrossDiscountedPrice				Optional (double)
				Total costs shoppers incur, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts. For example: Currency: "usd" NetPrice: 396 GrossPrice: 486.29 NetDiscountedPrice: 376.2 GrossDiscountedPrice: 466.49 Discount: 19.8 VAT: 90.29 AffiliateCommission: 94.05
Discount				Optional (double)
				Value of the discounts for an order expressed in the payment currency.
VAT				Optional (double)
				Value of sales tax/VAT expressed in the payment currency.
AffiliateCommission				Optional (double)
				Value of the affiliate commission for the order calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. Avangate does not take into account shipping costs when calculating affiliate commissions.