Merchandising GraphQL API

Use the Merchandising GraphQL API to access rich view-model (read-only) catalog data to build product-related storefront experiences. For more information about the API, see the developer documentation.

API Endpoints

https://na1-sandbox.api.commerce.adobe.com/{TENANT_ID}/graphql

Headers

# Required. Tenant ID for your Adobe Commerce Optimizer instance.
AC-Environment-Id: Fwus6kdpvYCmeEdcCX7PZg
# Required. View ID for catalog context.
AC-View-Id: cde0ab4c-1f7b-4e12-91f6-9c7840ab6523
# Required. Content type header.
Content-Type: application/json
# Price book identifier for pricing context.
AC-Price-Book-ID: us
# Trigger name and value that sets data access filters to restrict product access based on request attributes.
AC-Policy-{*}: AC-Policy-Brand

Required Headers

All API requests must include the following headers:

AC-Environment-Id: Tenant ID for your Commerce Optimizer instance
AC-View-Id: View ID for catalog context
AC-Source-Locale: Catalog source locale to filter products for display or update
Content-Type: application/json

These headers ensure proper context for your API requests. See the server configuration below for example values.

Queries

`attributeMetadata`

Description

Return a list of product attribute codes that can be used for sorting or filtering in a productSearch query

Response

Returns an AttributeMetadataResponse!

Example

Query

query attributeMetadata {
  attributeMetadata {
    filterableInSearch {
      ...FilterableInSearchAttributeFragment
    }
    sortable {
      ...SortableAttributeFragment
    }
  }
}

Response

{
  "data": {
    "attributeMetadata": {
      "filterableInSearch": [FilterableInSearchAttribute],
      "sortable": [SortableAttribute]
    }
  }
}

Queries

`categoryTree`

Description

Retrieve hierarchical category data in a tree structure with parent-child relationships and level information.

Primary Use Case: RetailCMS applications requiring full category tree management.

Response

Returns [CategoryTreeView]

Arguments

Name Description

Name	Description
`family` - `String!`	Required. The catalog family identifier that determines which catalog's categories to retrieve. Typically: Your store's catalog ID
`slugs` - `[String!]`	Optional array of specific category slugs to retrieve. When Provided: Returns only specified categories Includes their hierarchical relationships (parents and children) Enables targeted category tree queries When Omitted: All categories in the specified family are returned Use Cases: Fetching specific category branches Retrieving category subtrees Targeted hierarchy queries
`depth` - `Int`	Optional maximum depth level to retrieve in the category tree structure. Depth Levels: `0`: Root categories only `1`: Root categories + immediate children `2`: Root + children + grandchildren And so on... Benefits: Improves performance for large category trees Controls response payload size Enables progressive tree loading Default: All available levels are returned if omitted

family - String!

Required. The catalog family identifier that determines which catalog's categories to retrieve.

Typically: Your store's catalog ID

slugs - [String!]

Optional array of specific category slugs to retrieve.

When Provided:

Returns only specified categories
Includes their hierarchical relationships (parents and children)
Enables targeted category tree queries

When Omitted: All categories in the specified family are returned

Use Cases:

Fetching specific category branches
Retrieving category subtrees
Targeted hierarchy queries

depth - Int

Optional maximum depth level to retrieve in the category tree structure.

Depth Levels:

0: Root categories only
1: Root categories + immediate children
2: Root + children + grandchildren
And so on...

Benefits:

Improves performance for large category trees
Controls response payload size
Enables progressive tree loading

Default: All available levels are returned if omitted

Example

Query

query categoryTree(
  $family: String!,
  $slugs: [String!],
  $depth: Int
) {
  categoryTree(
    family: $family,
    slugs: $slugs,
    depth: $depth
  ) {
    slug
    name
    level
    parentSlug
    childrenSlugs
  }
}

Variables

{
  "family": "abc123",
  "slugs": ["abc123"],
  "depth": 987
}

Response

{
  "data": {
    "categoryTree": [
      {
        "slug": "abc123",
        "name": "abc123",
        "level": 123,
        "parentSlug": "xyz789",
        "childrenSlugs": ["abc123"]
      }
    ]
  }
}

Queries

`navigation`

Description

Retrieve category navigation data optimized for storefront menu rendering with built-in performance safeguards.

Performance Features:

Limited to 4 levels deep for optimal rendering
Single database query per family
Heavily cached responses
Excludes heavyweight category attributes

Response

Returns [CategoryNavigationView]

Arguments

Name Description

Name	Description
`family` - `String!`	Required. The catalog family identifier that determines which catalog's navigation structure to retrieve. Typically: Your store's catalog ID Performance Optimizations: Entire family structure retrieved in single query Heavily cached responses Optimized for frequent navigation requests Minimal database load for menu rendering

family - String!

Required. The catalog family identifier that determines which catalog's navigation structure to retrieve.

Typically: Your store's catalog ID

Performance Optimizations:

Entire family structure retrieved in single query
Heavily cached responses
Optimized for frequent navigation requests
Minimal database load for menu rendering

Example

Query

query navigation($family: String!) {
  navigation(family: $family) {
    slug
    name
    children {
      ...CategoryNavigationViewFragment
    }
  }
}

Variables

{"family": "abc123"}

Response

{
  "data": {
    "navigation": [
      {
        "slug": "abc123",
        "name": "xyz789",
        "children": [CategoryNavigationView]
      }
    ]
  }
}

Queries

`productSearch`

Description

Search products using Live Search

Response

Returns a ProductSearchResponse!

Arguments

Name	Description
`context` - `QueryContextInput`	The query context
`current_page` - `Int`	Specifies which page of results to return. The default value is 1. Default = `1`
`page_size` - `Int`	The maximum number of results to return at once. Default = `20`
`phrase` - `String!`	Phrase to search for in product catalog
`sort` - `[ProductSearchSortInput!]`	Attributes and direction to sort on

Example

Query

query productSearch(
  $context: QueryContextInput,
  $current_page: Int,
  $page_size: Int,
  $phrase: String!,
  $sort: [ProductSearchSortInput!]
) {
  productSearch(
    context: $context,
    current_page: $current_page,
    page_size: $page_size,
    phrase: $phrase,
    sort: $sort
  ) {
    facets {
      ...AggregationFragment
    }
    items {
      ...ProductSearchItemFragment
    }
    page_info {
      ...SearchResultPageInfoFragment
    }
    related_terms
    suggestions
    total_count
  }
}

Variables

{
  "context": QueryContextInput,
  "current_page": 1,
  "page_size": 20,
  "phrase": "abc123",
  "sort": [ProductSearchSortInput]
}

Response

{
  "data": {
    "productSearch": {
      "facets": [Aggregation],
      "items": [ProductSearchItem],
      "page_info": SearchResultPageInfo,
      "related_terms": ["xyz789"],
      "suggestions": ["abc123"],
      "total_count": 123
    }
  }
}

Queries

`products`

Description

Search for products that match the specified SKU values.

Response

Returns [ProductView]

Arguments

Name	Description
`skus` - `[String]`

Example

Query

