Encomendas e envios
Criar, ler, seguir; orçamentos assinados e compra de etiqueta.
Programadores
Uma API, um SDK, webhooks que chegam.
Acede à API com uma conta ativada; o SDK TypeScript descarrega-se a partir do portal do programador, com as suas chaves.
Começar
Comece em três etapas
- Uma chave de conta
Cria-a no portal do programador assim que a sua conta é ativada.
- O SDK TypeScript
Versionado, descarregado a partir do portal, com impressão digital apresentada.
- A sua primeira chamada
Cria um envio, recebe o URL de rastreio.
Webhooks
Webhooks que chegam
Cria uma subscrição, testa-a com um ping, lê o histórico de entrega. Cada evento parte de uma outbox e é reenviado até ser entregue; o que falha de forma persistente fica visível na dead-letter.
Âmbito
O que a API cobre
Rastreio
Eventos da transportadora, página de rastreio pública.
Catálogo e stock
Referências, correspondência de SKU, posição de stock.
Devoluções
Devoluções com fotografias e reposição em stock.
Checkout alojado
Janelas de entrega, pontos de recolha, cupões.
EDI e AS2
EDI X12, PIVOT/EANCOM, receção AS2.
Chaves de parceiro
Chaves de conta, chaves de parceiro
As suas chaves de conta criam-se e renovam-se a partir do portal do programador. As chaves com alcance de parceiro — para uma transportadora ou um armazém da rede — são emitidas por um administrador Ysend, limitadas à conta.
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);Obter acesso à API
Uma conta ativada dá acesso à API, ao SDK e aos webhooks.