Ctrlk
Sign up for free
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Product

Retrieve product info

get

Extract information about the products you configured for your account.

Query parameters
NamestringOptional

Product name. Can be NULL.

Example: Subscription
TypesstringOptional

Array of the values representing the type of products. Possible values: REGULAR or BUNDLE. Leave empty to have all product types returned to the search.Can be NULL. If NULL, 2Checkout returns both regular and bundle products.

Example: REGULAR
EnabledbooleanOptional

True or false. Can be NULL.

Example: true
ReviewStatusbooleanOptional

Can be 'Does not exist', 'Pending', 'In Review', 'Passed' or 'Rejected'.

Example: Passed
GroupNamestringOptional

The name of the group that the product is associated with. Can be NULL.

Example: General
LimitnumberOptional

Number of results (products) displayed per page. Default value is 10. Can be NULL.

Example: 10
PagenumberOptional

A specific page of search results. Default value is 1. Can be NULL.

Example: 1
Header parameters
Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Responses
200

OK

application/json
AvangateIdinteger · nullableOptional

Unique, system-generated product ID (read-only)

ProductCodestringOptional

The unique product code you can define for each of your offerings

ExternalReferencestringOptional

External reference set when defining the product

ProductTypestring · enumOptional

The type of the product (REGULAR or BUNDLE)

Default: REGULARPossible values:
ProductNamestringOptional

The name of the product

ProductVersionstringOptional

The product version number

PurchaseMultipleUnitsbooleanOptional

Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product

Default: true
GiftOptionbooleanOptional

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

Default: false
ShortDescriptionstringOptional

Product's short description

Default: ""
LongDescriptionstringOptional

Product's long description

Default: ""
SystemRequirementsstringOptional

System requirements

Default: ""
ProductCategoryone ofOptional

Product's category name

stringOptional
or
booleanOptionalDefault: false
TrialUrlstringOptional

The URL where shoppers can download trial software from

Default: ""
TrialDescriptionstringOptional

Descriptive text entered for trials

Default: ""
TangiblebooleanOptional

TRUE - for physical products, FALSE - for digital products

EnabledbooleanOptional

True/false depending on whether the products are active or disabled

Default: false
ReviewProductUrlbooleanOptional

The URL where the product can be reviewed before approval. Required if the "Enabled" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation.

Default: ""
ReviewAdditionalDetailsbooleanOptional

Additional information can be added to access the review of the product. Parameter is optional.

Default: ""
Fulfillmentstring · enumOptional

Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY

Possible values:
GeneratesSubscriptionbooleanOptional

TRUE or FALSE depending on whether you set the product to generate subscriptions or not

Default: false
get/products/
GET /rest/6.0/products/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

