Client SDKs

We provide an official client SDK for the fulfillmenttools platform (which is in beta status), and you can generate a client using third-party tools.

fulfillmenttools SDK

The official fulfillmenttools client SDK in TypeScript is now available on GitHub and npm and can be used wherever you run JavaScript.

The TypeScript SDK is open source and licensed under the MIT License. This means that you can use it in your projects and contribute to its development.

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

Currently, this client SDK does not provide access to all of our API's features, but we are continuously extending it and pushing out new versions. We hope you will find it easy to use and are looking forward to your feedback.

Generating a client

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

Of course, you can also use other tools (e.g. OpenAPI Generator) or choose not to generate classes/types and manually model the pieces you need for your particular use case.

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

TypeScript example

Here's an example of how to generate a TypeScript client:

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

2. Download our 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

1. This will put the generated classes into the client folder. In this folder, the api.ts file contains the generated namespaces, interfaces, etc. and is especially interesting for us.

2. Depending on your preferences, you can use all the generated client classes or only pick up the generated enum, interface, namespace, type and implement the actual client yourself.