query products($skus: [String]) {
  products(skus: $skus) {
    addToCartAllowed
    inStock
    lowStock
    attributes {
      ...ProductViewAttributeFragment
    }
    description
    id
    images {
      ...ProductViewImageFragment
    }
    videos {
      ...ProductViewVideoFragment
    }
    lastModifiedAt
    metaDescription
    metaKeyword
    metaTitle
    name
    shortDescription
    sku
    externalId
    url
    urlKey
    links {
      ...ProductViewLinkFragment
    }
    queryType
    visibility
  }
}

Variables

{"skus": ["abc123"]}

Response

{
  "data": {
    "products": [
      {
        "addToCartAllowed": true,
        "inStock": true,
        "lowStock": false,
        "attributes": [ProductViewAttribute],
        "description": "xyz789",
        "id": 4,
        "images": [ProductViewImage],
        "videos": [ProductViewVideo],
        "lastModifiedAt": "2007-12-03T10:15:30Z",
        "metaDescription": "abc123",
        "metaKeyword": "xyz789",
        "metaTitle": "abc123",
        "name": "abc123",
        "shortDescription": "xyz789",
        "sku": "abc123",
        "externalId": "xyz789",
        "url": "xyz789",
        "urlKey": "abc123",
        "links": [ProductViewLink],
        "queryType": "xyz789",
        "visibility": "abc123"
      }
    ]
  }
}

Queries

`recommendations`

Description

Get Recommendations

Response

Returns a Recommendations

Arguments

Name	Description
`cartSkus` - `[String]`	SKUs of products in the cart
`category` - `String`	Category currently being viewed
`currentSku` - `String`	SKU of the product currently being viewed on PDP
`pageType` - `PageType`	Type of page on which recommendations are requested
`userPurchaseHistory` - `[PurchaseHistory]`	User purchase history with timestamp
`userViewHistory` - `[ViewHistory]`	User view history with timestamp
`config` - `UnitConfigInput`	Optional unit configuration

Example

Query

query recommendations(
  $cartSkus: [String],
  $category: String,
  $currentSku: String,
  $pageType: PageType,
  $userPurchaseHistory: [PurchaseHistory],
  $userViewHistory: [ViewHistory],
  $config: UnitConfigInput
) {
  recommendations(
    cartSkus: $cartSkus,
    category: $category,
    currentSku: $currentSku,
    pageType: $pageType,
    userPurchaseHistory: $userPurchaseHistory,
    userViewHistory: $userViewHistory,
    config: $config
  ) {
    results {
      ...RecommendationUnitFragment
    }
    totalResults
  }
}

Variables

{
  "cartSkus": ["abc123"],
  "category": "abc123",
  "currentSku": "abc123",
  "pageType": "CMS",
  "userPurchaseHistory": [PurchaseHistory],
  "userViewHistory": [ViewHistory],
  "config": UnitConfigInput
}

Response

{
  "data": {
    "recommendations": {
      "results": [RecommendationUnit],
      "totalResults": 987
    }
  }
}

Queries

`recommendationsByUnitIds`

Response

Returns a Recommendations

Arguments

Name	Description
`unitIds` - `[String!]!`	List unit IDs of preconfigured units
`currentSku` - `String`	SKU of the product currently being viewed on PDP
`userPurchaseHistory` - `[PurchaseHistory]`	User purchase history with timestamp
`userViewHistory` - `[ViewHistory]`	User view history with timestamp
`cartSkus` - `[String]`	SKUs of products in the cart

Example

Query

query recommendationsByUnitIds(
  $unitIds: [String!]!,
  $currentSku: String,
  $userPurchaseHistory: [PurchaseHistory],
  $userViewHistory: [ViewHistory],
  $cartSkus: [String]
) {
  recommendationsByUnitIds(
    unitIds: $unitIds,
    currentSku: $currentSku,
    userPurchaseHistory: $userPurchaseHistory,
    userViewHistory: $userViewHistory,
    cartSkus: $cartSkus
  ) {
    results {
      ...RecommendationUnitFragment
    }
    totalResults
  }
}

Variables

{
  "unitIds": ["xyz789"],
  "currentSku": "abc123",
  "userPurchaseHistory": [PurchaseHistory],
  "userViewHistory": [ViewHistory],
  "cartSkus": ["xyz789"]
}

Response

{
  "data": {
    "recommendationsByUnitIds": {
      "results": [RecommendationUnit],
      "totalResults": 987
    }
  }
}

Queries

`refineProduct`

Response

Returns a ProductView

Arguments

Name	Description
`optionIds` - `[String!]!`
`sku` - `String!`

Example

Query

query refineProduct(
  $optionIds: [String!]!,
  $sku: String!
) {
  refineProduct(
    optionIds: $optionIds,
    sku: $sku
  ) {
    addToCartAllowed
    inStock
    lowStock
    attributes {
      ...ProductViewAttributeFragment
    }
    description
    id
    images {
      ...ProductViewImageFragment
    }
    videos {
      ...ProductViewVideoFragment
    }
    lastModifiedAt
    metaDescription
    metaKeyword
    metaTitle
    name
    shortDescription
    sku
    externalId
    url
    urlKey
    links {
      ...ProductViewLinkFragment
    }
    queryType
    visibility
  }
}

Variables

{
  "optionIds": ["abc123"],
  "sku": "abc123"
}

Response

{
  "data": {
    "refineProduct": {
      "addToCartAllowed": false,
      "inStock": false,
      "lowStock": false,
      "attributes": [ProductViewAttribute],
      "description": "xyz789",
      "id": 4,
      "images": [ProductViewImage],
      "videos": [ProductViewVideo],
      "lastModifiedAt": "2007-12-03T10:15:30Z",
      "metaDescription": "abc123",
      "metaKeyword": "abc123",
      "metaTitle": "abc123",
      "name": "xyz789",
      "shortDescription": "abc123",
      "sku": "xyz789",
      "externalId": "xyz789",
      "url": "xyz789",
      "urlKey": "abc123",
      "links": [ProductViewLink],
      "queryType": "xyz789",
      "visibility": "xyz789"
    }
  }
}

Queries

`variants`

Response

Returns a ProductViewVariantResults

Arguments

Name	Description
`sku` - `String!`
`optionIds` - `[String!]`
`pageSize` - `Int`
`cursor` - `String`

Example

Query

query variants(
  $sku: String!,
  $optionIds: [String!],
  $pageSize: Int,
  $cursor: String
) {
  variants(
    sku: $sku,
    optionIds: $optionIds,
    pageSize: $pageSize,
    cursor: $cursor
  ) {
    variants {
      ...ProductViewVariantFragment
    }
    cursor
  }
}

Variables

{
  "sku": "abc123",
  "optionIds": ["abc123"],
  "pageSize": 123,
  "cursor": "xyz789"
}

Response

{
  "data": {
    "variants": {
      "variants": [ProductViewVariant],
      "cursor": "xyz789"
    }
  }
}

Types

Aggregation

Description

A bucket that contains information for each filterable option

Fields

