Orders & shipments
Create, read, track; signed quotes and label purchase.
Developers
One API, one SDK, webhooks that arrive.
You access the API with an activated account; the TypeScript SDK downloads from the developer portal, with your keys.
Get started
Start in three steps
- An account key
You create it in the developer portal once your account is activated.
- The TypeScript SDK
Versioned, downloaded from the portal, fingerprint shown.
- Your first call
Create a shipment, receive the tracking URL.
Webhooks
Webhooks that arrive
You create a subscription, test it with a ping, read the delivery history. Every event leaves from an outbox and is retried until delivered; what fails durably stays visible in the dead-letter.
Scope
What the API covers
Tracking
Carrier events, public tracking page.
Catalog & stock
References, SKU mapping, stock position.
Returns
Returns with photos and restocking.
Hosted checkout
Delivery slots, relay points, coupons.
EDI & AS2
EDI X12, PIVOT/EANCOM, AS2 receiving.
Partner keys
Account keys, partner keys
Your account keys are created and rotated from the developer portal. Partner-scoped keys — for a carrier or a warehouse of the network — are issued by a Ysend administrator, scoped to the account.
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);Get API access
An activated account gives the API, the SDK and the webhooks.