{
  "AdditionalFields": [
    {
      "Code": "HiddenID123",
      "Enabled": true,
      "Label": "CustomField",
      "Required": false,
      "URLParameter": "ADDITIONAL_HiddenID123[4639321]"
    }
  ],
  "AvangateId": "4639321",
  "BundleProducts": [],
  "Enabled": true,
  "ReviewStatus": "Passed",
  "Fulfillment": "BY_AVANGATE",
  "FulfillmentInformation": {
    "AdditionalInformationByEmail": "Dear <--{FIRST_NAME}--><--{LAST_NAME}-->,\n\nThank you for your purchase <--{REFNO}-->!<--{PRODUCTNAME}-->. Check for more details at: <--{EMAIL}-->\n\nBest,\nCompany",
    "AdditionalInformationEmailTranslations": [
      {
        "Description": "<--{FIRST_NAME}--><--{LAST_NAME}--> ??????!",
        "Language": "ZH"
      }
    ],
    "AdditionalThankYouPage": "&lt;--{FIRST_NAME}--&gt;&lt;--{LAST_NAME}--&gt; thank you for your purchase &lt;--{REFNO}--&gt;!&lt;--{PRODUCTNAME}--&gt;. Check for more details at: &lt;--{EMAIL}--&gt;\n",
    "AdditionalThankYouPageTranslations": [
      {
        "Description": "<--{FIRST_NAME}--><--{LAST_NAME}--> ??????!",
        "Language": "ZH"
      }
    ],
    "BackupMedia": {
      "Code": "F9C9B37F86",
      "Name": "Backup USB Static",
      "Type": "USB"
    },
    "CodeList": {
      "Code": "5C6F821DA1",
      "Name": "General delivery",
      "Type": "STATIC"
    },
    "IsBackupMedia": true,
    "IsDisplayInPartnersCPanel": false,
    "IsDownloadInsuranceService": false,
    "IsDownloadLink": true,
    "IsElectronicCode": true,
    "IsInstantDeliveryThankYouPage": true,
    "IsStartAfterFulfillment": false,
    "ProductFile": {
      "Code": "223648A847",
      "File": "challenge_accepted.jpg",
      "LastUpdate": "2014-07-21 13:35:29",
      "Name": "TestProductFile",
      "Size": "40436",
      "Type": "image/jpeg",
      "Version": "1.0"
    }
  },
  "GeneratesSubscription": true,
  "GiftOption": false,
  "GroupName": "General",
  "LongDescription": "\r\n\t<span style=\"color: rgb(0, 0, 0); font-family: Arial, Helvetica, sans; font-size: 11px; line-height: 14px; text-align: justify;\">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec maximus orci a nulla dignissim, ut egestas nunc blandit. Nunc porta lorem sed dui placerat lobortis. Suspendisse rutrum justo enim, et mattis ex convallis at. Nullam vehicula justo nunc, non maximus purus pharetra a. Ut ipsum velit, efficitur ac laoreet a, pellentesque et lorem. Morbi ac nibh ut lectus tempus ullamcorper tincidunt in justo. Aenean viverra euismod cursus. Donec rhoncus laoreet ligula nec euismod.",
  "Platforms": [
    {
      "Category": "Mobile",
      "IdPlatform": "23",
      "PlatformName": "Android"
    },
    {
      "Category": "Mobile",
      "IdPlatform": "20",
      "PlatformName": "iPhone"
    },
    {
      "Category": "Desktop",
      "IdPlatform": "32",
      "PlatformName": "Windows 10"
    }
  ],
  "Prices": [],
  "PricingConfigurations": [
    {
      "Code": "54DCBC3DC8",
      "Default": true,
      "DefaultCurrency": "USD",
      "Name": "2Checkout Subscription's Price Configuration Marius",
      "PriceOptions": [
        {
          "Code": "SUPPORT",
          "Required": true
        },
        {
          "Code": "USERS",
          "Required": true
        },
        {
          "Code": "BACKUP",
          "Required": false
        }
      ],
      "PriceType": "NET",
      "Prices": {
        "Regular": [
          {
            "Amount": 99,
            "Currency": "USD",
            "MaxQuantity": "99999",
            "MinQuantity": "1",
            "OptionCodes": []
          },
          {
            "Amount": 0,
            "Currency": "EUR",
            "MaxQuantity": "99999",
            "MinQuantity": "1",
            "OptionCodes": []
          }
        ],
        "Renewal": []
      },
      "PricingSchema": "DYNAMIC"
    }
  ],
  "ProductCategory": "Audio & Video",
  "ProductCode": "my_subscription_1",
  "ProductImages": [
    {
      "Default": true,
      "URL": "https://store.avancart.com/images/merchant/ef0b9a69f90b1ab0228784ccc7d52136/products/box-2.jpg"
    }
  ],
  "ProductName": "2Checkout Subscription",
  "ProductType": "REGULAR",
  "ProductVersion": "1.0",
  "PurchaseMultipleUnits": true,
  "ShippingClass": {
    "Amount": "0.00",
    "Currency": "USD",
    "Name": "Electronic",
    "Type": "N/A"
  },
  "ShortDescription": "\r\n\tLorem ipsum dolor sit amet, consectetur adipiscing elit. Donec maximus orci a nulla dignissim, ut egestas nunc blandit.&nbsp;",
  "SubscriptionInformation": {
    "BillingCycle": "1",
    "BillingCycleUnits": "M",
    "BundleRenewalManagement": "GLOBAL",
    "ContractPeriod": {
      "Action": "RESTART",
      "EmailsDuringContract": true,
      "IsUnlimited": true,
      "Period": -1
    },
    "DeprecatedProducts": [],
    "GracePeriod": {
      "IsUnlimited": false,
      "Period": "7",
      "PeriodUnits": "D",
      "Type": "CUSTOM"
    },
    "IsOneTimeFee": false,
    "RenewalEmails": {
      "Settings": {
        "AutomaticRenewal": {
          "After15Days": false,
          "After5Days": false,
          "Before15Days": false,
          "Before1Day": false,
          "Before30Days": false,
          "Before7Days": true,
          "OnExpirationDate": true
        },
        "ManualRenewal": {
          "After15Days": false,
          "After5Days": false,
          "Before15Days": false,
          "Before1Day": false,
          "Before30Days": false,
          "Before7Days": true,
          "OnExpirationDate": true
        }
      },
      "Type": "CUSTOM"
    },
    "UsageBilling": 0
  },
  "SystemRequirements": "",
  "Translations": [
    {
      "Description": "?????",
      "Language": "ZH",
      "LongDescription": "?????",
      "Name": "????????"
    }
  ],
  "TrialDescription": "",
  "TrialUrl": ""
}

