Cancelar pedido

Este endpoint cancela un pedido, cambiando su estado. Se puede agregar un motivo para la cancelación, solo es necesario verificar si el motivo de la cancelación está disponible para el estado actual.

PUT

https://api.mercadopago.com/proximity-integration/shipments/{shipment_id}/cancel
Request parameters
Header
Authorization
string

REQUERIDO

Access Token obtenido a través del panel de desarrollador. Obligatorio ser enviado en todas las solicitudes.
Path
shipment_id
string

REQUERIDO

Shipment ID del pedido.
Body
status
string
Este campo indica el estado del pedido, que debe tener el valor "canceled" para este endpoint.
cancellation_reason
object
Motivo de la cancelación que se recuperó desde el endpoint de motivos de la cancelación.
Response parameters
status
string
Status of the order after its cancellation. The Status value that will be returned is "canceled".
Errores

400Error

400

Conflict-error - This order cannot be canceled 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 APP_USR-1*********685765-12*********1b4332e5c*********e077d7679*********664' \
    -d '{
  "status": "canceled",
  "cancellation_reason": {
    "id": "CS7452",
    "value": "out_of_stock",
    "message": "Me falta alguno de los productos."
  }
}'
Response
{
  "status": "canceled"
}