开发者

一个 API,一个 SDK,Webhook 稳定送达。

账户激活后即可访问 API;带版本管理的 TypeScript SDK 可在开发者门户下载,并附带您的密钥。

开发者门户:带版本管理的 TypeScript SDK(SHA-256 指纹)、使用 API 密钥快速上手

开始使用

三步即可开始

  1. 一个账户密钥

    账户激活后,您可以在开发者门户中自行创建。

  2. TypeScript SDK

    带版本管理,可从门户下载,并显示指纹信息。

  3. 发起第一次调用

    创建一个运单,获取跟踪链接。

Webhook

稳定送达的 Webhook

您可以创建订阅、通过 Ping 测试,并查看送达历史。每个事件都从 outbox 队列发出,并会持续重试直至送达;长期失败的事件会显示在失败队列中,方便您排查。

覆盖范围

API 能做什么

订单与运单

创建、查询、跟踪;报价签署与面单购买。

跟踪

承运商事件、公开跟踪页面。

商品目录与库存

商品编码、SKU 对应关系、库存状态。

退货

支持图片凭证的退货和重新入库。

托管结账页

预约时段、自提点、优惠券。

EDI 与 AS2

EDI X12、PIVOT/EANCOM、AS2 接收。

合作伙伴密钥

账户密钥与合作伙伴密钥

您的账户密钥可以在开发者门户中创建和续期。面向网络中承运商或合作伙伴仓库的合作伙伴级密钥,由 Ysend 管理员统一签发,权限范围仅限于对应账户。

使用 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);

获取 API 访问权限

账户激活后即可获得 API、SDK 和 Webhook。

获取 API 访问权限查看系统集成

真人客服将在一个工作日内为您配置账户。