Locations

Locations Management

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

Location Retrieval

Get All Locations

  • Endpoint: /get_locations
  • Description: This endpoint is designed to retrieve the complete list of locations available in our database, providing a comprehensive overview of all locations without applying any filters.
  • Usage Notes:
    • Pagination: To manage data effectively, this endpoint supports fetching up to 50 locations at a time.
    • Parameters:
    • offset - Specify the starting point from which to begin fetching locations.
    • limit - Control the number of locations 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 location information.



Fetching Location Data

  • Endpoint: /get_locations
  • Description: Use this endpoint to fetch location data belonging to a single location by using the location_id filter.
  • Parameters:
    • location_id - Specify the Location ID to retrieve data for a specific location.




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