Types > InventoryRule
Commerce APITypesInventoryRule
InventoryRule

Description

Topic: Inventory Rules

Fields

components: String!

Inventory rule components (custom JSON format)

Example: "[]"


id: String!

Unique inventory rule identifier. See also: Unique Identifiers

Example: "ir_EQzGqWoY"


inventory_strategy: InventoryStrategy!

How inventory location should be picked

Example: "closest"


multiple_locations: Boolean!

Whether to allow picking multiple locations per order

Example: true


name: String!

Name of the inventory rule

Example: "New York Local Tax"


prefer_pickup_location: Boolean!

Whether to consider customer selected pickup location before anything else

Example: true


priority: Int!

Priority of the rule (rule with higher priority is to be evaluated first)

Example: 0


split_bundle_items: Boolean!

Whether to allow splitting bundle line items across multiple locations

Example: false


split_line_items: Boolean!

Whether to allow splitting individual line items across multiple locations

Example: false


zones: [Zone!]!


Used By

Mutations

inventoryRulesCreate, inventoryRulesModify

Queries

inventoryRules

Preview (typescript)

Loading module