Change order is a feature that allows your store to modify the items or prices of an order. With this feature, the store can handle eventual changes in orders motivated by customer mistakes, product unavailability, and the inclusion of discounts, among other things. Learn more about how it works and its restrictions in the article Changing items from a completed order.
Learn more about Order replacement and how to enable your customers to easily request order changes.
The Register change on order endpoint in the Orders API allows you to create a discount, change an item or increase the price of an order.
When removing or adding items to an order, the inventory of the affected SKUs is not updated automatically - you should update it using the Logistics API.
Changes made this way can be confirmed by the
changesAttachment field in the response of the Get order endpoint. Alternatively, you may search for the order in the Orders > Orders management > All orders section of your Admin panel and see the item change history in the order details.
Increasing the price of an order is only available for credit card purchases. The connector must also be able to handle purchases without the CVV, as well as duplicated sequences.
See below what API errors can be returned when attempting to change an order via API and how to avoid or work around them.
These errors happen when there are one or more errors in the information sent in the request.
|All of these conditions are true:- |
|The request body contains either an |
These are errors that are returned when the request is correct but the order cannot be modified due to order change restrictions.
|The fulfillment order is not in a status that allows changes (|
|The order has a |
|The marketplace order is not on the status |
|Order is complete, but transaction |
|Order has |
|More than 50 registered change requests for a single order.|
|At least one of these conditions is true:- Removed item does not exist in the order.- Added item does not exist in the catalog.|
|An item’s quantity would be reduced to less than 0 after the change.|
|All of these conditions are true:- Attempt to increase order price.- Payment method does not support value change.- Payment method is not credit card payment, promissory card, cash or credit control.Consult with your payment gateway to see which methods allow for order value change.|
|All of these conditions are true:- Attempt to reduce order price.- Payment method does not support value change.Consult with your payment gateway to see which methods allow for order value change.|
|There is an issue with the payment gateway.|