Skip to content

List Inventory Sources

Returns a cursor-paginated list of inventory sources. Every column is populated on each row, so you can select whichever fields 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.

Operation

OperationTypePurpose
adminSettingsInventorySourcesQueryCollection (cursor)List inventory sources

Arguments

All arguments are optional and combine in a single query — filter, sort and paginate together.

Pagination

ArgumentDescription
firstNumber of records to return.
afterCursor to fetch the page after (from pageInfo.endCursor).

Filters

Each filter narrows the result; supplying more than one combines with logical AND. They mirror the admin Inventory Sources datagrid filters.

ArgumentTypeMatchExample
codeStringPartial (contains)."warehouse"
nameStringPartial (contains)."West"
statusIntExact — 0 (inactive) or 1 (active).1
countryStringExact — 2-letter country code."US"

Sorting

ArgumentTypeValues
sortStringid (default), code, name, priority, status
orderStringasc, desc (default desc)

Notes

  • Pass first (and after: <cursor>) to page through results. The connection exposes pageInfo and totalCount.
  • 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.

Requires settings.inventory_sources view access. All operations require an admin Bearer token — see Authentication.

Released under the MIT License.