location

Location - Get List

Changed on

Retrieve a paginated list of locations with optional filtering.

get/location/get_list

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/location/get_list
  • Auth
    HTTP bearer

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"
  }
]

Changes

  • fa53dd949b8eRevision changes
    • breaking

      the query request parameter selector became required

    • breaking

      for the query request parameter selector, the type changed from string to object

    • info

      api operation id get_location_get_list was added

    • info

      for the query request parameter limit, the format was generalized from integer to no format

    • info

      for the query request parameter skip, the format was generalized from integer to no format

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • e4bdf6984278Revision changes
    • breaking

      for the query request parameter sort, the type changed from number to object, and format from integer to no format