ReDoc documentation
Get system configuration values matching the given search criteria Standard Magento search: $searchCriteria's pageSize/currentPage drive real offset/limit pagination (0/unset pageSize preserves the legacy behavior of returning up to 500 paths with no paging); a "path" filter (single "eq" value or comma-separated "in" list) restricts the result to those specific paths instead of every allowed/visible one, in which case pageSize/ currentPage are ignored since the caller already controls the exact set requested — the returned pageSize/currentPage/totalCount then all reflect that single page. The result's echoed-back searchCriteria reflects the pageSize/currentPage actually applied.
200 Success.
401 Unauthorized
Internal Server error
Unexpected error
{- "items": [
- {
- "path": "string",
- "scope": "string",
- "scope_code": "string",
- "value": "string"
}
], - "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
}Update system configuration with multiple options at once Every submitted item is accounted for in the returned result — either persisted (SystemConfigUpdateResultInterface::getItems()) or rejected with a reason (SystemConfigUpdateResultInterface::getErrors()): a restricted path, a path not found in system.xml/not visible for the given scope/not allowed by ACL, an invalid scope code, or a value rejected by a declarative field rule. Saving behavior otherwise matches admin UI save. Persisting one (section, scope) group is independent of another — one group failing to save does not prevent an unrelated group in the same request from being saved. This never throws for a per-item validation problem; an exception here means a genuinely unexpected failure (e.g. a database error).
required | Array of objects (system-config-rest-data-system-config-item-interface) Configuration items to save |
200 Success.
401 Unauthorized
Unexpected error
{- "items": [
- {
- "path": "string",
- "scope": "string",
- "scope_code": "string",
- "value": "string"
}
]
}{- "errors": [
- {
- "message": "string",
- "path": "string",
- "scope": "string",
- "scope_code": "string"
}
], - "items": [
- {
- "path": "string",
- "scope": "string",
- "scope_code": "string",
- "value": "string"
}
]
}