Descripción de las capacidades de la API REST de ShipStation, cómo generar tokens de acceso y cómo obtener asistencia para problemas con la API REST.
Nuestra API REST está disponible para cualquier plan, y permite el acceso de lectura y escritura: acceso de lectura a casi todos los datos de tu cuenta, y acceso de escritura para crear objetos específicos, como pedidos, clientes y productos. La API 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.
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 el Portal para desarrolladores de ShipStation para obtener documentación completa sobre la API REST de ShipStation.
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!
Adjunto a este artículo, como referencia, encontrarás 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.
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 llamadas getRate no devolverán tarifas utilizables para UPS Surepost®. 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.
Para utilizar la API de ShipStation, tendrás que generar una clave y un secreto de API que se incluirán con cualquier llamada que se haga a la API. La clave y el secreto 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 48 horas
Por motivos de seguridad, hay un periodo de espera de 48 horas después de que te hayas registrado en una cuenta de ShipStation antes de que puedas generar claves API.
Para un acceso más rápido o para necesidades urgentes durante el periodo de espera inicial de 48 horas, no dudes en ponerte en contacto con el administrador de tu cuenta de prueba para que te ayude.
-
Haz clic en Generar nuevas claves de API si aún no se enumeran claves y secretos.
-
Copia tu clave y secreto.
A continuación, puedes proporcionarlos a la cuenta que desees para acceder a la API de ShipStation.
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.
Antes de comenzar con la API de ShipStation, te recomendamos encarecidamente que revises el Portal para desarrolladores de ShipStation para obtener una descripción completa de todas las acciones que se pueden realizar a través de llamadas de 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 llamadas a la API y necesitas ayuda, envía un correo electrónico a nuestro equipo de soporte de API directamente a apisupport@shipstation.com y nuestro equipo te ayudará a investigar el problema.
Limitaciones de la API abierta de ShipStation
-
La API abierta de ShipStation no es compatible con 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.
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.
Soporte para problemas con la API
Sin la información anterior, puede ser difícil para ShipStation solucionar los problemas de la API. Si no sabes 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 sugerimos que envíes una copia a tu desarrollador de la API en cualquier comunicación a apisupport@shipstation.com.