Conector Shippo

Integración con la API de Shippo

Introducción

Shippo es una API y una aplicación web de envío multitransportista que incluye transportistas como USPS, DHL y FedEx, entre muchos otros. Los clientes pueden obtener tarifas de envío, imprimir etiquetas, automatizar documentos internacionales, realizar el seguimiento de los envíos y facilitar las devoluciones.

Propósito

Esta integración destaca cómo se pueden aprovechar las funciones del conector HTTP de Tulip para integrarse con la API de Shippo para automatizar la creación de envíos, obtener una variedad de tarifas de una gama de transportistas, elegir la mejor tarifa y, finalmente, crear e imprimir una etiqueta de envío junto con la opción de realizar un seguimiento de los envíos. Todo esto se puede hacer desde su aplicación Tulip. Dependiendo de los diferentes casos de uso, la integración con Tulip se puede aprovechar para tener el control sobre la operación de la cadena de suministro y tener visibilidad en tiempo real en el envío de paquetes.

Documentación API

Documentación API Shippo

Requisitos previos

Cree una cuenta en el sitio web de Shippo y genere tokens de API que se utilizarán como cabeceras de autorización en todas las llamadas realizadas a la API de Shippo. Shippo le permite generar un token de prueba y un token activo. El token de prueba se puede utilizar para realizar llamadas HTTP de prueba con la API y diseñar tu aplicación Tulip, una vez que la aplicación esté lista, los tokens se pueden cambiar y las aplicaciones se pueden implementar en la producción para generar etiquetas de envío, transacciones en tiempo real.

Detalles de la conexión de Tulip

El conector HTTP de Tulip necesita ser configurado con los siguientes detalles para establecer una conexión con Shippo.

1. Ejecutando en: Cloud Connector Host
2. Host : api.goshippo.com
3. Puerto:443
4. TLS:Sí
5. Los tokens Shippo como cabecera de autorización se pueden pasar a través de la función del conector

Función del conector

Crear envío

Propósito

1. Esta función del conector crea un nuevo envío realizando una llamada POST a la API de Shippo con los detalles del remitente, los detalles del destinatario y los detalles del paquete como parte del cuerpo de la solicitud.
2. Una vez creado con éxito, Shippo devuelve un objeto JSON que incluye el estado del envío creado junto con una selección de tarifas de diferentes proveedores que los usuarios pueden aprovechar para seguir adelante e iniciar una transacción. Los usuarios pueden seleccionar la tarifa correcta, tener los IDs de tarifa almacenados en variables Tulip que se pasarían dinámicamente para crear la transacción para generar la etiqueta de Envío en la función de conector correspondiente.

Punto final

1. Llamada HTTP POST al punto final: https://api.goshippo.com:443/shipments/

Cabecera de Autorización

Para autenticarse con la API de Shippo, es necesario pasar el token HTTP de Shippo en la cabecera de la solicitud. El formato es el siguiente

Autorización : ShippoToken ($ShippoToken$)

Entrada obligatoria

Los siguientes son los parámetros de entrada que se pasan en el cuerpo de la solicitud donde JSON es el tipo de contenido.

1. Nombre del remitente, calle, ciudad, estado, código postal y país.
2. Receptores Nombre, Calle, Ciudad, Estado, Código postal, País
3. Dimensiones del paquete - Longitud, Anchura, Anchura y Peso

Extractor de salida requerido

Se devuelve mucha información para el objeto Envío creado, sin embargo, los campos importantes a extraer se mencionan a continuación

1. Estado: Indica si el Envío se ha creado correctamente
2. ID del Envío: Puede ser referenciado para obtener los detalles del Envío creado.
3. Opciones de Tarifa: Array de objetos que indican diferentes opciones de la tarifa proporcionada por diferentes vendedores. El ID de tarifa es la clave importante, entre otras, que se extraerá para crear la transacción real para este envío.

Crear Transacción

Propósito

1. Esta función del conector crea la transacción después de elegir el proveedor y la tarifa final entre las diferentes opciones que se devolvieron al crear un nuevo envío en la función del conector anterior.
2. Una transacción exitosa se establece haciendo una llamada POST HTTP al endpoint de Shippo pasando el ID asociado a la tarifa decidida. Cuando la llamada se realiza correctamente, Shippo devuelve un objeto JSON que incluye el estado de la transacción, el ID de seguimiento, la etiqueta de envío y la URL de seguimiento, entre otra información. La etiqueta de envío devuelta puede imprimirse directamente desde la propia Tulip App.

Punto final

1. Llamada HTTP POST al punto final: https://api.goshippo.com:443/transactions/

Cabecera de autorización

Para autenticarse con la API de Shippo, es necesario introducir el token HTTP de Shippo en la cabecera de la solicitud. El formato es el siguiente

Autorización : ShippoToken ($ShippoToken$)

Entrada obligatoria

Los siguientes son los parámetros de entrada que se pasan en el cuerpo de la solicitud donde JSON es el tipo de contenido.

1. Rate ID: Pasando el ID de la tarifa elegida para seguir adelante con el fin de crear una transacción exitosa.

Extractor de salida requerido

Se devuelve mucha información para el objeto Envío creado, sin embargo, los campos importantes a extraer se mencionan a continuación

1. Estado: Indica si la transacción se ha creado con éxito
2. ID de Transacción: Puede ser referenciado para obtener los detalles de la transacción ejecutada.
3. Número de seguimiento: Para realizar el seguimiento del envío
4. URL de seguimiento: La URL de la página de seguimiento del proveedor elegido
5. URL de la etiqueta: Etiqueta de envío que podría incrustarse dentro de la aplicación Tulip para su impresión