Add a product

post

Use the Product object to create/add, update/edit and retrieve products for your account. You cannot set a group name when creating a new product. You can control:

  • Product information

  • Pricing

  • Subscription plan settings and renewal configuration

  • Subscription plan recurring billing

  • Fulfillment

  • Shipping classes

  • Localization

Header parameters
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Acceptstring · enumRequiredExample: application/jsonPossible values:
Body
AvangateIdinteger · nullableOptional

Unique, system-generated product ID (read-only)

ProductCodestringRequired

The unique product code you can define for each of your offerings

ExternalReferencestringOptional

External reference set when defining the product

ProductTypestring · enumOptional

The type of the product (REGULAR or BUNDLE)

Default: REGULARPossible values:
ProductNamestringRequired

The name of the product

ProductVersionstringOptional

The product version number

PurchaseMultipleUnitsbooleanOptional

Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product

Default: true
GiftOptionbooleanOptional

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

Default: false
ShortDescriptionstringOptional

Product's short description

Default: ""
LongDescriptionstringOptional

Product's long description

Default: ""
SystemRequirementsstringOptional

System requirements

Default: ""
ProductCategoryone ofOptional

Product's category name

stringOptional
or
booleanOptionalDefault: false
TrialUrlstringOptional

The URL where shoppers can download trial software from

Default: ""
TrialDescriptionstringOptional

Descriptive text entered for trials

Default: ""
TangiblebooleanOptional

TRUE - for physical products, FALSE - for digital products

EnabledbooleanOptional

True/false depending on whether the products are active or disabled

Default: false
ReviewProductUrlbooleanOptional

The URL where the product can be reviewed before approval. Required if the "Enabled" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation.

Default: ""
ReviewAdditionalDetailsbooleanOptional

Additional information can be added to access the review of the product. Parameter is optional.

Default: ""
Fulfillmentstring · enumOptional

Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY

Possible values:
GeneratesSubscriptionbooleanOptional

TRUE or FALSE depending on whether you set the product to generate subscriptions or not

Default: false
Responses
201

Created

No content
post/products/
POST /rest/6.0/products/ HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 569

