Admin Settings: Inventory Sources

List inventory sources

Paginated, filterable, sortable list of inventory sources. Returns the standard { data, meta } admin envelope.

get/settings/inventory-sources

Request

Query parameters

pageinteger
Example:1

Page number.

per_pageinteger
Example:10

Items per page (default 10, max 50).

codestring

Filter by code (partial match).

namestring

Filter by name (partial match).

status0 | 1

0 or 1.

countrystring

Exact country code.

sort'id' | 'code' | 'name' | 'priority' | 'status'

Sort column.

order'asc' | 'desc'

Sort direction.

Response

Paginated list in the { data, meta } envelope.

idinteger nullable
codestring nullable
namestring nullable
descriptionstring nullable
contactNamestring nullable
contactEmailstring nullable
contactNumberstring nullable
contactFaxstring nullable
countrystring nullable
statestring nullable
citystring nullable
streetstring nullable
postcodestring nullable
priorityinteger nullable
latitudenumber nullable
longitudenumber nullable
statusinteger nullable
createdAtstring nullable
updatedAtstring nullable
messagestring nullable

Example response

[
  {
    "id": 1,
    "code": "default",
    "name": "Default Warehouse",
    "description": "Primary fulfilment warehouse",
    "contactName": "Jane Smith",
    "contactEmail": "warehouse@example.com",
    "contactNumber": "+1-555-0100",
    "contactFax": "+1-555-0101",
    "country": "US",
    "state": "CA",
    "city": "San Francisco",
    "street": "123 Market St",
    "postcode": "94103",
    "priority": 1,
    "latitude": 37.7749,
    "longitude": -122.4194,
    "status": 1,
    "createdAt": "2026-05-25T08:15:00+00:00",
    "updatedAt": "2026-05-25T08:20:00+00:00",
    "message": "Inventory source deleted successfully."
  }
]

Changes

No recorded changes to this operation across all 8 revisions of this API.