Proporcionamos servicio de API
para el seguimiento de contenedores

Tenga en cuenta que:

Cualquier interacción con la API siempre requerirá su CLAVE API. Estará disponible en su tablero cuando tenga una cuenta.

Nuestra documentación API puede proporcionar información más detallada sobre cómo crear una nueva solicitud.

La API de Shipsgo tiene 2 métodos: GET y POST.

Dado que se necesita cierta información, como {containerNumber}, {blContainersRef}, {emailAddress}, etc., para iniciar el seguimiento, el primer paso es crear la solicitud de seguimiento. La solicitud de seguimiento se crea mediante el método de publicación con el contenedor, el número de B/L o el número de reserva.

El {requestId} regresa con el Código de estado 200 OK a los clientes si la solicitud se creó y se publicó en Shipsgo con éxito y eso significa que la solicitud llegó al servidor.

Si la POST falla, regresa el "Error Message". La lista de respuestas de error para el método se puede encontrar aquí.

El cliente puede ejecutar el "método GET" para llamar a los datos del viaje utilizando {containerNumber} o {requestId} después de que se devuelva el "Success Message".

Tenga en cuenta que el método POST es idempotente. Es suficiente ejecutar POST para cada pista por una vez. Sin embargo, el cliente puede realizar llamadas GET tantas veces como sea necesario.

CONSEJO:

Dado que cada envío se actualiza 3 veces al día para cada envío, 3 llamadas GET son suficientes.

Precaución:

• La API de Shipsgo proporciona datos provenientes del viaje activo o más reciente de un contenedor.
• No se admite el seguimiento del "House of Bill of Lading".
• Solo se acepta el número de conocimiento de embarque maestro.
• Es suficiente ejecutar POST para cada pista por una vez.

Si desea desactivar la barra de búsqueda en la solución Live Map que está utilizando en sus sitios web, puede utilizar los siguientes códigos iframe.

<iframe

src="http://shipsgo.com/iframe/where-is-my-container/TEST1234567?tags=hide-search-box"

id="IframeShipsgoLiveMap"

style="height: 550px;width: 100%;"></iframe>

<script>

if (window.addEventListener)

window.addEventListener("message", ShipsgoMessagesListener);

function ShipsgoMessagesListener() {

if (event.data.Action === "LoadNewContainerCode")

document.getElementById("IframeShipsgoLiveMap").src =

"http://shipsgo.com/iframe/where-is-my-container/" +

event.data.Parameters.ContainerCode + '?tags=hide-search-box';

}

var urlParams = new URLSearchParams(window.location.search);

var defaultQuery = urlParams.get('query');

if (defaultQuery === undefined || defaultQuery === null)

defaultQuery = "default-container-code";

document.getElementById("IframeShipsgoLiveMap").src =

"http://shipsgo.com/iframe/where-is-my-container/" +

defaultQuery + '?tags=hide-search-box';

</script>

Nota importante: Si desea ocultar tanto la barra de búsqueda como la ventana de movimientos, también puede hacerlo; simplemente aplique ambas soluciones a su código.

Si desea desactivar la ventana de movimientos en la solución Live Map que está utilizando en sus sitios web, puede utilizar los siguientes códigos.

<iframe

src="http://shipsgo.com/iframe/where-is-my-container/TEST1234567?movements=hide"

id="IframeShipsgoLiveMap"

style="height: 550px;width: 100%;"></iframe>

<script>

if (window.addEventListener)

window.addEventListener("message", ShipsgoMessagesListener);

function ShipsgoMessagesListener() {

if (event.data.Action === "LoadNewContainerCode")

document.getElementById("IframeShipsgoLiveMap").src =

"http://shipsgo.com/iframe/where-is-my-container/" +

event.data.Parameters.ContainerCode + '?movements=hide';

}

var urlParams = new URLSearchParams(window.location.search);

var defaultQuery = urlParams.get('query');

if (defaultQuery === undefined || defaultQuery === null)

defaultQuery = "default-container-code";

document.getElementById("IframeShipsgoLiveMap").src =

"http://shipsgo.com/iframe/where-is-my-container/" +

defaultQuery + '?movements=hide';

</script>

Nota importante: Si desea ocultar tanto la barra de búsqueda como la ventana de movimientos, también puede hacerlo; simplemente aplique ambas soluciones a su código.

Si desea desactivar la ventana de movimientos y la barra de búsqueda que se encuentran en la solución Live Map que está utilizando en sus sitios web, puede utilizar los siguientes códigos.

