Overview

This object is returned directly or within a successful response from the following API requests:

Retrieve products by ID                                      Retrieve products by code                                              Search products

Product object

Overview

This object is returned directly or within a successful response from the following API requests:

• Retrieve product group
• Retrieve all product groups

Product group object

Overview

Alipay is a third-party online payment solution (digital wallet), providing a way for millions of individuals and businesses to make and receive payments on the Internet. The Alipay model involves escrow payments, designed to reduce transaction risk for online consumers, enabling them to release funds to vendors only if they're happy with the goods they have purchased.

As of 2019, Alipay has 1.2 billion registered users (900 million users in China), generating approximately 175 million transactions per day. Alipay's market share of online payments exceeds 54% in China.

By adding Alipay to your payment methods portfolio, you can increase authorization (for both new acquisitions and recurring payments) and conversion rates in China & APAC​ and have access to over 600 million consumers which means more customers and sales.

Alipay now supports:

• Full refunds
• Partial refunds
• Reverse orders
• Recurring payments

Supported currencies

Alipay supports USD and CNY transactions.

Workflow

To offer Alipay to your shoppers, you need to activate this payment method from your Merchant Control Panel account.

1. When placing the order, shoppers in China can select 支付宝 (Alipay) as a payment option.

2. On the next page, customers can finalize the payment. They are taken to the Alipay gateway and will receive an email confirmation and more information regarding the products/services delivery.

3. Once the payment is complete, the shoppers are taken back to the 2Checkout shopping cart Finish page.

Overview

Cross-selling allows you to recommend additional products to customers and increase the average order value. The 2Checkout Public API supports classic cross-sell campaigns which means you can recommend more products from your own product catalog to your shoppers.

CrossSell Object

Use the CrossSell object to recommend additional products to customers via the 2Checkout API.

Parameters

Overview

PayPal is a real-time payment and money transfer solution available globally. Businesses and customers with PayPal accounts can easily send and receive payments online without the need to turn to more traditional payment mechanisms.

The total value of PayPal transactions in 2011 was $118 billion, generated by 110 million active registered accounts and owned by customers in 190 markets worldwide. PayPal mobile payment volume in 2011 was $4 billion, growing from $750 million in mobile payments in 2010. (Active accounts are those that have had activity in the past 12 months.)

Availability

PayPal is available as a payment method for all 2Checkout accounts and it can be activated from the Merchant Control Panel. This payment method is not available to merchants registered in countries not supported by PayPal.

Please verify whether your country or region is supported by PayPal here. 

Workflow

For orders paid with PayPal, the following information is included in the order/item description fields on PayPal receipts and emails:

• Vendor domain (this is the only piece of info for trial conversions)
• Type of order: new purchase or renewal
• Order reference number (only for new purchases)

2Checkout automatically reverses fraud-suspect PayPal orders and orders with invalid data after 14 days.

Overview

Use this object to retrieve information about the cross-sell campaigns you configured for your account. 

Parameters

Overview

Apply discounts to specific products added to the shopping cart. Volume discounts impact the unit price applied by the platform.

Availability

Available for all 2Checkout accounts, and both Channel Manager and resellers if you (merchant) use the products in both channels.

How regular promotions work 

The 2Checkout system automatically applies regular product promotions when the shopping cart contains a product you assigned the promotion to.

Add a regular promotion

1. Log in to your Merchant Control Panel account.
2. Navigate to Marketing tools -> Promotions -> Regular promotions.
3. Click Add regular promotion.
4. Give a suggestive title and description to your promotion. Shoppers can see the promotion title during purchase.
   
   • Add localized promotion names for any of the supported languages. The 2Checkout shopping cart automatically displays localized promotion names based on the selected shopping cart language.
5. Select when you want the promotion to run. You can limit promotions to a specific time interval or let them run indefinitely. To start a promotion as soon as you mark it Active, leave the start date empty. If you don't set the end date, the promotion will stop when the maximum number of orders has been reached or will continue to run if the maximum number of orders is unlimited.
6. Select whether to apply the product promotion to eCommerce orders, partner orders (Channel Manager) or both.
7. Select the coupon/voucher type:
   
   • Single - one voucher to impact multiple orders;
   • Multiple - individual and unique, per-order vouchers.
