Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lincmba committed Sep 13, 2024
1 parent 601c62f commit 27e883c
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,31 @@ Example:
[GET] /LocationHierarchy?_id=<some-location-id>&administrativeLevelMin=2&administrativeLevelMax=4&_count=<page-size>&_page=<page-number>&_sort=<some-sort>
```

##### Inventory Filters

The `LocationHierarchy` endpoint supports filtering by inventory status,
allowing users to specify whether they want to retrieve only locations that have
associated inventories. This filter can be particularly useful for narrowing
down the results to locations that are actively involved in inventory
management.

The following search parameter is available:

- `filterInventory`: A boolean parameter that specifies whether the response
should be filtered by locations with inventories.
- `filterInventory=true`: Only locations with inventories will be included in
the response.
- `filterInventory=false` (or not set): Locations with or without inventories
will be returned. This effectively disables inventory-based filtering. The
response will include all locations, regardless of their inventory status.
Both locations with and without inventories will be returned.

Example:

```
[GET] /LocationHierarchy?_id=<some-location-id>&filterInventory=true&_count=<page-size>&_page=<page-number>&_sort=<some-sort>
```

#### Important Note:

Developers, please update your client applications accordingly to accommodate
Expand Down

0 comments on commit 27e883c

Please sign in to comment.