Description

Topic: Products

Fields

analytics: ProductAnalytics!

Cached product analytics data, far from realtime (updated every N hours)

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 denied depending on ban mode

ban_mode: ProductBanMode!

Ban mode for country-based banning

Example: "allow_all_but"

brand: Brand

Brand of the product

Expandable

Permission bit: "brands.read"

categories: [Category]

A set of category resource links product belongs to

Expandable

Permission bit: "categories.read"

content_image_files: [File]

Image files referenced by "raw_content".

Translatable

Expandable

Permission bit: "files.read"

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: CustomFieldObjects

Custom field objects extracted and ready for expansion

Translatable

custom_fields: [CustomField!]!

field_set: ProductFieldSet

Field set this product will use

Expandable

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"

inventory_summary: InventorySummary

Inventory summary if any of the product variants have inventory entries, null otherwise

max_inventory_count: Int!

Maximum of variant inventory counts

Example: 54

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_customer_group_prices: [MinCustomerGroupPrice!]!

Minimum customer group prices of all variants

min_inventory_count: Int!

Minimum of variant inventory counts

Example: 0

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: Boolean!

Whether server thinks product is published or not (depends on server time)

Example: false

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

Example: "not_allowed"

review_count: Int!

Total amount of reviews for this product

Example: 10

review_dimension_set: ReviewDimensionSet

Review dimension set this product will use

Expandable

Permission bit: "review_dimension_sets.read"

sales_channels: [SalesChannel]

A set of sales channel resource links product should be included into

Expandable

Permission bit: "sales_channels.read"

subscription_only: Boolean!

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

Example: false

subscription_plans: [SubscriptionPlan!]!

sum_inventory_count: Int!

Sum of variant inventory counts (only positive ones)

Example: 640

survey_answers_summary: [ProductReviewAnswerSummary!]!

tags: [String!]!

Product tags (can be used for organization)

tiered_pricing_mode: TieredPricingMode!

How to apply tiered pricing

Example: "all_variants"

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: [ProductVariant]

Variants of the product

Expandable

Permission bit: "product_variants.read"

yes_count: Int!

Number of customers which recommend this product (simple vote)

Example: 150

Used By

Mutations

productsCreate, productsModify

Queries

products

Types

CustomFieldObjects, MenuItem, ProductExpandableItems, ProductPage, ProductQuestion, ProductQuestionAnswer, ProductReview, ProductReviewAnswer, ProductSearchResult, ProductVariant, PromotionCondition, ReturnPolicyCondition, UnifiedSearchResult

Preview (typescript)

Loading module