Intelligent search powered by OpenAI
Cancel order
PUT
Products that use it:
Request's parameters
PATH
shipment_id
Shipment ID of the order.string
REQUIRED
BODY
status
This field indicates the order status, which must have the value "cancelled" for this endpoint.string
cancellation_reason
Reason of the cancellation that was retrieved from the endpoint of cancellation reason.object
Response parameters
status
Status of the order after its cancellation. The Status value that will be returned is "cancelled".string
Errors
400Error
400
Conflict-error - This order cannot be cancelled due to its current status.
401Error
401
Unauthorized - Access Token is invalid
403Error
403
Forbidden - User cannot access this resource
424Error
424
Not Found - Failed to get some information of the order
500Error
500
Internal server error
Request
curl -X PUT \
'https://api.mercadopago.com/proximity-integration/shipments/{shipment_id}/cancel'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TEST-4599*********755-11221*********d497ae962*********ecf8d85-1*********' \
-d '{
"status": "cancelled",
"cancellation_reason": {
"id": "CS7452",
"value": "out_of_stock",
"message": "Me falta alguno de los productos."
}
}'
Sample answer
{
"status": "cancelled"
}