Reliez vos outils aux commandes, au stock disponible et au suivi des expéditions grâce à l’API REST, au SDK TypeScript et aux webhooks.
Ouvrez le portail développeur pour consulter les API accessibles à votre compte et le SDK disponible dans votre environnement. La connexion et les droits de votre compte restent nécessaires.
TypeScript SDK
Un exemple TypeScript côté serveur avec le client Ysend. Configurez l’URL de base de l’API convenue à l’activation et conservez votre clé API dans les variables d’environnement du serveur.
import { Ysend } from "@ysend/sdk";
const ysend = new Ysend({
baseUrl: process.env.YSEND_API_BASE_URL!,
apiKey: process.env.YSEND_API_KEY!,
});
const stock = await ysend.inventory.listBalances({ page: 1, pageSize: 20 });
const orders = await ysend.orders.list({ status: "Open", page: 1, pageSize: 20 });
const shipments = await ysend.shipments.list({ page: 1, pageSize: 20 });Cet exemple requiert inventory:read, orders:read et shipments:read. Pour les écritures du SDK, fournissez un Idempotency-Key stable afin d’autoriser les relances sans créer une seconde opération.
Utilisez Node.js 20 ou plus récent. Si le portail propose un SDK, relevez sa version et son nom de fichier, puis vérifiez le SHA-256 du téléchargement. Remplacez PACKAGE_FILE.tgz ci-dessous par ce nom exact.
npm install ./PACKAGE_FILE.tgzYSEND_API_BASE_URL doit contenir l’origine API convenue : protocole HTTPS et hôte, sans /api/v1. Le SDK ajoute déjà ce chemin. Gardez YSEND_API_KEY sur le serveur ; les requêtes utilisent X-Api-Key.
Chaque consultation de liste renvoie une page. Indiquez page et pageSize, puis consultez items, totalCount, page et pageSize lorsqu’ils sont fournis avant de demander la suite. Une première page n’est pas un export complet.
YsendError expose le statut HTTP, le détail et le traceId disponibles. Une YsendTransportError signifie qu’aucune réponse exploitable n’a été reçue ; le résultat d’une écriture peut alors être inconnu.
Par défaut : trois tentatives au total, 30 secondes d’attente des en-têtes de réponse par tentative. Les GET/HEAD et les requêtes avec Idempotency-Key peuvent être relancés après une erreur réseau ou un statut 429, 502, 503 ou 504. Réutilisez la même clé pour la même opération. orders.list utilise POST sans cette clé et ne bénéficie pas de ces relances automatiques.
Pour préparer votre intégration, indiquez les données à échanger et vos outils dans votre demande de projet. Notre équipe vous oriente vers la documentation API, le SDK et les accès adaptés à votre organisation. Ne joignez aucun secret.
Démarrer
Après activation du compte, un administrateur autorisé crée une clé avec les permissions nécessaires à votre intégration.
Si un paquet SDK est publié dans votre environnement, téléchargez-le depuis le portail développeur, vérifiez son SHA-256 et installez le fichier téléchargé.
Consultez le stock, les commandes et les expéditions dans le périmètre autorisé par votre clé.
Webhooks
Créez les abonnements dans l’application, testez-les par un ping et consultez les tentatives de livraison. L’outbox relance les échecs éligibles ; les événements ayant épuisé leurs tentatives restent visibles dans la file d’échec.
Périmètre
Importez des fichiers CSV ou des lignes structurées ; consultez, corrigez et soumettez à nouveau les lignes rejetées.
Associez les SKU et consultez le stock physique, réservé et disponible.
Préparez les plans de réception, ajoutez les lignes, demandez un créneau et suivez les écarts de réception.
Consultez le transporteur, le suivi et la livraison après la création de l’expédition par la préparation.
Ouvrez un dossier lié à une commande et joignez des photos ou des documents.
Consultez les abonnements et l’historique de livraison depuis votre intégration.
Clés partenaires
Conservez les clés sur votre serveur. Les droits du compte et du partenaire définissent chaque opération ; la création et la rotation des clés ainsi que les abonnements webhook sont gérés par les administrateurs autorisés dans le portail concerné.
Présentez vos échanges de données et les opérations attendues. Nous confirmerons les accès, les permissions et le paquet SDK adapté à votre intégration.
L’équipe Ysend vous aide à définir les services, les connexions et le calendrier adaptés à votre activité.