v1

latestOpenAPI 3.0.02026-07-141525155.4 KB
External Seller

Cancel order in marketplace

This request is sent by the external seller to the VTEX marketplace to cancel an order.

post/{marketplaceServicesEndpoint}/pvt/orders/{marketplaceOrderId}/cancel

Path parameters

marketplaceServicesEndpointstring required
Example:marketplaceservicesendpoint.myvtex.com

This is an endpoint sent from VTEX to the external seller in the Order placement request.

marketplaceOrderIdstring required
Example:1138342255777-01

Identifies the order in the marketplace.

Headers

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required
Example:application/json

Describes the type of the content being sent.

Request body

reasonstring required

Insert here the reason for the order's cancellation.

Example request

{
  "reason": "Product is unavailable"
}

Response

OK