Client SDKs

An official client SDK for the fulfillmenttools platform is provided, and clients can also be generated using third-party tools.

fulfillmenttools SDK

The official fulfillmenttools client SDK in TypeScript is available on GitHub and npm and can be used in any JavaScript runtime environment.

The TypeScript SDK is open source and licensed under the MIT License, allowing it to be used in projects and for contributions to its development.

Learn how to set up and use the TypeScript SDK with the tutorial on GitHub.

Client generation

Another approach is to use Swagger Codegen, which can generate client SDKs from an OpenAPI specification for a wide range of programming languages.

Other tools, such as the OpenAPI Generator, can also be used. It is also possible to opt out of generating classes or types and instead manually model the required components for a specific use case.

The Swagger Codegen GitHub repository has more details on this tool.

TypeScript example

This example demonstrates how to generate a TypeScript client:

1. Follow the Swagger Codegen CLI Tool instructions on GitHub.

2. Download the fulfillmenttools OpenAPI specification api.swagger.yaml.

3. Use the Swagger Codegen CLI tool to generate a TypeScript client:

   java -jar swagger-codegen-cli-3.0.62.jar generate \
     -i api.swagger.yaml \
     -l typescript-fetch \
     -o client

4. This command generates the client classes in the client folder. Within this folder, the api.ts file contains the generated namespaces and interfaces.

5. It is possible to use all the generated client classes, or to selectively use the generated enum, interface, namespace, and type definitions to implement a custom client.