Conecte sus herramientas con pedidos, existencias disponibles y seguimiento de envíos mediante la API REST, el SDK de TypeScript y los webhooks.
Abra el portal para desarrolladores para consultar las API accesibles con su cuenta y el SDK disponible en su entorno. Es necesario iniciar sesión y disponer de los permisos correspondientes.
TypeScript SDK
Ejemplo de TypeScript en el servidor con el cliente Ysend. Configure la URL base de la API acordada durante la incorporación y guarde su clave API en las variables de entorno del servidor.
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 });El ejemplo requiere inventory:read, orders:read y shipments:read. Para las escrituras del SDK, proporcione un Idempotency-Key estable que permita reintentar sin crear una segunda operación.
Utilice Node.js 20 o posterior. Si el portal ofrece un SDK, anote la versión y el nombre del archivo y verifique el SHA-256 de la descarga. Sustituya PACKAGE_FILE.tgz por ese nombre exacto.
npm install ./PACKAGE_FILE.tgzYSEND_API_BASE_URL debe contener el origen de la API acordado: protocolo HTTPS y host, sin /api/v1. El SDK añade esa ruta. Mantenga YSEND_API_KEY en el servidor; las peticiones usan X-Api-Key.
Cada consulta de lista devuelve una página. Indique page y pageSize y revise items, totalCount, page y pageSize cuando se proporcionen antes de solicitar más páginas. La primera página no es una exportación completa.
YsendError incluye el estado HTTP, detail y traceId disponibles. YsendTransportError indica que no se recibió una respuesta utilizable; el resultado de una escritura puede quedar sin confirmar.
Valores predeterminados: tres intentos en total y 30 segundos de espera de las cabeceras de respuesta por intento. GET/HEAD y las peticiones con Idempotency-Key pueden reintentarse ante errores de red o HTTP 429, 502, 503 o 504. Reutilice la misma clave para la misma operación. orders.list utiliza POST sin esa clave y no dispone de estos reintentos automáticos.
¿Sin acceso o sin SDK disponible? Describa los intercambios que desea probar en su consulta de proyecto. Confirme el origen de la API, la versión del paquete, la referencia API aplicable, la cuenta de prueba y sus permisos antes de probar. No incluya secretos.
Empezar
Tras activar la cuenta, un administrador autorizado crea una clave con los permisos necesarios para su integración.
Si hay un paquete SDK publicado para su entorno, descárguelo desde el portal para desarrolladores, compruebe su SHA-256 e instale el archivo descargado.
Consulte existencias, pedidos y envíos con los permisos asignados a su clave.
Webhooks
Cree suscripciones en la aplicación, pruébelas con un ping y revise los intentos de entrega. La bandeja de salida reintenta los fallos que lo permiten; los eventos que agotan sus intentos siguen visibles en la cola de fallidos.
Alcance
Importe CSV o filas estructuradas; revise, corrija y vuelva a enviar las filas rechazadas.
Asocie SKU y consulte existencias físicas, reservadas y disponibles.
Prepare planes de entrada, añada líneas, solicite franjas de entrega y siga las discrepancias de recepción.
Consulte transportista, seguimiento y estado de entrega una vez creado el envío en la preparación.
Abra un caso vinculado a un pedido y adjunte fotografías o documentos.
Consulte suscripciones e historial de entrega desde su integración.
Claves de socio
Guarde las claves en su servidor. Los permisos de cuenta y de socio delimitan cada operación; los administradores autorizados gestionan la creación y rotación de claves y las suscripciones webhook en el portal correspondiente.
Comparta sus flujos de datos y las operaciones necesarias. Confirmaremos los accesos, los permisos y el paquete SDK para su integración.
El equipo de Ysend le ayuda a definir los servicios, las conexiones y el calendario para su negocio.