8. (Optional) If the cumulative promotion option is enabled on your account, select if the regular promotion is cumulative (can be added over another regular promotion) or not. 
9. (Optional) If the promotion is cumulative, you need to select the tax category for the discounted product as well, by selecting an option from the Product tax category drop-down list.
10. Choose whether to restrict the promotion to a number of orders, or apply it for all orders. This option is only available for single coupons.
11. Choose whether or not to limit the promotion based on the product quantity. Any product quantity above this limit will be sold at full price.
12. Fill in the promotion coupon/voucher code. The maximum length of a coupon code is 255 alphanumeric characters.
    
    • Single: enter the coupon values manually
    • Multiple: either add the values manually one coupon per line or use the coupon generator available in the Control Panel to generate 5, 10, 20, 30, 50, or 100 vouchers at a time and either append them to an existing list or replace existing items. The generator creates random vouchers that resemble this: D8C10E32. 2Checkout recommends limiting the number of coupon codes to a maximum of 25000.
13. Select the discount type:
    
    • Percentage
    • Fixed
14. Choose whether or not to apply discounts automatically. Only available for single coupons. This option applies discounts to all selected products in all orders, without allowing shoppers to enter the coupon manually.
15. Choose whether or not to publish the promotion to the 2Checkout Affiliate Network.
16. Activate the promotion.
17. Select the products to be included in the promotion.
18. Click Save.

Duplicate an active promotion

Users can duplicate an active promotion in the Merchant Control Panel. This will improve the user experience and simplify the actions needed to add a new promotion.

The feature is available for users who are offering promotions and can be activated from all the pages from the Promotion tabs.

To use the feature, follow the steps below:

1. Go to Marketing tools -> Promotions -> Select an active promotion that you want to Save as new.
2. Click on Save as new button.

  3. The promotion will be cloned as Inactive; the name will be by default Copy of cloned promotion.

  4.  A new code will be generated.

  5. Click on the Actions icon to activate the promotion.

  6. Click on the Activate button.

  7. The actions will be visible in the User Activity reports tab.

Overview

Configure product promotions to be available to your Affiliate Network. This way, your affiliates can offer shoppers a better price for their promoted products.

Availability

Available for all 2Checkout accounts.

Adding an affiliate promotion

1. Go to Marketing tools -> Promotions -> Regular promotions.
2. Click Add regular promotion.
3. Give the promotion a suggestive title and description. Shoppers can see the promotion title during purchase.
4. Select when you want the promotion to run. You can limit promotions to a specific time interval or let them run indefinitely. To start a promotion as soon as you mark it Active, leave the start date empty. If you don't set the end date, the promotion will stop when the maximum number of orders has been reached or will continue to run if the maximum number of orders is unlimited.
5. Choose whether to apply the product promotion to eCommerce orders, partner orders (Channel Manager) or both.
6. Choose the coupon / voucher type:
   
   • Single - one voucher to impact multiple orders;
   • Multiple - individual and unique, per-order vouchers.
7. Choose whether to restrict the promotion to a number of orders, or apply it for all orders. This option is only available for single coupons.
8. Choose whether or not to limit the promotion based on the product quantity. Any product quantity above this limit will be sold at full price.
9. Fill in the promotion coupon/voucher code. The maximum length of a coupon code is 255 alphanumeric characters.
   
   • Single: enter the coupon values manually
   • Multiple: either add the values manually one coupon per line, or use the coupon generator available in the Control Panel to generate 5, 10, 20, 30, 50 or 100 vouchers at a time and either append them to an existing list or replace existing items. The generator creates random vouchers that resemble this: D8C10E32. 2Checkout recommends limiting the number of coupon codes to a maximum of 25000.
10. Select the discount type:
    
    • Percentage
    • Fixed
11. Choose whether or not to apply discounts automatically. Only available for single coupons. This option applies discounts to all selected products in all orders, without the need for shoppers to enter the coupon manually.
12. Choose to publish the promotion to the 2Checkout Affiliate Network.
13. Activate the promotion.
14. Select the products to be included in the promotion.
15. Click Save.

Overview

Structure