{
  "ProductCode": "PRODUCT_CODE",
  "ProductName": "PRODUCT_NAME",
  "Enabled": true,
  "ReviewProductUrl": "https://ProductURLToBeReviewed.com",
  "ReviewAdditionalDetails": "Additional info if required to access the review URL",
  "ProductImages": [
    {
      "Default": true,
      "URL": "https://store.avancart.com/images/merchant/ef0b9a69f90b1ab0228784ccc7d52136/products/box-2.jpg"
    }
  ],
  "PricingConfigurations": [
    {
      "Code": "CE9CBA3B37",
      "Name": "genericPC",
      "PricingSchema": "FLAT",
      "PriceType": "NET",
      "DefaultCurrency": "EUR",
      "Prices": {
        "Regular": [
          {
            "Amount": 100,
            "Currency": "USD",
            "MinQuantity": 1,
            "MaxQuantity": 10
          }
        ]
      }
    }
  ]
}
No content

Retrieve product info by code

get

Extract product information using the unique identifier you assign to products.

Path parameters
ProductCodestringRequired

The editable code that you control at product-level, not the unique, system-generated product ID

Example: my_subscription_1
Header parameters
Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Responses
200

OK

application/json
AvangateIdinteger · nullableOptional

Unique, system-generated product ID (read-only)

ProductCodestringOptional

The unique product code you can define for each of your offerings

ExternalReferencestringOptional

External reference set when defining the product

ProductTypestring · enumOptional

The type of the product (REGULAR or BUNDLE)

Default: REGULARPossible values:
ProductNamestringOptional

The name of the product

ProductVersionstringOptional

The product version number

PurchaseMultipleUnitsbooleanOptional

Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product

Default: true
GiftOptionbooleanOptional

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

Default: false
ShortDescriptionstringOptional

Product's short description

Default: ""
LongDescriptionstringOptional

Product's long description

Default: ""
SystemRequirementsstringOptional

System requirements

Default: ""
ProductCategoryone ofOptional

Product's category name

stringOptional
or
booleanOptionalDefault: false
TrialUrlstringOptional

The URL where shoppers can download trial software from

Default: ""
TrialDescriptionstringOptional

Descriptive text entered for trials

Default: ""
TangiblebooleanOptional

TRUE - for physical products, FALSE - for digital products

EnabledbooleanOptional

True/false depending on whether the products are active or disabled

Default: false
ReviewProductUrlbooleanOptional

The URL where the product can be reviewed before approval. Required if the "Enabled" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation.

Default: ""
ReviewAdditionalDetailsbooleanOptional

Additional information can be added to access the review of the product. Parameter is optional.

Default: ""
Fulfillmentstring · enumOptional

Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY

Possible values:
GeneratesSubscriptionbooleanOptional

TRUE or FALSE depending on whether you set the product to generate subscriptions or not

Default: false
get/products/{ProductCode}/
GET /rest/6.0/products/{ProductCode}/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

