productsSearch

Example Query

1 query ExampleQuery($storeHash: String, $channelId: Int, $search: String, $productIds: [Int], $currencyCode: String, $companyId: String, $offset: Int, $limit: Int, $customerGroupId: Int, $showAllProducts: Boolean, $categoryFilter: Boolean) {
2   productsSearch(storeHash: $storeHash, channelId: $channelId, search: $search, productIds: $productIds, currencyCode: $currencyCode, companyId: $companyId, offset: $offset, limit: $limit, customerGroupId: $customerGroupId, showAllProducts: $showAllProducts, categoryFilter: $categoryFilter) {
3     id
4     name
5     sku
6     costPrice
7     inventoryLevel
8     inventoryTracking
9     availability
10     orderQuantityMinimum
11     orderQuantityMaximum
12     variants
13   }
14 }

Variables

1 {
2   "storeHash": "example",
3   "channelId": 0,
4   "search": "example",
5   "productIds": [
6     0
7   ],
8   "currencyCode": "example",
9   "companyId": "example",
10   "offset": 0,
11   "limit": 0,
12   "customerGroupId": 0,
13   "showAllProducts": true,
14   "categoryFilter": true
15 }

Example response

1 {
2   "data": {
3     "productsSearch": [
4       {
5         "id": 0,
6         "name": "example",
7         "sku": "example",
8         "costPrice": "example",
9         "inventoryLevel": 0,
10         "inventoryTracking": "example",
11         "availability": "example",
12         "orderQuantityMinimum": 0,
13         "orderQuantityMaximum": 0,
14         "variants": [
15           "example"
16         ]
17       }
18     ]
19   }
20 }

search products by name,sku,id. Doesn't require a Token.

Arguments

storeHashStringOptional

Store hash.

channelIdIntegerOptional

Store channel ID

searchStringOptional

search product name or sku

productIdslist of optional IntegersOptional

product id list

currencyCodeStringOptional

The currency code of product

companyIdStringOptional

The company Id

offsetIntegerOptional

The offset of pagination

limitIntegerOptional

The limit of pagination

customerGroupIdIntegerOptional

the customer group id

showAllProductsBooleanOptional

Show all products, contains non-purchasable products

categoryFilterBooleanOptional

Returns

an optional list of optional ProductInfoType

idInteger

The id of product

nameString

The name of product

skuString

The sku id of product

costPriceString

cost price

inventoryLevelInteger

The inventory warning level of product

inventoryTrackingString

The inventory tracking of product

availabilityString

Availability of the product

orderQuantityMinimumInteger

The minimum quantity in an order

orderQuantityMaximumInteger

The maximum quantity in an order

variantslist of optional Strings

The all variants of product

currencyCodeString

The currency code of the display currency used to present prices.

imageUrlString

The images url of product

modifierslist of optional Strings

The modifiers sku of product

optionslist of optional Strings

The options of product

optionsV3list of optional Strings

The options of product form v3 version API

channelIdlist of optional Integers

The channel ID of store

productUrlString

The product url

taxClassIdInteger

The tax class id of product

isPriceHiddenBoolean

Indicating that whether the product's price should be shown on the product page.

availableToSellInteger

Total available quantity for a product

unlimitedBackorderBoolean

Indicate if the product has unlimited backorder

totalOnHandInteger

Physical on-hand count for quote backorder display (when backorders enabled)

backorderMessageString

Store-configured backorder message when quantity exceeds on hand