Release notes

Keep track of changes and updates to the Commerce API.

2024/09/30

Introducing cancel reason codes and comments

We are excited to introduce significant enhancements to our Cancel Subscription API with the addition of two new parameters: cancelReasonCode and cancelComment. These updates aim to provide better tracking, analytics, and a richer context for subscription cancellations. For more information, see:

Shopper APIs: Cancelling a subscription
Admin APIs: Cancelling a subscription

2024/08/13

Introducing new test credit card numbers for enhanced payment testing

In our continuous effort to provide comprehensive tools for developers and testers, we are pleased to introduce new test credit card numbers. These numbers facilitate the evaluation of various payment-related success and error scenarios more efficiently. See Payment testing scenarios for a detailed overview of the new test card numbers along with their intended use cases:

We strongly recommend using these specific test credit card numbers in your testing routines to ensure thorough validation of your payment integrations. This update improves the reliability and robustness of your payment processing systems, providing a smoother experience for developers and end-users.

2024/07/26

Release Note: Introducing Gift Messaging in Commerce API

We're excited to share a significant update to enhance the shopping and gifting experience for retailers and their customers. The popular Gift Messaging feature, previously available exclusively in the Global Commerce-hosted solution, has now been seamlessly integrated into the Commerce API.

Gift messaging support

The Commerce API now supports gift messaging, leveraging the existing Global Commerce settings. This update allows shoppers to add personalized messages to their gift orders, making each gift even more special and memorable.

Feature highlights:

Enhanced gifting options: Retailers can now offer their customers the capability to send personalized messages with their gifts by activating the gifting option for sites and products. This feature can be easily enabled when creating or editing a product listing.
Improved communication: Depending on whether the product is physical or digital, the system can send tailored notification emails to both the purchaser and the gift recipient, ensuring clear and timely communication.
Personalized messages: For an added personal touch, gift messages are included on the gift invoice for physical products or in the email notification for digital products, providing a more personal and thoughtful gifting experience.

Getting started

Incorporating gift messaging into your Commerce API is straightforward for those already using the Global Commerce-hosted solution and will significantly enhance your customers' shopping experience.

Global Commerce

Commerce API

To send a gift from a Global Commerce-hosted checkout.

Select the Send as a gift checkbox.
Complete the required fields, including the recipient's first name, last name, email, and gift message.
Submit the cart to place the gift order.

API users can send an API request.

Send a POST /v1/shoppers/me/carts/active request with the following details to set up a gift order:
1. Set giftInfo.enabled = true.
2. Enter a personal message for the gift in giftInfo.message.
3. Enter the recipient's first name, last name, and email address in the shippingAddress object.
Submit the cart to finalize the gift order.

}
    "billingAddress": {},
    "shippingAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "jdoe@digitalriver.com"
    },
    "giftInfo": {
        "enabled":true,
        "message": "Happy Birthday! Wishing you a day filled with love, joy, and laughter. Enjoy your special gift! - Your Friend"
}

For more information, see:

Support

Should you have any questions or require further assistance, contact the Commerce Product Team. We're here to help you leverage this new feature to delight your shoppers and make gift-giving a breeze.

Stay tuned for more updates, and thank you for being a part of our community. Happy gifting!

2024/07/16

New feature - Prorate Non-subscription Child Products toggle

We are excited to announce a new feature that adds flexibility to your subscription management capabilities: the Prorate Non-subscription Child Products along with the Parent Product toggle!

Feature details

This new functionality allows you to maintain transparency and accuracy in subscription management like never before. It provides the option to include or exclude non-subscription child products from proration when adjusting the parent subscription plan.

Scenarios

Imagine this scenario: You're signing up for an online streaming service. Your annual subscription plan for unlimited streaming is priced at $120 annually. The subscription comes bundled with a one-time Setup Assistance service for $30, which helps you set up your account and devices.

Let's say you initially subscribed to the streaming service in January. In June, you decide to upgrade to a family plan, adding one more streaming device to your subscription for bedroom viewing. With the proration toggle set to OFF, the system calculates the prorated price for the upgraded family plan from June to December ($120 * 6/12 = $60) but keeps the one-time Setup Assistance service price fixed at $30.

Set the toggle to OFF when you have bundled services like a one-time Setup Assistance service and want to upgrade or change your subscription plan. The price of the Setup Assistance remains unchanged, ensuring that you bill the one-time services appropriately.
Set the toggle to ON when you want the subscription and any additional bundled services or products (e.g., warranties, add-ons) to be adjusted in price and prorated together. It ensures a seamless adjustment to pricing whenever you make changes to your subscription.

Benefits

