Inventory allows merchants to accurately manage how they sell products when there are limited quantity levels. This area of the API allows you to manage how that is done.
The following prerequisites will be necessary to accomplish the goals of this article:
- General understanding of REST and API’s
If you haven’t already done so, you should probably have a development environment ready to development against, complete with Hotcakes installed and configured.
REST API Endpoints for Product Inventory
There are a handful of REST API endpoints that allow you to display or manage various aspects of product inventory. Those endpoints are detailed below.
|ProductInventoryCreate||ProductInventoryDTO||Allows you to create an inventory record for a specific product or product variant.|
|ProductInventoryDelete||Boolean||Permanently deletes the inventory levels for a product.|
|ProductInventoryFind||ProductInventoryDTO||Returns a single record representing the inventory levels of a product.|
|ProductInventoryUpdate||ProductInventoryDTO||Updates the inventory levels of a product or product variant.|