In this article, we show you how to use our API to automate various warehouse and inventory management tasks. Our API gives you flexible options to ship orders, manage stock levels, and retrieve product information.
API documentation and Postman collection
To make getting started easier, you'll find a Postman collection attached. Postman is a free tool for API development and testing that allows developers to create and test API requests. It contains detailed information on all available endpoints, request formats, and expected responses. The collection also includes sample requests that you can run in your test environment. You can find the download link to the collection at the end of this article. You can import it into Postman as described here.
Available endpoints
Our API for warehouse and inventory management currently gives you access to a number of endpoints specifically designed to optimize warehouse and inventory processes. Here's an overview of the available endpoints:
POST Ship order completely: This endpoint lets you mark an order as completely shipped. This deducts the stock of the products in the order.
POST Move stock to and from stock locations: This endpoint lets you move stock between different storage locations. You can also use this endpoint to perform stock-ins and stock-outs.
POST Get all stocks by bin location id: This endpoint gives you a list of all stock located at specific bin locations, sorted by the bin location ID.
POST Get all stocks by bin location code: Similar to the previous endpoint, this endpoint gives you a list of all stock at a bin location, but the search & sorting here is based on the bin location code.
GET Get product stock: This endpoint lets you query the current stock of a specific product.
PATCH Update total product stock: This endpoint lets you update the available stock of a product. Based on the entered stock, either stock-ins or stock-outs are performed according to our booking strategy.
Support and feedback
If you have any questions or need help using the API, our support team is happy to assist you. Don't hesitate to contact us if you have suggestions or feedback for improving our API. Click here to go to the contact form.