Actions50
- Additional Service Actions
- Address Actions
- Common Actions
- Contact Person Actions
- Counterparty Actions
- Document Actions
- Loyalty Actions
- Payment Actions
- Registry Actions
- Scan Sheet Actions
- Tracking Actions
Address → Search Settlements
AI-generatedSummary
Search for Nova Poshta settlements by city name.
Inputs
- cityName (required) — Name of the city to search for
- limit — Max number of results to return (minimum 1, default 50)
Output shape
An array of settlement objects from the Nova Poshta API, each containing a SettlementRef and Name, usable with subsequent getWarehouses or getStreets operations.
Consumes cityName as a required string parameter; limit is optional with a minimum value of 1 and default of 50. The operation queries the Nova Poshta Address API's searchSettlements method.
Examples
Example 1: Find up to 20 settlements matching city name
Set cityName to the target city and limit to 20.