TypeScript SDK

Installation

npm

npm install @tracktile/sdk

pnpm

pnpm add @tracktile/sdk

yarn

yarn add @tracktile/sdk

bun

bun add @tracktile/sdk

Quick Start

import { Tracktile } from "@tracktile/sdk";

const client = new Tracktile({
  jwt: process.env.TRACKTILE_TOKEN,
});

const products = await client.products.list();

Authentication

const client = new Tracktile({
  jwt: "your-api-token",
});

Available Resources

Resource	Methods
client.inventory	receive, move, update, waste, assign, unassign, bundle, merge, unmerge
client.orders	list, create, get, update, delete, getProductAttributes
client.products	list, create, get, update, delete, batchUpdate, fetchByIds
client.purchaseOrders	list, create, get, update, delete
client.shipments	list, create, get, update, patch, delete, getItems
client.suppliers	list, create, get, update, delete, getDefaultOrder
client.transports	list, create, get, update, delete

Error Handling

import * as errors from "@tracktile/sdk/models/errors";

try {
  await client.products.get({ id: "invalid" });
} catch (error) {
  if (error instanceof errors.FourHundredError) {
    // Bad request
  } else if (error instanceof errors.FourHundredAndOneError) {
    // Unauthorized
  } else if (error instanceof errors.FourHundredAndThreeError) {
    // Forbidden
  } else if (error instanceof errors.FiveHundredError) {
    // Server error
  }
}

Retries

const client = new Tracktile({
  jwt: process.env.TRACKTILE_TOKEN,
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

Custom HTTP Client

import { Tracktile } from "@tracktile/sdk";
import { HTTPClient } from "@tracktile/sdk/lib/http";

const httpClient = new HTTPClient({
  fetcher: (request) => fetch(request),
});

httpClient.addHook("beforeRequest", (request) => {
  console.log("Request:", request.url);
  return request;
});

const client = new Tracktile({
  jwt: process.env.TRACKTILE_TOKEN,
  httpClient,
});

Debug Logging

const client = new Tracktile({
  jwt: process.env.TRACKTILE_TOKEN,
  debugLogger: console,
});

Runtime Support

Runtime	Version
Node.js	18+
Deno	1.39+
Bun	1.0+

This package is ESM only. For CommonJS, use dynamic import:

const { Tracktile } = await import("@tracktile/sdk");