<iframe

src="http://shipsgo.com/iframe/where-is-my-container/TEST1234567?movements=hide&tags

=hide-search-box" id="IframeShipsgoLiveMap"

style="height: 550px;width: 100%;"></iframe>

<script>

if (window.addEventListener)

window.addEventListener("message", ShipsgoMessagesListener);

function ShipsgoMessagesListener() {

if (event.data.Action === "LoadNewContainerCode")

document.getElementById("IframeShipsgoLiveMap").src =

"http://shipsgo.com/iframe/where-is-my-container/" +

event.data.Parameters.ContainerCode +

'?movements=hide&tags=hide-search-box';

}

var urlParams = new URLSearchParams(window.location.search);

var defaultQuery = urlParams.get('query');

if (defaultQuery === undefined || defaultQuery === null)

defaultQuery = "default-container-code";

document.getElementById("IframeShipsgoLiveMap").src =

"http://shipsgo.com/iframe/where-is-my-container/" +

defaultQuery + '?movements=hide&tags=hide-search-box';

</script>

Cuando publica el envío en Shipsgo, obtiene una ID de solicitud si el POST es exitoso. Después de obtener el ID de solicitud, puede realizar una llamada de inmediato. Tendrás una respuesta. Sin embargo, es posible que los datos no estén disponibles en ese momento y que el archivo XML sea nulo porque la disponibilidad de los datos depende del operador. Si los datos están disponibles en el sitio web del operador, el tiempo de respuesta promedio es en segundos.

Los datos del viaje se actualizan 3 veces en un día. Por lo tanto, puede configurar su función GET para que se active 3 veces al día.

Para obtener datos de Shipsgo, inicialmente, debe enviar datos a nuestro sistema utilizando la función POST de nuestra API. Después de la publicación, su solicitud debería llegarnos con éxito. Luego puede extraer los datos del viaje mediante el método GET de la API.

Si sus datos nos llegan con éxito, entonces una "Solicitud de ID" regresa como respuesta. Estas identificaciones son únicas para cada solicitud de seguimiento suya y difieren de un envío a otro. La función más importante de esta identificación es que cuando obtenga esta identificación, ya estará seguro de que su POST nos ha llegado con éxito. Es un mensaje de confirmación de Shipsgo, por así decirlo.

Ejemplo de respuesta exitosa ID 1-534567

Sin embargo, su POST falló si obtiene las siguientes respuestas en lugar de request-id. Debe corregir los datos de acuerdo con las explicaciones y publicar la solicitud nuevamente.

Respuesta: "The Field (Code) Value (test1234) is not in a valid format"

El número de contenedor debe constar de 11 caracteres: 4 letras seguidas de 7 números EX. AAAA1234567

Respuesta: "The Field (Code) Value (EGHU9483781) is not valid"

El formato del número del contenedor es verdadero; sin embargo, el número no es válido. Sería EGHU948378-8 debido a las reglas de creación del número de contenedor

Respuesta: "The shipping line field is required"

Debe ingresar el nombre de la línea de envío de acuerdo con la lista de líneas de envío de Shipsgo

Respuesta: "The Entered Value (support@gmaıl.com) In Field (Email) Is Not A Valid Email Address"

Escribiste mal la dirección de correo electrónico. Por favor controle la escritura

Respuesta: "No Active Subscription Or It Is Expire"

Probablemente sus créditos se agotaron o su cuenta estaba inactiva por alguna otra razón. Póngase en contacto con el equipo de Shipsgo cuando suceda.

Una vez que haya completado con éxito el POST, puede ejecutar el método GET siguiendo las reglas. Puede encontrar algunos mensajes de error mientras ejecuta GET. Aquí están ellos y su significado:

Mensaje de error: "Invalid authentication code"

Está utilizando una CLAVE API no válida o su cuenta tiene prohibido usar la conexión API

Mensaje de error: "No Active Subscription Or It Is Expire"

Probablemente sus créditos se agotaron o su cuenta estaba inactiva por alguna otra razón.

Mensaje de error: "No Active Subscription Or It Is Expire"

Está ingresando el número de contenedor/ID de solicitud incorrecto. O intenta obtener los datos del contenedor de los que no ha POST la solicitud de seguimiento para nosotros.

Puede encontrar todos los detalles sobre los términos de la API aquí.

