Client SDKs

Using the fulfillmenttools API with a client SDK.

Last updated 5 months ago

Was this helpful?

Client SDKs

Using the fulfillmenttools API with a client SDK.

This page is outdated. Please go to our new documentation under .

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 and 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.

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

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 , 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. ) or choose not to generate classes/types and just model the pieces that you need for your particular use case manually.

The Swagger has more details on this tool.

TypeScript Example

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

Follow the how to install Swagger Codegen CLI tool
Download the fulfillmenttools OpenAPI specification
Use the 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

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.
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.

PreviousPostman Collection NextFAQ

Last updated 5 months ago

Was this helpful?

This page is outdated. Please go to our new documentation under .

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 and 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.

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

Generating a Client

Another approach is to use , 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. ) or choose not to generate classes/types and just model the pieces that you need for your particular use case manually.

The Swagger has more details on this tool.

TypeScript Example

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

Follow the how to install Swagger Codegen CLI tool
Download the fulfillmenttools OpenAPI specification
Use the 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

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.
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 and is updated regularly, it may be necessary to update the generated classes if you want to use new API endpoints.