{
  "AdditionalFields": [
    {
      "Code": "HiddenID123",
      "Enabled": true,
      "Label": "CustomField",
      "Required": false,
      "URLParameter": "ADDITIONAL_HiddenID123[4639321]"
    }
  ],
  "AvangateId": "4639321",
  "BundleProducts": [],
  "Enabled": true,
  "ReviewStatus": "Passed",
  "Fulfillment": "BY_AVANGATE",
  "FulfillmentInformation": {
    "AdditionalInformationByEmail": "Dear &lt;--{FIRST_NAME}--&gt;&lt;--{LAST_NAME}--&gt;,\n\nThank you for your purchase &lt;--{REFNO}--&gt;!&lt;--{PRODUCTNAME}--&gt;. Check for more details at: &lt;--{EMAIL}--&gt;\n\nBest,\nCompany",
    "AdditionalInformationEmailTranslations": [
      {
        "Description": "<--{FIRST_NAME}--><--{LAST_NAME}--> ??????!",
        "Language": "ZH"
      }
    ],
    "AdditionalThankYouPage": "&lt;--{FIRST_NAME}--&gt;&lt;--{LAST_NAME}--&gt; thank you for your purchase &lt;--{REFNO}--&gt;!&lt;--{PRODUCTNAME}--&gt;. Check for more details at: &lt;--{EMAIL}--&gt;\n",
    "AdditionalThankYouPageTranslations": [
      {
        "Description": "<--{FIRST_NAME}--><--{LAST_NAME}--> ??????!",
        "Language": "ZH"
      }
    ],
    "BackupMedia": {
      "Code": "F9C9B37F86",
      "Name": "Backup USB Static",
      "Type": "USB"
    },
    "CodeList": {
      "Code": "5C6F821DA1",
      "Name": "General delivery",
      "Type": "STATIC"
    },
    "IsBackupMedia": true,
    "IsDisplayInPartnersCPanel": false,
    "IsDownloadInsuranceService": false,
    "IsDownloadLink": true,
    "IsElectronicCode": true,
    "IsInstantDeliveryThankYouPage": true,
    "IsStartAfterFulfillment": false,
    "ProductFile": {
      "Code": "223648A847",
      "File": "challenge_accepted.jpg",
      "LastUpdate": "2014-07-21 13:35:29",
      "Name": "TestProductFile",
      "Size": "40436",
      "Type": "image/jpeg",
      "Version": "1.0"
    }
  },
  "GeneratesSubscription": true,
  "GiftOption": false,
  "GroupName": "General",
  "LongDescription": "\r\n\t<span style=\"color: rgb(0, 0, 0); font-family: Arial, Helvetica, sans; font-size: 11px; line-height: 14px; text-align: justify;\">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec maximus orci a nulla dignissim, ut egestas nunc blandit. Nunc porta lorem sed dui placerat lobortis. Suspendisse rutrum justo enim, et mattis ex convallis at. Nullam vehicula justo nunc, non maximus purus pharetra a. Ut ipsum velit, efficitur ac laoreet a, pellentesque et lorem. Morbi ac nibh ut lectus tempus ullamcorper tincidunt in justo. Aenean viverra euismod cursus. Donec rhoncus laoreet ligula nec euismod.",
  "Platforms": [
    {
      "Category": "Mobile",
      "IdPlatform": "23",
      "PlatformName": "Android"
    },
    {
      "Category": "Mobile",
      "IdPlatform": "20",
      "PlatformName": "iPhone"
    },
    {
      "Category": "Desktop",
      "IdPlatform": "32",
      "PlatformName": "Windows 10"
    }
  ],
  "Prices": [],
  "PricingConfigurations": [
    {
      "Code": "54DCBC3DC8",
      "Default": true,
      "DefaultCurrency": "USD",
      "Name": "2Checkout Subscription's Price Configuration Marius",
      "PriceOptions": [
        {
          "Code": "SUPPORT",
          "Required": true
        },
        {
          "Code": "USERS",
          "Required": true
        },
        {
          "Code": "BACKUP",
          "Required": false
        }
      ],
      "PriceType": "NET",
      "Prices": {
        "Regular": [
          {
            "Amount": 99,
            "Currency": "USD",
            "MaxQuantity": "99999",
            "MinQuantity": "1",
            "OptionCodes": []
          },
          {
            "Amount": 0,
            "Currency": "EUR",
            "MaxQuantity": "99999",
            "MinQuantity": "1",
            "OptionCodes": []
          }
        ],
        "Renewal": []
      },
      "PricingSchema": "DYNAMIC"
    }
  ],
  "ProductCategory": "Audio & Video",
  "ProductCode": "my_subscription_1",
  "ProductImages": [
    {
      "Default": true,
      "URL": "https://store.avancart.com/images/merchant/ef0b9a69f90b1ab0228784ccc7d52136/products/box-2.jpg"
    }
  ],
  "ProductName": "2Checkout Subscription",
  "ProductType": "REGULAR",
  "ProductVersion": "1.0",
  "PurchaseMultipleUnits": true,
  "ShippingClass": {
    "Amount": "0.00",
    "Currency": "USD",
    "Name": "Electronic",
    "Type": "N/A"
  },
  "ShortDescription": "\r\n\tLorem ipsum dolor sit amet, consectetur adipiscing elit. Donec maximus orci a nulla dignissim, ut egestas nunc blandit.&nbsp;",
  "SubscriptionInformation": {
    "BillingCycle": "1",
    "BillingCycleUnits": "M",
    "BundleRenewalManagement": "GLOBAL",
    "ContractPeriod": {
      "Action": "RESTART",
      "EmailsDuringContract": true,
      "IsUnlimited": true,
      "Period": -1
    },
    "DeprecatedProducts": [],
    "GracePeriod": {
      "IsUnlimited": false,
      "Period": "7",
      "PeriodUnits": "D",
      "Type": "CUSTOM"
    },
    "IsOneTimeFee": false,
    "RenewalEmails": {
      "Settings": {
        "AutomaticRenewal": {
          "After15Days": false,
          "After5Days": false,
          "Before15Days": false,
          "Before1Day": false,
          "Before30Days": false,
          "Before7Days": true,
          "OnExpirationDate": true
        },
        "ManualRenewal": {
          "After15Days": false,
          "After5Days": false,
          "Before15Days": false,
          "Before1Day": false,
          "Before30Days": false,
          "Before7Days": true,
          "OnExpirationDate": true
        }
      },
      "Type": "CUSTOM"
    },
    "UsageBilling": 0
  },
  "SystemRequirements": "",
  "Translations": [
    {
      "Description": "?????",
      "Language": "ZH",
      "LongDescription": "?????",
      "Name": "????????"
    }
  ],
  "TrialDescription": "",
  "TrialUrl": ""
}