Flexibility: Customize how you bill bundled products or services during subscription plan changes.
Accuracy: Ensure you reflect accurate pricing for the parent subscription and any associated child products or services.
Simplicity: Managing subscription plans is now more straightforward, with clear, controllable billing adjustments.

Getting started

To start leveraging this new feature, we invite you to follow the instructions for enabling price proration. This resource will help you understand the feature in detail and implement it effectively.

Support

If you have any questions or require assistance, contact the Commerce Product Team.

2024/06/12

In our latest update, we've significantly improved and added to our error-handling mechanisms. These changes provide developers with more specific and actionable feedback, making your work easier and more efficient and enhancing overall system robustness and reliability.

New 409 conflict error codes

We added the following 409 Conflict error codes:

invalid-payment-source: This error code appears when the provided payment source is invalid or cannot be processed. Ensure the payment source details are correct and try again.
resource-already-exists: This error appears when a user attempts to create a resource that already exists. It prevents duplicate entries and maintains data integrity.

New synchronous response error codes

We added the following synchronous response error codes.

resource-duplicated: This error indicates the customer's external reference ID{externalReferenceID} is not unique on the site. It ensures that each resource remains unique.
invalid-subscription-id: This error is returned when the subscription ID does not match existing subscriptions. Verify the subscription ID and try again.
cannot find the order [{orderId}].: This error message indicates that the system could not find the specified order. Ensure the order ID is correct and exists within the system.

These updates are part of our ongoing efforts to improve the developer experience and system usability. We appreciate your feedback and are here to support your integration efforts with our platform.

2024/06/4

Subscription documentation update

In our continuous effort to improve the clarity and usability of our API documentation, we are pleased to announce some significant updates in our latest release:

We renamed the section formerly known as Common Shopper and Admin APIs to Warnings and Error Codes. This change aims to provide a clearer understanding of the APIs' functionalities and to ensure a more intuitive navigation experience.
We've reorganized our subscription documentation. The section is now more comprehensively divided into two main subsections:
- Subscriptions: This section provides a broad overview of our subscription capabilities in the Shopper APIs.
- Subscription management: Here, users will find detailed instructions on managing subscriptions, covering everything from creation and modification to cancellation processes in the Admin APIs.

2024/05/21

New offer features

We're excited to announce the latest updates to our Admin API, making the management of offers even more seamless and efficient. Enhancing your ability to provide value and flexibility to your customers has always been our priority. Here's what we've rolled out:

Retrieve the latest offer: Access the most recent version of any offer with the new endpoint GET /v1/offers/{offerID} to ensure you're always working with the latest information.
Track the latest deployed offer: Stay on top of your offer edits with the ability to track the latest deployed offer via GET v1/offers-api/offers/{offerId}?version=deployed. This feature helps in ensuring consistency across your promotional activities.
Retire outdated offers: Clean up your active promotions by easily retiring outdated offers using POST /v1/offers/{offerId}/retire. Keep your promotions relevant and engaging for your customers.

Improvements

Integration and management: We optimized the entire process from creation to retirement of offers for smoother integration and management through your existing systems.

Coming Soon

Create offer: We are working on the ability to update coupon code offers. Stay tuned for future releases!

Try out these new enhancements today!

2024/05/20

Post-order Notification Integration Guide updates

We're thrilled to unveil the latest enhancements to our Post-order Notification Integration Guide. These new features elevate the developer experience and streamline post-order communications, offering you more control and efficiency. Here are the key updates:

PON payload examples: As part of our commitment to providing comprehensive resources, we've introduced detailed payload examples for various post-order notifications. These examples, meticulously crafted for order confirmations, shipping updates, and delivery statuses, will give you a deep understanding of the required structure and content for crafting effective notifications across different scenarios.
Order event notification schema: Understanding the importance of timely and relevant order updates, we've unveiled a new section dedicated to order event notifications. This section provides comprehensive descriptions and examples of event triggers, empowering developers to fine-tune their notification systems to respond to specific order milestones accurately and efficiently.

These updates are part of our ongoing efforts to support and empower the developer community with the tools and knowledge to create seamless post-order communication experiences.

2024/05/16

Update on Apple Pay domain association

In our continuous effort to enhance our services and security, we have updated the apple-developer-merchantid-domain association for Apple Pay. This change is part of our ongoing updates to ensure a seamless and secure payment process for all our users.

Impact:

Current Clients: Rest assured, no action is required from your end. This update does not impact clients who have already registered their domains with Apple Pay. Your services will seamlessly continue to operate without any disruption.
New Clients: This update applies to registering domains with Apple Pay. We advise new clients to follow the updated registration process to ensure a smooth integration.

2024/05/09

