La API de Cancelación de Envíos en la plataforma permite anular guías previamente generadas.
Mediante esta API, los usuarios pueden cancelar envíos proporcionando la información de la guía previamente generada. La respuesta de la API confirmará si la cancelación fue procesada exitosamente o, en su defecto, entregará el detalle del error.
La estructura de la URL para enviar peticiones de cancelación es la siguiente:
| PAQUETERÍA | URL |
| DHL | |
| FedEx | |
| Estafeta | |
| Paquetexpress |
La autenticación para el uso de la API de Generación se hace
mediante dos campos: key y password
definido en el encabezado (header) en un
objeto de nombre “security” de la petición.
Estos campos requieren de su solicitud al equipo de desarrollo de la API.
| PROPIEDAD | DESCRIPCIÓN |
key |
Es una de las credenciales solicitadas para el acceso de la aplicación, se trata de una cadena de caracteres cifrados obligatoria cuyo nombre en la petición es “key”, debe de ser solicitada al equipo de desarrollo de la API y está asociada al usuario generado para el consumo de la aplicación. |
password |
Es una de las credenciales solicitadas para el acceso de la aplicación, se trata de una cadena de caracteres cifrados obligatoria cuyo nombre en la petición es “password”, debe de ser solicitada al equipo de desarrollo de la API y está asociada al usuario generado para el consumo de la aplicación. |
| PROPIEDAD | OBLIGATORIO | TIPO DE DATO | LONGITUD | RESTRICCIONES |
|---|---|---|---|---|
| key | ✔ | Texto Cifrado | Ilimitado | Solicitar su generación |
| password | ✔ | Texto Cifrado | Ilimitado | Solicitar su generación |
| shippingNumber | ✔ | Cadena de caracteres | Ilimitado | Número de guía a cancelar |
En esta sección obligatoria representada como un objeto de nombre “header” se solicitarán datos de autenticación para validar la petición de cancelación.
key (Llave).
Cadena de texto cifrado obligatoria. Este valor debe solicitarse al administrador del sistema.
password (Clave).
Cadena de texto cifrado obligatoria. Este valor debe solicitarse al administrador del sistema.
En este objeto se especifican los datos necesarios para la cancelación de una guía previamente generada.
En esta sección se solicitará el número de la guía que se desea cancelar.
shippingNumber (Número de guía).
Cadena de caracteres obligatoria que identifica el envío que se desea cancelar. Este valor corresponde al número de guía generado en la creación del envío.
{
"header": {
"security": {
"key": "[USER KEY]",
"password": "[USER PASSWORD]"
}
},
"body": {
"request": {
"data": {
"shippingNumber": "[shippingNumber]"
}
}
}
}
curl -X POST 'https://sistemahuipix.com/ws-national-canceling-dhl' \
-H 'Content-Type: application/json' \
-d '{
"header": {
"security": {
"key": "[USER KEY]",
"password": "[USER PASSWORD]"
}
},
"body": {
"request": {
"data": {
"shippingNumber": "3864781745"
}
}
}
}'
La API procesa la cancelación de la guía DHL indicada. Solo se admite el método
POST.
OK
Una respuesta con el texto OK y código HTTP 200
confirma que la cancelación fue procesada correctamente.
status (CÓDIGOS DE ERROR)
Este valor significa que la respuesta ha sido exitosa.
key/password son inválidas, están incompletas o el token expiró.
POST.
[
{
"status": "400",
"message": "Bad Request",
"responseDetails": "shippingNumber requerido"
}
]
[
{
"status": "404",
"message": "shipping Number Invalid",
"shippingNumber": "1"
}
]
Apartado que presenta la descripción textual del estado de la petición, en caso de tener un error identificado se brindará la descripción en esta sección.
Apartado que presenta una cadena de caracteres con el número de envío ingresado.
Apartado que presenta más detalles de la petición.