Pilotlly SDK v1.0.1 🚀

Official Node.js SDK for Pilotlly — Create labels, upload documents, and automate printing or emailing dispatches.

📦 Installation

npm install pilotlly

⚙️ Usage Example

import { PilotllyClient } from "pilotlly";
import fs from "fs";

const client = new PilotllyClient("YOUR_API_KEY");

const response = await client.createShipment([
  {
    shipment: {
      service_code: "usps_first_class_mail",
      ship_to: {
        name: "John Doe",
        address_line1: "123 Street",
        city_locality: "Lagos",
        country_code: "NG"
      },
      ship_from: {
        name: "CJet Dispatch",
        address_line1: "123 Main St",
        city_locality: "Los Angeles",
        state_province: "CA",
        postal_code: "90001",
        country_code: "US"
      }
    },
    documents: [fs.createReadStream("./micr-CJET_DISPATCH_Paystack2.pdf")]
  }
]);

console.log("✅ Shipment response:", response);

🌍 API Base URL

By default:

https://api.pilotlly.com/api

Override if needed:

const client = new PilotllyClient("API_KEY", "https://staging.pilotlly.com/api");

🧱 Features

• ✅ Create shipments (supports multiple indexed uploads)
• ✅ Upload documents
• ✅ Retrieve shipping labels
• ✅ Trigger email or print dispatch
• ✅ Track shipments

💬 Support

Visit https://pilotlly.com or email [email protected]