Description

Get all inventory items of a shop.

See also: Pagination.

Topic: Customer Inventory

Arguments

item_type: CustomerInventoryItemTypeParam

Filter output by inventory item type

last_key: String

Key of the last item from previous page. See also: Pagination

limit: Int

Return up to N entries (pagination). See also: Pagination

offset: Int

Skip N entries (pagination). See also: Pagination

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

sort_by: StorefrontCustomerInventoryPageSortBy

Whether to sort output in some specific way. See also: Pagination

sort_desc: Boolean

Whether to use descending sort order. See also: Pagination

type: CustomerInventoryTypeParam

Filter output by inventory type

Result

StorefrontCustomerInventoryPage

Preview (typescript)

function storefrontCustomerInventoryPage(
item_type?: CustomerInventoryItemTypeParam | null
last_key?: string
limit?: number
offset?: number
shop_id: string
sort_by?: StorefrontCustomerInventoryPageSortBy | null
sort_desc?: boolean
type?: CustomerInventoryTypeParam | null
): StorefrontCustomerInventoryPage | null