ReDoc documentation
Retrieve regions belonging to the given country, matching search criteria. $searchCriteria is optional; when omitted, all regions for the country are returned unfiltered.
200 Success.
401 Unauthorized
Unexpected error
{- "items": [
- {
- "code": "string",
- "country_id": "string",
- "default_name": "string",
- "locale_names": [
- {
- "locale": "string",
- "name": "string"
}
], - "region_id": 0,
- "system": true
}
], - "search_criteria": {
- "current_page": 0,
- "filter_groups": [
- {
- "filters": [
- {
- "condition_type": "string",
- "field": "string",
- "value": "string"
}
]
}
], - "page_size": 0,
- "sort_orders": [
- {
- "direction": "string",
- "field": "string"
}
]
}, - "total_count": 0
}Create one or more regions under the given country in a single atomic operation. All-or-nothing: the whole payload is validated before anything is written, and every region is persisted in one transaction, so a failure anywhere leaves no rows behind. Validation failures are reported together in one InputException, each naming the offending payload position (e.g. regions[3].code). Region codes must be unique within the country and within the payload. The number of regions accepted per call is capped.
200 Success.
401 Unauthorized
Internal Server error
Unexpected error
{- "regions": [
- {
- "code": "string",
- "default_name": "string",
- "locale_names": [
- {
- "locale": "string",
- "name": "string"
}
]
}
]
}[- {
- "code": "string",
- "country_id": "string",
- "default_name": "string",
- "locale_names": [
- {
- "locale": "string",
- "name": "string"
}
], - "region_id": 0,
- "system": true
}
]