Inventory > Inventory Rules > inventoryRules
Commerce APIInventoryInventory RulesinventoryRules
inventoryRules
GET:inventory_rules.json

Description

Get all or specific inventory rules for a given shop.

This is a typical bulk get endpoint.

Permission bit: "inventory_rules.read"

Topic: Inventory Rules

Arguments

ids: [String!]

List of inventory rule ids. See also: Unique Identifiers

Example: ["ir_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

[InventoryRule!]

Preview (typescript)

Loading module