---
title: "List inventory sources"
method: GET
path: "/settings/inventory-sources"
tags: ["Admin Settings: Inventory Sources"]
---

# List inventory sources

`GET /settings/inventory-sources`

## Request

- Base URL: `http://localhost:8000/api/admin`
- URL: `http://localhost:8000/api/admin/settings/inventory-sources`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bagisto/apis/bagisto-admin-api/docs/settings/inventory-sources/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Query parameters

- `page` integer
- `per_page` integer
- `code` string
- `name` string
- `status` 0 | 1
- `country` string
- `sort` 'id' | 'code' | 'name' | 'priority' | 'status'
- `order` 'asc' | 'desc'

## Response `200`

Paginated list in the { data, meta } envelope.

- AdminSettingsInventorySource[]
  - `id` integer, nullable
  - `code` string, nullable
  - `name` string, nullable
  - `description` string, nullable
  - `contactName` string, nullable
  - `contactEmail` string, nullable
  - `contactNumber` string, nullable
  - `contactFax` string, nullable
  - `country` string, nullable
  - `state` string, nullable
  - `city` string, nullable
  - `street` string, nullable
  - `postcode` string, nullable
  - `priority` integer, nullable
  - `latitude` number, nullable
  - `longitude` number, nullable
  - `status` integer, nullable
  - `createdAt` string, nullable
  - `updatedAt` string, nullable
  - `message` string, nullable

---

[API](https://skmtc.dev/bagisto/apis/bagisto-admin-api.md) - [All operations](https://skmtc.dev/bagisto/apis/bagisto-admin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bagisto/apis/bagisto-admin-api/revisions/3198f11be70f?raw)