magento2-graphql-types
Version:
TypeScript definitions for the Magento 2 Graphql API
1,252 lines (1,168 loc) • 272 kB
TypeScript
export type Maybe<T> = T | null
export type Exact<T extends { [key: string]: unknown }> = {
[K in keyof T]: T[K]
}
/** All built-in and custom scalars, mapped to their actual values */
export type Scalars = {
ID: string
String: string
Boolean: boolean
Int: number
Float: number
}
export type AddBundleProductsToCartInput = {
cart_id: Scalars["String"]
cart_items: Array<Maybe<BundleProductCartItemInput>>
}
export type AddBundleProductsToCartOutput = {
__typename?: "AddBundleProductsToCartOutput"
cart: Cart
}
export type AddConfigurableProductsToCartInput = {
cart_id: Scalars["String"]
cart_items: Array<Maybe<ConfigurableProductCartItemInput>>
}
export type AddConfigurableProductsToCartOutput = {
__typename?: "AddConfigurableProductsToCartOutput"
cart: Cart
}
export type AddDownloadableProductsToCartInput = {
cart_id: Scalars["String"]
cart_items: Array<Maybe<DownloadableProductCartItemInput>>
}
export type AddDownloadableProductsToCartOutput = {
__typename?: "AddDownloadableProductsToCartOutput"
cart: Cart
}
export type AddProductsToCartOutput = {
__typename?: "AddProductsToCartOutput"
/** The cart after products have been added */
cart: Cart
/** An error encountered while adding an item to the cart. */
user_errors: Array<Maybe<CartUserInputError>>
}
/** Contains the customer's wish list and any errors encountered */
export type AddProductsToWishlistOutput = {
__typename?: "AddProductsToWishlistOutput"
/** An array of errors encountered while adding products to a wish list */
user_errors: Array<Maybe<WishListUserInputError>>
/** Contains the wish list with all items that were successfully added */
wishlist: Wishlist
}
export type AddSimpleProductsToCartInput = {
cart_id: Scalars["String"]
cart_items: Array<Maybe<SimpleProductCartItemInput>>
}
export type AddSimpleProductsToCartOutput = {
__typename?: "AddSimpleProductsToCartOutput"
cart: Cart
}
export type AddVirtualProductsToCartInput = {
cart_id: Scalars["String"]
cart_items: Array<Maybe<VirtualProductCartItemInput>>
}
export type AddVirtualProductsToCartOutput = {
__typename?: "AddVirtualProductsToCartOutput"
cart: Cart
}
/** A bucket that contains information for each filterable option (such as price, category ID, and custom attributes). */
export type Aggregation = {
__typename?: "Aggregation"
/** Attribute code of the aggregation group. */
attribute_code: Scalars["String"]
/** The number of options in the aggregation group. */
count?: Maybe<Scalars["Int"]>
/** The aggregation display name. */
label?: Maybe<Scalars["String"]>
/** Array of options for the aggregation. */
options?: Maybe<Array<Maybe<AggregationOption>>>
}
export type AggregationOption = AggregationOptionInterface & {
__typename?: "AggregationOption"
/** The number of items that match the aggregation option. */
count?: Maybe<Scalars["Int"]>
/** Aggregation option display label. */
label?: Maybe<Scalars["String"]>
/** The internal ID that represents the value of the option. */
value: Scalars["String"]
}
export type AggregationOptionInterface = {
/** The number of items that match the aggregation option. */
count?: Maybe<Scalars["Int"]>
/** Aggregation option display label. */
label?: Maybe<Scalars["String"]>
/** The internal ID that represents the value of the option. */
value: Scalars["String"]
}
export type AppliedCoupon = {
__typename?: "AppliedCoupon"
code: Scalars["String"]
}
/** Contains the applied gift card with applied and remaining balance */
export type AppliedGiftCard = {
__typename?: "AppliedGiftCard"
/** Applied balance to the current cart */
applied_balance?: Maybe<Money>
/** Gift card account code */
code?: Maybe<Scalars["String"]>
/** Current balance remaining on gift card */
current_balance?: Maybe<Money>
/** Gift card expiration date */
expiration_date?: Maybe<Scalars["String"]>
}
/** Applied and current balance */
export type AppliedStoreCredit = {
__typename?: "AppliedStoreCredit"
/** Applied store credit balance to the current cart */
applied_balance?: Maybe<Money>
/** Current balance remaining on store credit */
current_balance?: Maybe<Money>
/** Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned */
enabled?: Maybe<Scalars["Boolean"]>
}
export type ApplyCouponToCartInput = {
cart_id: Scalars["String"]
coupon_code: Scalars["String"]
}
export type ApplyCouponToCartOutput = {
__typename?: "ApplyCouponToCartOutput"
cart: Cart
}
/** Defines the input required to run the applyGiftCardToCart mutation */
export type ApplyGiftCardToCartInput = {
/** The unique ID that identifies the customer's cart */
cart_id: Scalars["String"]
/** The gift card code to be applied to the cart */
gift_card_code: Scalars["String"]
}
/** Defines the possible output for the applyGiftCardToCart mutation */
export type ApplyGiftCardToCartOutput = {
__typename?: "ApplyGiftCardToCartOutput"
/** Describes the contents of the specified shopping cart */
cart: Cart
}
export type ApplyRewardPointsToCartOutput = {
__typename?: "ApplyRewardPointsToCartOutput"
/** The customer cart after reward points are applied */
cart: Cart
}
/** Defines the input required to run the applyStoreCreditToCart mutation */
export type ApplyStoreCreditToCartInput = {
/** The unique ID that identifies the customer's cart */
cart_id: Scalars["String"]
}
/** Defines the possible output for the applyStoreCreditToCart mutation */
export type ApplyStoreCreditToCartOutput = {
__typename?: "ApplyStoreCreditToCartOutput"
/** Describes the contents of the specified shopping cart */
cart: Cart
}
/** AreaInput defines the parameters which will be used for filter by specified location. */
export type AreaInput = {
/** The radius for the search in KM. */
radius: Scalars["Int"]
/** The country code where search must be performed. Required parameter together with region, city or postcode. */
search_term: Scalars["String"]
}
export type Assets = {
__typename?: "Assets"
/** The payment method logo url (descriptive) */
descriptive?: Maybe<Scalars["String"]>
/** The payment method logo url (standard) */
standard?: Maybe<Scalars["String"]>
}
/** Attribute contains the attribute_type of the specified attribute_code and entity_type */
export type Attribute = {
__typename?: "Attribute"
/** The unique identifier for an attribute code. This value should be in lowercase letters without spaces. */
attribute_code?: Maybe<Scalars["String"]>
/** Attribute options list. */
attribute_options?: Maybe<Array<Maybe<AttributeOption>>>
/** The data type of the attribute */
attribute_type?: Maybe<Scalars["String"]>
/** The type of entity that defines the attribute */
entity_type?: Maybe<Scalars["String"]>
/** The frontend input type of the attribute */
input_type?: Maybe<Scalars["String"]>
}
/** AttributeInput specifies the attribute_code and entity_type to search */
export type AttributeInput = {
/** The unique identifier for an attribute code. This value should be in lowercase letters without spaces. */
attribute_code?: Maybe<Scalars["String"]>
/** The type of entity that defines the attribute */
entity_type?: Maybe<Scalars["String"]>
}
/** Attribute option. */
export type AttributeOption = {
__typename?: "AttributeOption"
/** Attribute option label. */
label?: Maybe<Scalars["String"]>
/** Attribute option value. */
value?: Maybe<Scalars["String"]>
}
export type AvailablePaymentMethod = {
__typename?: "AvailablePaymentMethod"
/** The payment method code */
code: Scalars["String"]
/** The payment method title. */
title: Scalars["String"]
}
export type AvailableShippingMethod = {
__typename?: "AvailableShippingMethod"
amount: Money
available: Scalars["Boolean"]
/** @deprecated The field should not be used on the storefront */
base_amount?: Maybe<Money>
carrier_code: Scalars["String"]
carrier_title: Scalars["String"]
error_message?: Maybe<Scalars["String"]>
/** Could be null if method is not available */
method_code?: Maybe<Scalars["String"]>
/** Could be null if method is not available */
method_title?: Maybe<Scalars["String"]>
price_excl_tax: Money
price_incl_tax: Money
}
export type BillingAddressInput = {
address?: Maybe<CartAddressInput>
customer_address_id?: Maybe<Scalars["Int"]>
/** Set billing address same as shipping */
same_as_shipping?: Maybe<Scalars["Boolean"]>
/** Deprecated: use `same_as_shipping` field instead */
use_for_shipping?: Maybe<Scalars["Boolean"]>
}
export type BillingCartAddress = CartAddressInterface & {
__typename?: "BillingCartAddress"
city: Scalars["String"]
company?: Maybe<Scalars["String"]>
country: CartAddressCountry
/** @deprecated The field is used only in shipping address */
customer_notes?: Maybe<Scalars["String"]>
firstname: Scalars["String"]
lastname: Scalars["String"]
postcode?: Maybe<Scalars["String"]>
region?: Maybe<CartAddressRegion>
street: Array<Maybe<Scalars["String"]>>
telephone: Scalars["String"]
}
export type BraintreeCcVaultInput = {
device_data?: Maybe<Scalars["String"]>
public_hash: Scalars["String"]
}
export type BraintreeInput = {
/**
* Contains a fingerprint provided by Braintree JS SDK and should be sent with
* sale transaction details to the Braintree payment gateway. Should be specified
* only in a case if Kount (advanced fraud protection) is enabled for Braintree
* payment integration.
*/
device_data?: Maybe<Scalars["String"]>
/**
* States whether an entered by a customer credit/debit card should be tokenized
* for later usage. Required only if Vault is enabled for Braintree payment integration.
*/
is_active_payment_token_enabler: Scalars["Boolean"]
/**
* The one-time payment token generated by Braintree payment gateway based on
* card details. Required field to make sale transaction.
*/
payment_method_nonce: Scalars["String"]
}
/** Breadcrumb item. */
export type Breadcrumb = {
__typename?: "Breadcrumb"
/** Category ID. */
category_id?: Maybe<Scalars["Int"]>
/** Category level. */
category_level?: Maybe<Scalars["Int"]>
/** Category name. */
category_name?: Maybe<Scalars["String"]>
/** Category URL key. */
category_url_key?: Maybe<Scalars["String"]>
/** Category URL path. */
category_url_path?: Maybe<Scalars["String"]>
}
export type BundleCartItem = CartItemInterface & {
__typename?: "BundleCartItem"
/** The list of available gift wrapping options for the cart item */
available_gift_wrapping: Array<Maybe<GiftWrapping>>
bundle_options: Array<Maybe<SelectedBundleOption>>
customizable_options: Array<Maybe<SelectedCustomizableOption>>
/** The entered gift message for the cart item */
gift_message?: Maybe<GiftMessage>
/** The selected gift wrapping for the cart item */
gift_wrapping?: Maybe<GiftWrapping>
id: Scalars["String"]
prices?: Maybe<CartItemPrices>
product: ProductInterface
quantity: Scalars["Float"]
}
export type BundleCreditMemoItem = CreditMemoItemInterface & {
__typename?: "BundleCreditMemoItem"
/** A list of bundle options that are assigned to the bundle product */
bundle_options?: Maybe<Array<Maybe<ItemSelectedBundleOption>>>
/** Contains information about the final discount amount for the base product, including discounts on options */
discounts?: Maybe<Array<Maybe<Discount>>>
/** The unique ID of the credit memo item, used for API purposes */
id: Scalars["ID"]
/** The order item the credit memo is applied to */
order_item?: Maybe<OrderItemInterface>
/** The name of the base product */
product_name?: Maybe<Scalars["String"]>
/** The sale price for the base product, including selected options */
product_sale_price: Money
/** SKU of the base product */
product_sku: Scalars["String"]
/** The number of refunded items */
quantity_refunded?: Maybe<Scalars["Float"]>
}
export type BundleInvoiceItem = InvoiceItemInterface & {
__typename?: "BundleInvoiceItem"
/** A list of bundle options that are assigned to the bundle product */
bundle_options?: Maybe<Array<Maybe<ItemSelectedBundleOption>>>
/** Contains information about the final discount amount for the base product, including discounts on options */
discounts?: Maybe<Array<Maybe<Discount>>>
/** The unique ID of the invoice item */
id: Scalars["ID"]
/** Contains details about an individual order item */
order_item?: Maybe<OrderItemInterface>
/** The name of the base product */
product_name?: Maybe<Scalars["String"]>
/** The sale price for the base product including selected options */
product_sale_price: Money
/** The SKU of the base product */
product_sku: Scalars["String"]
/** The number of invoiced items */
quantity_invoiced?: Maybe<Scalars["Float"]>
}
/** BundleItem defines an individual item in a bundle product. */
export type BundleItem = {
__typename?: "BundleItem"
/** An ID assigned to each type of item in a bundle product. */
option_id?: Maybe<Scalars["Int"]>
/** An array of additional options for this bundle item. */
options?: Maybe<Array<Maybe<BundleItemOption>>>
/** he relative position of this item compared to the other bundle items. */
position?: Maybe<Scalars["Int"]>
/** Indicates whether the item must be included in the bundle. */
required?: Maybe<Scalars["Boolean"]>
/** The SKU of the bundle product. */
sku?: Maybe<Scalars["String"]>
/** The display name of the item. */
title?: Maybe<Scalars["String"]>
/** The input type that the customer uses to select the item. Examples include radio button and checkbox. */
type?: Maybe<Scalars["String"]>
}
/** BundleItemOption defines characteristics and options for a specific bundle item. */
export type BundleItemOption = {
__typename?: "BundleItemOption"
/** Indicates whether the customer can change the number of items for this option. */
can_change_quantity?: Maybe<Scalars["Boolean"]>
/** The ID assigned to the bundled item option. */
id?: Maybe<Scalars["Int"]>
/** Indicates whether this option is the default option. */
is_default?: Maybe<Scalars["Boolean"]>
/** The text that identifies the bundled item option. */
label?: Maybe<Scalars["String"]>
/** When a bundle item contains multiple options, the relative position of this option compared to the other options. */
position?: Maybe<Scalars["Int"]>
/** The price of the selected option. */
price?: Maybe<Scalars["Float"]>
/** One of FIXED, PERCENT, or DYNAMIC. */
price_type?: Maybe<PriceTypeEnum>
/** Contains details about this product option. */
product?: Maybe<ProductInterface>
/**
* Indicates the quantity of this specific bundle item.
* @deprecated The `qty` is deprecated. Use `quantity` instead.
*/
qty?: Maybe<Scalars["Float"]>
/** Indicates the quantity of this specific bundle item. */
quantity?: Maybe<Scalars["Float"]>
/** A string that encodes option details. */
uid: Scalars["ID"]
}
export type BundleOptionInput = {
id: Scalars["Int"]
quantity: Scalars["Float"]
value: Array<Maybe<Scalars["String"]>>
}
export type BundleOrderItem = OrderItemInterface & {
__typename?: "BundleOrderItem"
/** A list of bundle options that are assigned to the bundle product */
bundle_options?: Maybe<Array<Maybe<ItemSelectedBundleOption>>>
/** The final discount information for the product */
discounts?: Maybe<Array<Maybe<Discount>>>
/** The entered option for the base product, such as a logo or image */
entered_options?: Maybe<Array<Maybe<OrderItemOption>>>
/** The selected gift wrapping for the order item */
gift_wrapping?: Maybe<GiftWrapping>
/** The unique identifier of the order item */
id: Scalars["ID"]
/** The name of the base product */
product_name?: Maybe<Scalars["String"]>
/** The sale price of the base product, including selected options */
product_sale_price: Money
/** The SKU of the base product */
product_sku: Scalars["String"]
/** The type of product, such as simple, configurable, etc. */
product_type?: Maybe<Scalars["String"]>
/** URL key of the base product */
product_url_key?: Maybe<Scalars["String"]>
/** The number of canceled items */
quantity_canceled?: Maybe<Scalars["Float"]>
/** The number of invoiced items */
quantity_invoiced?: Maybe<Scalars["Float"]>
/** The number of units ordered for this item */
quantity_ordered?: Maybe<Scalars["Float"]>
/** The number of refunded items */
quantity_refunded?: Maybe<Scalars["Float"]>
/** The number of returned items */
quantity_returned?: Maybe<Scalars["Float"]>
/** The number of shipped items */
quantity_shipped?: Maybe<Scalars["Float"]>
/** The selected options for the base product, such as color or size */
selected_options?: Maybe<Array<Maybe<OrderItemOption>>>
/** The status of the order item */
status?: Maybe<Scalars["String"]>
}
/** BundleProduct defines basic features of a bundle product and contains multiple BundleItems. */
export type BundleProduct = ProductInterface &
PhysicalProductInterface &
CustomizableProductInterface & {
__typename?: "BundleProduct"
/** The attribute set assigned to the product. */
attribute_set_id?: Maybe<Scalars["Int"]>
/**
* Relative canonical URL. This value is returned only if the system setting 'Use
* Canonical Link Meta Tag For Products' is enabled
*/
canonical_url?: Maybe<Scalars["String"]>
/** The categories assigned to a product. */
categories?: Maybe<Array<Maybe<CategoryInterface>>>
color?: Maybe<Scalars["Int"]>
/** The product's country of origin. */
country_of_manufacture?: Maybe<Scalars["String"]>
/** Timestamp indicating when the product was created. */
created_at?: Maybe<Scalars["String"]>
/** Crosssell Products */
crosssell_products?: Maybe<Array<Maybe<ProductInterface>>>
/** Detailed information about the product. The value can include simple HTML tags. */
description?: Maybe<ComplexTextValue>
/** Indicates whether the bundle product has a dynamic price. */
dynamic_price?: Maybe<Scalars["Boolean"]>
/** Indicates whether the bundle product has a dynamic SK. */
dynamic_sku?: Maybe<Scalars["Boolean"]>
/** Indicates whether the bundle product has a dynamically calculated weight. */
dynamic_weight?: Maybe<Scalars["Boolean"]>
fashion_color?: Maybe<Scalars["Int"]>
fashion_material?: Maybe<Scalars["String"]>
fashion_size?: Maybe<Scalars["Int"]>
fashion_style?: Maybe<Scalars["String"]>
format?: Maybe<Scalars["Int"]>
/** Indicates whether a gift message is available. */
gift_message_available?: Maybe<Scalars["String"]>
has_video?: Maybe<Scalars["Int"]>
/** The ID number assigned to the product. */
id?: Maybe<Scalars["Int"]>
/** The relative path to the main image on the product page. */
image?: Maybe<ProductImage>
/** Indicates whether the product can be returned */
is_returnable?: Maybe<Scalars["String"]>
/** An array containing information about individual bundle items. */
items?: Maybe<Array<Maybe<BundleItem>>>
/** A number representing the product's manufacturer. */
manufacturer?: Maybe<Scalars["Int"]>
/** An array of Media Gallery objects. */
media_gallery?: Maybe<Array<Maybe<MediaGalleryInterface>>>
/**
* An array of MediaGalleryEntry objects.
* @deprecated Use product's `media_gallery` instead
*/
media_gallery_entries?: Maybe<Array<Maybe<MediaGalleryEntry>>>
/** A brief overview of the product for search results listings, maximum 255 characters. */
meta_description?: Maybe<Scalars["String"]>
/** A comma-separated list of keywords that are visible only to search engines. */
meta_keyword?: Maybe<Scalars["String"]>
/** A string that is displayed in the title bar and tab of the browser and in search results lists. */
meta_title?: Maybe<Scalars["String"]>
/** The product name. Customers use this name to identify the product. */
name?: Maybe<Scalars["String"]>
/** The beginning date for new product listings, and determines if the product is featured as a new product. */
new_from_date?: Maybe<Scalars["String"]>
/** The end date for new product listings. */
new_to_date?: Maybe<Scalars["String"]>
/** Product stock only x left count */
only_x_left_in_stock?: Maybe<Scalars["Float"]>
/** An array of options for a customizable product. */
options?: Maybe<Array<Maybe<CustomizableOptionInterface>>>
/** If the product has multiple options, determines where they appear on the product page. */
options_container?: Maybe<Scalars["String"]>
/**
* A ProductPrices object, indicating the price of an item.
* @deprecated Use price_range for product price information.
*/
price?: Maybe<ProductPrices>
/** A PriceRange object, indicating the range of prices for the product */
price_range: PriceRange
/** An array of TierPrice objects. */
price_tiers?: Maybe<Array<Maybe<TierPrice>>>
/** One of PRICE_RANGE or AS_LOW_AS. */
price_view?: Maybe<PriceViewEnum>
/** An array of ProductLinks objects. */
product_links?: Maybe<Array<Maybe<ProductLinksInterface>>>
/** The average of all the ratings given to the product. */
rating_summary: Scalars["Float"]
/** Related Products */
related_products?: Maybe<Array<Maybe<ProductInterface>>>
/** The total count of all the reviews given to the product. */
review_count: Scalars["Int"]
/** The list of products reviews. */
reviews: ProductReviews
/** Indicates whether to ship bundle items together or individually. */
ship_bundle_items?: Maybe<ShipBundleItemsEnum>
/** A short description of the product. Its use depends on the theme. */
short_description?: Maybe<ComplexTextValue>
/** A number or code assigned to a product to identify the product, options, price, and manufacturer. */
sku?: Maybe<Scalars["String"]>
/** The relative path to the small image, which is used on catalog pages. */
small_image?: Maybe<ProductImage>
/** The beginning date that a product has a special price. */
special_from_date?: Maybe<Scalars["String"]>
/** The discounted price of the product. */
special_price?: Maybe<Scalars["Float"]>
/** The end date that a product has a special price. */
special_to_date?: Maybe<Scalars["String"]>
/** Stock status of the product */
stock_status?: Maybe<ProductStockStatus>
/** The file name of a swatch image */
swatch_image?: Maybe<Scalars["String"]>
/** The relative path to the product's thumbnail image. */
thumbnail?: Maybe<ProductImage>
/**
* The price when tier pricing is in effect and the items purchased threshold has been reached.
* @deprecated Use price_tiers for product tier price information.
*/
tier_price?: Maybe<Scalars["Float"]>
/**
* An array of ProductTierPrices objects.
* @deprecated Use price_tiers for product tier price information.
*/
tier_prices?: Maybe<Array<Maybe<ProductTierPrices>>>
/**
* One of simple, virtual, bundle, downloadable, grouped, or configurable.
* @deprecated Use __typename instead.
*/
type_id?: Maybe<Scalars["String"]>
/** Timestamp indicating when the product was updated. */
updated_at?: Maybe<Scalars["String"]>
/** Upsell Products */
upsell_products?: Maybe<Array<Maybe<ProductInterface>>>
/** The part of the URL that identifies the product */
url_key?: Maybe<Scalars["String"]>
/** @deprecated Use product's `canonical_url` or url rewrites instead */
url_path?: Maybe<Scalars["String"]>
/** URL rewrites list */
url_rewrites?: Maybe<Array<Maybe<UrlRewrite>>>
/** The part of the product URL that is appended after the url key */
url_suffix?: Maybe<Scalars["String"]>
video_file?: Maybe<Scalars["String"]>
/**
* An array of websites in which the product is available.
* @deprecated The field should not be used on the storefront.
*/
websites?: Maybe<Array<Maybe<Website>>>
/** The weight of the item, in units defined by the store. */
weight?: Maybe<Scalars["Float"]>
}
/** BundleProduct defines basic features of a bundle product and contains multiple BundleItems. */
export type BundleProductReviewsArgs = {
pageSize?: Maybe<Scalars["Int"]>
currentPage?: Maybe<Scalars["Int"]>
}
export type BundleProductCartItemInput = {
bundle_options: Array<Maybe<BundleOptionInput>>
customizable_options?: Maybe<Array<Maybe<CustomizableOptionInput>>>
data: CartItemInput
}
export type BundleShipmentItem = ShipmentItemInterface & {
__typename?: "BundleShipmentItem"
/** A list of bundle options that are assigned to the bundle product */
bundle_options?: Maybe<Array<Maybe<ItemSelectedBundleOption>>>
/** Shipment item unique identifier */
id: Scalars["ID"]
/** Associated order item */
order_item?: Maybe<OrderItemInterface>
/** Name of the base product */
product_name?: Maybe<Scalars["String"]>
/** Sale price for the base product */
product_sale_price: Money
/** SKU of the base product */
product_sku: Scalars["String"]
/** Number of shipped items */
quantity_shipped: Scalars["Float"]
}
export type Cart = {
__typename?: "Cart"
/**
* An array of coupons that have been applied to the cart
* @deprecated Use applied_coupons instead
*/
applied_coupon?: Maybe<AppliedCoupon>
/** An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code */
applied_coupons?: Maybe<Array<Maybe<AppliedCoupon>>>
/** Contains the code attribute, which specifies the applied gift card codes */
applied_gift_cards?: Maybe<Array<Maybe<AppliedGiftCard>>>
/** The amount of reward points applied to the cart */
applied_reward_points?: Maybe<RewardPointsAmount>
/** Contains store credit information applied on the cart */
applied_store_credit?: Maybe<AppliedStoreCredit>
/** The list of available gift wrapping options for the cart */
available_gift_wrappings: Array<Maybe<GiftWrapping>>
/** Available payment methods */
available_payment_methods?: Maybe<Array<Maybe<AvailablePaymentMethod>>>
billing_address?: Maybe<BillingCartAddress>
email?: Maybe<Scalars["String"]>
/** The entered gift message for the cart */
gift_message?: Maybe<GiftMessage>
/** Wether customer requested gift receipt for the cart */
gift_receipt_included: Scalars["Boolean"]
/** The selected gift wrapping for the cart */
gift_wrapping?: Maybe<GiftWrapping>
/** The ID of the cart. */
id: Scalars["ID"]
is_virtual: Scalars["Boolean"]
items?: Maybe<Array<Maybe<CartItemInterface>>>
prices?: Maybe<CartPrices>
/** Wether customer requested printed card for the cart */
printed_card_included: Scalars["Boolean"]
selected_payment_method?: Maybe<SelectedPaymentMethod>
shipping_addresses: Array<Maybe<ShippingCartAddress>>
total_quantity: Scalars["Float"]
}
export type CartAddressCountry = {
__typename?: "CartAddressCountry"
code: Scalars["String"]
label: Scalars["String"]
}
export type CartAddressInput = {
city: Scalars["String"]
company?: Maybe<Scalars["String"]>
country_code: Scalars["String"]
firstname: Scalars["String"]
lastname: Scalars["String"]
postcode?: Maybe<Scalars["String"]>
region?: Maybe<Scalars["String"]>
region_id?: Maybe<Scalars["Int"]>
/** Determines whether to save the address in the customer's address book. The default value is true */
save_in_address_book?: Maybe<Scalars["Boolean"]>
street: Array<Maybe<Scalars["String"]>>
telephone: Scalars["String"]
}
export type CartAddressInterface = {
city: Scalars["String"]
company?: Maybe<Scalars["String"]>
country: CartAddressCountry
firstname: Scalars["String"]
lastname: Scalars["String"]
postcode?: Maybe<Scalars["String"]>
region?: Maybe<CartAddressRegion>
street: Array<Maybe<Scalars["String"]>>
telephone: Scalars["String"]
}
export type CartAddressRegion = {
__typename?: "CartAddressRegion"
code?: Maybe<Scalars["String"]>
label?: Maybe<Scalars["String"]>
region_id?: Maybe<Scalars["Int"]>
}
export type CartDiscount = {
__typename?: "CartDiscount"
amount: Money
label: Array<Maybe<Scalars["String"]>>
}
export type CartItemInput = {
/** An array of entered options for the base product, such as personalization text */
entered_options?: Maybe<Array<Maybe<EnteredOptionInput>>>
/** For child products, the SKU of its parent product */
parent_sku?: Maybe<Scalars["String"]>
quantity: Scalars["Float"]
/** The selected options for the base product, such as color or size */
selected_options?: Maybe<Array<Maybe<Scalars["ID"]>>>
sku: Scalars["String"]
}
export type CartItemInterface = {
id: Scalars["String"]
prices?: Maybe<CartItemPrices>
product: ProductInterface
quantity: Scalars["Float"]
}
export type CartItemPrices = {
__typename?: "CartItemPrices"
/** An array of discounts to be applied to the cart item */
discounts?: Maybe<Array<Maybe<Discount>>>
price: Money
row_total: Money
row_total_including_tax: Money
/** The total of all discounts applied to the item */
total_item_discount?: Maybe<Money>
}
/** Deprecated: `cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity` */
export type CartItemQuantity = {
__typename?: "CartItemQuantity"
/** @deprecated `cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity` */
cart_item_id: Scalars["Int"]
/** @deprecated `cart_items` field of `ShippingCartAddress` returns now `CartItemInterface` instead of `CartItemQuantity` */
quantity: Scalars["Float"]
}
export type CartItemSelectedOptionValuePrice = {
__typename?: "CartItemSelectedOptionValuePrice"
type: PriceTypeEnum
units: Scalars["String"]
value: Scalars["Float"]
}
export type CartItemUpdateInput = {
cart_item_id: Scalars["Int"]
customizable_options?: Maybe<Array<Maybe<CustomizableOptionInput>>>
/** Gift message details for the cart item */
gift_message?: Maybe<GiftMessageInput>
/** The unique identifier of the gift wrapping to be used for the cart item */
gift_wrapping_id?: Maybe<Scalars["ID"]>
quantity?: Maybe<Scalars["Float"]>
}
export type CartPrices = {
__typename?: "CartPrices"
applied_taxes?: Maybe<Array<Maybe<CartTaxItem>>>
/** @deprecated Use discounts instead */
discount?: Maybe<CartDiscount>
/** An array of applied discounts */
discounts?: Maybe<Array<Maybe<Discount>>>
/** The list of prices for the selected gift options */
gift_options?: Maybe<GiftOptionsPrices>
grand_total?: Maybe<Money>
subtotal_excluding_tax?: Maybe<Money>
subtotal_including_tax?: Maybe<Money>
subtotal_with_discount_excluding_tax?: Maybe<Money>
}
export type CartTaxItem = {
__typename?: "CartTaxItem"
amount: Money
label: Scalars["String"]
}
/** An error encountered while adding an item to the the cart. */
export type CartUserInputError = {
__typename?: "CartUserInputError"
/** Cart-specific error code */
code: CartUserInputErrorType
/** A localized error message */
message: Scalars["String"]
}
export enum CartUserInputErrorType {
ProductNotFound = "PRODUCT_NOT_FOUND",
NotSalable = "NOT_SALABLE",
InsufficientStock = "INSUFFICIENT_STOCK",
Undefined = "UNDEFINED"
}
export type Categories = {
__typename?: "Categories"
/** The payment method assets */
asset_urls?: Maybe<Array<Maybe<Assets>>>
/** The payment method identifier */
identifier: Scalars["String"]
/** The payment method name */
name: Scalars["String"]
}
/**
* CategoryFilterInput defines the filters to be used in the search. A filter
* contains at least one attribute, a comparison operator, and the value that is
* being searched for.
*/
export type CategoryFilterInput = {
/** Filter by category ID that uniquely identifies the category. */
ids?: Maybe<FilterEqualTypeInput>
/** Filter by the display name of the category. */
name?: Maybe<FilterMatchTypeInput>
/** Filter by the part of the URL that identifies the category. */
url_key?: Maybe<FilterEqualTypeInput>
/** Filter by the URL path for the category. */
url_path?: Maybe<FilterEqualTypeInput>
}
/** CategoryInterface contains the full set of attributes that can be returned in a category search. */
export type CategoryInterface = {
automatic_sorting?: Maybe<Scalars["String"]>
available_sort_by?: Maybe<Array<Maybe<Scalars["String"]>>>
/** Breadcrumbs, parent categories info. */
breadcrumbs?: Maybe<Array<Maybe<Breadcrumb>>>
/**
* Relative canonical URL. This value is returned only if the system setting 'Use
* Canonical Link Meta Tag For Categories' is enabled
*/
canonical_url?: Maybe<Scalars["String"]>
children_count?: Maybe<Scalars["String"]>
/** Category CMS Block. */
cms_block?: Maybe<CmsBlock>
/** Timestamp indicating when the category was created. */
created_at?: Maybe<Scalars["String"]>
custom_layout_update_file?: Maybe<Scalars["String"]>
/** The attribute to use for sorting. */
default_sort_by?: Maybe<Scalars["String"]>
/** An optional description of the category. */
description?: Maybe<Scalars["String"]>
display_mode?: Maybe<Scalars["String"]>
filter_price_range?: Maybe<Scalars["Float"]>
/** An ID that uniquely identifies the category. */
id?: Maybe<Scalars["Int"]>
image?: Maybe<Scalars["String"]>
include_in_menu?: Maybe<Scalars["Int"]>
is_anchor?: Maybe<Scalars["Int"]>
landing_page?: Maybe<Scalars["Int"]>
/** Indicates the depth of the category within the tree. */
level?: Maybe<Scalars["Int"]>
meta_description?: Maybe<Scalars["String"]>
meta_keywords?: Maybe<Scalars["String"]>
meta_title?: Maybe<Scalars["String"]>
/** The display name of the category. */
name?: Maybe<Scalars["String"]>
/** Category Path. */
path?: Maybe<Scalars["String"]>
/** Category path in store. */
path_in_store?: Maybe<Scalars["String"]>
/** The position of the category relative to other categories at the same level in tree. */
position?: Maybe<Scalars["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.
*/
product_count?: Maybe<Scalars["Int"]>
/** The list of products assigned to the category. */
products?: Maybe<CategoryProducts>
/** Timestamp indicating when the category was updated. */
updated_at?: Maybe<Scalars["String"]>
/** The url key assigned to the category. */
url_key?: Maybe<Scalars["String"]>
/** The url path assigned to the category. */
url_path?: Maybe<Scalars["String"]>
/** The part of the category URL that is appended after the url key */
url_suffix?: Maybe<Scalars["String"]>
}
/** CategoryInterface contains the full set of attributes that can be returned in a category search. */
export type CategoryInterfaceProductsArgs = {
pageSize?: Maybe<Scalars["Int"]>
currentPage?: Maybe<Scalars["Int"]>
sort?: Maybe<ProductAttributeSortInput>
}
/** The category products object returned in the Category query. */
export type CategoryProducts = {
__typename?: "CategoryProducts"
/** An array of products that are assigned to the category. */
items?: Maybe<Array<Maybe<ProductInterface>>>
/** An object that includes the page_info and currentPage values specified in the query. */
page_info?: Maybe<SearchResultPageInfo>
/**
* 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.
*/
total_count?: Maybe<Scalars["Int"]>
}
/** A collection of CategoryTree objects and pagination information. */
export type CategoryResult = {
__typename?: "CategoryResult"
/** A list of categories that match the filter criteria. */
items?: Maybe<Array<Maybe<CategoryTree>>>
/** An object that includes the page_info and currentPage values specified in the query. */
page_info?: Maybe<SearchResultPageInfo>
/** The total number of categories that match the criteria. */
total_count?: Maybe<Scalars["Int"]>
}
/** Category Tree implementation. */
export type CategoryTree = CategoryInterface & {
__typename?: "CategoryTree"
automatic_sorting?: Maybe<Scalars["String"]>
available_sort_by?: Maybe<Array<Maybe<Scalars["String"]>>>
/** Breadcrumbs, parent categories info. */
breadcrumbs?: Maybe<Array<Maybe<Breadcrumb>>>
/**
* Relative canonical URL. This value is returned only if the system setting 'Use
* Canonical Link Meta Tag For Categories' is enabled
*/
canonical_url?: Maybe<Scalars["String"]>
/** Child categories tree. */
children?: Maybe<Array<Maybe<CategoryTree>>>
children_count?: Maybe<Scalars["String"]>
/** Category CMS Block. */
cms_block?: Maybe<CmsBlock>
/** Timestamp indicating when the category was created. */
created_at?: Maybe<Scalars["String"]>
custom_layout_update_file?: Maybe<Scalars["String"]>
/** The attribute to use for sorting. */
default_sort_by?: Maybe<Scalars["String"]>
/** An optional description of the category. */
description?: Maybe<Scalars["String"]>
display_mode?: Maybe<Scalars["String"]>
filter_price_range?: Maybe<Scalars["Float"]>
/** An ID that uniquely identifies the category. */
id?: Maybe<Scalars["Int"]>
image?: Maybe<Scalars["String"]>
include_in_menu?: Maybe<Scalars["Int"]>
is_anchor?: Maybe<Scalars["Int"]>
landing_page?: Maybe<Scalars["Int"]>
/** Indicates the depth of the category within the tree. */
level?: Maybe<Scalars["Int"]>
meta_description?: Maybe<Scalars["String"]>
meta_keywords?: Maybe<Scalars["String"]>
meta_title?: Maybe<Scalars["String"]>
/** The display name of the category. */
name?: Maybe<Scalars["String"]>
/** Category Path. */
path?: Maybe<Scalars["String"]>
/** Category path in store. */
path_in_store?: Maybe<Scalars["String"]>
/** The position of the category relative to other categories at the same level in tree. */
position?: Maybe<Scalars["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.
*/
product_count?: Maybe<Scalars["Int"]>
/** The list of products assigned to the category. */
products?: Maybe<CategoryProducts>
/** Timestamp indicating when the category was updated. */
updated_at?: Maybe<Scalars["String"]>
/** The url key assigned to the category. */
url_key?: Maybe<Scalars["String"]>
/** The url path assigned to the category. */
url_path?: Maybe<Scalars["String"]>
/** The part of the category URL that is appended after the url key */
url_suffix?: Maybe<Scalars["String"]>
}
/** Category Tree implementation. */
export type CategoryTreeProductsArgs = {
pageSize?: Maybe<Scalars["Int"]>
currentPage?: Maybe<Scalars["Int"]>
sort?: Maybe<ProductAttributeSortInput>
}
/** Defines all Checkout Agreement information */
export type CheckoutAgreement = {
__typename?: "CheckoutAgreement"
/** Checkout Agreement identifier */
agreement_id: Scalars["Int"]
/** Checkout Agreement checkbox text */
checkbox_text: Scalars["String"]
/** Checkout Agreement content */
content: Scalars["String"]
/** Checkout Agreement content height */
content_height?: Maybe<Scalars["String"]>
/** Is Checkout Agreement content in HTML format */
is_html: Scalars["Boolean"]
mode: CheckoutAgreementMode
/** Checkout Agreement name */
name: Scalars["String"]
}
export enum CheckoutAgreementMode {
Auto = "AUTO",
Manual = "MANUAL"
}
/** An error encountered while adding an item the the cart. */
export type CheckoutUserInputError = {
__typename?: "CheckoutUserInputError"
/** Checkout-specific error code */
code: CheckoutUserInputErrorCodes
/** Localized error message */
message: Scalars["String"]
/**
* Path to the input field that caused an error. See the GraphQL specification
* about path errors for details: http://spec.graphql.org/draft/#sec-Errors
*/
path: Array<Maybe<Scalars["String"]>>
}
export enum CheckoutUserInputErrorCodes {
ReorderNotAvailable = "REORDER_NOT_AVAILABLE",
ProductNotFound = "PRODUCT_NOT_FOUND",
NotSalable = "NOT_SALABLE",
InsufficientStock = "INSUFFICIENT_STOCK",
Undefined = "UNDEFINED"
}
/** CMS block defines all CMS block information */
export type CmsBlock = {
__typename?: "CmsBlock"
/** CMS block content */
content?: Maybe<Scalars["String"]>
/** CMS block identifier */
identifier?: Maybe<Scalars["String"]>
/** CMS block title */
title?: Maybe<Scalars["String"]>
}
/** CMS blocks information */
export type CmsBlocks = {
__typename?: "CmsBlocks"
/** An array of CMS blocks */
items?: Maybe<Array<Maybe<CmsBlock>>>
}
/** CMS page defines all CMS page information */
export type CmsPage = {
__typename?: "CmsPage"
/** CMS page content */
content?: Maybe<Scalars["String"]>
/** CMS page content heading */
content_heading?: Maybe<Scalars["String"]>
/** Identifier of the CMS page */
identifier?: Maybe<Scalars["String"]>
/** CMS page meta description */
meta_description?: Maybe<Scalars["String"]>
/** CMS page meta keywords */
meta_keywords?: Maybe<Scalars["String"]>
/** CMS page meta title */
meta_title?: Maybe<Scalars["String"]>
/** CMS page content heading */
page_layout?: Maybe<Scalars["String"]>
/** CMS page title */
title?: Maybe<Scalars["String"]>
/** URL key of CMS page */
url_key?: Maybe<Scalars["String"]>
}
export type ColorSwatchData = SwatchDataInterface & {
__typename?: "ColorSwatchData"
/** Value of swatch item (HEX color code, image link or textual value) */
value?: Maybe<Scalars["String"]>
}
export type ComplexTextValue = {
__typename?: "ComplexTextValue"
/** HTML format */
html: Scalars["String"]
}
/**
* ConfigurableAttributeOption contains the value_index (and other related
* information) assigned to a configurable product option
*/
export type ConfigurableAttributeOption = {
__typename?: "ConfigurableAttributeOption"
/** The ID assigned to the attribute */
code?: Maybe<Scalars["String"]>
/** A string that describes the configurable attribute option */
label?: Maybe<Scalars["String"]>
/** A string that encodes option details. */
uid: Scalars["ID"]
/** A unique index number assigned to the configurable product option */
value_index?: Maybe<Scalars["Int"]>
}
export type ConfigurableCartItem = CartItemInterface & {
__typename?: "ConfigurableCartItem"
/** The list of available gift wrapping options for the cart item */
available_gift_wrapping: Array<Maybe<GiftWrapping>>
configurable_options: Array<Maybe<SelectedConfigurableOption>>
customizable_options?: Maybe<Array<Maybe<SelectedCustomizableOption>>>
/** The entered gift message for the cart item */
gift_message?: Maybe<GiftMessage>
/** The selected gift wrapping for the cart item */
gift_wrapping?: Maybe<GiftWrapping>
id: Scalars["String"]
prices?: Maybe<CartItemPrices>
product: ProductInterface
quantity: Scalars["Float"]
}
/** ConfigurableProduct defines basic features of a configurable product and its simple product variants */
export type ConfigurableProduct = ProductInterface &
PhysicalProductInterface &
CustomizableProductInterface & {
__typename?: "ConfigurableProduct"
/** The attribute set assigned to the product. */
attribute_set_id?: Maybe<Scalars["Int"]>
/**
* Relative canonical URL. This value is returned only if the system setting 'Use
* Canonical Link Meta Tag For Products' is enabled
*/
canonical_url?: Maybe<Scalars["String"]>
/** The categories assigned to a product. */
categories?: Maybe<Array<Maybe<CategoryInterface>>>
color?: Maybe<Scalars["Int"]>
/** An array of linked simple product items */
configurable_options?: Maybe<Array<Maybe<ConfigurableProductOptions>>>
/** The product's country of origin. */
country_of_manufacture?: Maybe<Scalars["String"]>
/** Timestamp indicating when the product was created. */
created_at?: Maybe<Scalars["String"]>
/** Crosssell Products */
crosssell_products?: Maybe<Array<Maybe<ProductInterface>>>
/** Detailed information about the product. The value can include simple HTML tags. */
description?: Maybe<ComplexTextValue>
fashion_color?: Maybe<Scalars["Int"]>
fashion_material?: Maybe<Scalars["String"]>
fashion_size?: Maybe<Scalars["Int"]>
fashion_style?: Maybe<Scalars["String"]>
format?: Maybe<Scalars["Int"]>
/** Indicates whether a gift message is available. */
gift_message_available?: Maybe<Scalars["String"]>
has_video?: Maybe<Scalars["Int"]>
/** The ID number assigned to the product. */
id?: Maybe<Scalars["Int"]>
/** The relative path to the main image on the product page. */
image?: Maybe<ProductImage>
/** Indicates whether the product can be returned */
is_returnable?: Maybe<Scalars["String"]>
/** A number representing the product's manufacturer. */
manufacturer?: Maybe<Scalars["Int"]>
/** An array of Media Gallery objects. */
media_gallery?: Maybe<Array<Maybe<MediaGalleryInterface>>>
/**
* An array of MediaGalleryEntry objects.
* @deprecated Use product's `media_gallery` instead
*/
media_gallery_entries?: Maybe<Array<Maybe<MediaGalleryEntry>>>
/** A brief overview of the product for search results listings, maximum 255 characters. */
meta_description?: Maybe<Scalars["String"]>
/** A comma-separated list of keywords that are visible only to search engines. */
meta_keyword?: Maybe<Scalars["String"]>
/** A string that is displayed in the title bar and tab of the browser and in search results lists. */
meta_title?: Maybe<Scalars["String"]>
/** The product name. Customers use this name to identify the product. */
name?: Maybe<Scalars["String"]>
/** The beginning date for new product listings, and determines if the product is featured as a new product. */
new_from_date?: Maybe<Scalars["String"]>
/** The end date for new product listings. */
new_to_date?: Maybe<Scalars["String"]>
/** Product stock only x left count */
only_x_left_in_stock?: Maybe<Scalars["Float"]>
/** An array of options for a customizable product. */
options?: Maybe<Array<Maybe<CustomizableOptionInterface>>>
/** If the product has multiple options, determines where they appear on the product page. */
options_container?: Maybe<Scalars["String"]>
/**
* A ProductPrices object, indicating the price of an item.
* @deprecated Use price_range for product price information.
*/
price?: Maybe<ProductPrices>
/** A PriceRange object, indicating the range of prices for the product */
price_range: PriceRange
/** An array of TierPrice objects. */
price_tiers?: Maybe<Array<Maybe<TierPrice>>>
/** An array of ProductLinks objects. */
product_links?: Maybe<Array<Maybe<ProductLinksInterface>>>
/** The average of all the ratings given to the product. */
rating_summary: Scalars["Float"]
/** Related Products */
related_products?: Maybe<Array<Maybe<ProductInterface>>>
/** The total count of all the reviews given to the product. */
review_count: Scalars["Int"]
/** The list of products reviews. */
reviews: ProductReviews
/** A short description of the product. Its use depends on the theme. */
short_description?: Maybe<ComplexTextValue>
/** A number or code assigned to a product to identify the product, options, price, and manufacturer. */
sku?: Maybe<Scalars["String"]>
/** The relative path to the small image, which is used on catalog pages. */
small_image?: Maybe<ProductImage>
/** The beginning date that a product has a special price. */
special_from_date?: Maybe<Scalars["String"]>
/** The discounted price of the product. */
special_price?: Maybe<Scalars["Float"]>
/** The end date that a product has a special price. */
special_to_date?: Maybe<Scalars["String"]>
/** Stock status of the product */
stock_status?: Maybe<ProductStockStatus>
/** The file name of a swatch image */
swatch_image?: Maybe<Scalars["String"]>
/** The relative path to the product's thumbnail image. */
thumbnail?: Maybe<ProductImage>
/**
* The price when tier pricing is in effect and the items purchased threshold has been reached.
* @