Description

Topic: Products

Fields

average_score: Float!

Average review score, from 0 to 9 (inclusive, both ends)

Example: 7.09

average_scores: [ProductReviewAverageScore!]!

ban_countries: [String!]!

List of countries, allowed or denies depending on ban_mode

ban_mode: ProductBanMode!

Ban mode for country-based banning

brand: StorefrontBrand

categories: [StorefrontCategory]

A set of category resource links product belongs to

Expandable

Permission bit: "categories.read"

content_image_files: [StorefrontFile]

created_at: String!

The date and time when the product was created, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

custom_field_objects: StorefrontCustomFieldObjects

Custom field objects extracted and ready for expansion

Translatable

custom_fields: [CustomField!]!

field_set: ProductFieldSet

google_product_category_code: Int!

Google Product Category numeric code

Example: 499938

google_product_category_name: String!

Google Product Category human-friendly name

Example: "Toys & Games > Toys > Educational Toys > Astronomy Toys & Models"

handle: String!

A human-friendly unique string for the product automatically generated from its title

Example: "ipod-nano"

id: String!

A unique product identifier

Example: "pd_EQzGqWoY"

maximum_quantity: Int

Maximum amount of items customer can buy within one order

Example: 100

meta_description: String!

Meta description for SEO purposes

Translatable

Example: ""

meta_title: String!

SEO-friendly title of the product

Translatable

Example: ""

min_currency_prices: [MinCurrencyPrice!]!

Minimum currency prices of all variants

min_price: Int!

Minimum price of all product variants

Example: 0

minimum_quantity: Int

Minimum amount of items customer must order to buy a product

Example: 0

no_count: Int!

Number of customers which don't recommend this product (simple vote)

Example: 20

published_at: String

The date and time when the product was published or null

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

raw_content: String!

Raw content of the product

Translatable

Example: "{}"

recommended_no_count: Int!

Number of customers which don't recommend this product (reviews)

Example: 20

recommended_yes_count: Int!

Number of customers which recommend this product (reviews)

Example: 150

return_mode: ProductReturnMode!

What to do if customer wants to return the product

review_count: Int!

Total amount of reviews for this product

Example: 10

review_dimension_set: ReviewDimensionSet

subscription_only: Boolean!

Whether this product can only be used with a subscription or not

Example: false

subscription_plans: [SubscriptionPlan!]!

survey_answers_summary: [ProductReviewAnswerSummary!]!

tiered_pricing_mode: TieredPricingMode!

How to apply tiered pricing

title: String!

The name of the product

Translatable

Example: "IPod Nano - 8GB"

updated_at: String!

The date and time when the product was last updated, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

variants: [StorefrontProductVariant]

voted: StorefrontCustomerVote!

Whether customer voted or not and how

yes_count: Int!

Number of customers which recommend this product (simple vote)

Example: 150

Used By

Queries

storefrontProducts, storefrontProductsLookup

Types

StorefrontCustomFieldObjects, StorefrontMenuItem, StorefrontProductExpandableItems, StorefrontProductPage, StorefrontProductQuestion, StorefrontProductQuestionAnswer, StorefrontProductReview, StorefrontProductReviewAnswer, StorefrontProductSearchResult, StorefrontProductVariant

Preview (typescript)

Loading module