productsSearch

Example Query

query ExampleQuery($storeHash: String, $channelId: Int, $search: String, $productIds: [Int], $currencyCode: String, $companyId: String, $offset: Int, $limit: Int, $customerGroupId: Int, $showAllProducts: Boolean, $categoryFilter: Boolean) {
  productsSearch(storeHash: $storeHash, channelId: $channelId, search: $search, productIds: $productIds, currencyCode: $currencyCode, companyId: $companyId, offset: $offset, limit: $limit, customerGroupId: $customerGroupId, showAllProducts: $showAllProducts, categoryFilter: $categoryFilter) {
    id
    name
    sku
    costPrice
    inventoryLevel
    inventoryTracking
    availability
    orderQuantityMinimum
    orderQuantityMaximum
    variants
  }
}

Variables

{
  "storeHash": "example",
  "channelId": 0,
  "search": "example",
  "productIds": [
    0
  ],
  "currencyCode": "example",
  "companyId": "example",
  "offset": 0,
  "limit": 0,
  "customerGroupId": 0,
  "showAllProducts": true,
  "categoryFilter": true
}

Example response

{
  "data": {
    "productsSearch": [
      {
        "id": 0,
        "name": "example",
        "sku": "example",
        "costPrice": "example",
        "inventoryLevel": 0,
        "inventoryTracking": "example",
        "availability": "example",
        "orderQuantityMinimum": 0,
        "orderQuantityMaximum": 0,
        "variants": [
          "example"
        ]
      }
    ]
  }
}

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

idIntegerOptional

The id of product

nameStringOptional

The name of product

skuStringOptional

The sku id of product

costPriceStringOptional

cost price

inventoryLevelIntegerOptional

The inventory warning level of product

inventoryTrackingStringOptional

The inventory tracking of product

availabilityStringOptional

Availability of the product

orderQuantityMinimumIntegerOptional

The minimum quantity in an order

orderQuantityMaximumIntegerOptional

The maximum quantity in an order

variantslist of optional StringsOptional

The all variants of product

currencyCodeStringOptional

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

imageUrlStringOptional

The images url of product

modifierslist of optional StringsOptional

The modifiers sku of product

optionslist of optional StringsOptional

The options of product

optionsV3list of optional StringsOptional

The options of product form v3 version API

channelIdlist of optional IntegersOptional

The channel ID of store

productUrlStringOptional

The product url

taxClassIdIntegerOptional

The tax class id of product

isPriceHiddenBooleanOptional

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

availableToSellIntegerOptional

Total available quantity for a product

unlimitedBackorderBooleanOptional

Indicate if the product has unlimited backorder

totalOnHandIntegerOptional

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

backorderMessageStringOptional

Store-configured backorder message when quantity exceeds on hand