Order session content
Overview
The object below is returned directly or within a successful response from the following API requests:
Retrieve session content Retrieve contents with prefill Retrieve VAT or sales tax
Session contents object
Parameters | Type/Description | ||||
---|---|---|---|---|---|
Errors |
|
Array of strings | |||
|
|
Payment gateway processing errors. | |||
Items |
Array of objects |
||||
Details below. | |||||
|
ProductDetails |
Object |
|||
Details below. | |||||
|
|
Name |
String |
||
|
|
|
Product name. |
||
ShortDescription | String | ||||
Product short description. | |||||
Tangible | Boolean | ||||
Possible values:
|
|||||
IsDynamic | Boolean | ||||
Possible values:
|
|||||
|
|
ExtraInfo |
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 |
Boolean |
||
|
|
|
|
||
|
|
Subscriptions |
Object |
||
Details below. | |||||
|
|
|
SubscriptionReference |
String |
|
|
|
|
|
Unique, system-generated subscription identifier. |
|
|
|
|
PurchaseDate |
String | |
|
|
|
|
The date time stamp when shoppers acquired their subscriptions corresponding to the moment when the 2Checkout 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 |
String | |
|
|
|
|
Example: 2015-09-29 17:57:59 |
|
|
|
|
ExpirationDate |
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 |
Boolean |
|
|
|
|
|
|
|
|
|
|
Trial |
Boolean | |
|
|
|
|
|
|
|
|
|
Enabled |
Boolean | |
|
|
|
|
|
|
|
|
|
RecurringEnabled |
Boolean | |
|
|
|
|
|
|
|
PriceOptions |
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 |
Float |
||
|
|
|
The value per product unit, excluding sales tax/VAT expressed in the payment currency. |
||
|
|
UnitGrossPrice |
Float | ||
|
|
|
Total value per product unit, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts. |
||
|
|
UnitVAT |
Int | ||
|
|
Sales tax/VAT per product unit expressed in the payment currency. |
|||
|
|
UnitDiscount |
Int | ||
|
|
|
Value of the discount per product unit expressed in the payment currency. |
||
|
|
UnitNetDiscountedPrice |
Float |
||
|
|
|
The value per product unit, expressed in the payment currency, excluding sales tax/VAT, from which 2Checkout deducts the unit discount. |
||
|
|
UnitGrossDiscountedPrice |
Float |
||
|
|
|
Total costs shoppers incur per product unit, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts. |
||
|
|
UnitAffiliateCommission |
Int |
||
|
|
|
Value of the affiliate commission per product unit calculated expressed in the payment currency.
2Checkout deducts discounts from the costs incurred by shoppers before calculating affiliate commissions.
2Checkout does not take into account shipping costs when calculating affiliate commissions.
NULL when 2Checkout does not apply an affiliate commission. |
||
VATPercent | Int | ||||
Percentage of VAT charged on the order. | |||||
HandlingFeeNetPrice | Int | ||||
Handling fee applied to your net price configuration. | |||||
HandlingFeeGrossPrice | Int | ||||
Handling fee applied to your gross price configuration. | |||||
|
|
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 2Checkout 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, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts.
Example:
|
||
|
|
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. 2Checkout does not take into account shipping costs when calculating affiliate commissions. |
||
LineItemReference | String | ||||
System-generated item reference. | |||||
PurchaseType | String | ||||
Possible values:
|
|||||
ExternalReference | String | ||||
External order reference that you control. | |||||
|
Code |
String |
|||
|
|
Unique product identifier your control. Max length 256 characters. |
|||
|
Quantity |
Int |
|||
|
|
Number of units |
|||
|
SKU |
String |
|||
|
|
SKU identifier. |
|||
|
CrossSell |
Object |
|||
Details below. | |||||
|
|
ParentCode |
String |
||
|
|
|
The product code of the master product you set to trigger the campaign. |
||
|
|
CampaignCode |
String |
||
|
|
|
Unique, system-generated identifier for cross-sell campaigns. |
||
|
Trial |
Object |
|||
Details below. | |||||
|
|
Period |
Int |
||
|
|
|
The length of the trial subscription lifetime in days. |
||
|
|
GrossPrice |
Float |
||
|
|
|
Total trial price in the payment currency before 2Checkout deducts any taxes, discounts, etc. |
||
|
|
VAT |
Float |
||
|
|
|
The total value of taxes for the trial in the payment currency, before 2Checkout deducts any discounts. |
||
|
|
NetPrice |
Float |
||
|
|
|
Total trial price in the payment currency, not including taxes, before 2Checkout deducts any discounts. |
||
|
AdditionalFields |
Array of objects |
|||
Details below. | |||||
|
|
Code |
String |
||
|
|
|
The alpha-numeric characters, underscores and dashes that are set as the field identifier. |
||
|
|
Text |
String |
||
|
|
|
Field text visible to shoppers in the cart. |
||
|
|
Value |
String |
||
|
|
|
Selected field value. |
||
|
Promotion |
Object |
|||
Details below. | |||||
|
|
Name |
String |
||
|
|
|
Promotion name. |
||
|
|
Description |
String | ||
|
|
|
Promotion description. |
||
|
|
StartDate |
String | ||
|
|
|
The date when you set the promotion to start. NULL for promotions that start immediately after you create them. |
||
|
|
EndDate |
String | ||
|
|
|
The date when you set the promotion to end. NULL for promotions you want active indefinitely. |
||
|
|
MaximumOrdersNumber |
Int |
||
|
|
|
2Checkout 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 |
Int |
||
|
|
|
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 |
Boolean |
||
|
|
|
The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon. |
||
|
|
Coupon |
String |
||
|
|
|
Promotion coupon/voucher. |
||
|
|
DiscountLabel |
String | ||
|
|
|
Discounts can be set as a percentage from the product price or as a fixed amount in the chosen currency. |
||
|
|
Enabled |
String | ||
|
|
|
true or false, depending on whether a promotion is active or disabled. |
||
|
|
Type |
String | ||
|
|
|
|
||
Promotions |
Array of objects |
||||
Details below. | |||||
|
Name |
String |
|||
|
|
Promotion name. |
|||
|
Description |
String | |||
|
|
Promotion description. |
|||
|
StartDate |
String | |||
|
|
The date when you set the promotion to start. NULL for promotions that start immediately after you create them. |
|||
|
EndDate |
String | |||
|
|
The date when you set the promotion to end. NULL for promotions you want active indefinitely. |
|||
|
MaximumOrdersNumber |
Int |
|||
|
|
2Checkout 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 |
Int |
|||
|
|
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 |
Boolean |
|||
|
|
The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon. |
|||
|
Coupon |
String |
|||
|
|
Promotion coupon/voucher. |
|||
|
DiscountLabel |
String |
|||
|
|
Discounts can be set as a percentage from the product price or as a fixed amount in the payment currency. |
|||
|
Enabled |
String |
|||
|
|
true or false, depending on whether a promotion is active or disabled. |
|||
|
Type |
String |
|||
|
|
|
|||
AdditionalFields |
Array of objects |
||||
Details below. | |||||
|
Code |
String |
|||
|
|
The alpha-numeric characters, underscores and dashes that are set as the field identifier. |
|||
|
Text |
String |
|||
|
|
Field text visible to shoppers in the cart. |
|||
|
Value |
String |
|||
|
|
Selected field value. |
|||
BillingDetails |
Object Details below |
||||
Person |
Object Details below |
||||
FirstName | String | ||||
Customer first billing name. | |||||
LastName | String | ||||
Customer last billing name. | |||||
CountryCode | String | ||||
Two-letters code for customer billing country. | |||||
State | String | ||||
Customer billing state. | |||||
City | String | ||||
Customer billing city. | |||||
Address1 | String | ||||
Customer billing address. | |||||
Address2 | String | ||||
Customer additional address information. | |||||
Zip | String | ||||
Customer billing zip code. | |||||
String | |||||
Customer billing email. | |||||
Phone | String | ||||
Customer billing phone. | |||||
Company | String | ||||
Customer billing company. | |||||
FiscalCode | String | ||||
Customer billing fiscal code. | |||||
DeliveryDetails |
Object Details below |
||||
Person |
Object Details below |
||||
Phone | String | ||||
Customer delivery phone number. | |||||
FirstName | String | ||||
Customer delivery first name. | |||||
LastName | String | ||||
Customer delivery last name. | |||||
Company | String | ||||
Customer delivery company. | |||||
String | |||||
Customer delivery email. | |||||
Address1 | String | ||||
Customer delivery address. | |||||
Address2 | String | ||||
Customer additional delivery address. | |||||
City | String | ||||
Customer delivery city. | |||||
Zip | String | ||||
Customer delivery zip code. | |||||
CountryCode | String | ||||
Customer delivery country code. | |||||
State | String | ||||
Customer delivery state. | |||||
DeliveryInformation |
Object Details below |
||||
ShippingMethod |
Object Details below |
||||
Code | String | ||||
System-generated code assigned to the shipping method. | |||||
TrackingURL | String | ||||
Tracking URL assigned to the shipping method. | |||||
TrackingNumber | String | ||||
Tracking Number provided to customers, used for obtaining more information about their package. | |||||
Comment | String | ||||
Additional information regarding the physical delivery of the product. | |||||
Currency |
String |
||||
|
The currency ISO code for the payment - ISO 4217. Example: usd. |
||||
NetPrice |
Float |
||||
|
Order value excluding sales tax/VAT expressed in the payment currency. |
||||
GrossPrice |
Float | ||||
|
Total order value, including sales tax/VAT expressed in the payment currency. GrossPrice does not reflect any discounts. |
||||
NetDiscountedPrice |
Float | ||||
|
The NetPrice order value excluding sales tax/VAT, from which 2Checkout deducts discounts. NetDiscountedPrice is expressed in the payment currency. |
||||
GrossDiscountedPrice |
Float | ||||
|
Total costs shoppers incur, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts.
For example:
|
||||
Discount |
Float | ||||
|
Value of the discounts for an order expressed in the payment currency. |
||||
VAT |
Float | ||||
|
Value of sales tax/VAT expressed in the payment currency. |
||||
AffiliateCommission |
Float | ||||
|
Value of the affiliate commission for the order calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. 2Checkout does not take into account shipping costs when calculating affiliate commissions. |