Documentacion API - Estado de Guia

Esta documentación cubre los puntos finales para consultar y actualizar el estado de las guias previamente generadas.

1. Recupera el estado de una guia por su identificador packageSave

Endpoint: GET /statusorder/:packageSave

Descripción: Recupera un el estado de una guia por su identificador packageSave.

Request Headers:

  • Authorization: Bearer token

Ejemplo de solicitud:

                    
curl --location 'https://api-lockers.unitsmartlabs.com/api/v1/statusorder/298687929879' \
--header 'Authorization: Bearer nOtG1lTi6Y66FMABgwlmYZQ0v5T3wi6VNY....'

Response:

                    
{
    "packageSave": "298687929879",
    "status": "completed"
}

2. Actualizacion de estado de guia

Endpoint: PATCH /statusorder/:packageSave

Descripción: Actualiza el estado de un pedido por su identificador packageSave.

Nota: Los estados aceptados estan limitados a "Generation successful", "completed" y "Ready to collect".

Request Headers:

  • Authorization: Bearer token

Request Parameters:

  • packageSave: El ID de la guia al cual se le cambiara el estado.

Request Body (x-www-form-urlencoded):

  • status: El nuevo estado del pedido.

Ejemplo de solicitud:

                    
curl --location --request PATCH 'https://api-lockers.unitsmartlabs.com/api/v1/statusorder/298687929879' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer DI4MH0.te3LRp90enOtG1lTi6Y66FMABgwlmYZQ0v5T3wi6VNY...' \
--data-urlencode 'status=completed'

Response:

                    
{
    "message": "StatusOrder with packageSave '298687929879' updated successfully",
    "status": "completed"
}

Códigos de respuesta:

  • 200 OK: La solicitud se completó exitosamente.
  • 400 Bad Request: Error en los parámetros de la solicitud.
  • 401 Unauthorized: Token de autenticación inválido o expirado.
  • 404 Not Found: No se encontraron logs para el locker o la fecha especificada.
  • 500 Internal Server Error: Error interno del servidor.