Blocks API: Get Block Products

Authorization

X-Storefront-Access-Token

string

required

Token-based authentication header in the form of <YOUR_LAYERS_TOKEN>.

Headers

Content-Type

string

default:"application/json"

required

string

default:"application/json"

required

Path parameters

blockId

string

required

The unique identifier (ULID) of the block you wish to retrieve products for.

Body

anchor_id

string

The anchor identifier for the block. Required for product and collection anchor types.

Product anchors: Numeric product ID (e.g., "8234567890123") or Shopify GID (e.g., "gid://shopify/Product/8234567890123"). Both formats are resolved automatically.
Collection anchors: Collection ID (e.g., "456789012345") or collection handle (e.g., "summer-collection"). The system automatically resolves both numeric IDs and string handles.
Cart anchors: Not required (uses context.productsInCart instead)
None anchors: Not required (global blocks)

anchor_handle

string

Deprecated: Use anchor_id instead. For collection anchors, anchor_id now accepts both collection IDs and handles.

attributes

string[]

Product attributes to include in the response. By default, all attributes are included. Available attributes include: id, title, handle, body_html, vendor, product_type, tags, images, available, created_at, updated_at, published_at, price_range, options, original_options, metafields, named_tags, calculated, category, featured_media, is_gift_card, has_variants_that_require_components, combined_listing_parent_product_id, combined_listing_role, first_or_matched_variant, and variants. See the Product Schema for detailed descriptions.

excludeProductIds

string[]

A list of product IDs to exclude from the recommendations returned by this block. Use this to deduplicate products across multiple blocks rendered on the same page — for example, to prevent the same product from appearing in both a “Frequently Bought Together” block and a “Customers Also Viewed” block.Each entry can be either a numeric product ID (e.g., "8234567890123") or a Shopify GID (e.g., "gid://shopify/Product/8234567890123"). Both formats are accepted and resolved automatically.Excluded products are filtered out before strategy ranking, safeguard checks, and fallback evaluation. If excluding products causes the primary block to fall below its minimum products safeguard, the fallback chain is used and exclusions are applied to fallback blocks as well.

filter_group

object

Refer to our dedicated Filter Expressions guide to learn more about filter expressions.

pagination

Pagination Object

Show pagination

page

int

The current page of results to fetch.

limit

int

The max results to fetch per page

facets

string[]

Facets to be included. Accepts both exact facet codes (e.g., "vendor", "options.Size") and wildcard patterns (e.g., "options.*", "metafields.product.*").Wildcard patterns expand to all matching attribute codes. For example, "options.*" expands to all option facets like "options.Size" and "options.Color". Wildcards must match at least one attribute code to be valid.Examples:

// Exact facet codes
"facets": ["vendor", "options.Size", "options.Color"]

// Wildcard pattern
"facets": ["options.*"]

// Mixed exact and wildcard
"facets": ["vendor", "options.*", "metafields.product.*"]

retrieveFacetCount

boolean

If the count of each facet value should be calculated

includeFacetRanges

boolean

If you want a min/max range for numeric facets such as price.

identity

object

User identity information for tracking and personalization. Automatically managed by the Storefront Pixel; required for headless integrations.

Show Properties

deviceId

string

Persistent browser identifier that remains constant across sessions. Used to recognize returning visitors for long-term personalization. Automatically generated and managed by the Storefront Pixel.

sessionId

string

Temporary session identifier. Typically corresponds to the Shopify session ID and expires after inactivity or when the browser is closed.

customerId

string

Shopify customer ID for authenticated users. Only present when the user is signed in to their account.

context

object

Contextual information about the customer’s session, behavior, and environment. Automatically collected by the Storefront Pixel; must be manually provided for headless integrations. See Contextual Information for implementation guidance.

Show Properties

geo

object

Geographic location information for regional personalization and merchandising. Automatically determined by the platform for client-side requests based on IP address. For server-side API calls (headless integrations), you should provide this explicitly.

Show Properties

country

string

Country code or name (e.g., “US”, “Canada”).

province

string

State or province name (e.g., “California”, “Ontario”).

city

string

City name (e.g., “Los Angeles”, “Toronto”).

productsInCart

array

Products currently in the customer’s cart. Used to surface complementary products and influence relevance scoring.

Show Array Item Properties

title

string

required

Product title.

price

number

Product price.

type

string

Product type or category.

productId

string

Product identifier. Accepts a numeric ID (e.g., "8234567890123") or a Shopify GID (e.g., "gid://shopify/Product/8234567890123").

variantId

string

Product variant identifier.

options

object

Product variant options (e.g., {"Size": "11", "Color": "Red"}).

productsPurchased

array

Products the customer has previously purchased. Informs recommendations and prevents over-promotion of owned items.

Show Array Item Properties

title

string

required

Product title.

price

number

Product price at time of purchase.

type

string

Product type or category.

productId

string

Product identifier. Accepts a numeric ID (e.g., "8234567890123") or a Shopify GID (e.g., "gid://shopify/Product/8234567890123").

variantId

string

Product variant identifier.

options

object

