ProductInfo Object Structure
Parameters
Parameter | Type/Description | ||
---|---|---|---|
SimpleProduct | Object | ||
Product object with the structure detailed below. | |||
LongDescription |
String/Optional
The product's long description. |
||
SystemRequirements |
String
Localized system requirements. |
||
Platforms |
Array of Platform objects/Optional
An array of objects detailing the platforms supported by the application. |
||
URLImage |
String
The location of the image in the 2Checkout system. |
||
TrialURL |
String
The trial URL for users speaking the language corresponding to the Translation object. |
||
TrialDescription |
String/Optional
Descriptive text entered for trials. |
||
AdditionalInfo |
NULL
Additional information about the product. |
||
RenewalProductID |
Int
The product renewal ID. |
||
ProductId |
String
Unique, system-generated product ID. |
||
ProductCode |
String
Editable product code that you control. |
||
ProductName |
String
Editable product name. |
||
ProductVersion |
String/Optional
The product version number. |
||
ProductStatus |
Boolean
The status of the product. Enabled if TRUE, disabled if FALSE. |
||
ProductType |
String/Optional
REGULAR or BUNDLE Defaults to REGULAR. |
||
Currency |
String
The currency ISO code used for shipping costs - ISO 4217. |
||
DefaultCurrency |
String
The ISO code of the default currency for the pricing configuration. |
||
Price |
String
The product price. |
||
GiftOption |
Boolean/Optional
TRUE or FALSE depending on whether the product can be gifted or not. |
||
IdGroup |
String
The ID of the product group. |
||
GroupName |
String/Optional
The name of the Product Group to which the product belongs. |
||
ShortDescription |
String/Optional
The product's short description. |
||
ProductImage |
NULL
Image object. |
||
Languages |
Array
An array of objects detailing the languages supported by the application. |
||
PriceIntervals |
NULL
|
||
PriceType |
String
Possible values: NET/GROSS. |
||
PriceSchema |
String
DYNAMIC |
||
PriceOptions |
Array of AssignedPriceOptionGroup objects
PriceOptionsGroupItem object with the structure detailed below. |
||
Id |
String
Price option identifier. |
||
Name |
String
Pricing configuration name. |
||
Description |
String
Description of the pricing option. |
||
Required |
Boolean
TRUE or FALSE depending on whether the assigned product field is required or not. |
||
Type |
String
The type of pricing option. |
||
Options |
Array of strings
The pricing options group option code you configured that the 2Checkout system uses to calculate product prices for pricing configurations without a base price. |