Nuestra API permite a los desarrolladores diseñar aplicaciones que interactúen con la plataforma ShipStation. Puedes utilizar la API para gestionar muchas tareas, entre ellas:
-
Administrar pedidos
-
Administrar envíos
-
Crear etiquetas de envío
-
Recuperar tarifas de envío
-
¡y mucho más!
ShipStation ha lanzado recientemente la API V2, una nueva versión de nuestra API que incluye puntos finales de envío e inventario. La API abierta anterior ahora se denomina API V1 y sigue estando operativa.
ShipStation se esfuerza por agilizar los envíos para los vendedores en línea, independientemente de dónde vendan sus productos en línea. Agregamos continuamente nuevos marketplaces, carritos de compra y herramientas de integración porque sabemos que el espacio del comercio electrónico está creciendo. Como resultado, hemos trabajado arduamente para proporcionar recursos a los desarrolladores para que diseñen integraciones personalizadas con ShipStation.
Consulta esta página de desarrolladores de ShipStation para ver la documentación completa de la V2 y esta página para ver la documentación de la API abierta de la V1. Consulta el Portal para desarrolladores de ShipStation a fin de obtener la documentación completa sobre la API REST de ShipStation.
La API V2 es una excelente manera de obtener datos directamente desde y hacia ShipStation, especialmente cuando creas pedidos, agregas clientes o consultas tus datos de pedidos y envíos.
La API V1 estará limitada únicamente a aquellas cuentas con planes Gold, Acelerar o superiores. La API V1 no estará disponible a través del complemento ni en los planes más bajos.
Para las cuentas de ShipStaton con un plan Gold, Accelerate o superior, tendrás acceso a los puntos finales de la API V2 y la API V1. Para V1 puedes generar dos claves API. Para cuentas en cualquier país con cualquier otro plan de suscripción, los puntos finales de inventario de la API V2 estarán disponibles como un complemento de pago.
Adjunto al final de este artículo, encontrarás como referencia hojas de cálculo con códigos API para muchos de nuestros servicios de envío disponibles. Solo incluye los códigos de los servicios de envío disponibles públicamente.
Utiliza varias claves de API V1 para una sola plataforma
ShipStation permite dos claves API V1 que facilitan el proceso de rotación de claves dentro de la misma integración. Esta rotación tiene como objetivo garantizar un flujo de trabajo y una seguridad constantes. Estas claves no deben ser utilizadas para dos integraciones distintas.
Cuando tu clave API esté a punto de expirar, te enviaremos un recordatorio por correo electrónico para que rotes tus claves antes de que la actual quede inactiva.
Plan Gold (🇺🇸 EE. UU., 🇨🇦 CA) o plan Accelerate (🇬🇧 Reino Unido, 🇦🇺 AU, 🇳🇿 NZ, 🇪🇺 UE) o superior: la API V1 se incluirá automáticamente para las cuentas en estos planes. Ten en cuenta que:
-
Puedes seguir accediendo a V1 de la misma manera que antes.
-
Tus claves API expirarán. Puedes generar una nueva clave de API para actualizarla y ponerla en uso antes de que expire la primera. No experimentarás ninguna pérdida de tiempo en tu flujo de trabajo y disfrutarás de una mayor seguridad.
Las Cuentas en cualquier plan inferior a Gold, deben tener en cuenta que:
-
Ya no podrás generar claves API V1 (ShipStation OpenAPI).
-
La API V1 (ShipStation openAPI) no estará disponible a través del complemento. En su lugar, te animamos a que actualices y pruebes la API V2.
Estos puntos finales serán similares a la API V1, pero tendrán características ampliadas y seguirán desarrollándose. Los dos aspectos incluyen una API de Inventario y una API de Envío:
API de Inventario:
La API de inventario de ShipStation ofrece herramientas potentes para gestionar el inventario en múltiples almacenes. Con estos puntos finales de API, puedes recuperar los niveles de existencias, establecer y actualizar los recuentos de SKU, actualizar las cantidades de inventario y sincronizar los datos entre ShipStation, los almacenes de inventario y los sistemas externos.
CARACTERÍSTICAS:
-
Seguimiento de inventario en tiempo real: Obtén niveles precisos de existencias en todas las ubicaciones.
-
Actualizaciones por lotes: Modifica las cantidades de inventario en lote.
-
Administración de almacenes: Asigna inventario a almacenes específicos.
-
Ajustes de stock: Seguimiento de cambios debido a ventas, devoluciones o ajustes manuales.
API de Envío:
Estos puntos finales incluyen todo lo demás relacionado con el envío, como tarifas, formularios de aduanas, etiquetas, seguimiento, etc.
Para cualquiera de los dos, también puedes generar una segunda clave API antes de que expire la otra. No experimentarás ninguna pérdida de tiempo en tu flujo de trabajo y disfrutarás de una mayor seguridad.
Gold, Acelerar o superior:
-
Tienes acceso a los puntos de conexión de la API V1 y V2, y puedes generar múltiples claves para V1.
Planes de cuenta inferiores a Gold o Accelerate:
-
Puedes agregar la API V2 (solo puntos finales de inventario) a través de los complementos.
-
V1 no estará disponible. Cualquier clave de API que se esté utilizando actualmente expirará.
Para usar la API de ShipStation, deberás generar una clave de API y, en el caso de la versión 1, también un secreto de API. Esta información se incluirá con cualquier llamada realizada a la API. La clave de API y el secreto de API se utilizan para autenticar las llamadas a la API, de modo que ShipStation actualice la información dentro de tu cuenta específica.
Las cuentas nuevas obtienen acceso después de la verificación por correo electrónico
Por motivos de seguridad, requerimos la verificación de la cuenta por correo electrónico después de que te hayas registrado para tener una cuenta en ShipStation y antes de que puedas generar claves API.
Para un acceso más rápido o para necesidades urgentes durante el periodo de espera para que se complete la verificación por email, no dudes en ponerte en contacto con el administrador de tu cuenta de prueba o contacta al equipo de soporte de ShipStation para que te ayude.
Para obtener tu clave API y tu secreto en ShipStation:
-
Selecciona tu versión de API en el menú desplegable y haz clic en Generar clave de API.
Te enviaremos un enlace de verificación a tu dirección de correo electrónico de usuario.
IMPORTANTE: Claves API generadas
Las claves API y los secretos API solo se mostrarán en la interfaz de usuario de ShipStation cuando se generen y solo para el usuario que los generó. Estarán ocultos a la vista en la interfaz de usuario de ShipStation después de que navegues fuera de la página.
Es muy recomendable que copies las claves API y los secretos API y mantengas un registro de estos inmediatamente después de que se generen.
La generación de claves API está limitada únicamente al propietario de la cuenta
-
Solo el Propietario de la Cuenta puede generar claves API. Deberá verificar su correo electrónico para acceder al generador de claves API.
-
Las claves API solo pueden visualizarse en texto sin formato. Esta vista estará disponible solo una vez, inmediatamente después de que se generen las claves.
-
Si no está seguro de quién se considera el propietario de su cuenta, póngase en contacto con support@shipstation.compara confirmarlo.
-
-
Verifica el enlace de verificación que enviamos a tu dirección de correo electrónico de usuario y luego vuelve a generar las claves.
El botón Generar clave de API se restablecerá una vez que verifiques tu correo electrónico.
-
Establece la caducidad (3, 6 o 12 meses) para tu nueva clave de API y, a continuación, haz clic en Generar.
-
Haz clic en el ícono Copiar
para copiar tu clave de API recién generada. Asegúrate de almacenarla de forma segura.
A continuación, puedes proporcionar a la API de ShipStation tu clave y tu secreto de la cuenta a la que deseas acceder.
Una vez generadas las claves de API, podrás copiarlas desde esta página y proporcionarlas cuando sea necesario a cualquier desarrollador de API.
Tu cuenta de ShipStation solo puede emitir un único conjunto de claves API a la vez. El mismo conjunto de claves API puede utilizarse para varias aplicaciones API. Si generas nuevas claves en algún momento, asegúrate de proporcionar las nuevas claves a cualquier aplicación que las utilice, o la conexión con ShipStation dejará de funcionar.
En este momento, no hay forma de limitar el alcance del acceso a la API. Si un desarrollador de la API tiene acceso a tu clave y secreto, podrá realizar cualquier acción disponible de la API de ShipStation.
Actualizar una clave API significa reemplazar la clave antigua por una nueva. Periódicamente, deberás crear una nueva clave y actualizar tus integraciones.
Para actualizar una clave de API:
-
Ve a Configuración > Cuenta > Configuración de API.
-
Selecciona tu versión de API en el menú desplegable y haz clic en Generar clave de API.
Si ya tienes dos conjuntos de claves de API, elimina uno antes de generar un nuevo conjunto.
¿Ve V2 en el menú desplegable? Esto es lo que necesitas saber.
Si aún no tienes generadas las claves de API V2, no es necesario generar claves de API V2 para este proceso. Ten en cuenta que las claves de API V1 y V2 no son intercambiables; se utilizan para diferentes tipos de integraciones.
Te enviaremos un enlace de verificación a tu dirección de correo electrónico de usuario.
-
Verifica el enlace de verificación que enviamos a tu dirección de correo electrónico de usuario y luego vuelve a generar las claves.
El botón Generar clave de API se restablecerá una vez que verifiques tu correo electrónico.
-
Establece la caducidad (3, 6 o 12 meses) para tu nueva clave de API y, a continuación, haz clic en Generar.
-
Haz clic en el ícono Copiar
-
Localiza la clave API que deseas cambiar y haz clic en el ícono de la papelera
a su lado.
-
Haz clic en Eliminar clave en la ventana emergente Eliminar clave de API.
Eliminar una clave API es una acción que no se puede deshacer. Tendrás que actualizar cualquier plataforma que haya usado esa clave cuando generes una nueva clave.
Antes de comenzar con la API de ShipStation, te recomendamos encarecidamente que revises el Portal para desarrolladores de ShipStation para obtener una visión general completa de todas las acciones que pueden realizar las llamadas a la API. Esta documentación también te proporciona ejemplos de llamadas y respuestas para la comunicación API e información detallada sobre cómo autenticar tu clave y secreto de API para las llamadas de la API.
El equipo de soporte de ShipStation no puede ayudarte a ayudarte a diseñar o desarrollar una integración de API, pero sí a probar las llamadas de API y asegurarnos de que todo funciona según lo diseñado o a identificar información dentro del cuerpo de la llamada que podría causar errores.
Si tienes problemas con una o más de tus llamadas a la API y necesitas ayuda, envía un correo electrónico directamente a nuestro equipo de soporte de API.
Para obtener soporte de API V1, envía un correo electrónico a apisupport@shipstation.com y nuestro equipo te ayudará a investigar el problema.
Para obtener Soporte de la API V2, envía un correo electrónico a shippingapisupport@shipstation.com y nuestro equipo te ayudará a investigar el problema.
Para ayudarte mejor, asegúrate de incluir la siguiente información:
-
La acción de la API que intentabas realizar (por ejemplo: Listar envíos, Crear pedidos, etc.)
-
El punto final completo de la API con el que estabas contactando (ej: https://ssapi.shipstation.com/shipments?orderNumber=zen-285858-1)
-
Si haces una llamada para PUBLICAR una API, el cuerpo completo de JSON de la solicitud.
-
El número de código de estado de la respuesta de la API.
-
La respuesta JSON completa a la llamada a la API.
Sin la información anterior, puede ser difícil para ShipStation solucionar los problemas de la API. Si no estás seguro de cómo obtener esa información, te recomendamos que te pongas en contacto directamente con tu desarrollador de la API para que te ayude a obtener los registros disponibles. También te recomendamos que incluyas en copia a tu desarrollador de API en cualquier comunicación por correo electrónico para V1 vía apisupport@shipstation.com o para V2 vía shippingapisupport@shipstation.com.
-
Recuperar tarifas de envío puede no estar disponible para algunas empresas de transporte y servicios.
Es posible que algunas empresas de transporte y servicios para algunas empresas de transporte no estén disponibles para recuperar las tarifas de envío a través de llamadas de
GetRate. Por ejemplo, las llamadasgetRateno devolverán tarifas utilizables para UPS Ground Saver ®. Para garantizar que se haga correctamente, comprueba primero con tu empresa de transporte cuáles de sus servicios de envío disponibles admiten la navegación de tarifas. -
La API de ShipStation V1 no admite la función Reenviar un pedido.
-
La API abierta de ShipStation no admite conjuntos de caracteres no romanos, como el japonés, el chino y el cirílico. Estos conjuntos a menudo no son compatibles con la API de etiquetas de la empresa de transporte, lo que da como resultado símbolos ??? o espacios en blanco en la etiqueta donde deben estar los caracteres.