slovak-post-api

TypeScript API client for Slovak Post (Slovenská pošta) services.

Installation

npm install slovak-post-api

Features

• Track & Trace - Track parcels by tracking number
• WebEPH - Create and manage shipping sheets and parcels

Usage

Track & Trace

import { getTracking } from "slovak-post-api";

const result = await getTracking({
  trackingNumbers: ["RA123456789SK"],
  language: "en",
  includePostOfficeInfo: true,
});

console.log(result);

WebEPH API

import { SlovakPostAPI } from "slovak-post-api";

const client = new SlovakPostAPI({
  userId: "your-user-id",
  apiKey: "your-api-key",
});

// Create a sheet
const sheet = await client.createSheet({
  // sheet options
});

// Add a parcel
const parcel = await client.createParcel({
  sheetId: sheet.id,
  parcel: {
    // parcel options
  },
});

// Generate shipping label
const labelUrl = await client.generateLabel({
  sheetId: sheet.id,
  parcelId: parcel.id,
});

API Reference

getTracking(options)

Track one or more parcels.

| Option | Type | Default | Description | | ----------------------- | ---------------- | -------- | ----------------------------------- | | trackingNumbers | string[] | required | Array of tracking numbers (max 100) | | language | "sk" | "en" | "sk" | Response language | | includePostOfficeInfo | boolean | false | Include post office details |

SlovakPostAPI

Client for the WebEPH API.

Constructor Options

| Option | Type | Description | | -------- | -------- | ------------------- | | userId | string | Your WebEPH user ID | | apiKey | string | Your WebEPH API key |

License

MIT