Product variant options (e.g., {"Size": "11", "Color": "Red"}).

priorSearches

array

Recent search queries and their outcomes. Helps understand customer intent and refine relevance models.

Show Array Item Properties

searchQuery

string

required

The search query text.

hadClick

boolean

required

Whether the customer clicked on any results from this search.

hasResults

boolean

required

Whether the search returned any results.

fromPage

string

The page the search was initiated from (e.g., the referring page URL or page type).

marketing

object

UTM parameters and marketing campaign information for attribution tracking.

Show Properties

source

string

Marketing source (e.g., “google”, “facebook”).

medium

string

Marketing medium (e.g., “cpc”, “email”, “social”).

campaign

string

Campaign name.

term

string

Search term or keyword.

customer

object

Aggregated customer behavior and purchase patterns for personalization.

Show Properties

signedIn

boolean

Whether the customer is currently authenticated.

returning

boolean

Whether this is a returning customer.

numberOfOrders

integer

Total number of orders placed.

averageOrderValue

number

Average order value in store currency.

daysBetweenOrders

integer

Average days between orders.

daysSinceLastOrder

integer

Days since the most recent order.

daysSinceOldestOrder

integer

Days since the first order.

totalSpent

number

Total amount spent in store currency.

shoppingChannel

string

default:"web"

The shopping channel the customer is browsing from. Used for channel-specific merchandising, sorting, and analytics segmentation. Automatically detected from request headers when not provided (e.g., mobile app requests via Tapcart or Canvas are detected as "app").Accepted values:

"web" — Standard web browser (default)
"app" — Mobile app (e.g., Tapcart, Canvas)

custom

object

Custom contextual data specific to your implementation. Structure is flexible and can contain any key-value pairs relevant to your use case.

Response

results

Array of Objects

Show Properties

number

The unique identifier of the product.

title

string

The title of the product.

body_html

string

The HTML content describing the product.

vendor

string

The vendor of the product.

product_type

string

The type of the product.

created_at

number

The timestamp when the product was created.

handle

string

The handle of the product.

updated_at

number

The timestamp when the product was updated.

published_at

number

The timestamp when the product was published.

category

Object

The Shopify Product Taxonomy Category of the product.

Show Properties

name

string

The name of the category leaf.

full_name

string

The full name of the category.

string

The ID of the category.

is_leaf

boolean

Is the category a root category.

is_root

boolean

Is the category a root category.

first_or_matched_variant

Object

The first available variant (depending on OOS settings) or the variant matched with a filter or search query.

Show Properties

number

The ID of the variant.

title

string

The title of the variant.

available

boolean

The availability of the variant.

sku

number

The sku of the variant.

price

string

The price of the variant.

compare_at_price

string

The compare at price of the variant.

metafields

Object

The metafields of the variant.

selected_options

Array of Objects

The selected options of the variant.

Show Properties

name

string

The name of the option.

value

string

The value of the option

option_value

object

The linked metafield of the option.

position

number

The position of the variant in the product’s variant list.

inventory_quantity

number

Total inventory quantity across all locations. Only included when the store has the Expose Variant Inventory setting enabled.

inventory_policy

string

Inventory policy for the variant: DENY (stop selling when out of stock) or CONTINUE (allow overselling). Only included when the store has the Expose Variant Inventory setting enabled.

inventory_levels

object

Object mapping location IDs to available inventory quantities (e.g., {"1001": 5, "1002": 10}). Returns empty object {} when no inventory data exists. Only included when the store has the Expose Variant Inventory setting enabled.

featured_media

Object

The featured media of the product.

Show Properties

mediaContentType

string

The type of media.

alt

string

The alt text of the image.

src

string

The src of the image.

width

number

The width of the image.

height

number

The height of the image.

featured_media

Object

The featured media of the product.

Show Properties

mediaContentType

string

The type of media.

alt

string

The alt text of the image.

src

string

The src of the image.

width

number

The width of the image.

height

number

The height of the image.

available

boolean

The availability of the product.

price_range

Object

The price range of the product.

Show Properties

from

number

The starting price of the product.

number

The ending price of the product.

When the store has the Expose Variant Inventory setting enabled, variant data in block responses (both first_or_matched_variant and variants) includes the inventory_quantity, inventory_policy, and inventory_levels fields. This behavior is consistent across all storefront API endpoints — search, browse, and blocks. See Variant Schema Fields for details on these fields.

totalResults

number

The total number of results. When a maximum products safeguard is configured, this value is capped to the maximum. When variant breakouts are enabled, this reflects the count of tiles (both product and variant tiles) rather than just products.

page

number

The current page number.

totalPages

number

The total number of pages. Calculated from totalResults and the requested page size. When a maximum products safeguard is configured, this reflects the capped total. When variant breakouts are enabled, the calculation is based on tile count.

resultsPerPage

number

The number of results per page (matches the limit parameter from the request).

facets

object

If retrieveFacetCount is true then an object with keys and values of the specified attributes. When variant breakouts are enabled, facet counts reflect tile counts rather than product counts. Empty values and literal "null" strings are automatically excluded from facet results.

