Inventory > Inventory Locations > inventoryLocations
Commerce APIInventoryInventory LocationsinventoryLocations
inventoryLocations
GET:inventory_locations.json

Description

Get all or specific inventory locations.

Permission bit: "inventory_locations.read"

Topic: Inventory Locations

Arguments

disabled: Boolean

Whether to include disabled inventory locations


ids: [String!]

List of inventory location ids. See also: Unique Identifiers

Example: ["il_EQzGqWoY"]


loose: Boolean

When asking for multiple items, allow returning less than was asked (in case some are missing)


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Result

[InventoryLocation!]

Preview (typescript)

Loading module