Développeurs

Une API, un SDK, des webhooks qui arrivent.

Vous accédez à l'API avec un compte activé ; le SDK TypeScript se télécharge depuis le portail développeur, avec vos clés.

Portail développeur : SDK TypeScript versionné (empreinte SHA-256), démarrage avec une clé API

Démarrer

Démarrer en trois étapes

  1. Une clé de compte

    Vous la créez dans le portail développeur une fois votre compte activé.

  2. Le SDK TypeScript

    Versionné, téléchargé depuis le portail, empreinte affichée.

  3. Votre premier appel

    Créez une expédition, recevez l'URL de suivi.

Webhooks

Des webhooks qui arrivent

Vous créez un abonnement, vous le testez d'un ping, vous lisez l'historique de livraison. Chaque événement part d'une outbox et se relance jusqu'à livraison ; ce qui échoue durablement reste visible en dead-letter.

Périmètre

Ce que couvre l'API

Commandes & expéditions

Créer, lire, suivre ; devis signés et achat d'étiquette.

Suivi

Événements transporteur, page de suivi publique.

Catalogue & stock

Références, correspondance SKU, position de stock.

Retours

Retours avec photos et remise en stock.

Checkout hébergé

Créneaux, points relais, coupons.

EDI & AS2

EDI X12, PIVOT/EANCOM, réception AS2.

Clés partenaires

Clés de compte, clés partenaires

Vos clés de compte se créent et se renouvellent depuis le portail développeur. Les clés à portée partenaire — pour un transporteur ou un entrepôt du réseau — sont émises par un administrateur Ysend, avec une portée limitée au compte.

Créer une expédition avec le SDK
import { YsendClient } from "@ysend/sdk";

const ysend = new YsendClient({ apiKey: process.env.YSEND_API_KEY });

const shipment = await ysend.shipments.create({
  orderRef: "SHIP-2026-0501",
  parcels: [{ weightKg: 1.2 }],
  to: { country: "FR", postalCode: "06700" },
});
console.log(shipment.trackingUrl);

Obtenir un accès API

Un compte activé donne l'API, le SDK et les webhooks.

Obtenir un accès APIVoir les intégrations

Un humain configure votre compte sous un jour ouvré.