POST:suggest/customer_inventory.json
Commerce APIPOST:suggest/customer_inventory.json

POST:suggest/customer_inventory.json

Description

Perform a customer inventory item suggest query.

This endpoint is useful for customer inventory autocompletion UI widgets and is optimized to work in situations alike.

Permission bit: "customer_inventory.search"

Topic: Search

Query Parameters

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY


type: CustomerInventoryTypeFilter

Filter output by customer inventory item type

Example: ?type=digital_good

Request Body

Query

{
  "query": "fancy shoes"
}

Response Body

CustomerInventoryExpandableItems

Response Body Type

Loading module