Query the status of a guide batch

Allows querying the current status of a previously created guide batch.

GET /hawb/{batchId} v1.0.0
Autenticación
Bearer Token
Ambiente
Development Server (DEV), Test Server, Production Server

Descripción

Allows querying the current status of a previously created guide batch.

The batch is considered fully processed when processingGuides equals 0. At that point, generatedGuides + failedGuides must equal totalGuides.

Rate limiting: 50 requests per minute per client. Best practice: implement a minimum 2-second interval between status checks.

Step 3 of 6 in the nationalization flow:

  1. Authentication
  2. POST /hawb → batchId is returned
  3. GET /hawb/{batchId} ← HERE — check batch status
  4. POST /mawb
  5. POST /mawb/hawb
  6. POST /mawb/nationalization

🔐 Authentication required

HeaderAuthorization: Bearer <access_token>
Token (TEST)POST https://api-test.coordinadora.tech/oauth/token
Token (PROD)POST https://api.coordinadora.tech/oauth/token
MethodBasic Auth — Client ID as username, Client Secret as password
BodyContent-Type: application/x-www-form-urlencoded · grant_type=client_credentials
Validity3600 seconds
HTTP 401Token not sent, invalid or expired

Credentials (Client ID and Client Secret) are provided by Coordinadora's Technology Department.

Quick Start

  1. Obtén tus credenciales de acceso (Bearer Token).
  2. Selecciona el ambiente y completa los parámetros requeridos.
  3. Envía la solicitud y procesa la respuesta.

Ejemplo rápido

Generando ejemplo…

Endpoint

GET /hawb/{batchId}

Base URL https://api-dev.coordinadora.tech/nacionalizacion

Parámetros

Nombre Tipo Requerido Descripción
batchId path string Sí Unique batch identifier. Value returned in the batchId field of the POST /hawb response. Case-sensitive.

Respuesta

200
Batch status information retrieved successfully.
{
    "isError": false,
    "data": {
        "batchId": "264081134-1776785291254-9d6c97",
        "totalGuides": 3,
        "generatedGuides": 2,
        "failedGuides": 1,
        "processingGuides": 0,
        "customerEmail": "logistics@globalcommerce.com",
        "generatedGuidesDetail": [
            {
                "customerOrderId": "ORD-2025-00892",
                "trackingNumber": "13220721777"
            }
        ]
    }
}
204
The queried batch does not exist. Occurs when the batchId does not match any existing record. Verify the batchId was copied correctly from the POST /hawb response. The response body will be empty — do not attempt to parse JSON.

Ejemplo de respuesta

200 Batch status information retrieved successfully. 
{
    "isError": false,
    "data": {
        "batchId": "264081134-1776785291254-9d6c97",
        "totalGuides": 3,
        "generatedGuides": 2,
        "failedGuides": 1,
        "processingGuides": 0,
        "customerEmail": "logistics@globalcommerce.com",
        "generatedGuidesDetail": [
            {
                "customerOrderId": "ORD-2025-00892",
                "trackingNumber": "13220721777"
            }
        ]
    }
}

Errores

400
Bad Request. The submitted data does not comply with the required format or validations.
{
    "isError": true,
    "data": {
        "ok": "Invalid input data",
        "message": "The request contains invalid or incorrectly formatted data.",
        "detail": "Please review the request fields and try again."
    }
}
401
Unauthorized. The authentication token is invalid, has expired, or was not provided.
JWT has expired
500
Internal Server Error.
{
    "isError": true,
    "data": {
        "ok": "Internal server error",
        "message": "Internal server error",
        "detail": "An unexpected error occurred while processing the request."
    }
}