Field Name	Description
`attribute` - `String!`	The attribute code of the filter item
`buckets` - `[Bucket]!`	A container that divides the data into manageable groups. For example, attributes that can have numeric values might have buckets that define price ranges
`title` - `String!`	The filter name displayed in layered navigation
`type` - `AggregationType`	Identifies the data type of the aggregation

Example

{
  "attribute": "abc123",
  "buckets": [Bucket],
  "title": "xyz789",
  "type": "INTELLIGENT"
}

Types

AggregationType

Description

Identifies the data type of the aggregation

Values

Enum Value	Description
`INTELLIGENT`
`PINNED`
`POPULAR`

Example

"INTELLIGENT"

Types

AppliedQueryRule

Description

The rule that was applied to this product

Fields

Field Name	Description
`action_type` - `AppliedQueryRuleActionType`	An enum that defines the type of rule that was applied
`rule_id` - `String`	The ID assigned to the rule
`rule_name` - `String`	The name of the applied rule

Example

{
  "action_type": "BOOST",
  "rule_id": "xyz789",
  "rule_name": "xyz789"
}

Types

AppliedQueryRuleActionType

Description

The type of rule that was applied to a product during search (optional)

Values

Enum Value	Description
`BOOST`
`BURY`
`PIN`

Example

"BOOST"

Types

AttributeMetadataResponse

Description

Contains the output of the attributeMetadata query

Fields

Field Name	Description
`filterableInSearch` - `[FilterableInSearchAttribute!]`	An array of product attributes that can be used for filtering in a `productSearch` query
`sortable` - `[SortableAttribute!]`	An array of product attributes that can be used for sorting in a `productSearch` query

Example

