Products

Queries

productVariantsByIds

A list of ProductVariants by IDs

Arguments

• ids ([ID!]!) — The IDs of the ProductVariants

Returns: [ProductVariant]!

searchProductVariants

Searches ProductVariants

Arguments

• after (String) — A cursor to search after (only include first & after or last & before)
• before (String) — A cursor to search before (only include first & after or last & before)
• filters ([SearchFilterInput!]) — A set of filters to apply
• first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
• last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
• search (String) — A search query to filter results
• sortBy (SortProductVariantsBy) — The sort key
• sortDir (SortDirection) — The sort direction

Returns: ProductVariantConnection! — A connection to a list of items.

Objects

DraftProductContent

Fields

• id (ID!) — The ID of the Content
• in_signature (Boolean!) — Whether the Content is in the signature
• initial (Boolean!) — Whether the Content is the initial Content
• product (DraftProductContentData!)
• template_id (ID) — The ID of Template to attribute the content to

DraftProductContentData

Fields

• height (PositiveInt) — The height of the product
• id (ID!) — The ID of the Content
• in_signature (Boolean!) — Whether the Content is in the signature
• initial (Boolean!) — Whether the Content is the initial Content
• link_url (URL) — A URL to view the product — 🚧 Deprecated: Use view_url instead
• preview_url (URL!) — The thumbnail URL of the product
• product (Product) — The Product of the product
• template_id (ID) — The ID of Template to attribute the content to
• title (String!) — The title of the product
• url (URL) — The source URL of the product — 🚧 Deprecated: Use link_url instead
• view_url (URL) — A URL to view the product
• width (PositiveInt) — The width of the product

DraftProductsContent

Fields

• id (ID!) — The ID of the Content
• in_signature (Boolean!) — Whether the Content is in the signature
• initial (Boolean!) — Whether the Content is the initial Content
• items ([DraftProductContent!]!)
• products ([DraftProductContentData!]!) — 🚧 Deprecated: Use items instead
• template_id (ID) — The ID of Template to attribute the content to

Product

Fields

• description_html (String) — The description of the Product
• external_id (ID!) — The unique identifier of the Product
• id (ID!) — The unique identifier of the Product
• image (ProductMediaImage) — The image of the Product
• integration (Integration!) — The integration of the Product
• media ([ProductMediaImage!]!) — The media of the Product
• sku (String) — The SKU of the Product
• slug (String) — The slug of the Product
• tags ([String!]!) — The tags of the Product
• title (String) — The title of the Product
• type ([String!]!) — The type of the Product
• url (URL) — The slug of the Product
• vendor (String) — The vendor of the Product

ProductMediaImage

Fields

• alt (String) — The alt of the ProductMediaImage
• height (Float) — The height of the ProductMediaImage
• id (ID) — The ID of the ProductMediaImage
• original_source (String!) — The orignal source URL of the ProductMediaImage
• source (String!) — The source URL of the ProductMediaImage
• source_set (String!) — The source URL of the ProductMediaImage
• width (Float) — The width of the ProductMediaImage

ProductVariant

Fields

• barcode (String) — The barcode of the ProductVariant
• created_at (DateTime!) — The date the ProductVariant was created
• current_price (Money) — The current price of the ProductVariant
• deleted_at (DateTime) — The date the ProductVariant was deleted
• description_html (String) — The description of the ProductVariant
• external_id (ID!) — The unique identifier of the ProductVariant
• id (ID!) — The unique identifier of the ProductVariant
• image (ProductMediaImage) — The image of the ProductVariant
• integration (Integration!) — The integration of the ProductVariant
• options ([ProductVariantOption!]!) — The options of the ProductVariant
• product (Product!) — The Product that this ProductVariant belongs to
• sku (String) — The SKU of the ProductVariant
• subtitle (String) — The subtitle of the ProductVariant
• tags ([String!]!) — The tags of the ProductVariant
• title (String) — The title of the ProductVariant — 🚧 Deprecated: Use the subtitle field instead
• type ([String!]!) — The type of the ProductVariant
• updated_at (DateTime!) — The date the ProductVariant was last updated
• vendor (String) — The vendor of the ProductVariant

