DEdesty
Warehouse

List warehouse locations with pagination

Changed on

Returns a flat location list. Filters are combined; Default Storage participates in matching.

Pagination is optional: supply both pageNumber and pageSize, or omit both.

post/api/warehouse/location/list

Request

  • Base URL
    https://api.desty.app
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

Authorization (Only:Bearer <access_token>)

Request body

externalWarehouseIdstring required

External warehouse ID from /api/warehouse/list, belonging to the authenticated tenant.

levelinteger nullable

Optional exact level-number filter; normally 1–7. A nonmatching level returns no rows.

keywordstring nullable

Optional case-insensitive substring of the location's own name. Trimmed before filtering.

includeDescendantsboolean nullable

With parentLocationId: true includes all descendants; omitted/null/false includes direct children only.

pageNumberinteger nullable

Optional. Supply together with pageSize; omit both to return all matching locations.

pageSizeinteger nullable

Optional (1–200). Supply together with pageNumber.

Response

successful operation

codestring required

Business result code: "0" on success; otherwise INVALID_PARAMETER, INVALID_TOKEN, LIMIT_REQUEST or SERVER_ERROR.

msgstring nullable

Result message; normally null on success.

successboolean required

True when code equals "0".

Changes