{
  "filterableInSearch": [FilterableInSearchAttribute],
  "sortable": [SortableAttribute]
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Bucket

Description

An interface for bucket contents

Fields

Field Name	Description
`title` - `String!`	A human-readable name of a bucket

Possible Types

Bucket Types
`CategoryBucket`
`CategoryView`
`RangeBucket`
`ScalarBucket`
`StatsBucket`

Example

{"title": "abc123"}

Types

CategoryBucket

Description

New category bucket for federation

Fields

Field Name	Description
`count` - `Int!`
`id` - `ID!`
`path` - `String!`
`title` - `String!`

Example

{
  "count": 987,
  "id": "4",
  "path": "xyz789",
  "title": "xyz789"
}

Types

CategoryBucketInterface

Fields

Field Name	Description
`id` - `ID!`

Possible Types

CategoryBucketInterface Types
`CategoryBucket`

Example

{"id": 4}

Types

CategoryInterface

Description

Contains the full set of attributes that can be returned in a category search.

Fields

Field Name	Description
`available_sort_by` - `[String]`
`canonical_url` - `String`	The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.
`children_count` - `String`
`custom_layout_update_file` - `String`
`default_sort_by` - `String`	The attribute to use for sorting.
`description` - `String`	An optional description of the category.
`display_mode` - `String`
`filter_price_range` - `Float`
`image` - `String`
`include_in_menu` - `Int`
`is_anchor` - `Int`
`landing_page` - `Int`
`level` - `Int`	The depth of the category within the tree.
`meta_description` - `String`
`meta_keywords` - `String`
`meta_title` - `String`
`name` - `String`	The display name of the category.
`path` - `String`	The full category path.
`path_in_store` - `String`	The category path within the store.
`position` - `Int`	The position of the category relative to other categories at the same level in tree.
`product_count` - `Int`	The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
`uid` - `ID!`	The unique ID for a `CategoryInterface` object.
`url_key` - `String`	The URL key assigned to the category.
`url_path` - `String`	The URL path assigned to the category.

Example

{
  "available_sort_by": ["xyz789"],
  "canonical_url": "xyz789",
  "children_count": "abc123",
  "custom_layout_update_file": "xyz789",
  "default_sort_by": "abc123",
  "description": "abc123",
  "display_mode": "xyz789",
  "filter_price_range": 123.45,
  "image": "xyz789",
  "include_in_menu": 123,
  "is_anchor": 987,
  "landing_page": 123,
  "level": 123,
  "meta_description": "xyz789",
  "meta_keywords": "abc123",
  "meta_title": "abc123",
  "name": "xyz789",
  "path": "xyz789",
  "path_in_store": "xyz789",
  "position": 987,
  "product_count": 123,
  "uid": "4",
  "url_key": "abc123",
  "url_path": "abc123"
}

Types

CategoryNavigationView

Description

Represents a category optimized for storefront menu rendering with recursive child category structure.

Performance Safeguards:

Limited to 4 levels deep
Excludes heavyweight category attributes
Supports heavy caching
Single query optimization

Ideal For:

Responsive navigation components
Dropdown menus
Mobile navigation
Breadcrumb systems

Fields

Field Name Description

slug - String! The unique URL-friendly identifier for the category, used in routing and navigation.

name - String! The display name of the category as shown to customers in the storefront navigation.

children - [CategoryNavigationView]

Array of direct child categories in a recursive structure.

Structure:

Each child contains their own children (recursive)
Limited to 4 levels deep for performance
Empty array if no children or max depth reached

Optimized For: Multi-level navigation menu rendering with built-in performance safeguards.

Example

{
  "slug": "xyz789",
  "name": "xyz789",
  "children": [CategoryNavigationView]
}

Types

CategoryTreeView

Description

Represents a category in a hierarchical tree structure with comprehensive parent-child relationship metadata.

Key Features:

Implements CategoryViewV2 interface
Designed for RetailCMS applications
Full category tree management capabilities

Provides:

Level depth information
Parent slug references
Children slug collections
Complete hierarchy metadata

Fields

Field Name	Description
`slug` - `String!`	The unique URL-friendly identifier for the category, used in routing and navigation.
`name` - `String!`	The display name of the category as shown to customers in the storefront.
`level` - `Int`	The hierarchical depth level of the category in the tree structure. Level Structure: Root categories: level 0 First-level children: level 1 Second-level children: level 2 And so on... Used For: Tree traversal and hierarchy management in RetailCMS applications.
`parentSlug` - `String`	The slug of the immediate parent category in the hierarchy. Values: Parent category slug for child categories `null` for root-level categories Common Uses: Building breadcrumb navigation Understanding category relationships Tree management system operations
`childrenSlugs` - `[String]`	Array of slugs for all direct child categories (immediate descendants only). Contains: Slugs of immediate children only (not grandchildren) Empty array if no children exist Benefits: Determine subcategory existence without fetching full objects Efficient category tree management Quick hierarchy assessment

Example

{
  "slug": "abc123",
  "name": "xyz789",
  "level": 987,
  "parentSlug": "abc123",
  "childrenSlugs": ["xyz789"]
}

Types

CategoryView

Description

Old category bucket for federation

Fields

Field Name	Description
`availableSortBy` - `[String]`
`children` - `[String!]`
`defaultSortBy` - `String`
`id` - `ID!`	'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.
`level` - `Int`
`name` - `String`
`parentId` - `String!`
`path` - `String`	'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.
`roles` - `[String!]!`
`urlKey` - `String`
`urlPath` - `String`
`count` - `Int!`	'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.
`title` - `String!`	'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.

Example

{
  "availableSortBy": ["abc123"],
  "children": ["abc123"],
  "defaultSortBy": "abc123",
  "id": "4",
  "level": 123,
  "name": "abc123",
  "parentId": "abc123",
  "path": "xyz789",
  "roles": ["abc123"],
  "urlKey": "abc123",
  "urlPath": "xyz789",
  "count": 123,
  "title": "xyz789"
}

Types

CategoryViewInterface

Fields

Field Name	Description
`availableSortBy` - `[String]`
`defaultSortBy` - `String`
`id` - `ID!`	'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.
`level` - `Int`
`name` - `String`
`path` - `String`
`roles` - `[String]`
`urlKey` - `String`
`urlPath` - `String`

Possible Types

CategoryViewInterface Types
`CategoryView`

Example

{
  "availableSortBy": ["abc123"],
  "defaultSortBy": "xyz789",
  "id": 4,
  "level": 123,
  "name": "abc123",
  "path": "xyz789",
  "roles": ["xyz789"],
  "urlKey": "xyz789",
  "urlPath": "abc123"
}

Types

CategoryViewV2

Description

Lightweight base interface for category view models designed for storefront APIs without backward compatibility constraints.

Design Principles:

Minimal essential properties (slug and name only)
Optimal performance for storefront use cases
No coupling with search facets

Replaces: The heavyweight CategoryView interface

Implemented By:

CategoryNavigationView (menu rendering)
CategoryTreeView (hierarchy management)

Fields

Field Name	Description
`slug` - `String!`	The unique URL-friendly identifier for the category, used in routing and navigation.
`name` - `String!`	The display name of the category as shown to customers in the storefront.

Possible Types

CategoryViewV2 Types
`CategoryNavigationView`
`CategoryTreeView`

Example

{
  "slug": "xyz789",
  "name": "abc123"
}

Types

ComplexProductView

Description

Represents all product types, except simple products. Complex product prices are returned as a price range, because price values can vary based on selected options.

Fields

Field Name	Description
`addToCartAllowed` - `Boolean`	A flag stating if the product can be added to cart This field is deprecated and will be removed.
`inStock` - `Boolean`	A flag stating if the product is in stock This field is deprecated and will be removed.
`lowStock` - `Boolean`	A flag stating if the product stock is low This field is deprecated and will be removed.
`attributes` - `[ProductViewAttribute]`	A list of merchant-defined attributes designated for the storefront.
Arguments `roles` - `[String]`
`description` - `String`	The detailed description of the product.
`id` - `ID!`	The product ID, generated as a composite key, unique per locale.
`images` - `[ProductViewImage]`	A list of images defined for the product.
Arguments `roles` - `[String]`
`videos` - `[ProductViewVideo]`	A list of videos defined for the product.
`lastModifiedAt` - `DateTime`	Date and time when the product was last updated.
`metaDescription` - `String`	A brief overview of the product for search results listings.
`metaKeyword` - `String`	A comma-separated list of keywords that are visible only to search engines.
`metaTitle` - `String`	A string that is displayed in the title bar and tab of the browser and in search results lists.
`name` - `String`	Product name.
`options` - `[ProductViewOption]`	A list of selectable options.
`priceRange` - `ProductViewPriceRange`	A range of possible prices for a complex product.
`shortDescription` - `String`	A summary of the product.
`sku` - `String`	Product SKU.
`externalId` - `String`	External Id This field is deprecated and will be removed.
`url` - `String`	Canonical URL of the product. This field is deprecated and will be removed.
`urlKey` - `String`	The URL key of the product.
`links` - `[ProductViewLink]`	A list of product links
Arguments `linkTypes` - `[String!]`
`queryType` - `String`	Indicates if the product was retrieved from the primary or the backup query
`visibility` - `String`	Visibility setting of the product

Example

{
  "addToCartAllowed": true,
  "inStock": false,
  "lowStock": true,
  "attributes": [ProductViewAttribute],
  "description": "xyz789",
  "id": "4",
  "images": [ProductViewImage],
  "videos": [ProductViewVideo],
  "lastModifiedAt": "2007-12-03T10:15:30Z",
  "metaDescription": "xyz789",
  "metaKeyword": "abc123",
  "metaTitle": "abc123",
  "name": "xyz789",
  "options": [ProductViewOption],
  "priceRange": ProductViewPriceRange,
  "shortDescription": "xyz789",
  "sku": "xyz789",
  "externalId": "xyz789",
  "url": "xyz789",
  "urlKey": "xyz789",
  "links": [ProductViewLink],
  "queryType": "xyz789",
  "visibility": "xyz789"
}

Types

ConditionInput

Fields

Input Field	Description
`field` - `Field`
`operator` - `OperatorInput`
`enabled` - `Boolean`

Example

{
  "field": "UNKNOWN_FIELD",
  "operator": OperatorInput,
  "enabled": true
}

Types

CustomOperatorInput

Fields

Input Field	Description
`type` - `CustomOperatorType`
`value` - `[String]`

Example

{
  "type": "UNKNOWN_CUSTOMOPERATOR_TYPE",
  "value": ["xyz789"]
}

Types

CustomOperatorType

Values

Enum Value	Description
`UNKNOWN_CUSTOMOPERATOR_TYPE`
`CUSTOM`

Example

"UNKNOWN_CUSTOMOPERATOR_TYPE"

Types

DateTime

Description

An RFC-3339 compliant DateTime Scalar

Example

"2007-12-03T10:15:30Z"

Types

Field

Values

Enum Value	Description
`UNKNOWN_FIELD`
`CATEGORY`
`PRICE`
`PRODUCT`
`OUT_OF_STOCK`
`LOW_STOCK`
`TYPE`
`VISIBILITY`

Example

"UNKNOWN_FIELD"

Types

FilterRuleInput

Fields

Input Field	Description
`name` - `String`
`type` - `FilterRuleType`
`conditions` - `[ConditionInput]`

Example

{
  "name": "xyz789",
  "type": "UNKNOWN_FILTER_RULE_TYPE",
  "conditions": [ConditionInput]
}

Types

FilterRuleType

Values

Enum Value	Description
`UNKNOWN_FILTER_RULE_TYPE`
`INCLUSION`
`EXCLUSION`

Example

"UNKNOWN_FILTER_RULE_TYPE"

Types

FilterableInSearchAttribute

Description

Contains product attributes that can be used for filtering in a productSearch query

Fields

Field Name	Description
`attribute` - `String!`	The unique identifier for an attribute code. This value should be in lowercase letters and without spaces
`frontendInput` - `String`	Indicates how field rendered on storefront
`label` - `String`	The display name assigned to the attribute
`numeric` - `Boolean`	Indicates whether this attribute has a numeric value, such as a price or integer

Example

{
  "attribute": "abc123",
  "frontendInput": "abc123",
  "label": "xyz789",
  "numeric": false
}

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

Types

Highlight

Description

An object that provides highlighted text for matched words

Fields

Field Name	Description
`attribute` - `String!`	The product attribute that contains a match for the search phrase
`matched_words` - `[String]!`	An array of strings
`value` - `String!`	The matched text, enclosed within emphasis tags

Example

{
  "attribute": "abc123",
  "matched_words": ["xyz789"],
  "value": "xyz789"
}

Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

IsOperatorInput

Fields

Input Field	Description
`type` - `IsOperatorType`
`value` - `Boolean`

Example

{"type": "UNKNOWN_ISOPERATOR_TYPE", "value": true}

Types

IsOperatorType

Values

Enum Value	Description
`UNKNOWN_ISOPERATOR_TYPE`
`IS`

Example

"UNKNOWN_ISOPERATOR_TYPE"

Types

JSON

Description

A JSON scalar

Example

{}

Types

MediaGalleryInterface

Description

Contains basic information about a product image or video.

Fields

Field Name	Description
`disabled` - `Boolean`	Indicates whether the image is hidden from view.
`label` - `String`	The label of the product image or video.
`position` - `Int`	The media item's position after it has been sorted.
`url` - `String`	The URL of the product image or video.

Example

{
  "disabled": false,
  "label": "abc123",
  "position": 123,
  "url": "abc123"
}

Types

NumericOperatorInput

Fields

Input Field	Description
`type` - `NumericOperatorType`

Example

{"type": "UNKNOWN_NUMERIC_OPERATOR"}

Types

NumericOperatorType

Values

Enum Value	Description
`UNKNOWN_NUMERIC_OPERATOR`
`GREATER_THAN_CURRENT`
`LESS_THAN_CURRENT`

Example

"UNKNOWN_NUMERIC_OPERATOR"

Types

OperatorInput

Fields

Input Field	Description
`rangeOperator` - `RangeOperatorInput`
`customOperator` - `CustomOperatorInput`
`isOperator` - `IsOperatorInput`
`numericOperator` - `NumericOperatorInput`
`stringOperator` - `StringOperatorInput`

Example

{
  "rangeOperator": RangeOperatorInput,
  "customOperator": CustomOperatorInput,
  "isOperator": IsOperatorInput,
  "numericOperator": NumericOperatorInput,
  "stringOperator": StringOperatorInput
}

Types

PageType

Description

Type of page on which recommendations are requested

Values

Enum Value	Description
`CMS`
`Cart`
`Category`	This field is deprecated and will be removed.
`Checkout`
`PageBuilder`
`Product`

Example

"CMS"

Types

Price

Description

Defines the price of a simple product or a part of a price range for a complex product. It can include a list of price adjustments.

Fields

Field Name	Description
`adjustments` - `[PriceAdjustment]`	A list of price adjustments.
`amount` - `ProductViewMoney`	Contains the monetary value and currency code of a product.

Example

{
  "adjustments": [PriceAdjustment],
  "amount": ProductViewMoney
}

Types

PriceAdjustment

Description

Specifies the amount and type of price adjustment.

Fields

Field Name	Description
`amount` - `Float`	The amount of the price adjustment.
`code` - `String`	Identifies the type of price adjustment.

Example

{"amount": 123.45, "code": "abc123"}

Types

ProductInterface

Description

Contains fields that are common to all types of products.

Fields

Field Name	Description
`canonical_url` - `String`	The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
`categories` - `[CategoryInterface]`	The categories assigned to a product.
`country_of_manufacture` - `String`	The product's country of origin.
`crosssell_products` - `[ProductInterface]`	Crosssell Products
`gift_message_available` - `Boolean!`	Returns a value indicating gift message availability for the product.
`gift_wrapping_available` - `Boolean!`	Returns a value indicating gift wrapping availability for the product.
`is_returnable` - `String`	Indicates whether the product can be returned.
`manufacturer` - `Int`	A number representing the product's manufacturer.
`max_sale_qty` - `Float`	Maximum Qty Allowed in Shopping Cart
`media_gallery` - `[MediaGalleryInterface]`	An array of media gallery objects.
`meta_description` - `String`	A brief overview of the product for search results listings, maximum 255 characters.
`meta_keyword` - `String`	A comma-separated list of keywords that are visible only to search engines.
`meta_title` - `String`	A string that is displayed in the title bar and tab of the browser and in search results lists.
`min_sale_qty` - `Float`	Minimum Qty Allowed in Shopping Cart
`name` - `String`	The product name. Customers use this name to identify the product.
`new_from_date` - `String`	The beginning date for new product listings, and determines if the product is featured as a new product.
`new_to_date` - `String`	The end date for new product listings.
`only_x_left_in_stock` - `Float`	Product stock only x left count
`options_container` - `String`	If the product has multiple options, determines where they appear on the product page.
`product_links` - `[ProductLinksInterface]`	An array of `ProductLinks` objects.
`quantity` - `Float`	Quantity of available stock
`related_products` - `[ProductInterface]`	An array of products to be displayed in a Related Products block.
`sku` - `String`	A number or code assigned to a product to identify the product, options, price, and manufacturer.
`special_price` - `Float`	The discounted price of the product.
`special_to_date` - `String`	The end date for a product with a special price.
`swatch_image` - `String`	The file name of a swatch image.
`uid` - `ID!`	The unique ID for a `ProductInterface` object.
`upsell_products` - `[ProductInterface]`	Upsell Products
`url_key` - `String`	The part of the URL that identifies the product

Example

{
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "country_of_manufacture": "abc123",
  "crosssell_products": [ProductInterface],
  "gift_message_available": true,
  "gift_wrapping_available": true,
  "is_returnable": "xyz789",
  "manufacturer": 987,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "meta_description": "abc123",
  "meta_keyword": "abc123",
  "meta_title": "xyz789",
  "min_sale_qty": 123.45,
  "name": "xyz789",
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options_container": "xyz789",
  "product_links": [ProductLinksInterface],
  "quantity": 123.45,
  "related_products": [ProductInterface],
  "sku": "abc123",
  "special_price": 987.65,
  "special_to_date": "abc123",
  "swatch_image": "abc123",
  "uid": "4",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789"
}

Types

ProductLinksInterface

Description

Contains information about linked products, including the link type and product type of each item.

Fields

Field Name	Description
`link_type` - `String`	One of related, associated, upsell, or crosssell.
`linked_product_sku` - `String`	The SKU of the linked product.
`linked_product_type` - `String`	The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).
`position` - `Int`	The position within the list of product links.
`sku` - `String`	The identifier of the linked product.