ProductVariantConnection

A connection to a list of items.

Fields

• edges ([ProductVariantEdge]) — A list of edges.
• pageInfo (PageInfo!) — Information to aid in pagination.
• total (Int)

ProductVariantEdge

An edge in a connection.

Fields

• cursor (String!) — A cursor for use in pagination
• node (ProductVariant) — The item at the end of the edge

ProductVariantOption

Fields

• key (ID!) — The key of the ProductVariantOption
• values ([String!]!) — The values of the ProductVariantOption

StoryItemProduct

Fields

• description_html (String)
• external_id (ID!)
• id (ID!)
• price (Money)
• title (String)
• vendor (String)

Input Objects

ExternalProductImageInput

An ExternalProductImage to be added/updated

Fields

• alt (String) — The alt text of the ExternalProductImage
• id (ID!) — The unique identifier of the ExternalProductImage
• src (URL!) — The source URL of the ExternalProductImage

ExternalProductInput

An ExternalProduct to be added/updated

Fields

• available_for_sale (Boolean!) — Whether the ExternalProduct is available for sale
• created_at (DateTime) — The date the ExternalProduct was created
• deleted_at (DateTime) — The date the ExternalProduct was deleted
• description_html (String) — The description of the ExternalProduct
• id (ID!) — The unique identifier of the ExternalProduct
• image_id (ID) — The unique identifier of the image media that is the main image of the ExternalProduct
• media ([ExternalProductImageInput!]) — The media of the ExternalProduct
• sku (String) — The SKU of the ExternalProduct
• slug (String) — The slug of the ExternalProduct (if set, url will be ignored)
• tags ([String!]) — The tags of the ExternalProduct
• title (String!) — The title of the ExternalProduct
• type ([String!]) — The type of the ExternalProduct
• updated_at (DateTime) — The date the ExternalProduct was last updated
• url (URL) — The url of the ExternalProduct (ignored if slug is set)
• vendor (String) — The vendor of the ExternalProduct

ExternalProductVariantInput

An ExternalProductVariant to be added/updated

Fields

• barcode (String) — The barcode of the ExternalProductVariant
• compare_at_price (MoneyInput) — The original price of the ExternalProductVariant (must be greater than or equal to the current_price)
• created_at (DateTime) — The date the ExternalProductVariant was created
• current_price (MoneyInput!) — The current price of the ExternalProductVariant
• deleted_at (DateTime) — The date the ExternalProductVariant was deleted
• description_html (String) — The description of the ExternalProductVariant
• id (ID!) — The unique identifier of the ExternalProductVariant
• image_id (ID) — The unique identifier of the image in the ExternalProduct associated with the ExternalProductVariant
• options ([ExternalProductVariantOptionInput!]) — The options of the ExternalProductVariant
• product_id (ID!) — The unique identifier of the ExternalProduct associated with the ExternalProductVariant
• quantity (NonNegativeInt) — The quantity of the ExternalProductVariant
• sku (String) — The SKU of the ExternalProductVariant
• tags ([String!]) — The tags of the ExternalProductVariant
• title (String!) — The title of the ExternalProductVariant
• type ([String!]) — The type of the ExternalProductVariant
• updated_at (DateTime) — The date the ExternalProductVariant was last updated
• vendor (String) — The vendor of the ExternalProductVariant

ExternalProductVariantOptionInput

An ExternalProductVariantOption to be added/updated

Fields

• key (ID!) — The key of the ExternalProductVariantOption
• values ([String!]!) — The values of the ExternalProductVariantOption

Enums

SortProductVariantsBy

The available keys to sort ProductVariants

Values

• CREATED_AT
• RELEVANCE
• UPDATED_AT