UPS - Cancelar Envio
Descripcion
Sección titulada «Descripcion»Este modulo cancela un envio previamente creado en UPS. Recibe el numero de identificacion del envio (Shipment Identification Number) y realiza una peticion DELETE al endpoint /api/shipments/v1/shipments/cancel. Si la cancelacion es exitosa, retorna el numero de envio, el estado de la respuesta del VoidShipmentResponse y un mensaje de confirmacion.
Configuracion
Sección titulada «Configuracion»| Parametro | Tipo | Requerido | Descripcion |
|---|---|---|---|
| credentials_id | credentials | Si | Credencial UPS (provider: ups) |
| shipment_identification_number | text | Si | Numero de identificacion del envio a cancelar |
Credenciales
Sección titulada «Credenciales»Se requiere una credencial de tipo ups con los siguientes campos:
- client_id: Client ID de la API de UPS
- client_secret: Client Secret de la API de UPS
{ "success": true, "shipment_identification_number": "1Z999AA10123456784", "status": "CANCELLED", "message": "Envio UPS 1Z999AA10123456784 cancelado exitosamente"}Ejemplo de Uso
Sección titulada «Ejemplo de Uso»Caso basico
Sección titulada «Caso basico»{ "credentials_id": "mi_credencial_ups", "shipment_identification_number": "1Z999AA10123456784"}API Utilizada
Sección titulada «API Utilizada»- Endpoint: DELETE
/api/shipments/v1/shipments/cancel - Base: UPS API (via helper
_upsHelper) - Documentacion: https://developer.ups.com/api/reference
- Solo se pueden cancelar envios que aun no hayan sido recogidos por UPS
- El estado se obtiene de VoidShipmentResponse.Status.Description
- La operacion es irreversible una vez completada