Skip to content

Consigned Inventory

Kevin C edited this page Mar 6, 2026 · 9 revisions

Overview

The Consigned Inventory resources in the POS Portal API are essential for managing inventory that is stored at a POS Portal warehouse location but remains owned by the by the client until it is used or sold. This guide will walk you through how to use these resources to effectively track and manage consigned inventory.

Managing Consigned Inventory

Consigned inventory management involves tracking the stock levels of consigned items at each POS Portal warehouse location, ensuring that the inventory is accurately recorded, and managing its use over time. Below are the key steps for using the consigned inventory resources in the POS Portal API.

Retrieve Consigned Inventory for All Products

The first step in managing consigned inventory is to retrieve detailed information about the inventory that is currently consigned to a specific location.

  • Get Consigned Inventory
    Use this endpoint to retrieve a list of all consigned inventory items. This allows you monitor inventory levels and track which items are still owned by you, but have not shipped out from a POS Portal facility. The response will include details such as product IDs, quantities, and status of each consigned item.

    GET /v2/inventory/consigned
    

Retrieve Consigned Inventory for Individual Products

The first step in managing consigned inventory is to retrieve detailed information about the inventory that is currently consigned to a specific location.

  • Get Consigned Inventory by Product
    Use this endpoint to retrieve consigned inventory by item. This allows you monitor inventory levels and track which item is still owned by you, but has not shipped out from a POS Portal facility. The response will include details such as product IDs, quantities, and status of the consigned item.

    GET /v2/inventory/consigned{productId}
    
    

Summary

Effective management of consigned inventory is crucial for maintaining accurate stock levels and ensuring customer satisfaction. By using the consigned inventory resources in the POS Portal API, you can track inventory in real-time.

For more detailed information on the Inventory endpoint and its parameters, please refer to the POS Portal API Documentation.

Clone this wiki locally