Enable products

post

Enable products for your account.

Path parameters
ProductCodestringRequired

The editable code that you control at product-level, not the unique, system-generated product ID

Example: my_subscription_1
Header parameters
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Acceptstring · enumRequiredExample: application/jsonPossible values:
Body
AvangateIdinteger · nullableOptional

Unique, system-generated product ID (read-only)

ProductCodestringOptional

The unique product code you can define for each of your offerings

ExternalReferencestringOptional

External reference set when defining the product

ProductTypestring · enumOptional

The type of the product (REGULAR or BUNDLE)

Default: REGULARPossible values:
ProductNamestringOptional

The name of the product

ProductVersionstringOptional

The product version number

PurchaseMultipleUnitsbooleanOptional

Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product

Default: true
GiftOptionbooleanOptional

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

Default: false
ShortDescriptionstringOptional

Product's short description

Default: ""
LongDescriptionstringOptional

Product's long description

Default: ""
SystemRequirementsstringOptional

System requirements

Default: ""
ProductCategoryone ofOptional

Product's category name

stringOptional
or
booleanOptionalDefault: false
TrialUrlstringOptional

The URL where shoppers can download trial software from

Default: ""
TrialDescriptionstringOptional

Descriptive text entered for trials

Default: ""
TangiblebooleanOptional

TRUE - for physical products, FALSE - for digital products

EnabledbooleanOptional

True/false depending on whether the products are active or disabled

Default: false
ReviewProductUrlbooleanOptional

The URL where the product can be reviewed before approval. Required if the "Enabled" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation.

Default: ""
ReviewAdditionalDetailsbooleanOptional

Additional information can be added to access the review of the product. Parameter is optional.

Default: ""
Fulfillmentstring · enumOptional

Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY

Possible values:
GeneratesSubscriptionbooleanOptional

TRUE or FALSE depending on whether you set the product to generate subscriptions or not

Default: false
Responses
200

OK

application/json
post/products/{ProductCode}/
POST /rest/6.0/products/{ProductCode}/ HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 57

{
  "ReviewProductUrl": "https://ProductURLToBeReviewed.com"
}
{ 'TRUE' }

