Cancel Bag
Bag cancellation is in beta. Please report any errors to Violet.
Cancel a single Bag from an Order. This action will attempt to cancel the external order in the merchants system. The total amount paid for this Bag will be refunded to the shopper upon successful cancellation.
The Bag must be in a cancellable state. Any Bag’s that have a status of IN_PROGRESS, REFUNDED, or CANCELED cannot be cancelled.
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
Cancellation record for an order.
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?