Example

{
  "link_type": "xyz789",
  "linked_product_sku": "abc123",
  "linked_product_type": "xyz789",
  "position": 987,
  "sku": "abc123"
}

Types

ProductSearchItem

Description

A single product returned by the query

Fields

Field Name	Description
`applied_query_rule` - `AppliedQueryRule`	The query rule type that was applied to this product, if any (in preview mode only, returns null otherwise)
`highlights` - `[Highlight]`	An object that provides highlighted text for matched words
`productView` - `ProductView`	Contains a product view

Example

{
  "applied_query_rule": AppliedQueryRule,
  "highlights": [Highlight],
  "productView": ProductView
}

Types

ProductSearchResponse

Description

Contains the output of a productSearch query

Fields

Field Name	Description
`facets` - `[Aggregation]`	Details about the static and dynamic facets relevant to the search
`items` - `[ProductSearchItem]`	An array of products returned by the query
`page_info` - `SearchResultPageInfo`	Information for rendering pages of search results
`related_terms` - `[String]`	An array of strings that might include merchant-defined synonyms
`suggestions` - `[String]`	An array of strings that include the names of products and categories that exist in the catalog that are similar to the search query
`total_count` - `Int`	The total number of products returned that matched the query

Example

{
  "facets": [Aggregation],
  "items": [ProductSearchItem],
  "page_info": SearchResultPageInfo,
  "related_terms": ["xyz789"],
  "suggestions": ["abc123"],
  "total_count": 987
}

