fulfillmenttools-api-reference

Public api assets for the fulfillmenttools platform API

• Open API Specification
• Technical Documentation

Generate API Client with HeyAPI OpenAPI Generator

1. Obtain the OpenAPI specification

Ensure you have the latest version of FFT’s api.swagger.yaml in your working directory. You can download it from this link.

wget https://raw.githubusercontent.com/fulfillmenttools/fulfillmenttools-api-reference/refs/heads/master/api.swagger.yaml

2. Generate the client (e.g. node / typescript)

Run the generator with your preferred target language. For example, to generate a TypeScript client using the Fetch API:

npx @hey-api/openapi-ts -i api.swagger.yaml -o src/client

3. Use the client in a project (node / typescript)

1. Initialize a new node project

npm init -y
npm install typescript ts-node node-fetch @types/node

2. Compile and Integrate the Generated Client

• Copy the src/client folder into your project
• Add a tsconfig.json to configure TypeScript if not present:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "outDir": "./dist",
    "esModuleInterop": true,
    "strict": true,
    "skipLibCheck": true
  },
  "include": ["./src/client", "./src"]
}

3. Call an API endpoint

• Create a src/index.ts file and replace placeholders with your tenant information and credentials

import { type ClientOptions, getAllUsers } from "./client";
import { createConfig } from "./client/client";
import { client } from "./client/client.gen";

const options = {
    baseUrl: 'https://<tenant>.api.fulfillmenttools.com',
    email: '<email>',
    password: '<password>',
    apiKey: '<api-key>'
}

async function getJwtToken(): Promise<string> {
    const url = `https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=${options.apiKey}`;
    const res = await fetch(url, {
        method: 'POST',
        headers: { 'Content-Type': 'application/json', Accept: 'application/json' },
        body: JSON.stringify({ email: options.email, password: options.password, returnSecureToken: true,}),
    });

    if (!res.ok) {
        const text = await res.text();
        console.error(text);
        throw new Error('Error obtaining firebase token, please check credentials.');
    }
    return (await res.json()).idToken;
}


async function run() {
    try {
        client.setConfig(createConfig<ClientOptions>({
            baseUrl: options.baseUrl,
            headers: { Authorization: `Bearer ${await getJwtToken()}` },
        }));

        const result = await getAllUsers();
        console.log(result.data);
    } catch (error) {
        console.error('Request failed:', error);
    }
}

run();

4. Run the Code

npx ts-node src/index.ts