No, no hay limitación para publicar solicitudes de seguimiento; o hacer una llamada para obtener datos de viaje. Su límite de llamadas API solo está restringido a la cantidad de crédito en sus cuentas. Sus créditos solo se consumirán cuando POST el envío al sistema. No paga por GET datos de viaje, es decir, por múltiples llamadas API.

Cada envío se actualiza cada 8 horas después del tiempo de creación, por lo que el tiempo de actualización difiere de un envío a otro según el tiempo de creación. Sin embargo, puede configurar su función GET 3 veces al día por la mañana, al mediodía y por la noche. Entonces, al final del día, tendrá todas las actualizaciones para todos sus envíos.

Una vez que nos llega su solicitud de seguimiento, nuestro sistema verifica el sitio web del transportista para completar el formulario XML.

1. Si su sistema llama a los datos antes de que el sistema recopile los datos del sitio web del operador, puede tener una respuesta de datos vacía. Lo más probable es que, en el segundo intento de llamada, tengas los datos.

2. Si el transportista aún no proporciona los datos del viaje, la respuesta XML simplemente estará vacía. Sin embargo, nuestro sistema revisa el sitio web del operador 3 veces al día y obtiene los datos cuando están listos. Lo que debe hacer es configurar su llamada GET para que se ejecute 3 veces al día y, al final del día, tendrá todos los datos disponibles. El estado de este tipo de datos es "In Progress"".

3. A veces, sin embargo, los envíos no son rastreables en absoluto. El estado de este tipo de envío es "Untracked". El envío puede ser imposible de rastrear si la línea de envío no tiene ningún sistema de seguimiento o si el número de contenedor no se puede asignar a ninguna línea de envío.

Ejemplo de datos completos XML: https://drive.google.com/file/d/1_yHhrFHOMcBBjGUgWgAH53oxGoiNEZze/view?usp=sharing

Ejemplo de datos completos de JSON: https://drive.google.com/file/d/167S4Ljoo_Op8u3J5k74c-_5In2hGUbOt/view?usp=sharing"

Sí, proporcionamos API. Puede encontrar todos los detalles sobre la API aquí. Si necesita soporte técnico o más información relacionada con la integración de API, no dude en escribirnos desde Live Chat o support@shipsgo.com.

Por supuesto. Basta con"crear una función GET con API y agregar "&mapPoint=true" al final de la URL de solicitud. Luego verá que se abrirá una nueva ventana que muestra la posición de la embarcación en un mapa en vivo.

Después de crear su cuenta, tendrá una clave API. Puede acceder a él a través de su panel de control en la sección "Integración de Shipsgo" en la barra lateral izquierda. Puede considerar esta clave como un código de comunicación entre su empresa y Shipsgo.

Gracias a esta clave, cuando el cliente envía la solicitud de seguimiento, el sistema Shipsgo reconoce el nombre de la empresa y almacena la solicitud en la cuenta de la empresa. Luego, nuestro sistema envía el correo electrónico de notificación a usted y a sus clientes con su logotipo y dirección de correo electrónico si lo desea.

Además, también usamos esta clave para calcular el consumo de sus créditos.

Cuando utiliza la integración API, obtiene información de viaje en formato XML o JSON. Una de las primeras cosas que verá en el archivo XML O JSON es el "status". Este "status" indica el estado de los envíos.

Los significados de los estados son los siguientes;

InProgress (StatusId = 20): la línea naviera aún no ha publicado ninguna información sobre el contenedor.

Booked (StatusId = 30): la línea naviera ha compartido la información del viaje sobre este envío. Aún no ha navegado.

Loaded (StatusId = 35): el envío está cargado en el barco, pero el barco aún no ha salido de POL.

Sailing (StatusId = 40): El contenedor está en camino.

Arrived (StatusId = 45): el buque llegó a POD pero el envío está esperando para ser descargado

Discharged (StatusId = 50): El contenedor fue descargado en el puerto de descarga.

Untracked (StatusId = 60): No es posible rastrear el contenedor porque la naviera responsable de transportar el contenedor no tiene un servicio de rastreo en línea.

No, since Shipsgo collects publicly available information, authorization is not required. You can track your shipment at any time, as long as your shipping line is one of the supported shipping lines and you have an API key.

No. Lo único que debe hacer es enviar el número de BL. El sistema activará los contenedores debajo del BL con los datos del viaje y los preparará en XML/JSON.

Desafortunadamente, nuestra API actual le permite consultar cada envío por separado.