List Inventory Sources

Endpoint	Method
/api/admin/settings/inventory-sources	GET

Returns every inventory source configured in the store in the { data, meta } envelope. Every column is populated on each row, so you can read whatever you need without a follow-up call.

How this menu works

For what an inventory source is, field meanings, and the delete guards, see the Inventory Sources overview.

Pagination

Parameter	Description
page	Page number, 1-based. Default 1.
per_page	Items per page. Default 10, max 50.

Filters

Query parameters that narrow the result. Supplying more than one narrows further — they combine with logical AND. They mirror the admin Inventory Sources datagrid filters.

Parameter	Match	Example
code	Partial (contains).	?code=warehouse
name	Partial (contains).	?name=West
status	Exact — 0 (inactive) or 1 (active).	?status=1
country	Exact — 2-letter country code.	?country=US

Sorting

Parameter	Values
sort	id (default), code, name, priority, status
order	asc, desc (default desc)

Both the compound form ?sort=name-asc and the split form ?sort=name&order=asc are accepted.

Notes

• status is 0 (inactive) or 1 (active); only active sources are available for fulfilment.
• latitude / longitude are null when the source has no geo-coordinates configured.
• Seeded core sources (such as the default source) may have null createdAt / updatedAt.

See the Inventory Sources overview for field meanings and behaviour.