Client SDKs

Using the fulfillmenttools API with a client SDK.

We do provide an official client SDK for the fulfillmenttools platform (which is in beta status), and you can generate a client yourself 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 can run JavaScript.

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

Currently, this client SDK does not provide access to all of the features of our API 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 just model the pieces that you need for your particular use case manually.

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

TypeScript Example

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

  1. Follow the instructions how to install Swagger Codegen CLI tool

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

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

java -jar swagger-codegen-cli-3.0.41.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.

Because the fulfillment API is considered versionless and is updated regularly, it may be necessary to update the generated classes if you want to use new API endpoints.

Last updated