Cancel Order
Order cancellation is in beta. Please report any errors to Violet.
Cancel a complete Order. This action will attempt to cancel the external order in the merchants system for every Bag in the Order. The total amount paid for each Bag will be refunded to the shopper upon successful cancellation.
All Bag’s must be in a cancellable state. If any Bag has a status of IN_PROGRESS, REFUNDED, or CANCELED the request will be rejected.
Headers
Path Parameters
Body
Custom message describing the reason for the cancellation.
Code that best represents the reason for the cancellation.
OTHER, CUSTOMER, INVENTORY, FRAUD, DECLINED Should the items be restocked. In most cases this should be true since only unfulfilled orders can be cancelled.
Should the customer be notified by the merchants system that a cancellation has occurred.
Response
The ID of the order this cancellation relates to.
The ID of the app that originated this order.
Status of the overall cancellation.
CANCELED, PARTIALLY_CANCELED, CANCELLATION_FAILURE Bags within the order that were cancelled.
Description of the outcome of the order cancellation request.
Was this page helpful?