Marketplace order cancellation

This request may be sent from VTEX to the external seller in case of order cancelation. For that, the seller will need to implement the Marketplace order cancellation endpoint. Whenever this request is received by the seler, the order should be canceled and the fulfillment flow should not proceed.

For the seller to:

  • Evaluate a cancellation request: it is possible to send an empty body as a response to the cancellation request, meaning that the seller is evaluating whether to proceed with the cancellation or not.

  • Confirm the cancellation request: it is possible to confirm the order cancellation by the marketplace by responding to the call with a body including only one information: the marketplaceOrderId, which identifies the order in the marketplace. The seller should use this ID to trigger the cancellation of the corresponding order. The seller should then respond with the same marketplaceOrderId and also with the orderId, which identifies the order in the seller, the date and time of the notification receipt, and a protocol code that confirms the receipt of the request (which may have the value null).

  • Refuse a cancellation request: it is possible to to send the Invoice, meaning that the cancellation has been denied, and the flow continues to the Order Invoicing step, and the ones that follow it.

This call should be made twice: once for the Evaluate cancellation request scenario, and a second time to Confirm cancellation or Refuse cancellation.

Request body example

{
   "marketplaceOrderId": "959311095"
}

Response body fields

Name Type Mandatory Description
date string Yes Date and time of the notification receipt.
marketplaceOrderId string Yes ID that identifies the order in the marketplace.
orderId string Yes ID that identifies the order in the seller.
receipt string Yes Protocol code that confirms the receipt of the request. The value of this field may be null.

Response body example

{
   "date": "2014-10-06 18:52:00",
   "marketplaceOrderId": "959311095",
   "orderId": "123543123",
   "receipt": "e39d05f9-0c54-4469-a626-8bb5cff169f8"
}
Language
Authentication
Click Try It! to start a request and see the response here!