Shelves

Shelves Management

This section provides a comprehensive guide to managing the shelves in our system. You will find various options for retrieving shelf information, each tailored to different requirements.

Shelf Retrieval

Get All Shelves

  • Endpoint: /get_shelves
  • Description: This endpoint is designed to retrieve the complete list of shelves available in our database, providing a comprehensive overview of all shelves without applying any filters.
  • Usage Notes:
    • Pagination: To manage data effectively, this endpoint supports fetching up to 50 shelves at a time.
    • Parameters:
    • offset - Specify the starting point from which to begin fetching shelves.
    • limit - Control the number of shelves returned in a single request. The maximum limit is 50, but you can opt for a smaller number based on your needs.
    • Method: Utilize this functionality by including payload or parameters in your POST request to manage the offset and limit.

These features are particularly useful for handling large datasets and for applications requiring batch processing of shelf information.

  • Full Documentation and Practical Examples: Get Shelves



Fetching Shelf Data

  • Endpoint: /get_shelves
  • Description: Use this endpoint to fetch shelf data belonging to a single shelf by using the shelf_id filter.
  • Parameters:
    • shelf_id - Specify the Shelf ID to retrieve data for a specific shelf.



Filtering Shelves by a Location

  • location_id: filtering shelves by location_id is possible when passing location_id (integer) value as an argument to the API call. A single location id can be passed for getting shelves belonging to a specific location







For further assistance or API integration support, please refer to our API Documentation or contact our technical support team.