GetShipment

Devuelve las órdenes de trabajo de un expediente, que se busca por la referencia del expediente: para cada orden de trabajo, su contenedor o ID de carga, su tamaño, su peso y su mercancía, y el último evento que puede ver el cliente. Utilícelo para mostrar el avance de un expediente en otro sistema, como una página de seguimiento; el widget de seguimiento público de TrakIT muestra los mismos datos. La API llama «shipment» (envío) a un expediente.

Para seguir dónde están los contenedores de un cliente, use GetAssetLocation o GetList. En TrakIT, los mismos datos están en la cabecera de la orden de trabajo, donde Customer Status muestra el último evento que puede ver el cliente.

Cómo enviar la clave y leer la respuesta: Claves de API, Respuestas.

GET /api/public/GetShipment?Num=EXL-2610-0042
APIKey: your-api-key

Envíe la clave en el encabezado APIKey. La clave debe tener permiso para obtener envíos (public.getshipment); lo configura el soporte de TrakIT.

Parámetro	Obligatorio	Significado
Num	Sí	La referencia del expediente. Solo letras, dígitos, /, - y _. Se eliminan los espacios de los extremos, y las mayúsculas no importan.

Num debe estar en la cadena de consulta: sin él, TrakIT responde HTTP 404.

Reglas

Regla	Info si no se cumple
La solicitud tiene un encabezado APIKey.	API Key Missing
La clave está activa y tiene permiso para obtener envíos.	Key is disabled, not recognized or permission denied
Num solo contiene letras, dígitos, /, - y _.	Invalid Number Specified

Respuesta

Si tiene éxito, Code es 1, RetInfo lista las órdenes de trabajo del expediente, un elemento por cada una, en el orden de sus identificadores, y RowsAffected indica cuántas son. Se listan todas las órdenes de trabajo del expediente, sea cual sea su estado, incluidas las cerradas y las canceladas.

Cuando ningún expediente tiene esa referencia, Code sigue siendo 1: RetInfo es una lista vacía y RowsAffected es 0.

{
  "Code": 1,
  "Info": "",
  "RetInfo": [
    {
      "WorkOrderID": 48211,
      "Corridor": "Import Full",
      "Container": "ABCU1234560",
      "Manifest": null,
      "Size": 40,
      "Weight": 18450.0,
      "Commodity": "Cocoa beans",
      "LastEvent": "Discharged",
      "LastEventDate": "2026-10-19T14:20:00"
    }
  ],
  "RowsAffected": 1,
  "Scalar": null,
  "Identity": 0
}

Campo	Significado
WorkOrderID	El identificador de la orden de trabajo.
Corridor	El nombre del flujo de trabajo del expediente.
Container	El número de contenedor, si la orden de trabajo tiene uno.
Manifest	El ID de carga, si la orden de trabajo tiene uno.
Size	La longitud del contenedor en pies, por ejemplo 20 o 40.
Weight	El peso, en kilogramos.
Commodity	La mercancía.
LastEvent	El último evento que puede ver el cliente: su nombre externo si lo tiene; si no, su nombre. null cuando la orden de trabajo todavía no tiene ningún evento así. Los eventos que ven los clientes se definen con External Access en cada evento: consulte campos de los eventos.
LastEventDate	La fecha y la hora de ese evento, en UTC. Consulte Fechas y horas.