For the complete documentation index, see llms.txt. This page is also available as Markdown.

ProductInfo object structure

Parameters

Parameter
Type / Description

SimpleProduct

Object

Product object with the structure detailed below.

SimpleProduct.LongDescription

Optional (string)

The product's long description.

SystemRequirements

String

Localized system requirements.

SystemRequirements.Platforms

Optional (array of Platform objects)

An array of objects detailing the platforms supported by the application.

SystemRequirements.URLImage

String

The location of the image in the 2Checkout system.

SystemRequirements.TrialURL

String

The trial URL for users speaking the language corresponding to the Translation object.

SystemRequirements.TrialDescription

Optional (string)

Descriptive text entered for trials.

SystemRequirements.AdditionalInfo

NULL

Additional information about the product.

SystemRequirements.RenewalProductID

Int

The product renewal ID.

SystemRequirements.ProductId

String

Unique, system-generated product ID.

SystemRequirements.ProductCode

String

Editable product code that you control.

SystemRequirements.ProductName

String

Editable product name.

SystemRequirements.ProductVersion

Optional (string)

The product version number.

SystemRequirements.ProductStatus

Boolean

The status of the product. Enabled if TRUE, disabled if FALSE.

SystemRequirements.ProductType

Optional (string)

REGULAR or BUNDLE. Defaults to REGULAR.

SystemRequirements.Currency

String

The currency ISO code used for shipping costs - ISO 4217.

SystemRequirements.Currency.DefaultCurrency

String

The ISO code of the default currency for the pricing configuration.

SystemRequirements.Price

String

The product price.

SystemRequirements.GiftOption

Optional (boolean)

True or false depending on whether the product can be gifted or not.

SystemRequirements.IdGroup

String

The ID of the product group.

SystemRequirements.GroupName

Optional (string)

The name of the Product Group to which the product belongs.

SystemRequirements.ShortDescription

Optional (string)

The product's short description.

SystemRequirements.ProductImage

NULL

Image object.

SystemRequirements.Languages

Array

An array of objects detailing the languages supported by the application.

SystemRequirements.PriceIntervals

NULL

SystemRequirements.PriceType

String

Possible values: NET / GROSS.

SystemRequirements.PriceSchema

String

DYNAMIC

SystemRequirements.PriceOptions

Array of AssignedPriceOptionGroup objects

PriceOptionsGroupItem object with the structure detailed below.

SystemRequirements.PriceOptions.id

String

Price option identifier.

SystemRequirements.PriceOptions.Name

String

Pricing configuration name.

SystemRequirements.PriceOptions.Description

String

Description of the pricing option.

SystemRequirements.PriceOptions.Required

Boolean

True or false depending on whether the assigned product field is required or not.

SystemRequirements.PriceOptions.Type

String

The type of pricing option.

SystemRequirements.PriceOptions.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.

Last updated

Was this helpful?