Types

ProductSearchSortInput

Description

The product attribute to sort on

Fields

Input Field	Description
`attribute` - `String!`	The attribute code of a product attribute

Example

{"attribute": "xyz789"}

Types

ProductView

Description

Defines the product fields available to the SimpleProductView and ComplexProductView types.

Fields

Field Name	Description
`addToCartAllowed` - `Boolean`	A flag stating if the product can be added to cart This field is deprecated and will be removed.
`inStock` - `Boolean`	A flag stating if the product is in stock This field is deprecated and will be removed.
`lowStock` - `Boolean`	A flag stating if the product stock is low This field is deprecated and will be removed.
`attributes` - `[ProductViewAttribute]`	A list of merchant-defined attributes designated for the storefront.
Arguments `roles` - `[String]`
`description` - `String`	The detailed description of the product.
`id` - `ID!`	The product ID, generated as a composite key, unique per locale.
`images` - `[ProductViewImage]`	A list of images defined for the product.
Arguments `roles` - `[String]`
`videos` - `[ProductViewVideo]`	A list of videos defined for the product.
`lastModifiedAt` - `DateTime`	Date and time when the product was last updated.
`metaDescription` - `String`	A brief overview of the product for search results listings.
`metaKeyword` - `String`	A comma-separated list of keywords that are visible only to search engines.
`metaTitle` - `String`	A string that is displayed in the title bar and tab of the browser and in search results lists.
`name` - `String`	Product name.
`shortDescription` - `String`	A summary of the product.
`sku` - `String`	Product SKU.
`externalId` - `String`	External Id This field is deprecated and will be removed.
`url` - `String`	Canonical URL of the product. This field is deprecated and will be removed.
`urlKey` - `String`	The URL key of the product.
`links` - `[ProductViewLink]`	A list of product links.
Arguments `linkTypes` - `[String!]`
`queryType` - `String`	Indicates if the product was retrieved from the primary or the backup query
`visibility` - `String`	Visibility setting of the product

Possible Types

ProductView Types
`ComplexProductView`
`SimpleProductView`

Example

{
  "addToCartAllowed": false,
  "inStock": true,
  "lowStock": false,
  "attributes": [ProductViewAttribute],
  "description": "abc123",
  "id": "4",
  "images": [ProductViewImage],
  "videos": [ProductViewVideo],
  "lastModifiedAt": "2007-12-03T10:15:30Z",
  "metaDescription": "xyz789",
  "metaKeyword": "xyz789",
  "metaTitle": "abc123",
  "name": "abc123",
  "shortDescription": "xyz789",
  "sku": "abc123",
  "externalId": "xyz789",
  "url": "xyz789",
  "urlKey": "xyz789",
  "links": [ProductViewLink],
  "queryType": "abc123",
  "visibility": "xyz789"
}

Types

ProductViewAttribute

Description

A container for customer-defined attributes that are displayed the storefront.

Fields

Field Name	Description
`label` - `String`	Label of the attribute.
`name` - `String!`	Name of an attribute code.
`roles` - `[String]`	Roles designated for an attribute on the storefront, such as "Show on PLP", "Show in PDP", or "Show in Search".
`value` - `JSON`	Attribute value, arbitrary of type.

Example

{
  "label": "abc123",
  "name": "abc123",
  "roles": ["abc123"],
  "value": {}
}

Types

ProductViewCurrency

Description

The list of supported currency codes.

Values

Enum Value	Description
`AED`
`AFN`
`ALL`
`AMD`
`ANG`
`AOA`
`ARS`
`AUD`
`AWG`
`AZM`
`AZN`
`BAM`
`BBD`
`BDT`
`BGN`
`BHD`
`BIF`
`BMD`
`BND`
`BOB`
`BRL`
`BSD`
`BTN`
`BUK`
`BWP`
`BYN`
`BZD`
`CAD`
`CDF`
`CHE`
`CHF`
`CHW`
`CLP`
`CNY`
`COP`
`CRC`
`CUP`
`CVE`
`CZK`
`DJF`
`DKK`
`DOP`
`DZD`
`EEK`
`EGP`
`ERN`
`ETB`
`EUR`
`FJD`
`FKP`
`GBP`
`GEK`
`GEL`
`GHS`
`GIP`
`GMD`
`GNF`
`GQE`
`GTQ`
`GYD`
`HKD`
`HNL`
`HRK`
`HTG`
`HUF`
`IDR`
`ILS`
`INR`
`IQD`
`IRR`
`ISK`
`JMD`
`JOD`
`JPY`
`KES`
`KGS`
`KHR`
`KMF`
`KPW`
`KRW`
`KWD`
`KYD`
`KZT`
`LAK`
`LBP`
`LKR`
`LRD`
`LSL`
`LSM`
`LTL`
`LVL`
`LYD`
`MAD`
`MDL`
`MGA`
`MKD`
`MMK`
`MNT`
`MOP`
`MRO`
`MUR`
`MVR`
`MWK`
`MXN`
`MYR`
`MZN`
`NAD`
`NGN`
`NIC`
`NOK`
`NPR`
`NZD`
`OMR`
`PAB`
`PEN`
`PGK`
`PHP`
`PKR`
`PLN`
`PYG`
`QAR`
`RHD`
`ROL`
`RON`
`RSD`
`RUB`
`RWF`
`SAR`
`SBD`
`SCR`
`SDG`
`SEK`
`SGD`
`SHP`
`SKK`
`SLL`
`SOS`
`SRD`
`STD`
`SVC`
`SYP`
`SZL`
`THB`
`TJS`
`TMM`
`TND`
`TOP`
`TRL`
`TRY`
`TTD`
`TWD`
`TZS`
`UAH`
`UGX`
`USD`
`UYU`
`UZS`
`VEB`
`VEF`
`VND`
`VUV`
`WST`
`XCD`
`XOF`
`XPF`
`YER`
`ZAR`
`ZMK`
`ZWD`
`NONE`

Example

"AED"

Types

ProductViewImage

Description

Contains details about a product image.

Fields

Field Name	Description
`label` - `String`	The display label of the product image.
`roles` - `[String]`	A list that describes how the image is used. Can be image, small_image, or thumbnail.
`url` - `String!`	The URL to the product image.

Example

