GET:customer_inventory/page.json

Description

Get all inventory items of a shop.

See also: Pagination.

Permission bit: "customer_inventory.read"

Topic: Customer Inventory

Query Parameters

customer_id: String

Unique customer identifier. See also: Unique Identifiers

Example: ?customer_id=cu_EQzGqWoY

item_type: CustomerInventoryItemTypeParam

Filter output by inventory item type

Example: ?item_type=any

last_key: String

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

Example: ?last_key=str

limit: Int

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

Example: ?limit=5

offset: Int

Skip N entries (pagination). See also: Pagination

Example: ?offset=5

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

sort_by: CustomerInventoryPageSortBy

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

Example: ?sort_by=created_at

sort_desc: Boolean

Whether to use descending sort order. See also: Pagination

Example: ?sort_desc=true

type: CustomerInventoryTypeParam

Filter output by inventory type

Example: ?type=digital_good

Response Body

CustomerInventoryPage

Response Body Type

Loading module