Developer Guide

Developer Quickstart Guide

Learn how to authenticate, create your first shipment in sandbox, and handle webhook callbacks.

Obtain Sandbox API Credentials

Sign in to your STS Wasel Merchant Portal and navigate to Settings > Developer API. Generate a sandbox API key to begin testing without affecting live accounts.

Install SDK or Configure REST Client

SDK Installation (CLI)

npm install @stswasel/sdk # Or use direct HTTPS REST calls

Create Your First Shipment

Sample Dispatch Script (Node.js)

const { WaselClient } = require('@stswasel/sdk');

const client = new WaselClient({
  apiKey: 'wasel_sandbox_key_example',
  environment: 'sandbox'
});

// Book a test parcel
async function createTestShipment() {
  const res = await client.shipments.create({
    sender: { name: 'Riyadh Central Depot', city: 'Riyadh' },
    recipient: { name: 'Abdullah Test', city: 'Jeddah', phone: '+966500000000' },
    serviceType: 'LAST_MILE_STANDARD',
    codAmount: 0
  });

  console.log('Shipment Created! Tracking Number:', res.trackingNumber);
}

createTestShipment();

Explore the Full API Schema

Review all available endpoints, query filters, and error codes.

View API Reference