{
  "label": "abc123",
  "roles": ["xyz789"],
  "url": "xyz789"
}

Types

ProductViewLink

Description

The product link type.

Fields

Field Name	Description
`product` - `ProductView!`	Contains the details of the product found in the link.
`linkTypes` - `[String!]!`	Stores the types of the links with this product.

Example

{
  "product": ProductView,
  "linkTypes": ["abc123"]
}

Types

ProductViewMoney

Description

Defines a monetary value, including a numeric value and a currency code.

Fields

Field Name	Description
`currency` - `ProductViewCurrency`	A three-letter currency code, such as USD or EUR.
`value` - `Float`	A number expressing a monetary value.

Example

{"currency": "AED", "value": 987.65}

Types

ProductViewOption

Description

Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product.

Fields

Field Name	Description
`id` - `ID`	The ID of the option.
`multi` - `Boolean`	Indicates whether the option allows multiple choices.
`required` - `Boolean`	Indicates whether the option must be selected.
`title` - `String`	The display name of the option.
`values` - `[ProductViewOptionValue!]`	List of available option values.

Example

{
  "id": 4,
  "multi": true,
  "required": true,
  "title": "abc123",
  "values": [ProductViewOptionValue]
}

Types

ProductViewOptionValue

Description

Defines the product fields available to the ProductViewOptionValueProduct and ProductViewOptionValueConfiguration types.

Fields

Field Name	Description
`id` - `ID`	The ID of an option value.
`title` - `String`	The display name of the option value.
`inStock` - `Boolean`	Indicates if the option is in stock.

Possible Types

ProductViewOptionValue Types
`ProductViewOptionValueConfiguration`
`ProductViewOptionValueProduct`
`ProductViewOptionValueSwatch`

Example

{
  "id": 4,
  "title": "abc123",
  "inStock": true
}

Types

ProductViewOptionValueConfiguration

Description

An implementation of ProductViewOptionValue for configuration values.

Fields

Field Name	Description
`id` - `ID`	The ID of an option value.
`title` - `String`	The display name of the option value.
`inStock` - `Boolean`	Indicates if the option is in stock.

Example

{
  "id": "4",
  "title": "xyz789",
  "inStock": true
}

Types

ProductViewOptionValueProduct

Description

An implementation of ProductViewOptionValue that adds details about a simple product.

Fields

Field Name	Description
`id` - `ID`	The ID of an option value.
`isDefault` - `Boolean`	States if the option value is default or not.
`product` - `SimpleProductView`	Details about a simple product.
`quantity` - `Float`	Default quantity of an option value.
`title` - `String`	The display name of the option value.
`inStock` - `Boolean`	Indicates if the option is in stock.

Example

{
  "id": "4",
  "isDefault": true,
  "product": SimpleProductView,
  "quantity": 987.65,
  "title": "abc123",
  "inStock": false
}

Types

ProductViewOptionValueSwatch

Description

An implementation of ProductViewOptionValueSwatch for swatches.

Fields

Field Name	Description
`id` - `ID`	The ID of an option value.
`title` - `String`	The display name of the option value.
`type` - `SwatchType`	Indicates the type of the swatch.
`value` - `String`	The value of the swatch depending on the type of the swatch.
`inStock` - `Boolean`	Indicates if the option is in stock.

Example

{
  "id": "4",
  "title": "abc123",
  "type": "TEXT",
  "value": "xyz789",
  "inStock": false
}

Types

ProductViewPrice

Description

Base product price view, inherent for simple products.

Fields

Field Name	Description
`final` - `Price`	Price value after discounts, excluding personalized promotions.
`regular` - `Price`	Base product price specified by the merchant.
`tiers` - `[ProductViewTierPrice]`	Volume based pricing
`roles` - `[String]`	Price roles, stating if the price should be visible or hidden.

Example

{
  "final": Price,
  "regular": Price,
  "tiers": [ProductViewTierPrice],
  "roles": ["xyz789"]
}

Types

ProductViewPriceRange

Description

The minimum and maximum price of a complex product.

Fields

Field Name	Description
`maximum` - `ProductViewPrice`	Maximum price.
`minimum` - `ProductViewPrice`	Minimum price.

Example

{
  "maximum": ProductViewPrice,
  "minimum": ProductViewPrice
}

Types

ProductViewTierCondition

Types

Union Types
`ProductViewTierRangeCondition`
`ProductViewTierExactMatchCondition`

Example

ProductViewTierRangeCondition

Types

ProductViewTierExactMatchCondition

Fields

Field Name	Description
`in` - `[Float]`

Example

{"in": [123.45]}

Types

ProductViewTierPrice

Fields

Field Name	Description
`tier` - `Price`	Volume based price
`quantity` - `[ProductViewTierCondition!]!`	Condition to active price

Example

{
  "tier": Price,
  "quantity": [ProductViewTierRangeCondition]
}

Types

ProductViewTierRangeCondition

Fields

Field Name	Description
`gte` - `Float`
`lt` - `Float`

Example

{"gte": 987.65, "lt": 123.45}

Types

ProductViewVariant

Fields

Field Name	Description
`selections` - `[String!]`	List of option values that make up the variant.
`product` - `ProductView`	Product corresponding to the variant.

Example

{
  "selections": ["xyz789"],
  "product": ProductView
}

Types

ProductViewVariantResults

Fields

Field Name	Description
`variants` - `[ProductViewVariant]!`	List of product variants.
`cursor` - `String`	Pagination cursor

Example

{
  "variants": [ProductViewVariant],
  "cursor": "abc123"
}

Types

ProductViewVideo

Description

Contains details about a product video

Fields

Field Name	Description
`preview` - `ProductViewImage`	Preview image for the video
`url` - `String!`	The URL to the product video.
`description` - `String`	Description of the product video.
`title` - `String`	The title of the product video.

Example

{
  "preview": ProductViewImage,
  "url": "xyz789",
  "description": "abc123",
  "title": "xyz789"
}

Types

PurchaseHistory

Description

User purchase history

Fields

Input Field	Description
`date` - `DateTime`
`items` - `[String]!`

Example

{
  "date": "2007-12-03T10:15:30Z",
  "items": ["xyz789"]
}

Types

QueryContextInput

Fields

Input Field	Description
`customerGroup` - `String!`	The customer group code. Field reserved for future use. Currently, passing this field will have no impact on search results, that is, the search results will be for "Not logged in" customer

Example

{"customerGroup": "xyz789"}

Types

RangeBucket

Description

For use on numeric product fields

Fields

Field Name	Description
`count` - `Int!`	The number of items in the bucket
`from` - `Float!`	The minimum amount in a price range
`title` - `String!`	The display text defining the price range
`to` - `Float`	The maximum amount in a price range

Example

{
  "count": 123,
  "from": 987.65,
  "title": "abc123",
  "to": 123.45
}

Types

RangeOperatorInput

Fields

Input Field	Description
`type` - `RangeType`
`value` - `RangeValueInput`

Example

{"type": "UNKNOWN_RANGE_TYPE", "value": RangeValueInput}

Types

RangeType

Values