Update a product

put

Update/change the settings of a product you already configured for your account.

Path parameters
ProductCodestringRequired

The editable code that you control at product-level, not the unique, system-generated product ID

Example: my_subscription_1
Header parameters
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Acceptstring · enumRequiredExample: application/jsonPossible values:
Body
AvangateIdinteger · nullableOptional

Unique, system-generated product ID (read-only)

ProductCodestringOptional

The unique product code you can define for each of your offerings

ExternalReferencestringOptional

External reference set when defining the product

ProductTypestring · enumOptional

The type of the product (REGULAR or BUNDLE)

Default: REGULARPossible values:
ProductNamestringOptional

The name of the product

ProductVersionstringOptional

The product version number

PurchaseMultipleUnitsbooleanOptional

Customers can purchase multiple units (when set TRUE) or only one unit (when set FALSE) of this product

Default: true
GiftOptionbooleanOptional

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

Default: false
ShortDescriptionstringOptional

Product's short description

Default: ""
LongDescriptionstringOptional

Product's long description

Default: ""
SystemRequirementsstringOptional

System requirements

Default: ""
ProductCategoryone ofOptional

Product's category name

stringOptional
or
booleanOptionalDefault: false
TrialUrlstringOptional

The URL where shoppers can download trial software from

Default: ""
TrialDescriptionstringOptional

Descriptive text entered for trials

Default: ""
TangiblebooleanOptional

TRUE - for physical products, FALSE - for digital products

EnabledbooleanOptional

True/false depending on whether the products are active or disabled

Default: false
ReviewProductUrlbooleanOptional

The URL where the product can be reviewed before approval. Required if the "Enabled" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation.

Default: ""
ReviewAdditionalDetailsbooleanOptional

Additional information can be added to access the review of the product. Parameter is optional.

Default: ""
Fulfillmentstring · enumOptional

Possible values BY_AVANGATE, BY_VENDOR, NO_DELIVERY

Possible values:
GeneratesSubscriptionbooleanOptional

TRUE or FALSE depending on whether you set the product to generate subscriptions or not

Default: false
GroupNamestringOptional
Responses
200

OK

No content
put/products/{ProductCode}/
PUT /rest/6.0/products/{ProductCode}/ HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 19

"my_subscription_1"
No content

Disable products

delete

Disable products for your account.

Path parameters
ProductCodestringRequired

"The editable code that you control at product-level, not the unique, system-generated product ID"

Example: my_subscription_1
Header parameters
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Responses
200

OK

