GET:inventory_locations.json
Commerce APIGET:inventory_locations.json

GET:inventory_locations.json

Description

Get all or specific inventory locations.

Permission bit: "inventory_locations.read"

Topic: Inventory Locations

Query Parameters

disabled: Boolean

Whether to include disabled inventory locations

Example: ?disabled=true


ids: Comma-separated array of String, required

List of inventory location ids. See also: Unique Identifiers

Example: ?ids=il_EQzGqWoY,il_EQzGqWoY


loose: Boolean

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

Example: ?loose=true


shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Response Body

Array of InventoryLocation

Response Body Type

Loading module