2021

Commerce API release notes for 2021.

2021/12/3

• We added the ability to update the subscription billing email address and shipping email address.

• We added the applyEmailToSubscriptions field to Update current shopper.

2021/10/4

We added a new legal entity, Digital River UK Limited.

2021/10/1

We added the ability to create a refund for a delayed payment method such as Konbini, and Wire Transfer.

2021/9/29

We added the ability to receive payment detail update notifications when a shopper updates their payment details for a subscription.

2021/9/16

• We added the ability to remove a tax identifier from a cart.

• We added the trigger to the offer object response. The possible values are:

  • Always Triggered–The offer is available to any shopper in your store. Shoppers have to meet the conditions you set up in the offer for the offer to be triggered and redeemed by shoppers.

  • User Triggered–To redeem an offer, the shopper must take additional actions such as click a link or enter a coupon code.

  You can set the trigger when you configure the offer type in Global Commerce.

• We added the ability to add or remove the organization identifier (client_reference_id) to a cart for the TreviPay payment method.

2021/9/7

We added the ability to set the renew reminders for trial subscriptions.

2021/9/1

• We added the ability for a Customer Service Representative to cancel an order in Global Commerce.

• We added the ability to use the Expired Card Optimizer (ECO) for third-party subscription engine renewal orders.

• We added support for using the tax registration resource to attach a tax ID to a cart using the tax registration resource.

• We expanded the pay later options now available in the PayPal Wallet, including PayPal RatenZahlung for German shoppers.

2021/8/12

We added instructions on how to get the inventory for a specific product.

2021/8/6

We added supportsStorage to indicate whether a payment method supports storage to Retrieving available payment methods.

2021/7/29

We expanded the pay later options in the PayPal Wallet, including PayPal Pay in 4 for shoppers in Australia and France, as well as PayPal Pay in 3 and PayPal Credit for UK shoppers.

2021/7/27

You can now use the Delayed Payment Instructions element to generate a template containing instructions explaining how to complete payment for delayed payment types such as Konbini and Wire Transfer.

2021/7/26

You can customize and control your subscription email notifications through events notifications and webhooks. This feature allows you to control your communications with your consumers, including integrating the capabilities of leading notification providers.

2021/7/7

We added the ability to create a trial subscription for a subscription product and configure trial renewal reminders in Global Commerce.

2021/7/2

We added support for Pay in 3 to the PayPal payment method.

2021/6/3

• We made the following changes to Subscriptions API:

  • In the response for GET /v1/subscriptions/{subscriptionId} , added shopper and renewalPrice to the subscription information attributes. We also added renewalPrice to the addOn object.

• We made the following changes to the Shopper API to allow you to suppress an order confirmation email.

  • Added the suppressorderconfirmationemail parameter to Add line items to a cart and Update current cart.

  To use this feature, contact your Digital River representative.

• We revised the statements for subtotal and discount at the order level for the Submit the cart and create an order.

2021/5/18

• We added test and use cases to help you when you're developing and testing the Commerce API and your commerce connector.

• We updated the error codes that provide you with:

  • Additional credit card decline reason codes and metadata responses. You can then perform reporting and analytics to understand better why authorizations are declined so you can optimize your business.

  • Greater visibility into why a transaction failed, reducing the work you need to do to determine why the transaction failed.

  • Data points to determine when you should or shouldn't retry a renewal attempt. This feature categorized credit card decline reason codes into "soft" and "hard declines."

2021/5/14

We added Site Management to the Commerce API Reference that includes the following resources:

• /authorized-shipping-countries

• /authorized-billing-countries

2021/5/6

You can now programmatically retrieve a list of your site's authorized billing or shipping countries using your Global Commerce user credentials.

2021/4/29

We replaced Supported geographies for each payment method in DigitalRiver.js with Supported markets. To find information on supported markets and currencies for Drop-in and DigitalRiver.js, go to:

• Payment Method Guide: digitalriver.com/payment-method-guide

• Country Guide: digitalriver.com/country-guide/

2021/4/27

• We made the following to the Commerce API Reference:

  • Removed x-siteid and x-companyId headers for Subscription APIs. You only need to provide a token now.
  • Removed sku and displayName from the product object in the response for preview, preview-cart, and reduce resources.

  • Removed proratedUnitPrice from the reduce resource.

  • Updated the payload for the API trigger offer request.

  • Updated the order states for the GET and POST orders APIs by adding In Review, Pending Payment, and Complete.

  • Updated the customAttributes for the get shopper order.

  • Added chargeType to apply shopper to cart, apply billing address to cart, apply shipping address to cart, apply payment method to cart, apply shipping option to cart, and get current cart.

  • Corrected the API path domain in the examples. It's now api.digitalriver.com.

2021/3/31

• We added information on how to sell subscriptions with add-ons and manage subscriptions.

• Digital River Clients can now extend a branded, fully managed line of credit program to their business buyers that is engineered to increase purchase frequency, average order values, brand loyalty, and cash flow while mitigating risk. By offering TreviPay, you cultivate a consumer-like purchase experience for buyers, so they can purchase what they need now and pay later with net terms – all online. Learn how you can offer TreviPay to your buyers!

2021/3/30

You can now use thechargeType in a Cart without a subscription line item to initiate a charge.

2021/3/11

We added the continue type to the list of button types for Drop-in and make it the default type in Customizing the text of the Drop-in button.

2021/3/10

• We added information on initiating a charge.

• We moved the Declined messages under Submitting a cart and renamed it Authorization declines.

• You can now find the error codes In the Commerce API doc.

2021/3/9

We updated the information on landed cost.

2021/2/1

• We improved the error format for transactional errors using a credit card saved in the payment source and added a declined message (declinedMessage) to provide more information.

• We moved the description of API keys from the Commerce API Reference to Best practices.

2021/1/15

You can now use the authenticateSource method to determine whether the saved payment source selected by a customer during the checkout process requires Strong Customer Authentication (SCA).

2021/1/12

• When creating a source, you can now configure the usage parameter. It allows you to specify the type of transaction the source will likely be used for. The parameter is available in both Drop-in and DigitalRiver.js. We recommend you use it when building purchase and account management workflows that allow customers to save their credit card information.

• When creating an instance of Drop-in, you can now customize the button's text. Additionally, we created new Drop-in options that allow you to set the showTermsOfSaleDisclosure and disableAutomaticRedirects parameters.

2021/1/8

We added information on creating a cart with a perpetual unit price using POST /v1/shoppers/me/carts/active/line-items resource.

2021/1/6

A note to Apply shopper to cart stating this method requires an authenticated shopper token.

• Added the following to the response schema for GET /v1/shoppers/me/payment-options:

  • PaymentOptionsResponseLegacy

  • PaymentOptionsResponseLegacyExpand

  • PaymentOptionsResponsePaymentSource

  • PaymentOptionsResponsePaymentSourceExpand

• A sourceId to GET /v1/shoppers/me/payment-options.

• The following to the response schema for POST /v1/shoppers/me/carts/active/apply-payment-method:

  • ApplyPaymentMethodLegacy

  • ApplyPaymentMethodPaymentSource

• The following to the response schema for GET /v1/shoppers/me/orders/{orderId}/line-items:

  • DefaultOrderLineItems

  • ExpandedOrderLineItems

  • lineItemStateDetails

• A chargeType to the subscriptionInfo section in the request and response. See Providing subscription information for more details.

2021/1/5

We added the best practices for using the Commerce API that include Authentication, Creating authenticated shopper tokens, Caching responses, Capturing the customer's IP address, and Elements.