New limit shipping country feature

We're excited to announce new features in our Amazon Pay integration that aim to enhance the checkout experience for you and your customers. With these updates, you can specify shipping preferences directly within the Amazon Pay setup, offering clearer communication and streamlined checkout processes. Below are the details of the newly released features:

allowShippingCountries: Specify the countries you want to allow shipping by listing their two-letter country codes. Only addresses associated with these countries will be available as shipping destinations in the Amazon Pay wallet. Note: If a country code appears in both allowShippingCountries and denyShippingCountries, the allow list takes precedence, ensuring the country is available for shipping.
denyShippingCountries: List the two-letter country codes of the countries you want to deny shipping. These addresses associated with these countries will not appear as selectable options in the Amazon Pay wallet.

For more detailed information on configuring these new features in your Amazon Pay integration and insights into the broader capabilities of the Amazon Pay element, refer to the Configuring Amazon Pay and Amazon Pay element sections. This resource provides comprehensive guidance on optimizing your checkout experience using the latest features.

2024/05/06

Pricing scenarios

With our pricing scenarios, you can determine a pricing strategy for a subscription product combination in Global Commerce. These pricing scenarios explain how price settings affect the subscription renewal price.

2024/04/16

Introducing Offer Admin API for creating and deploying an offer!

Big news for our Global Commerce platform users! We're happy to announce the latest addition to our Admin API family – the Offer Admin API!

In this exciting release, you can leverage the brand-new Offer Admin API to create specific offer triggers with offer types. Plus, deploying the created offer is easier than ever, all through the Offer Admin API!

Here's what we support in this initial release:

Create an offer for a trigger such as a "Promotional URL" and a discount type such as "Discount," allowing you to tailor your offers to suit your promotional needs precisely.
Deploy the offer: Seamlessly deploy your offers with just one call.

Do you want to associate the offer with your offer system? We've got you covered! We also included support for an External Reference Offer ID.

But wait, there's more! Stay tuned for additional Offer Admin API support in future releases.

Enhance your offer management capabilities and stay ahead of the game with the Offer Admin API. Don't miss out – try it today!

Unlock advanced offer management with our new Offer Admin API! 🚀

2023/04/05

Post-order Notification (PON) Integration Guide

We are thrilled to announce the release of the Post-order Notification (PON) Integration Guide. This comprehensive guide provides developers and businesses with the necessary tools and knowledge to seamlessly integrate post-order notifications into their systems, enhancing the post-purchase experience for customers across the board.

What's New:

Detailed Implementation Steps: Step-by-step instructions to guide you through the PON integration process.
Event Triggers Explained: An in-depth look into various events that can trigger post-order notifications, ensuring you have the control to customize your customer's journey.
Best Practice Recommendations: Insights and recommendations on using PON to boost customer satisfaction and loyalty.

We believe this guide will be invaluable in enabling more engaging and informative communication with your customers post-purchase.

2024/03/27

Introducing Inventory Management Webhook Events!

We've got fantastic news for our commerce platform users! We're thrilled to introduce three new webhook events to streamline inventory management.

Now, managing your inventory is even more efficient with these new webhook events:

inventory.out_of_stock: Receive instant notifications when your inventory runs out of stock, ensuring you're always aware of stock shortages.
inventory.self_managed_updated: Stay informed about any updates made to your self-managed inventory, keeping you in the loop with real-time changes.
inventory.fulfiller_managed_updated: Get notified when there are updates to your fulfiller-managed inventory, ensuring seamless coordination with your suppliers.

These new webhook events empower you to stay on top of your inventory levels and respond promptly to changes. Never miss a beat in inventory management – try them out today!

Experience streamlined inventory management with our enhanced webhook events! 🚀

2024/02/07

Exciting news! Managing Personal Identifiable Information (PII) removal became even easier with our Admin API solution!

You could always log the customer's PII removal request from Global Commerce; in our latest enhancement, you can now seamlessly request PII removal for a customer via the API solution using a customer ID (shopper ID) or an order ID to initiate the request. If a user has previously asked to be forgotten, the responses for the following requests will display the PII removal request timestamps.

Customer Admin API requests:
- GET /v1/customers/{customerId}
- POST /v1/customers/{customerId}/requestPIIRemoval
Order Admin API requests:
- GET /v1/orders/{orderId}

Simplify your data management – give it a try today!

2024/01/23

Good news! Managing Product Combinations just got easier. With our latest enhancement, you can perform bulk actions —create, read, update, and remove product combinations using the original Excel or XML BPU function. Simplify your workflow and check it out today! 🚀

PreviousTransparent Commerce purchase flow Next2023

Last updated 4 days ago