TypeScript SDK

pnpm add @landedfees/sdk
# or
npm install @landedfees/sdk
# or
yarn add @landedfees/sdk

import { LandedFeesClient } from "@landedfees/sdk";

const client = new LandedFeesClient({
  apiKey: process.env.LANDEDFEES_API_KEY!,
});

const { result, compliance_flags } = await client.calc({
  destination_country: "US",
  origin_country: "CN",
  incoterm: "FOB",
  transport_mode: "ocean",
  currency: "USD",
  freight: 250,
  insurance: 45,
  line_items: [
    {
      description: "Wireless earbuds",
      hs_code: "8517.62.00",
      quantity: 500,
      unit_value: 12.5,
      origin_country: "CN",
      weight_kg: 0.15,
    },
  ],
});

console.log(result.total_landed_cost, result.currency);

client.calc(body, options?)
client.calcBulk(body, options?)
client.classify(body, options?)
client.compare(body, options?)
client.rates(country, hs, query?, options?)

new LandedFeesClient({
  apiKey: string,
  baseUrl?: string,          // default: "https://www.landedfees.com"
  timeoutMs?: number,        // default: 30_000
  maxRetries?: number,       // default: 1
  fetch?: typeof fetch,      // inject a custom fetch (undici, tests)
  userAgent?: string,        // default: "@landedfees/sdk@0.1"
});

import { randomUUID } from "node:crypto";

const idempotencyKey = randomUUID();
const first  = await client.calc(payload, { idempotencyKey });
const second = await client.calc(payload, { idempotencyKey });
// first.id === second.id

import { ApiError } from "@landedfees/sdk";

try {
  await client.calc(payload);
} catch (err) {
  if (err instanceof ApiError) {
    if (err.status === 429) {
      await new Promise((r) => setTimeout(r, (err.retryAfter ?? 60) * 1000));
    } else if (err.status === 422 && err.code === "MISSING_HS_CODE") {
      // Run classify first.
    } else {
      throw err;
    }
  }
}

import type {
  CalcRequest,
  CalcResponse,
  ClassificationResult,
  CompareResponse,
  RatesResponse,
  ComplianceFlag,
  CostLayer,
} from "@landedfees/sdk";

import { fetch } from "undici";
import { LandedFeesClient } from "@landedfees/sdk";

const client = new LandedFeesClient({ apiKey: process.env.KEY!, fetch });