Enum Value	Description
`UNKNOWN_RANGE_TYPE`
`STATIC`
`PERCENTAGE`
`DYNAMIC`

Example

"UNKNOWN_RANGE_TYPE"

Types

RangeValueInput

Fields

Input Field	Description
`from` - `Float`
`to` - `Float`

Example

{"from": 987.65, "to": 987.65}

Types

RecommendationUnit

Description

Recommendation Unit containing product and other details

Fields

Field Name	Description
`displayOrder` - `Int`	Order in which recommendation units are displayed
`pageType` - `String`	Page type
`productsView` - `[ProductView]`	List of product view
`storefrontLabel` - `String`	Storefront label to be displayed on the storefront
`totalProducts` - `Int`	Total products returned in recommedations
`typeId` - `String`	Type of recommendation
`unitId` - `String`	Id of the preconfigured unit
`unitName` - `String`	Name of the preconfigured unit

Example

{
  "displayOrder": 987,
  "pageType": "xyz789",
  "productsView": [ProductView],
  "storefrontLabel": "abc123",
  "totalProducts": 123,
  "typeId": "xyz789",
  "unitId": "abc123",
  "unitName": "abc123"
}

Types

Recommendations

Description

Recommendations response

Fields

Field Name	Description
`results` - `[RecommendationUnit]`	List of rec units with products recommended
`totalResults` - `Int`	total number of rec units for which recommendations are returned

Example

{"results": [RecommendationUnit], "totalResults": 123}

Types

ScalarBucket

Description

For use on string and other scalar product fields

Fields

Field Name	Description
`count` - `Int!`	The number of items in the bucket
`id` - `ID!`	An identifier that can be used for filtering. It may contain non-human readable data
`title` - `String!`	The display text for the scalar value

Example

{
  "count": 123,
  "id": "4",
  "title": "abc123"
}

Types

SearchResultPageInfo

Description

Provides navigation for the query response.

Fields

Field Name	Description
`current_page` - `Int`	The specific page to return.
`page_size` - `Int`	The maximum number of items to return per page of results.
`total_pages` - `Int`	The total number of pages in the response.

Example

{"current_page": 123, "page_size": 987, "total_pages": 123}

Types

SimpleProductView

Description

Represents simple products. Simple product prices do not contain price ranges.

Fields

Field Name	Description
`addToCartAllowed` - `Boolean`	A flag stating if the product can be added to cart This field is deprecated and will be removed.
`inStock` - `Boolean`	A flag stating if the product is in stock This field is deprecated and will be removed.
`lowStock` - `Boolean`	A flag stating if the product stock is low This field is deprecated and will be removed.
`attributes` - `[ProductViewAttribute]`	A list of merchant-defined attributes designated for the storefront.
Arguments `roles` - `[String]`
`description` - `String`	The detailed description of the product.
`id` - `ID!`	The product ID, generated as a composite key, unique per locale.
`images` - `[ProductViewImage]`	A list of images defined for the product.
Arguments `roles` - `[String]`
`videos` - `[ProductViewVideo]`	A list of videos defined for the product.
`lastModifiedAt` - `DateTime`	Date and time when the product was last updated.
`metaDescription` - `String`	A brief overview of the product for search results listings.
`metaKeyword` - `String`	A comma-separated list of keywords that are visible only to search engines.
`metaTitle` - `String`	A string that is displayed in the title bar and tab of the browser and in search results lists.
`name` - `String`	Product name.
`price` - `ProductViewPrice`	Base product price view.
`shortDescription` - `String`	A summary of the product.
`sku` - `String`	Product SKU.
`externalId` - `String`	External Id This field is deprecated and will be removed.
`url` - `String`	Canonical URL of the product. This field is deprecated and will be removed.
`urlKey` - `String`	The URL key of the product.
`links` - `[ProductViewLink]`	A list of product links
Arguments `linkTypes` - `[String!]`
`queryType` - `String`	Indicates if the product was retrieved from the primary or the backup query
`visibility` - `String`	Visibility setting of the product

Example

{
  "addToCartAllowed": true,
  "inStock": true,
  "lowStock": false,
  "attributes": [ProductViewAttribute],
  "description": "abc123",
  "id": 4,
  "images": [ProductViewImage],
  "videos": [ProductViewVideo],
  "lastModifiedAt": "2007-12-03T10:15:30Z",
  "metaDescription": "xyz789",
  "metaKeyword": "abc123",
  "metaTitle": "abc123",
  "name": "abc123",
  "price": ProductViewPrice,
  "shortDescription": "xyz789",
  "sku": "xyz789",
  "externalId": "xyz789",
  "url": "abc123",
  "urlKey": "abc123",
  "links": [ProductViewLink],
  "queryType": "abc123",
  "visibility": "xyz789"
}

Types

SortableAttribute

Description

Contains product attributes that be used for sorting in a productSearch query

Fields

Field Name	Description
`attribute` - `String!`	The unique identifier for an attribute code. This value should be in lowercase letters and without space
`frontendInput` - `String`	Indicates how field rendered on storefront
`label` - `String`	The display name assigned to the attribute
`numeric` - `Boolean`	Indicates whether this attribute has a numeric value, such as a price or integer

Example

{
  "attribute": "xyz789",
  "frontendInput": "abc123",
  "label": "xyz789",
  "numeric": true
}

Types

StatsBucket

Description

For retrieving statistics across multiple buckets

Fields

Field Name	Description
`max` - `Float!`	The maximum value
`min` - `Float!`	The minimum value
`title` - `String!`	The display text for the bucket

Example

{
  "max": 123.45,
  "min": 987.65,
  "title": "abc123"
}

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"xyz789"

Types

StringOperatorInput

Fields

Input Field	Description
`type` - `StringOperatorType`

Example

{"type": "UNKNOWN_STRING_OPERATOR"}

Types

StringOperatorType

Values

Enum Value	Description
`UNKNOWN_STRING_OPERATOR`
`SAME_AS_CURRENT`
`ALL_EXCEPT_CURRENT`

Example

"UNKNOWN_STRING_OPERATOR"

Types

SwatchType

Values

Enum Value	Description
`TEXT`
`IMAGE`
`COLOR_HEX`
`CUSTOM`

Example

"TEXT"

Types

UnitConfigInput

Fields

Input Field	Description
`unitName` - `String`
`storefrontLabel` - `String`
`pagePlacement` - `String`
`displayNumber` - `Int`
`pageType` - `String`
`unitStatus` - `String`
`typeId` - `String`
`filterRules` - `[FilterRuleInput]`

Example

{
  "unitName": "xyz789",
  "storefrontLabel": "abc123",
  "pagePlacement": "xyz789",
  "displayNumber": 123,
  "pageType": "abc123",
  "unitStatus": "xyz789",
  "typeId": "xyz789",
  "filterRules": [FilterRuleInput]
}

Types

ViewHistory

Description

User view history

Fields

Input Field	Description
`date` - `DateTime`
`sku` - `String!`

Example

{
  "date": "2007-12-03T10:15:30Z",
  "sku": "xyz789"
}

Documentation by Anvil SpectaQL