facetRanges

object

If includeFacetRanges is true then an object with keys of the facet attribute code and value is an object with min/max.

attributionToken

string

A unique request identifier (ULID) for this API call. Use this token to correlate block requests with analytics events via the Beacon API.

block

object

Information about the block that generated these recommendations.

Show Properties

string

The block ID.

title

string

The customer-facing title of the block.

anchor_type

string

The anchor type of the block: product, collection, cart, or none.

strategy_type

string

The strategy type used: interaction, collection_interaction, similar_products, or manual.

strategy_key

string

The specific strategy key. For product interaction strategies: frequently_bought_together, customers_also_viewed, customers_also_added_to_cart, viewed_then_bought, customers_also_bought. For collection interaction strategies: browsed_then_bought, browsed_then_viewed, collection_trending.

_training

boolean

Present and set to true when the block’s interaction strategy data is still being computed. In this state, the primary block returns empty results and the fallback chain is used instead. Once the strategy data is ready, this field is no longer included in the response.

_meta

object

Show Properties

affinities

array of objects

User affinity signals derived from the session’s contextual information. Only present when you pass the context and identity parameters and the engine detects meaningful affinity patterns from cart contents and purchase history. The array contains both promotion entries (positive weights for preferred attribute values) and demotion entries (small negative weights for non-preferred values within the same attribute). Entries are grouped by property and sorted by weight in descending order.

Show Properties

property

string

The product attribute the affinity applies to (e.g., "vendor", "product_type", "named_tags.color", "options.Size").

operator

string

The comparison operator. "eq" for promotion entries that boost a specific value. "not_in" for demotion entries that slightly suppress products that don’t match any detected preference for this attribute.

value

string | array of strings

For promotion entries ("eq"): the specific attribute value that was boosted (e.g., "Nike", "Running Shoes"). For demotion entries ("not_in"): an array of all promoted values for this attribute, so products not matching any of them receive a small negative boost.

weight

number

The boost weight applied. Promotion weights range from 0 to 1.2, where higher values indicate stronger preferences. Demotion weights are small negative values proportional to the strongest promotion in the same attribute group. Option-level attributes (e.g., options.Size) receive lower weights than product-level attributes (e.g., vendor).

variantBreakouts

array of objects

Array of variant breakout configurations applied to this block. Only present when one or more variant breakouts are active. Multiple breakouts with different option codes can work simultaneously. Each object has the structure {optionCode: "Stone"}.

Show Properties

optionCode

string

The product option code that determines which variants are broken out (e.g., “Stone”, “Color”). Each product is broken out by the first matching option code from the array.

_workflow

array of objects

An ordered trace of processing steps the engine performed to produce results. Each entry represents a stage in the pipeline, recorded in the order it was executed.See the Text Search documentation for the full list of possible step types.

Show Properties

type

string

The processing step type (e.g., "affinity-boosts", "rule-applied").

payload

string | array | object

The data associated with this processing step.

Response headers

Every API response includes the following headers for request tracing and performance optimization:

Header	Description
`x-request-id`	A unique identifier (ULID) for the request. This matches the `attributionToken` in the response body.
`x-layers-build`	The Layers build version that served the request.
`X-Layers-Results-Cache`	Indicates whether the response was served from the results cache. Returns `HIT` or `MISS`.
`Link`	Contains `rel="preload"` directives for product images (up to 6 items). See Early hints for details. Only included when early hints are enabled (enabled by default).

Block concepts

For details on how blocks work conceptually (anchor types, strategies, rules, safeguards, and fallback chains), see the platform documentation:

Error handling

error

string

Error message when the request fails.

Common errors:

404 - Block not found

The specified block ID doesn’t exist or is not active.

{
  "error": "Block not found"
}

404 - Unable to get products

The block exists but couldn’t generate recommendations (e.g., missing anchor_id for product anchor).

{
  "error": "Unable to get products for block"
}

401 - Unauthorized

Invalid or missing authentication token.

POST /storefront/v1/blocks/01HQXYZ123ABC456DEF789/products

{
  "anchor_id": "8234567890123",
  "pagination": {
    "page": 1,
    "limit": 12
  },
  "context": {
    "geo": {
      "country": "US",
      "province": "California"
    },
    "productsInCart": [
      {
        "title": "Nike Air Force 1",
        "productId": "8234567890123",
        "variantId": "45678901234567"
      }
    ],
    "shoppingChannel": "web"
  },
  "identity": {
    "sessionId": "abc123",
    "deviceId": "device-uuid"
  }
}

Browse

Product Search

Content Search

Blocks

Analytics

Facets

Utilities

Blocks API: Get Block Products

Authorization

Headers

Path parameters

Body

Response

Response headers

Block concepts

Error handling

See also

Browse

Product Search

Content Search

Blocks

Analytics

Facets

Utilities

Documentation Index

​Authorization

​Headers

​Path parameters

​Body

​Response

​Response headers

​Block concepts

​Error handling

​See also

Authorization

Headers

Path parameters

Body

Response

Response headers

Block concepts

Error handling

See also