Customers > Customer Inventory > customerInventoryPage
Commerce APICustomersCustomer InventorycustomerInventoryPage
customerInventoryPage
GET:customer_inventory/page.json

Description

Get all inventory items of a shop.

See also: Pagination.

Permission bit: "customer_inventory.read"

Topic: Customer Inventory

Arguments

customer_id: String

Unique customer identifier. See also: Unique Identifiers

Example: "cu_EQzGqWoY"


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: CustomerInventoryPageSortBy

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

CustomerInventoryPage

Preview (typescript)

Loading module