Collega i tuoi strumenti a ordini, stock disponibile e tracking delle spedizioni con API REST, SDK TypeScript e webhook.
Apri il portale sviluppatori per consultare le API accessibili al tuo account e l’SDK disponibile nel tuo ambiente. Sono necessari l’accesso e le autorizzazioni appropriate.
TypeScript SDK
Un esempio TypeScript lato server con il client Ysend. Configura l’URL base dell’API concordato durante l’attivazione e conserva la chiave API nelle variabili d’ambiente del server.
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 });L’esempio richiede inventory:read, orders:read e shipments:read. Per le scritture dell’SDK, fornisci un Idempotency-Key stabile per consentire i tentativi successivi senza creare una seconda operazione.
Usa Node.js 20 o successivo. Se il portale offre un SDK, annota versione e nome del file e verifica lo SHA-256 del download. Sostituisci PACKAGE_FILE.tgz qui sotto con quel nome esatto.
npm install ./PACKAGE_FILE.tgzYSEND_API_BASE_URL deve contenere l’origine API concordata: protocollo HTTPS e host, senza /api/v1. Il percorso viene aggiunto dall’SDK. Conserva YSEND_API_KEY sul server; le richieste usano X-Api-Key.
Ogni chiamata a un elenco restituisce una pagina. Indica page e pageSize, poi controlla items, totalCount, page e pageSize quando presenti prima di richiedere altre pagine. La prima pagina non è un’esportazione completa.
YsendError espone lo stato HTTP, detail e traceId disponibili. YsendTransportError indica che non è arrivata una risposta utilizzabile; l’esito di una scrittura può quindi restare sconosciuto.
Valori predefiniti: tre tentativi totali e 30 secondi di attesa delle intestazioni di risposta per tentativo. GET/HEAD e le richieste con Idempotency-Key possono essere ripetuti dopo un errore di rete o HTTP 429, 502, 503 o 504. Riutilizza la stessa chiave per la stessa operazione. orders.list usa POST senza questa chiave e non prevede questi tentativi automatici.
Accesso o SDK non disponibile? Descrivi gli scambi da provare nella richiesta relativa al tuo progetto. Prima delle prove, fai confermare origine API, versione del pacchetto, riferimento API applicabile, account di prova e autorizzazioni. Non includere segreti.
Inizia
Dopo l’attivazione dell’account, un amministratore autorizzato crea una chiave con i permessi necessari alla tua integrazione.
Se è stato pubblicato un pacchetto SDK per il tuo ambiente, scaricalo dal portale sviluppatori, verifica lo SHA-256 e installa il file scaricato.
Consulta stock, ordini e spedizioni nei limiti dei permessi assegnati alla tua chiave.
Webhook
Crea le sottoscrizioni nell’applicazione, testale con un ping e consulta i tentativi di consegna. L’outbox riprova gli errori che lo consentono; gli eventi che esauriscono i tentativi restano visibili nella coda degli errori.
Ambito
Importa CSV o righe strutturate; controlla, correggi e reinvia le righe rifiutate.
Associa gli SKU e leggi lo stock fisico, riservato e disponibile.
Prepara i piani di ingresso, aggiungi righe, richiedi fasce di consegna e segui le discrepanze di ricezione.
Leggi corriere, tracking e stato di consegna dopo la creazione della spedizione durante l’evasione.
Apri una pratica collegata a un ordine e allega foto o documenti.
Consulta sottoscrizioni e storico delle consegne dalla tua integrazione.
Chiavi partner
Conserva le chiavi sul server. I permessi di account e partner delimitano ogni operazione; gli amministratori autorizzati gestiscono creazione e rotazione delle chiavi e sottoscrizioni webhook nel portale appropriato.
Presenta i tuoi flussi di dati e le operazioni necessarie. Confermeremo accessi, permessi e pacchetto SDK per la tua integrazione.
Il team Ysend ti aiuta a scegliere i servizi, i collegamenti e il calendario per la tua attività.