fulfillmenttools TypeScript SDK

This is a JavaScript/TypeScript SDK (beta) for the fulfillmenttools REST API.

What is fulfillmenttools?

fulfillmenttools is a next generation order management system that helps retailers and brands to serve their customers faster and more reliably. Its MACH based architecture enables an easy and quick integration.

Table of contents

• Get started
• Documentation
• Development
• License
• Contributing

👉 Get started

The TypeScript SDK is fully open source and is available on GitHub. The SDK is published as a npmjs and a yarn package. It contains both an ESM and a CommonJS build, so you can use it in the browser and in the backend. You can install it with the command below:

1npm install @fulfillmenttools/fulfillmenttools-sdk-typescript
2
3// or
4
5yarn add @fulfillmenttools/fulfillmenttools-sdk-typescript

Learn how to set up and use the TypeScript SDK with our tutorial and have a look at some examples.

📖 Documentation

The official fulfillmenttools API documentation can be found here, and we also publish our OpenAPI specification.

[!NOTE] Currently, the SDK is still in beta status. It does not provide access to all of the features of our API but we are continuously extending it and pushing out new versions. The releases of this SDK follow the Semantic Versioning convention. However, until we have shipped a first stable 1.0 release, breaking changes can and will occur! We hope you will find it easy to use and are looking forward to your feedback.

👨‍💻 Development

👉 Requirements

• Node.js 20 with nvm and npm

🛫 Setup

1nvm use // or use your favorite node version manager

🤸 Building

1npm install
2npm run build

🕵️ Running unit tests

When running unit tests the .env.local file will be used with dummy settings.

1npm run test

🕵️‍♀️ Linting

1npm run lint

📜 License

All code in this repository is licensed under the MIT license.

🙌 Contributing

We'd love to have your helping hand on this ecosystem! Please see CONTRIBUTING.md for more information on our guidelines.

:blue_heart: Thanks

Thanks for all your contributions and efforts towards improving the fulfillmenttools TypeScript SDK. We thank you for being part of our :sparkles: community :sparkles:!