application/json
delete/products/{ProductCode}/
DELETE /rest/6.0/products/{ProductCode}/ HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: */*

{ 'TRUE' }

Get product images list

get
Path parameters
ProductCodestringRequired

Product code

Example: A720693CC9
Header parameters
Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Responses
200

Returns product images list

application/json
DefaultbooleanOptionalExample: true
URLstringOptionalExample: http://secure.avangate.org/images/merchant/2fa8fadcc0c3506875c09e7e7da28835/products/test.png
get/products/{ProductCode}/productimages/
GET /rest/6.0/products/{ProductCode}/productimages/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

[
  {
    "Name": false,
    "Code": "http://secure.avangate.org/images/merchant/2fa8fadcc0c3506875c09e7e71111111/products/image_1.png"
  },
  {
    "Name": true,
    "Code": "http://secure.avangate.org/images/merchant/2fa8fadcc0c3506875c09e7e71111111/products/image_2.png"
  }
]

Get product image by filter

get
Path parameters
ProductCodestringRequired

Product code

Example: A720693CC9
ImageFilterstringRequired

Image filter(numeric image index or image filename (.jpg|.png|.gif))

Example: test.png
Header parameters
Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Responses
200

Returns product image binary string

error_codestringOptional
messagestringOptional
get/products/{ProductCode}/productimages/{ImageFilter}/
GET /rest/6.0/products/{ProductCode}/productimages/{ImageFilter}/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

[
  {
    "filename": "test1.png",
    "data": "image/png:base64,iVBORw0KGgoAAAANSU"
  }
]

Get crossSell campaigns by filter

get
Path parameters
ProductCodestringRequired
Query parameters
EnabledbooleanOptionalExample: true
TypestringOptionalExample: MERCH
PagenumberOptionalExample: 1
LimitnumberOptionalExample: 10
Header parameters
Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Responses
200

Returns crossSell campaign collection

application/json
get/products/{ProductCode}/crosssells/
GET /rest/6.0/products/{ProductCode}/crosssells/ HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

{
  "Items": [
    {
      "IdCrossSellingCampaign": 435908435,
      "Name": "My campaign",
      "CampaignCode": "2Xrl83GEn+uBr3G3ddW9eg==",
      "DisplayType": "cart",
      "ProductCode": "cart",
      "MasterProducts": [
        "SOME_PRODUCT_CODE"
      ],
      "Products": [
        {
          "ProductCode": "SOME_PRODUCT_CODE",
          "Discount": 10,
          "DiscountType": "PERCENT",
          "Type": "Own",
          "AutoAdded": false,
          "DiscountedPrice": [
            {
              "Currency": "EUR",
              "Price": 9.04
            }
          ],
          "BasePrice": [
            {
              "Currency": "EUR",
              "Price": 9.04
            }
          ]
        }
      ]
    }
  ],
  "Pagination": {
    "Page": 1,
    "Limit": 10,
    "Count": 12
  }
}

Set product upgrade schema

post
Path parameters
ProductCodestringRequired

Unique code which represents the product

Body
AllowUpgradeFromstring[]Required

The list of the codes of products that can be upgraded to the product specified

Example: PROD322AX3
Responses
200

Set product upgrade schema success response

application/json
booleanOptionalExample: true
post/products/{ProductCode}/upgrade/
POST /rest/6.0/products/{ProductCode}/upgrade/ HTTP/1.1
Host: api.2checkout.com
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "AllowUpgradeFrom": [
    "PROD322AX3"
  ],
  "UpgradeSettings": {
    "PricingScheme": 1,
    "OptionPriceOperator": "ADD",
    "OptionPricePercentage": 5,
    "SubscriptionUpgradeType": 1,
    "UseProductCatalogPricing": true,
    "ProrateIgnoreGracePeriod": true,
    "ApplyExistingDiscountToRenewalsAfterUpgrade": true
  }
}
true

Retrieve price matrix for product

post
Header parameters
X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Acceptstring · enumRequiredExample: application/jsonPossible values:
Bodyobject · priceMatrixPrice[]
ProductCodestringOptional

product code

PricingConfigurationCodestringOptional

pricing configuration code

OptionHashstringOptional

hash generated based on price options

Responses
200

OK

application/json
ProductCodestringOptional

product code

PricingConfigurationCodestringOptional

pricing configuration code

OptionHashstringOptional

hash generated based on price options

post/promotions/priceMatrix/
POST /rest/6.0/promotions/priceMatrix/ HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 133

[
  {
    "productCode": "test",
    "pricingConfigurationCode": "738C6A2049"
  },
  {
    "productCode": "0YEATW7NJ9",
    "pricingConfigurationCode": "738C6A2049"
  }
]
200

OK

[
  {
    "ProductCode": "test",
    "PricingConfigurationCode": "738C6A2049",
    "OptionHash": "708e43960c4edc42f14cf388bcb24bde",
    "Options": [
      {
        "GroupName": "Units",
        "OptionText": "1 - maximum"
      }
    ],
    "Prices": [
      {
        "Value": null,
        "Currency": "CAD"
      },
      {
        "Value": null,
        "Currency": "EUR"
      },
      {
        "Value": null,
        "Currency": "USD"
      }
    ]
  }
]
PreviousJSON encoded requests
NextProduct SKU

Last updated

Was this helpful?