Notre API permet aux développeurs de créer des applications qui font interface avec la plateforme ShipStation. Vous pouvez utiliser l'API pour gérer de nombreuses tâches, notamment :
-
Gérer les commandes
-
Gérer les expéditions
-
Création d'étiquettes d'expédition
-
Récupération des tarifs d'expédition
-
et plus encore !
ShipStation a récemment lancé l'API V2, une nouvelle version de notre API qui inclut des points de terminaison pour l'expédition et les stocks. L'API ouverte précédente s'appelle désormais API V1 et est toujours opérationnelle.
ShipStation s'efforce de rationaliser l'expédition pour les vendeurs en ligne, quel que soit l'endroit où ils vendent leurs produits en ligne. Nous ajoutons continuellement de nouvelles plateformes marchandes, des paniers d'achat et des outils d'intégration, car nous savons que l'espace e-commerce est en plein essor. Par conséquent, nous avons travaillé dur pour fournir aux développeurs les ressources dont ils ont besoin pour créer des intégrations personnalisées avec ShipStation.
Consultez cette page ShipStation dédiée aux développeurs pour la documentation complète de V2 et cette page pour la documentation de l'API ouverte V1. Consultez le portail développeurs ShipStation pour obtenir une documentation complète sur l'API REST de ShipStation.
L'API V2 est un excellent moyen d'obtenir des données directement à partir de et vers ShipStation, surtout lorsque vous créez des commandes, ajoutez des clients ou interrogez vos données de commande et d'expédition.
L'API V1 sera réservée aux comptes ayant souscrit un forfait Or, Accélérer ou supérieur. Elle ne sera pas disponible par le biais du module complémentaire ni pour les forfaits de niveau inférieur.
Les comptes ShipStation abonnés à un forfait Or, Accélérer ou supérieur auront accès aux points de terminaison de l'API V2 et de l'API V1. L'API V1 permet de générer deux clés API. Les comptes enregistrés dans n'importe quel pays et qui disposent d'un autre forfait d'abonnement pourront bénéficier des points de terminaison des stocks de l'API V2 sous forme d'option payante.
À la fin de cet article, vous trouverez pour référence des feuilles de calcul avec les codes API de plusieurs de nos services d'expédition disponibles. Seuls sont inclus les codes correspondant aux services d'expédition accessibles au public.
Utiliser plusieurs clés API V1 pour une seule plateforme
Avec ShipStation, il est possible d'utiliser deux clés API V1 pour simplifier le processus de rotation des clés dans la même intégration. Cette rotation a pour but de vous assurer un workflow cohérent et une sécurité optimale. Ces clés ne doivent pas être utilisées pour deux intégrations distinctes.
Lorsque votre clé API sera sur le point d'expirer, nous vous rappellerons par e-mail que vous devez changer de clé avant que la clé actuelle ne devienne inactive.
Forfait Or (🇺🇸 États-Unis, 🇨🇦 Canada), Accélérer (🇬🇧 Royaume-Uni, 🇦🇺 Australie, 🇳🇿 Nouvelle-Zélande, 🇪🇺 UE) ou supérieur : l'API V1 sera automatiquement incluse pour les comptes qui y souscrivent. Veuillez noter que :
-
Vous pouvez continuer d'accéder à l'API V1 de la même manière qu'auparavant.
-
Vos clés API vont expirer. Vous pourrez générer une nouvelle clé API afin de changer de clé avant l'expiration de la première. Vous ne perdrez pas de temps dans votre workflow et bénéficierez d'une sécurité renforcée.
Pour les comptes disposant de n'importe quel forfait inférieur à Or, veuillez noter que :
-
Vous ne pourrez plus générer de clés API V1 (API ouverte de ShipStation).
-
L'API V1 (API ouverte de ShipStation) ne sera pas disponible par le biais du module complémentaire. Nous vous conseillons de passer à un forfait de niveau supérieur et de tester l'API V2.
Ces points de terminaison seront similaires à ceux de l'API V1, mais ils disposeront de fonctionnalités étendues et continueront à être développés. Les 2 aspects incluent une API Inventaire et une API Expédition :
API Inventaire :
L'API Inventaire de ShipStation fournit des outils puissants pour gérer les inventaires de plusieurs entrepôts. Grâce à ces points de terminaison de l'API, vous pouvez récupérer les niveaux de stock, définir et mettre à jour le nombre de SKU, mettre à jour les quantités de l'inventaire et synchroniser les données entre ShipStation, les entrepôts de l'inventaire et les systèmes externes.
FONCTIONNALITÉS :
-
Suivi de l'inventaire en temps réel : consultez des niveaux d'inventaire précis sur tous les sites.
-
Mises à jour par lots : modifiez les quantités d'inventaire en bloc.
-
Gestion des entrepôts : affectez l'inventaire à des entrepôts spécifiques.
-
Ajustements de stock : suivez les modifications dues aux ventes, aux retours ou aux ajustements manuels.
API Expédition :
Ces points de terminaison incluent tous les autres aspects de l'expédition : tarifs, formulaires de douane, étiquettes, suivi, etc.
Dans les deux cas, vous pouvez également générer une 2e clé API avant que l'autre n'expire. Vous ne perdrez pas de temps dans votre workflow et bénéficierez d'une sécurité renforcée.
Or, Accélérer ou supérieur :
-
Vous avez accès aux points de terminaison de l'API V1 et de l'API V2, et vous pouvez générer plusieurs clés pour l'API V1.
Forfaits inférieurs à Or ou Accélérer :
-
Vous pouvez ajouter l'API V2 (points de terminaison des stocks uniquement) par le biais des modules complémentaires.
-
L'API V1 ne sera pas disponible. Toutes les clés API actuellement utilisées expireront.
Pour utiliser l'API de ShipStation, vous devez générer une clé API. Pour V1, vous devez en outre générer un secret API. Ces informations seront incluses dans tous les appels d'API. La clé API et le secret API servent à authentifier les appels d'API afin que ShipStation mette à jour les informations de votre compte.
L'accès est accordé aux nouveaux comptes après vérification de l'adresse e-mail
Pour des raisons de sécurité, après la création d'un compte ShipStation, nous exigeons la vérification du compte par e-mail avant que vous ne puissiez générer des clés API.
Pour un accès plus rapide ou des besoins urgents en attendant que la vérification par e-mail soit terminée, n'hésitez pas à contacter votre gestionnaire de compte d'essai ou à contacter l'assistance ShipStation pour obtenir de l'aide.
Pour obtenir votre clé et votre secret d'API dans ShipStation :
-
Sélectionnez votre version d'API dans la liste déroulante et cliquez sur Générer une clé API.
Nous vous enverrons un lien de vérification à votre adresse e-mail d'utilisateur.
IMPORTANT : clés API générées
Les clés API et les secrets API ne s'affichent dans l'interface utilisateur de ShipStation que lorsqu'ils sont générés et uniquement pour l'utilisateur qui les a générés. Ils seront masqués de l'interface utilisateur de ShipStation une fois que vous aurez quitté la page.
Nous vous recommandons vivement de copier les clés API et les secrets API et d'en conserver un enregistrement immédiatement après leur génération.
Génération de clés API réservée au propriétaire du compte
-
Seul le propriétaire du compte peut générer des clés API. Celui-ci devra vérifier son adresse e-mail pour accéder au générateur de clés API.
-
Les clés API ne peuvent être consultées qu'en texte brut. Cette vue ne sera disponible qu'une seule fois, immédiatement après la génération des clés.
-
Si vous ne savez pas qui est considéré comme le propriétaire de votre compte, veuillez contacter support@shipstation.com pour confirmation.
-
-
Vérifiez le lien de vérification que nous avons envoyé à votre adresse e-mail d'utilisateur, puis générez à nouveau les clés.
Le bouton Générer une clé API sera réinitialisé une fois que vous aurez vérifié votre adresse e-mail.
-
Définissez la durée d'expiration (3, 6 ou 12 mois) de votre nouvelle clé API, puis cliquez sur Générer.
-
Cliquez sur l'icône Copier
pour copier votre clé API nouvellement générée. Assurez-vous de la conserver en lieu sûr.
Vous pouvez ensuite ajouter votre clé et votre secret au compte avec lequel vous souhaitez accéder à l'API de ShipStation.
Une fois que les clés API ont été générées, vous pouvez les copier sur cette page et les fournir, si nécessaire, à tout développeur d'API.
Votre compte ShipStation ne peut émettre qu'un seul ensemble de clés API à la fois. Le même ensemble de clés API peut être utilisé pour plusieurs applications API. Si, à quelque moment que ce soit, vous générez de nouvelles clés, assurez-vous de fournir les nouvelles clés à toute application qui les utilise, sans quoi la connexion avec ShipStation ne fonctionnera plus.
Il n'existe actuellement aucun moyen de limiter l'ampleur de l'accès à l'API. Si un développeur d'API a accès à votre clé et à votre secret, il pourra effectuer toutes les actions d'API ShipStation disponibles.
Lorsque vous changez de clé API, vous remplacez l'ancienne par une nouvelle. Vous devrez périodiquement créer une nouvelle clé et mettre à jour vos intégrations.
Pour changer de clé API :
-
Accédez à Paramètres > Compte > Paramètres API.
-
Sélectionnez votre version d'API dans la liste déroulante et cliquez sur Générer une clé API.
Si vous avez déjà deux ensembles de clés API, supprimez-en un avant d'en générer un nouveau.
Voyez-vous V2 dans la liste déroulante ? Voici ce que vous devez savoir.
Si vous n'avez pas encore généré de clés API V2, sachez que ce n'est pas nécessaire pour ce processus. Gardez à l'esprit que les clés API V1 et V2 ne sont pas interchangeables : elles s'utilisent pour différents types d'intégrations.
Nous vous enverrons un lien de vérification à votre adresse e-mail d'utilisateur.
-
Vérifiez le lien de vérification que nous avons envoyé à votre adresse e-mail d'utilisateur, puis générez à nouveau les clés.
Le bouton Générer une clé API sera réinitialisé une fois que vous aurez vérifié votre adresse e-mail.
-
Définissez la durée d'expiration (3, 6 ou 12 mois) de votre nouvelle clé API, puis cliquez sur Générer.
-
Cliquez sur l'icône Copier
-
Recherchez la clé API dont vous n'avez plus besoin, puis cliquez sur l'icône Corbeille
à côté de son nom.
-
Cliquez sur Supprimer la clé dans la fenêtre contextuelle Supprimer la clé API.
La suppression d'une clé API est irréversible. Lorsque vous générez une nouvelle clé, vous devez mettre à jour toutes les plateformes qui utilisaient la clé supprimée.
Avant de vous lancer dans l'utilisation de l'API de ShipStation, nous vous recommandons vivement de consulter le portail des développeurs de ShipStation. Vous y trouverez une présentation complète de toutes les actions que peuvent effectuer les appels d'API. Cette documentation vous fournit également des exemples d'appels et de réponses pour la communication API ainsi que des informations détaillées sur la façon d'authentifier votre clé d'API et votre secret pour les appels d'API.
L'équipe d'assistance de ShipStation n'est pas en mesure de vous aider à concevoir ou à construire une intégration d'API, mais peut parfaitement vous aider à tester les appels d'API et à vous assurer que tout fonctionne comme prévu ou vous aider à identifier les informations dans le corps de l'appel qui pourraient provoquer des erreurs.
Si vous rencontrez des problèmes avec un ou plusieurs de vos appels API et que vous avez besoin d'aide, envoyez un e-mail à notre équipe d'assistance API.
Pour l'assistance API V1, veuillez envoyer un e-mail à apisupport@shipstation.com, et notre équipe examinera votre problème.
Pour l'assistance API V2, veuillez envoyer un e-mail à shippingapisupport@shipstation.com et notre équipe se penchera sur votre problème.
Pour mieux vous aider, assurez-vous d'inclure les informations suivantes dans votre message :
-
L'action de l'API que vous avez essayé d'exécuter (par exemple : Faire la liste des expéditions, Créer des commandes, etc.)
-
Le terminal d'API complet que vous avez contacté (par exemple : https://ssapi.shipstation.com/shipments?orderNumber=zen-285858-1)
-
S'il s'agit d'un appel API POST, le corps JSON complet de la demande.
-
Le numéro du code d'état pour la réponse de l'API.
-
La réponse JSON complète à l'appel de l'API.
Sans les informations ci-dessus, il peut être difficile pour ShipStation de résoudre les problèmes d'API. Si vous ne savez pas comment obtenir ces informations, nous vous recommandons de contacter directement votre développeur d'API et de lui demander de l'aide pour l'extraction des journaux disponibles. Nous vous recommandons également de mettre votre développeur d'API en copie (CC) de tous vos e-mails à V1 apisupport@shipstation.com ou à V2 shippingapisupport@shipstation.com
-
La récupération des tarifs d'expédition peut ne pas être disponible pour certains transporteurs et services.
Pour certains transporteurs et certains services de transporteurs, la récupération des tarifs d'expédition peut ne pas être disponible avec les appels de type
getRate. Par exemple, les appelsgetRatene renverront pas les tarifs utilisables pour UPS Ground Saver®. Nous vous conseillons donc de demander au préalable à votre transporteur les services d'expédition disponibles qui prennent en charge la consultation des tarifs. -
L'API V1 de ShipStation ne prend pas en charge la fonction Réexpédier une commande.
-
L'API Open de ShipStation ne prend pas en charge les jeux de caractères non romains comme le japonais, le chinois et le cyrillique. Il arrive souvent que ces caractères ne soient pas pris en charge par l'API du transporteur qui gère les étiquettes, ce qui se traduit par des symboles ??? ou des espaces vides sur l'étiquette à la place des caractères.