Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
location

Location - Get List

Retrieve a paginated list of locations with optional filtering.

get/location/get_list

Query parameters

selectorobject required

Query selector object for filtering results

limitnumber

Max results to return

Example:50
skipnumber

Number of results to skip

sortobject

Sort fields object, e.g. { "name": 1 }

Response

Array of locations matching the query

_idstring required

Unique location identifier

namestring required

Location name

warehouse_idstring

Parent warehouse ID

deletedboolean

Whether the location has been deleted

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "warehouse_id": "507f1f77bcf86cd799439011"
  }
]